Add a superclass for all sections

2009-01-22 17:29:10 +01:00 · 2009-01-22 17:29:10 +01:00 · e6211c4c22
commit e6211c4c22
parent 318b81c027
1 changed files with 108 additions and 0 deletions
--- a/lib/section.php
+++ b/lib/section.php
@ -0,0 +1,108 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Base class for sections (sidebar widgets)
+ *
+ * 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  Widget
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/lib/widget.php';
+
+/**
+ * Base class for sections
+ *
+ * These are the widgets that show interesting data about a person
+ * group, or site.
+ *
+ * @category Widget
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
+
+class Section extends Widget
+{
+    /**
+     * Show the form
+     *
+     * Uses a recipe to output the form.
+     *
+     * @return void
+     * @see Widget::show()
+     */
+
+    function show()
+    {
+        $this->out->elementStart('div',
+                                 array('id' => $this->divId(),
+                                       'class' => 'section'));
+
+        $this->out->element('h2', null,
+                            $this->title());
+
+        $have_more = $this->showContent();
+
+        if ($have_more) {
+            $this->elementStart('p');
+            $this->element('a', array('href' => $this->moreUrl(),
+                                      'class' => 'more'),
+                           $this->moreTitle());
+            $this->elementEnd('p');
+        }
+
+        $this->elementEnd('div');
+    }
+
+    function divId()
+    {
+        return 'generic_section';
+    }
+
+    function title()
+    {
+        return _('Untitled section');
+    }
+
+    function showContent()
+    {
+        $this->out->element('p', null,
+                            _('(None)'));
+        return false;
+    }
+
+    function moreUrl()
+    {
+        return null;
+    }
+
+    function moreTitle()
+    {
+        return null;
+    }
+}