lib/nudgeform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for nudging 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   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/form.php';
  36
  37 /**
  38  * Form for nudging a user
  39  *
  40  * @category Form
  41  * @package  StatusNet
  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      DisfavorForm
  48  */
  49 class NudgeForm extends Form
  50 {
  51     /**
  52      * Profile of user to nudge
  53      */
  54     var $profile = null;
  55
  56     /**
  57      * Constructor
  58      *
  59      * @param HTMLOutputter $out     output channel
  60      * @param Profile       $profile profile of user to nudge
  61      */
  62     function __construct($out=null, $profile=null)
  63     {
  64         parent::__construct($out);
  65
  66         $this->profile = $profile;
  67     }
  68
  69     /**
  70      * ID of the form
  71      *
  72      * @return int ID of the form
  73      */
  74     function id()
  75     {
  76         return 'form_user_nudge';
  77     }
  78
  79
  80     /**
  81      * class of the form
  82      *
  83      * @return string of the form class
  84      */
  85     function formClass()
  86     {
  87         return 'form_user_nudge ajax';
  88     }
  89
  90
  91     /**
  92      * Action of the form
  93      *
  94      * @return string URL of the action
  95      */
  96     function action()
  97     {
  98         return common_local_url('nudge',
  99                                 array('nickname' => $this->profile->nickname));
 100     }
 101
 102
 103     /**
 104      * Legend of the Form
 105      *
 106      * @return void
 107      */
 108     function formLegend()
 109     {
 110         // TRANS: Form legend of form to nudge/ping another user.
 111         $this->out->element('legend', null, _('Nudge this user'));
 112     }
 113
 114
 115     /**
 116      * Action elements
 117      *
 118      * @return void
 119      */
 120     function formActions()
 121     {
 122         $this->out->submit('submit',
 123                            // TRANS: Button text to nudge/ping another user.
 124                            _m('BUTTON','Nudge'),
 125                            'submit',
 126                            null,
 127                            // TRANS: Button title to nudge/ping another user.
 128                            _('Send a nudge to this user.'));
 129     }
 130 }