lib/currentuserdesignaction.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for actions that use the current user's design
   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  * @copyright 2009-2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Base class for actions that use the current user's design
  36  *
  37  * Some pages (settings in particular) use the current user's chosen
  38  * design. This superclass returns that design.
  39  *
  40  * @category Action
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Zach Copley    <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  *
  47  */
  48 class CurrentUserDesignAction extends Action
  49 {
  50
  51     protected $cur = null; // The current user
  52
  53     /**
  54      * For initializing members of the class. Set a the
  55      * current user here.
  56      *
  57      * @param array $argarray misc. arguments
  58      *
  59      * @return boolean true
  60      */
  61     function prepare($argarray)
  62     {
  63         parent::prepare($argarray);
  64
  65         $this->cur = common_current_user();
  66
  67         return true;
  68     }
  69
  70     /**
  71      * A design for this action
  72      *
  73      * Returns the design preferences for the current user.
  74      *
  75      * @return Design a design object to use
  76      */
  77     function getDesign()
  78     {
  79         if (!empty($this->cur)) {
  80
  81             $design = $this->cur->getDesign();
  82
  83             if (!empty($design)) {
  84                 return $design;
  85             }
  86         }
  87
  88         return parent::getDesign();
  89     }
  90
  91     function getCurrentUser()
  92     {
  93         return $this->cur;
  94     }
  95 }
  96