]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/managedaction.php
Same goes to onStartShowAside() which has 'Action' as type-hint.
[quix0rs-gnu-social.git] / lib / managedaction.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for all actions with automatic showPage() call in handle()
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Action
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @author    Sarven Capadisli <csarven@status.net>
26  * @copyright 2008 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('GNUSOCIAL')) { exit(1); }
32
33 class ManagedAction extends Action
34 {
35     protected function prepare(array $args=array())
36     {
37         if (!parent::prepare($args)) {
38             return false;
39         }
40         $this->doPreparation();
41         return true;
42     }
43
44     protected function doPreparation()
45     {
46         // pass by default
47     }
48
49     /**
50      * Handler method
51      */
52     protected function handle()
53     {
54         parent::handle();
55
56         if ($this->canPost && $this->isPost()) {
57             try {
58                 $this->msg = $this->handlePost();
59             } catch (Exception $e) {
60                 $this->error = $e->getMessage();
61             }
62         }
63
64         $this->showPage();
65     }
66
67     protected function handlePost()
68     {
69         // This will only be run if the Action has the property canPost==true
70         assert($this->canPost);
71     }
72 }