lib/inviteform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for inviting collegues and friends
   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    Zach Copley <zach@status.net>
  25  * @copyright 2011 StatusNet, Inc.
  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')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/form.php';
  35
  36 /**
  37  * Form for inviting collegues and friends
  38  *
  39  * @category Form
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  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  */
  46 class InviteForm extends Form
  47 {
  48     /**
  49      * Constructor
  50      *
  51      * @param Action $out output channel
  52      */
  53     function __construct($out=null)
  54     {
  55         parent::__construct($out);
  56     }
  57
  58     /**
  59      * ID of the form
  60      *
  61      * @return string ID of the form
  62      */
  63     function id()
  64     {
  65        return 'form_invite';
  66     }
  67
  68     /**
  69      * class of the form
  70      *
  71      * @return string of the form class
  72      */
  73     function formClass()
  74     {
  75         return 'form_settings';
  76     }
  77
  78     /**
  79      * Action of the form
  80      *
  81      * @return string URL of the action
  82      */
  83     function action()
  84     {
  85         return common_local_url('invite');
  86     }
  87
  88     /**
  89      * Name of the form
  90      *
  91      * @return void
  92      */
  93     function formLegend()
  94     {
  95         // TRANS: Form legend.
  96         $this->out->element('legend', null, _('Invite collegues'));
  97     }
  98
  99     /**
 100      * Data elements of the form
 101      *
 102      * @return void
 103      */
 104     function formData()
 105     {
 106         $this->out->elementStart('ul', 'form_data');
 107         $this->out->elementStart('li');
 108         // TRANS: Field label for a list of e-mail addresses.
 109         $this->out->textarea(
 110             'addresses',
 111             _('Email addresses'),
 112             $this->out->trimmed('addresses'),
 113             // TRANS: Tooltip for field label for a list of e-mail addresses.
 114             _('Addresses of friends to invite (one per line).')
 115         );
 116         $this->out->elementEnd('li');
 117         $this->out->elementStart('li');
 118         // TRANS: Field label for a personal message to send to invitees.
 119         $this->out->textarea(
 120             'personal', _('Personal message'),
 121             $this->out->trimmed('personal'),
 122             // TRANS: Tooltip for field label for a personal message to send to invitees.
 123             _('Optionally add a personal message to the invitation.')
 124         );
 125         $this->out->elementEnd('li');
 126         $this->out->elementEnd('ul');
 127     }
 128
 129     /**
 130      * Action elements
 131      *
 132      * @return void
 133      */
 134     function formActions()
 135     {
 136         // TRANS: Send button for inviting friends
 137         $this->out->submit(
 138             'send',
 139             _m('BUTTON','Send'), 'submit form_action-primary',
 140             // TRANS: Submit button title.
 141             'send',
 142             _('Send')
 143         );
 144     }
 145 }