plugins/TagSub/tagsubform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for subscribing to a tag
   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  TagSubPlugin
  23  * @package   StatusNet
  24  * @author    Brion Vibber <brion@status.net>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Sarven Capadisli <csarven@status.net>
  27  * @copyright 2009-2011 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET') && !defined('LACONICA')) {
  33     exit(1);
  34 }
  35
  36 /**
  37  * Form for subscribing to a user
  38  *
  39  * @category TagSubPlugin
  40  * @package  StatusNet
  41  * @author   Brion Vibber <brion@status.net>
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Sarven Capadisli <csarven@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  *
  47  * @see      UnsubscribeForm
  48  */
  49
  50 class TagSubForm extends Form
  51 {
  52     /**
  53      * Name of tag to subscribe to
  54      */
  55
  56     var $tag = '';
  57
  58     /**
  59      * Constructor
  60      *
  61      * @param HTMLOutputter $out     output channel
  62      * @param string        $tag     name of tag to subscribe to
  63      */
  64
  65     function __construct($out=null, $tag=null)
  66     {
  67         parent::__construct($out);
  68
  69         $this->tag = $tag;
  70     }
  71
  72     /**
  73      * ID of the form
  74      *
  75      * @return int ID of the form
  76      */
  77
  78     function id()
  79     {
  80         return 'tag-subscribe-' . $this->tag;
  81     }
  82
  83
  84     /**
  85      * class of the form
  86      *
  87      * @return string of the form class
  88      */
  89
  90     function formClass()
  91     {
  92         // class to match existing styles...
  93         return 'form_user_subscribe ajax';
  94     }
  95
  96
  97     /**
  98      * Action of the form
  99      *
 100      * @return string URL of the action
 101      */
 102
 103     function action()
 104     {
 105         return common_local_url('tagsub', array('tag' => $this->tag));
 106     }
 107
 108
 109     /**
 110      * Legend of the Form
 111      *
 112      * @return void
 113      */
 114     function formLegend()
 115     {
 116         $this->out->element('legend', null, _m('Subscribe to this tag'));
 117     }
 118
 119     /**
 120      * Data elements of the form
 121      *
 122      * @return void
 123      */
 124
 125     function formData()
 126     {
 127         $this->out->hidden('subscribeto-' . $this->tag,
 128                            $this->tag,
 129                            'subscribeto');
 130     }
 131
 132     /**
 133      * Action elements
 134      *
 135      * @return void
 136      */
 137
 138     function formActions()
 139     {
 140         $this->out->submit('submit', _('Subscribe'), 'submit', null, _m('Subscribe to this tag'));
 141     }
 142 }