forked from GNUsocial/gnu-social
157 lines
3.7 KiB
PHP
157 lines
3.7 KiB
PHP
<?php
|
|
/**
|
|
* Laconica, the distributed open-source microblogging tool
|
|
*
|
|
* Base class for forms
|
|
*
|
|
* 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 Widget
|
|
* @package Laconica
|
|
* @author Evan Prodromou <evan@controlyourself.ca>
|
|
* @author Sarven Capadisli <csarven@controlyourself.ca>
|
|
* @copyright 2009 Control Yourself, Inc.
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
|
* @link http://laconi.ca/
|
|
*/
|
|
|
|
if (!defined('LACONICA')) {
|
|
exit(1);
|
|
}
|
|
|
|
require_once INSTALLDIR.'/lib/widget.php';
|
|
|
|
/**
|
|
* Base class for forms
|
|
*
|
|
* We have a lot of common forms (subscribe, fave, delete) and this superclass
|
|
* lets us abstract out the basic features of the form.
|
|
*
|
|
* @category Widget
|
|
* @package Laconica
|
|
* @author Evan Prodromou <evan@controlyourself.ca>
|
|
* @author Sarven Capadisli <csarven@controlyourself.ca>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
|
* @link http://laconi.ca/
|
|
*
|
|
* @see HTMLOutputter
|
|
*/
|
|
|
|
class Form extends Widget
|
|
{
|
|
/**
|
|
* Show the form
|
|
*
|
|
* Uses a recipe to output the form.
|
|
*
|
|
* @return void
|
|
* @see Widget::show()
|
|
*/
|
|
|
|
function show()
|
|
{
|
|
$this->out->elementStart('form',
|
|
array('id' => $this->id(),
|
|
'method' => 'POST',
|
|
'action' => $this->action()));
|
|
$this->out->elementStart('fieldset');
|
|
$this->formLegend();
|
|
$this->sessionToken();
|
|
$this->formData();
|
|
$this->formActions();
|
|
$this->out->elementEnd('fieldset');
|
|
$this->out->elementEnd('form');
|
|
}
|
|
|
|
/**
|
|
* Include a session token for CSRF protection
|
|
*
|
|
* @return void
|
|
*/
|
|
|
|
function sessionToken()
|
|
{
|
|
$this->out->hidden('token', common_session_token());
|
|
}
|
|
|
|
|
|
/**
|
|
* Name of the form
|
|
*
|
|
* Sub-classes should overload this with the name of their form.
|
|
*
|
|
* @return void
|
|
*/
|
|
|
|
function formLegend()
|
|
{
|
|
}
|
|
|
|
|
|
/**
|
|
* Visible or invisible data elements
|
|
*
|
|
* Display the form fields that make up the data of the form.
|
|
* Sub-classes should overload this to show their data.
|
|
*
|
|
* @return void
|
|
*/
|
|
|
|
function formData()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Buttons for form actions
|
|
*
|
|
* Submit and cancel buttons (or whatever)
|
|
* Sub-classes should overload this to show their own buttons.
|
|
*
|
|
* @return void
|
|
*/
|
|
|
|
function formActions()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* ID of the form
|
|
*
|
|
* Should be unique on the page. Sub-classes should overload this
|
|
* to show their own IDs.
|
|
*
|
|
* @return int ID of the form
|
|
*/
|
|
|
|
function id()
|
|
{
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Action of the form.
|
|
*
|
|
* URL to post to. Should be overloaded by subclasses to give
|
|
* somewhere to post to.
|
|
*
|
|
* @return string URL to post to
|
|
*/
|
|
|
|
function action()
|
|
{
|
|
}
|
|
}
|