lib/subscribeform.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * Form for subscribing to a user
   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   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 require_once INSTALLDIR.'/lib/form.php';
  36
  37 /**
  38  * Form for subscribing to a user
  39  *
  40  * @category Form
  41  * @package  Laconica
  42  * @author   Evan Prodromou <evan@controlyourself.ca>
  43  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://laconi.ca/
  46  *
  47  * @see      UnsubscribeForm
  48  */
  49
  50 class SubscribeForm extends Form
  51 {
  52     /**
  53      * Profile of user to subscribe to
  54      */
  55
  56     var $profile = null;
  57
  58     /**
  59      * Constructor
  60      *
  61      * @param HTMLOutputter $out     output channel
  62      * @param Profile       $profile profile of user to subscribe to
  63      */
  64
  65     function __construct($out=null, $profile=null)
  66     {
  67         parent::__construct($out);
  68
  69         $this->profile = $profile;
  70     }
  71
  72     /**
  73      * ID of the form
  74      *
  75      * @return int ID of the form
  76      */
  77
  78     function id()
  79     {
  80         return 'subscribe-' . $this->profile->id;
  81     }
  82
  83
  84     /**
  85      * class of the form
  86      *
  87      * @return string of the form class
  88      */
  89
  90     function formClass()
  91     {
  92         return 'form_user_subscribe';
  93     }
  94
  95
  96     /**
  97      * Action of the form
  98      *
  99      * @return string URL of the action
 100      */
 101
 102     function action()
 103     {
 104         return common_local_url('subscribe');
 105     }
 106
 107     /**
 108      * Data elements of the form
 109      *
 110      * @return void
 111      */
 112
 113     function formData()
 114     {
 115         $this->out->hidden('subscribeto-' . $this->profile->id,
 116                            $this->profile->id,
 117                            'subscribeto');
 118     }
 119
 120     /**
 121      * Action elements
 122      *
 123      * @return void
 124      */
 125
 126     function formActions()
 127     {
 128         $this->out->submit('submit', _('Subscribe'));
 129     }
 130 }