git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

unsubscribeform.php 3.34 KB
Newer Older
1 2
<?php
/**
3
 * StatusNet, the distributed open-source microblogging tool
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * Form for unsubscribing from a user
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Form
23
 * @package   StatusNet
24 25
 * @author    Evan Prodromou <evan@status.net>
 * @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 33 34 35 36 37 38 39 40
    exit(1);
}

require_once INSTALLDIR.'/lib/form.php';

/**
 * Form for unsubscribing from a user
 *
 * @category Form
41
 * @package  StatusNet
42 43
 * @author   Evan Prodromou <evan@status.net>
 * @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 48 49 50 51
 *
 * @see      SubscribeForm
 */
class UnsubscribeForm extends Form
{
    /**
Evan Prodromou's avatar
Evan Prodromou committed
52
     * Profile of user to unsubscribe from
53 54 55 56 57 58 59 60
     */

    var $profile = null;

    /**
     * Constructor
     *
     * @param HTMLOutputter $out     output channel
Evan Prodromou's avatar
Evan Prodromou committed
61
     * @param Profile       $profile profile of user to unsub from
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
     */
    function __construct($out=null, $profile=null)
    {
        parent::__construct($out);

        $this->profile = $profile;
    }

    /**
     * ID of the form
     *
     * @return int ID of the form
     */
    function id()
    {
        return 'unsubscribe-' . $this->profile->id;
    }

sarven's avatar
sarven committed
80 81 82 83 84 85 86 87

    /**
     * class of the form
     *
     * @return string of the form class
     */
    function formClass()
    {
88
        return 'form_user_unsubscribe ajax';
sarven's avatar
sarven committed
89 90
    }

91 92 93 94 95 96 97 98 99 100
    /**
     * Action of the form
     *
     * @return string URL of the action
     */
    function action()
    {
        return common_local_url('unsubscribe');
    }

101 102 103 104 105 106 107
    /**
     * Legend of the Form
     *
     * @return void
     */
    function formLegend()
    {
108
        // TRANS: Form legend on unsubscribe form.
109 110 111
        $this->out->element('legend', null, _('Unsubscribe from this user'));
    }

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
    /**
     * Data elements of the form
     *
     * @return void
     */
    function formData()
    {
        $this->out->hidden('unsubscribeto-' . $this->profile->id,
                           $this->profile->id,
                           'unsubscribeto');
    }

    /**
     * Action elements
     *
     * @return void
     */
    function formActions()
    {
131 132 133
        // TRANS: Button text on unsubscribe form.
        $this->out->submit('submit', _m('BUTTON','Unsubscribe'), 'submit', null,
                           // TRANS: Button title on unsubscribe form.
134
                           _('Unsubscribe from this user.'));
135
    }
sarven's avatar
sarven committed
136
}