gnu-social/lib/managedaction.php

91 lines
2.6 KiB
PHP
Raw Normal View History

<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Base class for all actions with automatic showPage() call in handle()
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Action
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2008 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
class ManagedAction extends Action
{
2014-07-06 11:55:18 +01:00
protected function prepare(array $args=array())
{
if (!parent::prepare($args)) {
return false;
}
$this->doPreparation();
return true;
}
protected function doPreparation()
{
// pass by default
}
/**
* Handler method
*/
protected function handle()
{
parent::handle();
if ($this->canPost && $this->isPost()) {
try {
$this->msg = $this->handlePost();
} catch (Exception $e) {
$this->error = $e->getMessage();
}
}
$this->showPage();
}
/**
* If this is extended in child classes, they should
* end with 'return parent::handlePost();' - and they
* should only extend this function if what they do
* cannot be handled in ->doPost()
*/
protected function handlePost()
{
// This will only be run if the Action has the property canPost==true
2014-07-06 11:55:18 +01:00
assert($this->canPost);
$this->checkSessionToken();
return $this->doPost();
}
/**
* Do Post stuff. Return a string if successful,
* describing what has been done. Always throw an
* exception on failure, with a descriptive message.
*/
protected function doPost() {
throw new Exception('Unhandled POST');
}
}