lib/subscribepeopletagform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for subscribing to a peopletag
   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  Form
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Shashi Gowda <connect2shashi@gmail.com>
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/form.php';
  35
  36 /**
  37  * Form for subscribing to a peopletag
  38  *
  39  * @category Form
  40  * @package  StatusNet
  41  * @author   Shashi Gowda <connect2shashi@gmail.com>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  *
  45  * @see      UnsubscribeForm
  46  */
  47 class SubscribePeopletagForm extends Form
  48 {
  49     /**
  50      * peopletag for the user to join
  51      */
  52     var $peopletag = null;
  53
  54     /**
  55      * Constructor
  56      *
  57      * @param HTMLOutputter $out   output channel
  58      * @param peopletag     $peopletag peopletag to subscribe to
  59      */
  60     function __construct($out=null, $peopletag=null)
  61     {
  62         parent::__construct($out);
  63
  64         $this->peopletag = $peopletag;
  65     }
  66
  67     /**
  68      * ID of the form
  69      *
  70      * @return string ID of the form
  71      */
  72     function id()
  73     {
  74         return 'peopletag-subscribe-' . $this->peopletag->id;
  75     }
  76
  77     /**
  78      * class of the form
  79      *
  80      * @return string of the form class
  81      */
  82     function formClass()
  83     {
  84         return 'form_peopletag_subscribe';
  85     }
  86
  87     /**
  88      * Action of the form
  89      *
  90      * @return string URL of the action
  91      */
  92     function action()
  93     {
  94         return common_local_url('subscribepeopletag',
  95                                 array('id' => $this->peopletag->id));
  96     }
  97
  98     /**
  99      * Action elements
 100      *
 101      * @return void
 102      */
 103     function formActions()
 104     {
 105         // TRANS: Button text for subscribing to a list.
 106         $this->out->submit('submit', _m('BUTTON', 'Subscribe'));
 107
 108     }
 109 }