Add a base class for UI widgets

1 files changed, 81 insertions, 0 deletions

diff --git a/lib/widget.php b/lib/widget.php
new file mode 100644
index 000000000..e69cc8b74
--- /dev/null
+++ b/lib/widget.php
@@ -0,0 +1,81 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Base class for UI 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>
+ * @author    Sarven Capadisli <csarven@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);
+}
+
+/**
+ * Base class for UI widgets
+ *
+ * A widget is a cluster of HTML elements that provide some functionality that's used on different
+ * parts of the site. Examples would be profile lists, notice lists, and common forms.
+ *
+ * @category Widget
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Sarven Capadisli <csarven@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/
+ *
+ * @see      HTMLOutputter
+ */
+
+class Widget
+{
+    /**
+     * HTMLOutputter to use for output
+     */
+
+    var $out = null;
+
+    /**
+     * Prepare the widget for use
+     *
+     * @param HTMLOutputter $out output helper, defaults to null
+     */
+
+    function __construct($out=null)
+    {
+        $this->out = $out;
+    }
+
+    /**
+     * Show the widget
+     *
+     * Emit the HTML for the widget, using the configured outputter.
+     *
+     * @return void
+     */
+
+    function show()
+    {
+    }
+}