lib/widget.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * Base class for UI widgets
   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  Widget
  23  * @package   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
  26  * @copyright 2009 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Base class for UI widgets
  37  *
  38  * A widget is a cluster of HTML elements that provide some functionality that's used on different
  39  * parts of the site. Examples would be profile lists, notice lists, and common forms.
  40  *
  41  * @category Widget
  42  * @package  Laconica
  43  * @author   Evan Prodromou <evan@controlyourself.ca>
  44  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://laconi.ca/
  47  *
  48  * @see      HTMLOutputter
  49  */
  50
  51 class Widget
  52 {
  53     /**
  54      * HTMLOutputter to use for output
  55      */
  56
  57     var $out = null;
  58
  59     /**
  60      * Prepare the widget for use
  61      *
  62      * @param HTMLOutputter $out output helper, defaults to null
  63      */
  64
  65     function __construct($out=null)
  66     {
  67         $this->out = $out;
  68     }
  69
  70     /**
  71      * Show the widget
  72      *
  73      * Emit the HTML for the widget, using the configured outputter.
  74      *
  75      * @return void
  76      */
  77
  78     function show()
  79     {
  80     }
  81 }