common superclass for menu widgets

2011-03-01 05:45:38 -05:00 · 2011-03-01 05:45:38 -05:00 · c8d6a77d8a
commit c8d6a77d8a
parent e109b2592f
1 changed files with 84 additions and 0 deletions
--- a/lib/menu.php
+++ b/lib/menu.php
@ -0,0 +1,84 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2011, StatusNet, Inc.
+ *
+ * Menu widget
+ * 
+ * PHP version 5
+ *
+ * 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  Widget
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2011 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    // This check helps protect against security problems;
+    // your code file can't be executed directly from the web.
+    exit(1);
+}
+
+/**
+ * Superclass for menus
+ *
+ * @category  General
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2011 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link      http://status.net/
+ */
+
+class Menu extends Widget
+{
+    var $action     = null;
+    var $actionName = null;
+    /**
+     * Construction
+     *
+     * @param Action $action current action, used for output
+     */
+    function __construct($action=null)
+    {
+        parent::__construct($action);
+
+        $this->action     = $action;
+        $this->actionName = $action->trimmed('action');
+    }
+
+    function item($actionName, $args, $label, $description, $id=null)
+    {
+        if (empty($id)) {
+            $id = $this->menuItemID($actionName);
+        }
+
+        $url = common_local_url($actionName, $args);
+
+        $this->out->menuItem($url,
+                             $label,
+                             $description,
+                             $actionName == $this->actionName,
+                             $id);
+    }
+
+    function menuItemID($actionName)
+    {
+        return sprintf('nav_%s', $actionName);
+    }
+}