gnu-social/lib/favorform.php
Mikael Nordfeldth 5f1fea1488 FavorAction upgraded to extend FormAction
Includes some minor changes to other things as well, such as the session
token input element now having the same 'name' attribute as everyone else.
(it still retains a 'token-'+noticeid 'id' attribute for clientside JS)
2013-09-23 13:06:09 +02:00

151 lines
3.9 KiB
PHP

<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Form for favoring a notice
*
* 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
* @package GNUSocial
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://www.gnu.org/software/social/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Form for favoring a notice
*
* @category Form
* @package GNUSocial
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @author Mikael Nordfeldth <mmn@hethane.se>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://www.gnu.org/software/social/
*
* @see DisfavorForm
*/
class FavorForm extends Form
{
/**
* Notice to favor
*/
var $notice = null;
/**
* Constructor
*
* @param HTMLOutputter $out output channel
* @param Notice $notice notice to favor
*/
function __construct($out=null, $notice=null)
{
parent::__construct($out);
$this->notice = $notice;
}
/**
* ID of the form
*
* @return int ID of the form
*/
function id()
{
return 'favor-' . $this->notice->id;
}
/**
* Action of the form
*
* @return string URL of the action
*/
function action()
{
return common_local_url('favor');
}
/**
* Include a session token for CSRF protection
*
* @return void
*/
function sessionToken()
{
$this->out->hidden('token-' . $this->notice->id,
common_session_token(),
'token');
}
/**
* Legend of the Form
*
* @return void
*/
function formLegend()
{
// TRANS: Form legend for adding the favourite status to a notice.
$this->out->element('legend', null, _('Favor this notice'));
}
/**
* Data elements
*
* @return void
*/
function formData()
{
if (Event::handle('StartFavorNoticeForm', array($this, $this->notice))) {
$this->out->hidden('notice-n'.$this->notice->id,
$this->notice->id,
'notice');
Event::handle('EndFavorNoticeForm', array($this, $this->notice));
}
}
/**
* Action elements
*
* @return void
*/
function formActions()
{
$this->out->submit('favor-submit-' . $this->notice->id,
// TRANS: Button text for adding the favourite status to a notice.
_m('BUTTON','Favor'),
'submit',
null,
// TRANS: Button title for adding the favourite status to a notice.
_('Add this notice to your list of favorite notices.'));
}
/**
* Class of the form.
*
* @return string the form's class
*/
function formClass()
{
return 'form_favor ajax';
}
}