1285 lines
36 KiB
PHP
1285 lines
36 KiB
PHP
<?php
|
|
/*
|
|
$Id$
|
|
|
|
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
|
Copyright (C) 2010 Roland Gruber
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 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 General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*/
|
|
|
|
/**
|
|
* Interface between modules and other parts of LAM.
|
|
*
|
|
* @package metaHTML
|
|
* @author Roland Gruber
|
|
*/
|
|
|
|
/**
|
|
* Represents a HTML element.
|
|
* This is used to build HTML code by using objects.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
abstract class htmlElement {
|
|
|
|
const OPTION_ALIGN = 0;
|
|
|
|
const ALIGN_TOP = 0;
|
|
const ALIGN_LEFT = 1;
|
|
const ALIGN_RIGHT = 2;
|
|
const ALIGN_BOTTOM = 3;
|
|
|
|
/** alignment when inside a table */
|
|
public $alignment = null;
|
|
/** colspan if inside a table */
|
|
public $colspan = null;
|
|
/** rowspan if inside a table */
|
|
public $rowspan = null;
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
abstract function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope);
|
|
|
|
/**
|
|
* Returns the HTML attributes for the alignment.
|
|
*
|
|
* @return String alignment HTML attributes (e.g. align="right" valign="top")
|
|
*/
|
|
public function getAlignmentString() {
|
|
$align = '';
|
|
if ($this->alignment !== null) {
|
|
switch ($this->alignment) {
|
|
case htmlElement::ALIGN_BOTTOM:
|
|
$align = 'valign="bottom"';
|
|
break;
|
|
case htmlElement::ALIGN_TOP:
|
|
$align = 'valign="top"';
|
|
break;
|
|
case htmlElement::ALIGN_LEFT:
|
|
$align = 'align="left"';
|
|
break;
|
|
case htmlElement::ALIGN_RIGHT:
|
|
$align = 'align="right"';
|
|
break;
|
|
}
|
|
}
|
|
return $align;
|
|
}
|
|
|
|
/**
|
|
* Returns the HTML attribute for the colspan.
|
|
*
|
|
* @return String colspan HTML attribute (e.g. colspan=3)
|
|
*/
|
|
public function getColspanString() {
|
|
if ($this->colspan == null) {
|
|
return '';
|
|
}
|
|
else return 'colspan="' . $this->colspan . '"';
|
|
}
|
|
|
|
/**
|
|
* Returns the HTML attribute for the rowspan.
|
|
*
|
|
* @return String rowspan HTML attribute (e.g. rowspan=3)
|
|
*/
|
|
public function getRowspanString() {
|
|
if ($this->rowspan == null) {
|
|
return '';
|
|
}
|
|
else return 'rowspan="' . $this->rowspan . '"';
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Structures elements using a table.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTable extends htmlElement {
|
|
|
|
/** table header */
|
|
const header = "<table>\n";
|
|
/** table footer */
|
|
const footer = "</table>\n";
|
|
/** new line */
|
|
const newLine = "</tr><tr>\n";
|
|
|
|
/** list of subelements */
|
|
private $elements = array();
|
|
/** specifies if currently a row is open */
|
|
private $rowOpen = false;
|
|
|
|
/**
|
|
* Adds an element to the table. The element may be a htmlElement object or a simple String.
|
|
*
|
|
* @param mixed $element htmlElement object or a simple String
|
|
* @param boolean $newLine adds a new line after the element (optional, default false)
|
|
* @param array $options list of options (e.g. htmlElement::OPTION_ALIGN => htmlElement::ALIGN_TOP)
|
|
*/
|
|
public function addElement($element, $newLine = false) {
|
|
// add row element
|
|
if ($element instanceof htmlTableRow) {
|
|
// check if a row needs to be closed
|
|
if ($this->rowOpen) {
|
|
$this->elements[] = "</tr>\n";
|
|
$this->rowOpen = false;
|
|
}
|
|
$this->elements[] = $element;
|
|
}
|
|
// add cell element
|
|
elseif ($element instanceof htmlElement) {
|
|
// check if a row needs to be opened
|
|
if (!$this->rowOpen) {
|
|
$this->elements[] = "<tr>\n";
|
|
$this->rowOpen = true;
|
|
}
|
|
// check if alignment option was given
|
|
$align = $element->getAlignmentString();
|
|
$colspan = $element->getColspanString();
|
|
$rowspan = $element->getRowspanString();
|
|
$this->elements[] = "<td $align $colspan $rowspan>\n";
|
|
$this->elements[] = $element;
|
|
$this->elements[] = "</td>\n";
|
|
if ($newLine) {
|
|
$this->addNewLine();
|
|
}
|
|
}
|
|
else {
|
|
StatusMessage('ERROR', 'Invalid element', print_r($element, true));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds another line to the table.
|
|
*/
|
|
public function addNewLine() {
|
|
if (!$this->rowOpen) {
|
|
$this->elements[] = "<tr>\n";
|
|
}
|
|
else {
|
|
$this->elements[] = htmlTable::newLine;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$return = array();
|
|
echo htmlTable::header;
|
|
// print all contained elements
|
|
for ($i = 0; $i < sizeof($this->elements); $i++) {
|
|
// print htmlElement objects
|
|
if ($this->elements[$i] instanceof htmlElement) {
|
|
$fields = $this->elements[$i]->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
$return = array_merge($return, $fields);
|
|
}
|
|
// print simple Strings
|
|
else {
|
|
if ($i != (sizeof($this->elements) - 1) || !($this->elements[$i] == htmlTable::newLine) ) {
|
|
echo $this->elements[$i];
|
|
}
|
|
}
|
|
}
|
|
if ($this->rowOpen) {
|
|
echo "</tr>\n";
|
|
}
|
|
echo htmlTable::footer;
|
|
return $return;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* A row inside a htmlTable.
|
|
*
|
|
* @see htmlTable
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTableRow extends htmlElement {
|
|
|
|
private $cells;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param array $cells list of htmlElements
|
|
* @see htmlElement
|
|
*/
|
|
function __construct($cells) {
|
|
$this->cells = $cells;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$types = array();
|
|
echo "<tr>\n";
|
|
for ($i = 0; $i < sizeof($this->cells); $i++) {
|
|
// check if alignment option was given
|
|
$align = $this->cells[$i]->getAlignmentString();
|
|
$colspan = $this->cells[$i]->getColspanString();
|
|
$rowspan = $this->cells[$i]->getRowspanString();
|
|
echo "<td $align $colspan $rowspan>\n";
|
|
$types = array_merge($types, $this->cells[$i]->generateHTML($module, $input, $values, $restricted, $tabindex, $scope));
|
|
echo "</td>\n";
|
|
}
|
|
echo "</tr>";
|
|
return $types;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* A standard input field.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlInputField extends htmlElement {
|
|
|
|
/** unique field name */
|
|
private $fieldName;
|
|
/** field value */
|
|
private $fieldValue;
|
|
/** field size (default 30) */
|
|
private $fieldSize = 30;
|
|
/** field max length (default 255) */
|
|
private $fieldMaxLength = 255;
|
|
/** password field */
|
|
private $isPassword = false;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param String $fieldName unique field name
|
|
* @param String $fieldValue value of input field (optional)
|
|
*/
|
|
function __construct($fieldName, $fieldValue = null) {
|
|
$this->fieldName = htmlspecialchars($fieldName);
|
|
$this->fieldValue = htmlspecialchars($fieldValue);
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
if (isset($values[$this->fieldName])) {
|
|
$this->fieldValue = $values[$this->fieldName][0];
|
|
}
|
|
// print input field
|
|
$name = ' name="' . $this->fieldName . '"';
|
|
$value = '';
|
|
if ($this->fieldValue != null) {
|
|
$value = ' value="' . $this->fieldValue . '"';
|
|
}
|
|
$maxLength = '';
|
|
if ($this->fieldMaxLength != null) {
|
|
$maxLength = ' maxlength="' . $this->fieldMaxLength . '"';
|
|
}
|
|
$size = ' size="' . $this->fieldSize . '"';
|
|
$fieldTabIndex = ' tabindex="' . $tabindex . '"';
|
|
$tabindex++;
|
|
$inputType = 'text';
|
|
if ($this->isPassword) {
|
|
$inputType = 'password';
|
|
}
|
|
echo '<input type="' . $inputType . '"' . $name . $value . $maxLength . $size . $fieldTabIndex . '>';
|
|
return array($this->fieldName => 'text');
|
|
}
|
|
|
|
/**
|
|
* Sets the maximum field length.
|
|
*
|
|
* @param int $fieldMaxLength length
|
|
*/
|
|
public function setFieldMaxLength($fieldMaxLength) {
|
|
$this->fieldMaxLength = $fieldMaxLength;
|
|
}
|
|
|
|
/**
|
|
* Sets the field size.
|
|
*
|
|
* @param int $fieldSize size
|
|
*/
|
|
public function setFieldSize($fieldSize) {
|
|
$this->fieldSize = $fieldSize;
|
|
}
|
|
|
|
/**
|
|
* Specifies if this is a password field.
|
|
*
|
|
* @param boolean $isPassword password field
|
|
*/
|
|
public function setIsPassword($isPassword) {
|
|
$this->isPassword = $isPassword;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* An extended input field that combines label, input field and help.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTableExtendedInputField extends htmlInputField {
|
|
|
|
/** Descriptive label */
|
|
private $label;
|
|
/** help ID */
|
|
private $helpID;
|
|
/** required field */
|
|
private $required = false;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param String $label descriptive label
|
|
* @param String $fieldName unique field name
|
|
* @param String $fieldValue value of input field (optional)
|
|
* @param String $helpID help ID (optional)
|
|
*/
|
|
function __construct($label, $fieldName, $fieldValue = null, $helpID = null) {
|
|
parent::__construct($fieldName, $fieldValue);
|
|
$this->label = htmlspecialchars($label);
|
|
$this->helpID = $helpID;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
// print label text
|
|
echo $this->label;
|
|
if ($this->required) {
|
|
echo '*';
|
|
}
|
|
echo "\n</td>\n<td>\n";
|
|
// print input field
|
|
$return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
// print help link
|
|
if ($this->helpID != null) {
|
|
echo "\n</td>\n<td>\n";
|
|
$helpLink = new htmlHelpLink($this->helpID);
|
|
$helpLink->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Specifies if this input field must be filled.
|
|
*
|
|
* @param boolean $required required or not
|
|
*/
|
|
public function setRequired($required) {
|
|
$this->required = $required;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Renders a help link.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlHelpLink extends htmlElement {
|
|
|
|
/** help ID */
|
|
private $helpID;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param String $helpID help ID
|
|
*/
|
|
function __construct($helpID) {
|
|
$this->helpID = $helpID;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$helpEntry = getHelp($module, $this->helpID, $scope);
|
|
printHelpLink($helpEntry, $this->helpID, $module, $scope);
|
|
return array();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Simple button.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlButton extends htmlElement {
|
|
|
|
/** button name */
|
|
protected $name;
|
|
/** button text or image */
|
|
protected $value;
|
|
/** image button or text button */
|
|
protected $isImageButton;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name button name
|
|
* @param String $value button text or image (16x16px, relative to graphics folder)
|
|
* @param String $isImageButton image or text button (default text)
|
|
*/
|
|
function __construct($name, $value, $isImageButton = false) {
|
|
$this->name = htmlspecialchars($name);
|
|
$this->value = htmlspecialchars($value);
|
|
$this->isImageButton = $isImageButton;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$value = '';
|
|
$style = '';
|
|
$class = '';
|
|
$name = ' name="' . $this->name . '"';
|
|
// image button
|
|
if ($this->isImageButton) {
|
|
$value = ' value=" "';
|
|
$class = ' class="smallImageButton"';
|
|
$style = ' style="background-image: url(../../graphics/' . $this->value . ');"';
|
|
}
|
|
// text button
|
|
else {
|
|
if ($this->value != null) {
|
|
$value = ' value="' . $this->value . '"';
|
|
}
|
|
}
|
|
echo '<input type="submit"' . $name . $value . $style . $class . '>';
|
|
return array($this->name => 'submit');
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints a button for the account pages.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlAccountPageButton extends htmlButton {
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param String $targetModule module name which renders next page
|
|
* @param String $targetPage name of next page
|
|
* @param String $identifier identifier for button
|
|
* @param String $value button text or image (16x16px, relative to graphics folder)
|
|
* @param String $isImageButton image or text button (default text)
|
|
*/
|
|
function __construct($targetModule, $targetPage, $identifier, $value, $isImageButton = false) {
|
|
$this->name = htmlspecialchars('form_subpage_' . $targetModule . '_' . $targetPage . '_' . $identifier);
|
|
$this->value = $value;
|
|
$this->isImageButton = $isImageButton;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Represents a select box.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlSelect extends htmlElement {
|
|
|
|
/** name of select field */
|
|
private $name;
|
|
/** size */
|
|
private $size;
|
|
/** allows multi-selection */
|
|
private $multiSelect = false;
|
|
/** elements */
|
|
private $elements;
|
|
/** selected elements */
|
|
private $selectedElements;
|
|
/** descriptive elements */
|
|
private $hasDescriptiveElements = false;
|
|
/** sorting enabled */
|
|
private $sortElements = true;
|
|
/** right to left text direction */
|
|
private $rightToLeftTextDirection = false;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name element name
|
|
* @param array $elements list of elememts (label => value)
|
|
* @param array $selectedElements list of selected elements (optional, default none)
|
|
* @param int $size size (optional, default = 1)
|
|
*/
|
|
function __construct($name, $elements, $selectedElements = array(), $size = 1) {
|
|
$this->name = htmlspecialchars($name);
|
|
$this->elements = $elements;
|
|
$this->selectedElements = $selectedElements;
|
|
$this->size = htmlspecialchars($size);
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
if (isset($values[$this->name])) {
|
|
$this->selectedElements = $values[$this->name];
|
|
}
|
|
$multi = '';
|
|
if ($this->multiSelect) {
|
|
$multi = ' multiple';
|
|
$this->name = $this->name . '[]';
|
|
}
|
|
$name = ' name="' . $this->name . '"';
|
|
$size = ' size="' . $this->size . '"';
|
|
$class = '';
|
|
if ($this->rightToLeftTextDirection) {
|
|
$class = ' class="rightToLeftText"';
|
|
}
|
|
echo '<select' . $class . $name . $size . $multi . ' tabindex="' . $tabindex . "\">\n";
|
|
$tabindex++;
|
|
// sorting
|
|
if ($this->sortElements) {
|
|
if ($this->hasDescriptiveElements) {
|
|
$labels = array_keys($this->elements);
|
|
natcasesort($labels);
|
|
$newElements = array();
|
|
foreach ($labels as $label) {
|
|
$newElements[$label] = $this->elements[$label];
|
|
}
|
|
$this->elements = $newElements;
|
|
}
|
|
else {
|
|
natcasesort($this->elements);
|
|
}
|
|
}
|
|
foreach ($this->elements as $key => $value) {
|
|
$selected = '';
|
|
if ($this->hasDescriptiveElements) {
|
|
if (in_array($value, $this->selectedElements)) {
|
|
$selected = ' selected';
|
|
}
|
|
echo "<option value=\"" . htmlspecialchars($value) . "\"$selected>" . htmlspecialchars($key) . "</option>\n";
|
|
}
|
|
else {
|
|
if (in_array($value, $this->selectedElements)) {
|
|
$selected = ' selected';
|
|
}
|
|
echo "<option$selected>" . htmlspecialchars($value) . "</option>\n";
|
|
}
|
|
}
|
|
echo "</select>\n";
|
|
if ($this->multiSelect) {
|
|
return array($this->name => 'multiselect');
|
|
}
|
|
else {
|
|
return array($this->name => 'select');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Specifies if the elements are just a simple list or an assoziative array (default: simple list).
|
|
*
|
|
* @param boolean $hasDescriptiveElements activates descriptive elements
|
|
*/
|
|
public function setHasDescriptiveElements($hasDescriptiveElements) {
|
|
$this->hasDescriptiveElements = $hasDescriptiveElements;
|
|
}
|
|
|
|
/**
|
|
* Specifies if multi-selection is enabled (default: disabled).
|
|
*
|
|
* @param boolean $multiSelect allows multi-selection
|
|
*/
|
|
public function setMultiSelect($multiSelect) {
|
|
$this->multiSelect = $multiSelect;
|
|
}
|
|
|
|
/**
|
|
* Specifies if the elemets should be sorted (default: sort).
|
|
*
|
|
* @param boolean $sortElements sort elements
|
|
*/
|
|
public function setSortElements($sortElements) {
|
|
$this->sortElements = $sortElements;
|
|
}
|
|
|
|
/**
|
|
* Specifies if the text direction should be set to right to left.
|
|
*
|
|
* @param boolean $rightToLeftTextDirection if true use right to left direction
|
|
*/
|
|
public function setRightToLeftTextDirection($rightToLeftTextDirection) {
|
|
$this->rightToLeftTextDirection = $rightToLeftTextDirection;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Select with label and help link.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTableExtendedSelect extends htmlSelect {
|
|
|
|
/** descriptive label */
|
|
private $label;
|
|
/** help ID */
|
|
private $helpID;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name element name
|
|
* @param array $elements list of elememts
|
|
* @param array $selectedElements list of selected elements
|
|
* @param String $label descriptive label
|
|
* @param String $helpID help ID (optional, default none)
|
|
* @param int $size size (optional, default = 1)
|
|
*/
|
|
function __construct($name, $elements, $selectedElements, $label, $helpID = null, $size = 1) {
|
|
parent::__construct($name, $elements, $selectedElements, $size);
|
|
$this->label = htmlspecialchars($label);
|
|
$this->helpID = $helpID;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
echo $this->label;
|
|
echo "\n</td>\n<td>\n";
|
|
$return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
// print help link
|
|
if ($this->helpID != null) {
|
|
echo "\n</td>\n<td>\n";
|
|
$helpLink = new htmlHelpLink($this->helpID);
|
|
$helpLink->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints the text and escapes contained HTML code by default.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlOutputText extends htmlElement {
|
|
|
|
/** the text to print */
|
|
private $string;
|
|
/** specifies if HTML code should be escaped */
|
|
private $escapeHTML;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $string output text
|
|
* @param boolean $escapeHTML escape HTML code (default yes)
|
|
*/
|
|
function __construct($string, $escapeHTML = true) {
|
|
$this->string = $string;
|
|
$this->escapeHTML = $escapeHTML;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
if ($this->escapeHTML) {
|
|
echo htmlspecialchars($this->string);
|
|
}
|
|
else {
|
|
echo $this->string;
|
|
}
|
|
return array();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for a checkbox.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlInputCheckbox extends htmlElement {
|
|
|
|
/** unique name of input element */
|
|
private $name;
|
|
/** value */
|
|
private $checked;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name unique name
|
|
* @param boolean $checked checked
|
|
*/
|
|
function __construct($name, $checked) {
|
|
$this->name = htmlspecialchars($name);
|
|
$this->checked = $checked;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
if (isset($values[$this->name])) {
|
|
if ($values[$this->name][0] == 'true') {
|
|
$this->checked = true;
|
|
}
|
|
else {
|
|
$this->checked = false;
|
|
}
|
|
}
|
|
$checked = '';
|
|
if ($this->checked) {
|
|
$checked = ' checked';
|
|
}
|
|
$tabindexValue = ' tabindex="' . $tabindex . '"';
|
|
$tabindex++;
|
|
echo '<input type="checkbox" name="' . $this->name . '"' . $tabindexValue . $checked . '>';
|
|
return array($this->name => 'checkbox');
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Checkbox with descriptive label and help link.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTableExtendedInputCheckbox extends htmlInputCheckbox {
|
|
|
|
/** descriptive label */
|
|
private $label;
|
|
/** help ID */
|
|
private $helpID;
|
|
/** specifies if label is printed before the checkbox */
|
|
private $labelFirst;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name unique name
|
|
* @param boolean $checked checked
|
|
* @param String $label descriptive label
|
|
* @param String $helpID help ID
|
|
* @param boolean $labelFirst specifies if the label is at the beginning or at the end (optional, default beginning)
|
|
*/
|
|
function __construct($name, $checked, $label, $helpID = null, $labelFirst = true) {
|
|
parent::__construct($name, $checked);
|
|
$this->label = htmlspecialchars($label);
|
|
$this->helpID = $helpID;
|
|
$this->labelFirst = $labelFirst;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
if ($this->labelFirst) {
|
|
echo $this->label;
|
|
echo "\n</td>\n<td>\n";
|
|
$return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
}
|
|
else {
|
|
$return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
echo "\n</td>\n<td>\n";
|
|
echo $this->label;
|
|
}
|
|
// print help link
|
|
if ($this->helpID != null) {
|
|
echo "\n</td>\n<td>\n";
|
|
$helpLink = new htmlHelpLink($this->helpID);
|
|
$helpLink->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for a file upload field.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlInputFileUpload extends htmlElement {
|
|
|
|
/** unique name of input element */
|
|
private $name;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name unique name
|
|
*/
|
|
function __construct($name) {
|
|
$this->name = htmlspecialchars($name);
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$tabindexValue = ' tabindex="' . $tabindex . '"';
|
|
$tabindex++;
|
|
echo '<input type="file" name="' . $this->name . '"' . $tabindexValue . '>';
|
|
return array($this->name => 'file');
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* File upload with descriptive label and help link.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTableExtendedInputFileUpload extends htmlInputFileUpload {
|
|
|
|
/** descriptive label */
|
|
private $label;
|
|
/** help ID */
|
|
private $helpID;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name unique name
|
|
* @param String $label descriptive label
|
|
* @param String $helpID help ID
|
|
*/
|
|
function __construct($name, $label, $helpID = null) {
|
|
parent::__construct($name);
|
|
$this->label = htmlspecialchars($label);
|
|
$this->helpID = $helpID;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
echo $this->label;
|
|
echo "\n</td>\n<td>\n";
|
|
$return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
// print help link
|
|
if ($this->helpID != null) {
|
|
echo "\n</td>\n<td>\n";
|
|
$helpLink = new htmlHelpLink($this->helpID);
|
|
$helpLink->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for a textarea.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlInputTextarea extends htmlElement {
|
|
|
|
/** unique name of input element */
|
|
private $name;
|
|
/** value */
|
|
private $value;
|
|
/** column count */
|
|
private $colCount;
|
|
/** row count */
|
|
private $rowCount;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name unique name
|
|
* @param String $value value
|
|
* @param int $colCount number of characters per line
|
|
* @param int $rowCount number of rows
|
|
*/
|
|
function __construct($name, $value, $colCount, $rowCount) {
|
|
$this->name = htmlspecialchars($name);
|
|
$this->value = htmlspecialchars($value);
|
|
$this->colCount = $colCount;
|
|
$this->rowCount = $rowCount;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
if (isset($values[$this->name])) {
|
|
$this->value = implode("\r\n", $values[$this->name]);
|
|
}
|
|
$colCount = ' cols="' . $this->colCount . '"';
|
|
$rowCount = ' rows="' . $this->rowCount . '"';
|
|
$tabindexValue = ' tabindex="' . $tabindex . '"';
|
|
$tabindex++;
|
|
echo '<textarea name="' . $this->name . '"' . $tabindexValue . $colCount . $rowCount . '>' . $this->value . '</textarea>';
|
|
return array($this->name => 'textarea');
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Text area with label and help link.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlTableExtendedInputTextarea extends htmlInputTextarea {
|
|
|
|
/** descriptive label */
|
|
private $label;
|
|
/** help ID */
|
|
private $helpID;
|
|
/** required field */
|
|
private $required = false;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $name unique name
|
|
* @param String $value value
|
|
* @param int $colCount number of characters per line
|
|
* @param int $rowCount number of rows
|
|
* @param String $label descriptive label
|
|
* @param String $helpID help ID
|
|
*/
|
|
function __construct($name, $value, $colCount, $rowCount, $label, $helpID) {
|
|
parent::__construct($name, $value, $colCount, $rowCount);
|
|
$this->label = htmlspecialchars($label);
|
|
$this->helpID = $helpID;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
echo $this->label;
|
|
if ($this->required) {
|
|
echo '*';
|
|
}
|
|
echo "\n</td>\n<td>\n";
|
|
$return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
// print help link
|
|
if ($this->helpID != null) {
|
|
echo "\n</td>\n<td>\n";
|
|
$helpLink = new htmlHelpLink($this->helpID);
|
|
$helpLink->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Specifies if this input field must be filled.
|
|
*
|
|
* @param boolean $required required or not
|
|
*/
|
|
public function setRequired($required) {
|
|
$this->required = $required;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for an image.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlImage extends htmlElement {
|
|
|
|
/** path to image */
|
|
private $path;
|
|
/** width */
|
|
private $width;
|
|
/** height */
|
|
private $height;
|
|
/** alt text */
|
|
private $alt;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $path image location
|
|
* @param int $width image width (optional, default original size)
|
|
* @param int $height image height (optional, default original size)
|
|
* @param String $alt alt text (optional)
|
|
*/
|
|
function __construct($path, $width = null, $height = null, $alt = ' ') {
|
|
$this->path = htmlspecialchars($path);
|
|
$this->width = $width;
|
|
$this->height = $height;
|
|
$this->alt = htmlspecialchars($alt);
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$path = ' src="' . $this->path . '"';
|
|
$width = '';
|
|
if ($this->width != null) {
|
|
$width = ' width="' . $this->width . '"';
|
|
}
|
|
$height = '';
|
|
if ($this->height != null) {
|
|
$height = ' height="' . $this->height . '"';
|
|
}
|
|
$alt = ' alt="' . $this->alt . '"';
|
|
echo '<img' . $path . $width . $height . $alt . ">\n";
|
|
return array();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Adds an empty space with given width and height.
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlSpacer extends htmlElement {
|
|
|
|
private $width;
|
|
private $height;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $width width (e.g. 10px)
|
|
* @param String $height height (e.g. 10px)
|
|
*/
|
|
function __construct($width, $height) {
|
|
$this->width = htmlspecialchars($width);
|
|
$this->height = htmlspecialchars($height);
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
$width = '';
|
|
if ($this->width != null) {
|
|
$width = 'width: ' . $this->width . ';';
|
|
}
|
|
$height = '';
|
|
if ($this->height != null) {
|
|
$height = 'height: ' . $this->height . ';';
|
|
}
|
|
echo "<div style=\"$width $height\"></div>\n";
|
|
return array();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Prints a status message (e.g. error message).
|
|
*
|
|
* @package metaHTML
|
|
*/
|
|
class htmlStatusMessage extends htmlElement {
|
|
|
|
private $type;
|
|
private $title;
|
|
private $text;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param String $type message type (e.g. ERROR)
|
|
* @param String $title message title
|
|
* @param String $text message
|
|
*/
|
|
function __construct($type, $title, $text) {
|
|
$this->type = $type;
|
|
$this->title = $title;
|
|
$this->text = $text;
|
|
}
|
|
|
|
/**
|
|
* Prints the HTML code for this element.
|
|
*
|
|
* @param string $module Name of account module
|
|
* @param array $input List of meta-HTML elements
|
|
* @param array $values List of values which override the defaults in $input (name => value)
|
|
* @param boolean $restricted If true then no buttons will be displayed
|
|
* @param integer $tabindex Start value of tabulator index for input fields
|
|
* @param string $scope Account type
|
|
* @return array List of input field names and their type (name => type)
|
|
*/
|
|
function generateHTML($module, $input, $values, $restricted, &$tabindex, $scope) {
|
|
StatusMessage($this->type, $this->title, $this->text);
|
|
return array();
|
|
}
|
|
|
|
}
|
|
|
|
?>
|