Page MenuHomePhorge
Files F117883625

kolab_form.php
No OneTemporary
Actions

Authored By
Unknown
Size
9 KB
Referenced Files
None
Subscribers
None

kolab_form.php
View Options

<?php
/*
+--------------------------------------------------------------------------+
| This file is part of the Kolab Web Admin Panel |
| |
| Copyright (C) 2011-2012, Kolab Systems AG |
| |
| 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/> |
+--------------------------------------------------------------------------+
| Author: Aleksander Machniak <machniak@kolabsys.com> |
+--------------------------------------------------------------------------+
*/
/**
* HTML Form generator
*/
class kolab_form
{
const INPUT_TEXT = 1;
const INPUT_PASSWORD = 2;
const INPUT_TEXTAREA = 3;
const INPUT_CHECKBOX = 4;
const INPUT_RADIO = 5;
const INPUT_BUTTON = 6;
const INPUT_SUBMIT = 7;
const INPUT_SELECT = 8;
const INPUT_HIDDEN = 9;
const INPUT_CUSTOM = 10;
const TYPE_LIST = 1;
private $attribs = array();
private $elements = array();
private $sections = array();
private $buttons = array();
private $title;
private $active_section;
/**
* Class constructor.
*
* @param array $attribs Form attributes
*/
public function __construct($attribs = array())
{
$this->attribs = $attribs;
}
/**
* Adds form section definition.
*
* @param string $index Section internal index
* @param string $legend Section label (fieldset's legend)
*/
public function add_section($index, $legend)
{
$this->sections[$index] = $legend;
}
/**
* Activate form section.
*
* @param string $index Section internal index
*/
public function activate_section($index)
{
$this->active_section = $index;
}
/**
* Adds form element definition.
*
* @param array $attribs Element attributes
* @param string $section Section index
*/
public function add_element($attribs, $section = null)
{
if (!empty($section)) {
$attribs['section'] = $section;
}
$this->elements[] = $attribs;
}
/**
* Adds form button definition.
*
* @param array $attribs Button attributes
*/
public function add_button($attribs)
{
$this->buttons[] = $attribs;
}
/**
* Sets form title (header).
*
* @param string $content Form header content
*/
public function set_title($content)
{
$this->title = $content;
}
/**
* Returns HTML output of the form.
*
* @return string HTML output
*/
public function output()
{
$content = '';
$hidden = array();
if (!empty($this->sections)) {
foreach ($this->sections as $set_idx => $set) {
$rows = array();
foreach ($this->elements as $element) {
if (empty($element['section']) || $element['section'] != $set_idx) {
continue;
}
if ($element['type'] == self::INPUT_HIDDEN) {
$hidden[] = $this->get_element($element);
continue;
}
$rows[] = $this->form_row($element);
}
if (!empty($rows)) {
$content .= "\n" . kolab_html::fieldset(array(
'legend' => $set,
'content' => kolab_html::table(array('body' => $rows, 'class' => 'form')),
'class' => $this->active_section == $set_idx ? 'active' : '',
));
}
}
}
$rows = array();
foreach ($this->elements as $element) {
if (!empty($element['section'])) {
continue;
}
if ($element['type'] == self::INPUT_HIDDEN) {
$hidden[] = $this->get_element($element);
continue;
}
$rows[] = $this->form_row($element);
}
if (!empty($rows)) {
$content = kolab_html::table(array('body' => $rows, 'class' => 'form'));
}
if (!empty($hidden)) {
$content .= implode("\n", $hidden);
}
// Add form buttons
if (!empty($this->buttons)) {
$buttons = '';
foreach ($this->buttons as $button) {
$button['type'] = 'button';
if (empty($button['value'])) {
$button['value'] = $button['label'];
}
$buttons .= kolab_html::input($button);
}
$content .= "\n" . kolab_html::div(array(
'class' => 'formbuttons',
'content' => $buttons
));
}
// Build form
$content = kolab_html::form($this->attribs, $content);
// Add title element
if ($this->title) {
$content = kolab_html::span(array(
'content' => $this->title,
'class' => 'formtitle',
)) . "\n" . $content;
}
// Add event trigger, so UI can rebuild the form e.g. adding tabs
$content .= kolab_html::script('kadm.form_init(\'' . $this->attribs['id'] . '\')');
return $content;
}
/**
* Builds a row of the form table.
*/
private function form_row($element)
{
$cells = array(
0 => array(
'class' => 'label',
'body' => $element['label'],
),
1 => array(
'class' => 'value',
'body' => $this->get_element($element),
),
);
$attrib = array('cells' => $cells);
if ($element['required']) {
$attrib['class'] = 'required';
}
return $attrib;
}
/**
* Builds an element of the form.
*/
private function get_element($attribs)
{
$type = isset($attribs['type']) ? $attribs['type'] : 0;
if (!empty($attribs['readonly']) || !empty($attribs['disabled'])) {
$attribs['class'] = (!empty($attribs['class']) ? $attribs['class'] . ' ' : '') . 'readonly';
}
switch ($type) {
case self::INPUT_TEXT:
case self::INPUT_PASSWORD:
// INPUT type
$attribs['type'] = $type == self::INPUT_PASSWORD ? 'password' : 'text';
// INPUT size
if (empty($attribs['size'])) {
$attribs['size'] = 40;
if (!empty($attribs['maxlength'])) {
$attribs['size'] = $attribs['maxlength'] > 10 ? 40 : 10;
}
}
if ($attribs['size'] >= 40) {
$attribs['class'] = (!empty($attribs['class']) ? $attribs['class'] . ' ' : '') . 'maxsize';
}
$content = kolab_html::input($attribs);
break;
case self::INPUT_HIDDEN:
$attribs['type'] = 'hidden';
$content = kolab_html::input($attribs);
break;
case self::INPUT_TEXTAREA:
if (empty($attribs['rows'])) {
$attribs['rows'] = 5;
}
if (empty($attribs['cols'])) {
$attribs['cols'] = 50;
}
if (!empty($attribs['data-type'])) {
switch ($attribs['data-type']) {
case self::TYPE_LIST:
$attribs['data-type'] = 'list';
break;
default:
unset($attribs['data-type']);
}
}
$content = kolab_html::textarea($attribs, true);
break;
case self::INPUT_SELECT:
if (!empty($attribs['multiple']) && empty($attribs['size'])) {
$attribs['size'] = 5;
}
$content = kolab_html::select($attribs, true);
break;
case self::INPUT_CUSTOM:
default:
if (is_array($attribs)) {
$content = isset($attribs['value']) ? $attribs['value'] : '';
}
else {
$content = $attribs;
}
}
if (!empty($attribs['suffix'])) {
$content .= ' ' . $attribs['suffix'];
}
return $content;
}
}

File Metadata

Mime Type
text/x-php
Expires
Mon, Apr 6, 1:07 AM (2 d, 18 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
18/fa/6a3d1ca6b416988d4e78866f6dac
Default Alt Text
kolab_form.php (9 KB)

Event Timeline