lib/menu.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Menu widget
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Widget
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Superclass for menus
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class Menu extends Widget
  49 {
  50     var $action     = null;
  51     var $actionName = null;
  52     /**
  53      * Construction
  54      *
  55      * @param Action $action current action, used for output
  56      */
  57     function __construct($action=null)
  58     {
  59         parent::__construct($action);
  60
  61         $this->action     = $action;
  62         $this->actionName = $action->trimmed('action');
  63     }
  64
  65     function id()
  66     {
  67         return 'unknown_menu';
  68     }
  69
  70     function menuStart()
  71     {
  72         $this->action->elementStart('div', array('id' => $this->id()));
  73         $this->action->elementStart('ul', array('class' => 'nav'));
  74     }
  75
  76     function menuEnd()
  77     {
  78         $this->action->elementEnd('ul');
  79         $this->action->elementEnd('div');
  80     }
  81
  82     function item($actionName, $args, $label, $description, $id=null)
  83     {
  84         if (empty($id)) {
  85             $id = $this->menuItemID($actionName);
  86         }
  87
  88         $url = common_local_url($actionName, $args);
  89
  90         $this->out->menuItem($url,
  91                              $label,
  92                              $description,
  93                              $actionName == $this->actionName,
  94                              $id);
  95     }
  96
  97     function menuItemID($actionName)
  98     {
  99         return sprintf('nav_%s', $actionName);
 100     }
 101
 102     function submenu($label, $menu)
 103     {
 104         $this->action->elementStart('li');
 105         $this->action->element('h3', null, $label);
 106         $menu->show();
 107         $this->action->elementEnd('li');
 108     }
 109 }