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; case htmlElement::ALIGN_CENTER: $align = 'align="center"'; 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 footer */ const footer = "\n"; /** new line */ const newLine = "
\n"; $types = array_merge($types, $this->cells[$i]->generateHTML($module, $input, $values, $restricted, $tabindex, $scope)); echo " | \n"; } echo "\n"; // print input field $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); // print help link if ($this->helpID != null) { echo "\n | \n\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;
/** module name if it should be forced */
private $module;
/** account type if it should be forced */
private $scope;
/**
* Constructor
*
* @param String $helpID help ID
* @param String $module module name (optional, only if value from generateHTML() should be overwritten)
* @param String $scope account type (e.g. user) (optional, only if value from generateHTML() should be overwritten)
*/
function __construct($helpID, $module = null, $scope = null) {
$this->helpID = $helpID;
$this->module = $module;
$this->scope = $scope;
}
/**
* 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) {
// overwrite module and scop if needed
if ($this->module != null) {
$module = $this->module;
}
if ($this->scope != null) {
$scope = $this->scope;
}
// print link
$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;
/** title */
private $title = null;
/** enabled or disabled */
private $isEnabled = true;
/** icon class (CSS) for buttons with icon + text */
private $iconClass = null;
/**
* 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) {
if ($restricted) {
// no buttons in restricted mode
logNewMessage(LOG_ERR, 'Meta HTML: Requested button in restricted mode.');
return array();
}
$style = '';
$class = '';
$title = '';
$name = ' name="' . $this->name . '"';
// image button
if ($this->isImageButton) {
$class = ' class="smallImageButton"';
$style = ' style="background-image: url(../../graphics/' . $this->value . ');"';
}
// text button
elseif ($this->iconClass == null) {
$class = ' class="smallPadding"';
}
if ($this->title != null) {
$title = ' title="' . $this->title . '"';
}
$disabled = '';
if (!$this->isEnabled) {
$disabled = ' disabled';
}
if ($this->isImageButton) {
echo '';
}
else {
echo '';
// text buttons get JQuery style
$icon = '';
if ($this->iconClass != null) {
$icon = '{ icons: { primary: \'' . $this->iconClass . '\' } }';
}
echo '';
}
return array($this->name => 'submit');
}
/**
* Sets the button title (tooltip).
*
* @param String $title title
*/
public function setTitle($title) {
$this->title = htmlspecialchars($title);
}
/**
* Specifies if this component is enabled and accepts user modification.
*
* @param boolean $isEnabled enabled if true
*/
public function setIsEnabled($isEnabled) {
$this->isEnabled = $isEnabled;
}
/**
* Sets an additional icon for a text button.
* The icon class is a CSS class that specifies the icon image (e.g. "deleteButton" in layout.css).
*
* @param String $iconClass icon class
*/
public function setIconClass($iconClass) {
$this->iconClass = htmlspecialchars($iconClass);
}
}
/**
* 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 = array();
/** descriptive elements */
private $hasDescriptiveElements = false;
/** contains optgroups */
private $containsOptgroups = false;
/** sorting enabled */
private $sortElements = true;
/** right to left text direction */
private $rightToLeftTextDirection = false;
/** enabled or disabled */
private $isEnabled = true;
/** width of input element */
private $width = '';
/** transform select boxes with one element to text */
private $transformSingleSelect = true;
/** onchange event */
private $onchangeEvent = null;
/**
* Constructor.
*
* Examples: * * $select = new htmlSelect('myName', array('value1', 'value2'), array('value1')); * * $select = new htmlSelect('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1')); * $select->setHasDescriptiveElements(true); * * $select = new htmlSelect('myName', array('optgroupLabel' => array('value1', 'value2')), array('value1')); * $select->setHasDescriptiveElements(true); * $select->setContainsOptgroups(true); * * @param String $name element name * @param array $elements list of elements array(label => value) or array(value1, value2) or array('optgroup' => array(...)) * @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; if ($selectedElements != null) { $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 = ''; $name = ' name="' . $this->name . '"'; if ($this->multiSelect) { $multi = ' multiple'; $name = ' name="' . $this->name . '[]"'; } $size = ' size="' . $this->size . '"'; $class = ''; if ($this->rightToLeftTextDirection) { $class = ' class="rightToLeftText"'; } $disabled = ''; if (!$this->isEnabled) { $disabled = ' disabled'; } $style = ''; if ($this->width != '') { $style = ' style="width: ' . $this->width . '"'; } $onchange = ''; if ($this->onchangeEvent != null) { $onchange = ' onchange="' . $this->onchangeEvent . '"'; } // hide select boxes that contain less than 2 elements if ((sizeof($this->elements) < 2) && $this->transformSingleSelect) { echo ' ';
}
// print select box
echo '\n";
// if select box has only one element then show it as text
if ((sizeof($this->elements) == 1) && $this->transformSingleSelect) {
echo ' ';
if ($this->hasDescriptiveElements) {
$keys = array_keys($this->elements);
echo $keys[0];
}
else {
echo $this->elements[0];
}
}
elseif (sizeof($this->elements) == 0) {
echo '';
}
if ($this->multiSelect) {
return array($this->name => 'multiselect');
}
else {
return array($this->name => 'select');
}
}
/**
* Prints the HTML code of the option tags.
*
* @param array $elements list of options
*/
private function printOptionsHTML($elements) {
// sorting
if ($this->sortElements) {
if ($this->hasDescriptiveElements) {
$labels = array_keys($elements);
natcasesort($labels);
$newElements = array();
foreach ($labels as $label) {
$newElements[$label] = $elements[$label];
}
$elements = $newElements;
}
else {
natcasesort($elements);
}
}
foreach ($elements as $key => $value) {
$selected = '';
if ($this->hasDescriptiveElements) {
if (in_array($value, $this->selectedElements)) {
$selected = ' selected';
}
echo "\n";
}
else {
if (in_array($value, $this->selectedElements)) {
$selected = ' selected';
}
echo "\n";
}
}
}
/**
* 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 the elements are divided into optgroups.
*
* @param boolean $containsOptgroups activates optgroups
*/
public function setContainsOptgroups($containsOptgroups) {
$this->containsOptgroups = $containsOptgroups;
}
/**
* 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;
}
/**
* Specifies if this component is enabled and accepts user modification.
*
* @param boolean $isEnabled enabled if true
*/
public function setIsEnabled($isEnabled) {
$this->isEnabled = $isEnabled;
}
/**
* Specifies the width of this selection box.
*
* @param String $width width (e.g. 20em)
*/
public function setWidth($width) {
$this->width = htmlspecialchars($width);
}
/**
* Specifies if select boxes that contain only a single element should be transformed to a simple text field.
*
* @param boolean $transformSingleSelect transform single options to text
*/
public function setTransformSingleSelect($transformSingleSelect) {
$this->transformSingleSelect = $transformSingleSelect;
}
/**
* Sets the JavaScript code for the onchange event.
*
* @param String $onchangeEvent onchange event code (e.g. myfunction();)
*/
public function setOnchangeEvent($onchangeEvent) {
$this->onchangeEvent = htmlspecialchars($onchangeEvent);
}
}
/**
* 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 '';
echo $this->label;
echo ' ';
echo "\n | \n\n"; $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); // print help link if ($this->helpID != null) { echo "\n | \n\n";
$helpLink = new htmlHelpLink($this->helpID);
$helpLink->generateHTML($module, $input, $values, $restricted, $tabindex, $scope);
}
return $return;
}
}
/**
* Represents a radio selection.
*
* @package metaHTML
*/
class htmlRadio extends htmlElement {
/** name of select field */
private $name;
/** elements */
private $elements;
/** selected element */
private $selectedElement = null;
/** enabled or disabled */
private $isEnabled = true;
/**
* Constructor.
*
* Examples: * * $radio = new htmlRadio('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1')); * * @param String $name element name * @param array $elements list of elements array(label => value) * @param array $selectedElement value of selected element (optional, default none) */ function __construct($name, $elements, $selectedElement = null) { $this->name = htmlspecialchars($name); $this->elements = $elements; if ($selectedElement != null) { $this->selectedElement = $selectedElement; } } /** * 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][0])) { $this->selectedElement = $values[$this->name][0]; } $name = ' name="' . $this->name . '"'; $disabled = ''; if (!$this->isEnabled) { $disabled = ' disabled'; } // print radio list foreach ($this->elements as $label => $value) { $selected = ''; if ($value == $this->selectedElement) { $selected = ' checked'; } echo ' ' . $label . ' '; $tabindex++; } return array($this->name => 'select'); } /** * Specifies if this component is enabled and accepts user modification. * * @param boolean $isEnabled enabled if true */ public function setIsEnabled($isEnabled) { $this->isEnabled = $isEnabled; } } /** * Radio list with descriptive label and help link. * * @package metaHTML */ class htmlTableExtendedRadio extends htmlRadio { /** descriptive label */ private $label; /** help ID */ private $helpID; /** * Constructor. * * @param String $label descriptive label * @param String $name element name * @param array $elements list of elements array(label => value) * @param array $selectedElement value of selected element (optional, default none) * @param String $helpID help ID */ function __construct($label, $name, $elements, $selectedElement = null, $helpID = null) { parent::__construct($name, $elements, $selectedElement); $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 ' ';
echo $this->label;
echo ' ';
echo "\n | \n\n"; $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); // print help link if ($this->helpID != null) { echo "\n | \n\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;
/** bold text */
private $isBold = false;
/** mark as required */
private $markAsRequired = false;
/** no wrap */
private $noWrap = false;
/**
* 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->noWrap) {
echo " ";
}
if ($this->isBold) {
echo "";
}
if ($this->escapeHTML) {
echo htmlspecialchars($this->string);
}
else {
echo $this->string;
}
if ($this->markAsRequired) {
$graphicsPath = "../../graphics";
if (is_dir("../graphics")) $graphicsPath = "../graphics";
echo '';
}
if ($this->isBold) {
echo "";
}
if ($this->noWrap) {
echo " ";
}
return array();
}
/**
* Specifies if the whole text should be printed in bold.
*
* @param boolean $isBold bold text
*/
public function setIsBold($isBold) {
$this->isBold = $isBold;
}
/**
* Adds a marker that indicates a required field.
*
* @param boolean $markAsRequired add marker
*/
public function setMarkAsRequired($markAsRequired) {
$this->markAsRequired = $markAsRequired;
}
/**
* Specifies if word wrap is allowed for this text.
*
* @param boolean $noWrap no wrapping if set to true (default false)
*/
public function setNoWrap($noWrap) {
$this->noWrap = $noWrap;
}
}
/**
* Prints the HTML code for a checkbox.
*
* @package metaHTML
*/
class htmlInputCheckbox extends htmlElement {
/** unique name of input element */
private $name;
/** value */
private $checked;
/** enabled or disabled */
private $isEnabled = true;
/**
* 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++;
$disabled = '';
if (!$this->isEnabled) {
$disabled = ' disabled';
}
echo '';
return array($this->name => 'checkbox');
}
/**
* Specifies if this component is enabled and accepts user modification.
*
* @param boolean $isEnabled enabled if true
*/
public function setIsEnabled($isEnabled) {
$this->isEnabled = $isEnabled;
}
}
/**
* 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 '';
echo $this->label;
echo ' ';
echo "\n | \n\n"; $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); } else { $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); echo "\n | \n\n";
echo ' ';
echo $this->label;
echo ' ';
}
// print help link
if ($this->helpID != null) {
echo "\n | \n\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;
/** enabled or disabled */
private $isEnabled = true;
/**
* 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++;
$disabled = '';
if (!$this->isEnabled) {
$disabled = ' disabled';
}
echo '';
return array($this->name => 'file');
}
/**
* Specifies if this component is enabled and accepts user modification.
*
* @param boolean $isEnabled enabled if true
*/
public function setIsEnabled($isEnabled) {
$this->isEnabled = $isEnabled;
}
}
/**
* 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 ' ';
echo $this->label;
echo ' ';
echo "\n | \n\n"; $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); // print help link if ($this->helpID != null) { echo "\n | \n\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;
/** enabled or disabled */
private $isEnabled = true;
/**
* 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++;
$disabled = '';
if (!$this->isEnabled) {
$disabled = ' disabled';
}
echo '';
return array($this->name => 'textarea');
}
/**
* Specifies if this component is enabled and accepts user modification.
*
* @param boolean $isEnabled enabled if true
*/
public function setIsEnabled($isEnabled) {
$this->isEnabled = $isEnabled;
}
}
/**
* 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 ' ';
echo $this->label;
if ($this->required) {
$graphicsPath = "../../graphics";
if (is_dir("../graphics")) $graphicsPath = "../graphics";
echo '';
}
echo ' ';
echo "\n | \n\n"; $return = parent::generateHTML($module, $input, $values, $restricted, $tabindex, $scope); // print help link if ($this->helpID != null) { echo "\n | \n\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 '\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 "\n";
return array();
}
}
/**
* Prints a status message (e.g. error message).
*
* @package metaHTML
*/
class htmlStatusMessage extends htmlElement {
private $type;
private $title;
private $text;
private $params;
/**
* Constructor.
*
* @param String $type message type (e.g. ERROR)
* @param String $title message title
* @param String $text message (optional)
*/
function __construct($type, $title, $text = null, $params = null) {
$this->type = $type;
$this->title = $title;
$this->text = $text;
$this->params = $params;
}
/**
* 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, $this->params);
return array();
}
}
/**
* Generates a fieldset.
*
* @package metaHTML
*/
class htmlFieldset extends htmlElement {
/** fieldset content */
private $content;
/** descriptive label */
private $label = null;
/** label image */
private $labelImage = null;
/**
* Constructor.
*
* @param htmlElement $content content to display inside fieldset
* @param String $label label
* @param String $labelImage image to put before label
*/
function __construct($content, $label = null, $labelImage = null) {
$this->content = $content;
$this->label = htmlspecialchars($label);
$this->labelImage = htmlspecialchars($labelImage);
}
/**
* 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) {
$class = 'ui-corner-all';
if ($scope != null) {
$class .= ' ' . $scope . 'edit';
}
echo "\n";
return $return;
}
}
/**
* Generates a title line. This is used for page titles.
*
* @package metaHTML
*/
class htmlTitle extends htmlElement {
/** descriptive label */
private $label = null;
/**
* Constructor.
*
* @param String $label label
*/
function __construct($label) {
$this->label = htmlspecialchars($label);
// the title should not end at a table cell
$this->colspan = 100;
}
/**
* 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 " \n";
echo " \n";
return array();
}
}
/**
* Generates a subtitle line. This is used to group multiple fields.
*
* @package metaHTML
*/
class htmlSubTitle extends htmlElement {
/** descriptive label */
private $label = null;
/** optional image */
private $image = null;
/**
* Constructor.
*
* @param String $label label
* @param String $image optional image
*/
function __construct($label, $image = null) {
$this->label = htmlspecialchars($label);
$this->image = htmlspecialchars($image);
// the title should not end at a table cell
$this->colspan = 100;
}
/**
* 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 "\n"; echo $this->label; echo "\n"; echo "\n";
echo " \n";
return array();
}
}
/**
* Generates a hidden input field.
*
* @package metaHTML
*/
class htmlHiddenInput extends htmlElement {
/** field name */
private $name = null;
/** field value */
private $value = null;
/**
* Constructor.
*
* @param String $name input name
* @param String $value input value
*/
function __construct($name, $value) {
$this->name = htmlspecialchars($name);
$this->value = htmlspecialchars($value);
}
/**
* 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 '';
return array();
}
}
/**
* Generates a link.
* The link can include an optional image in front of the link text.
*
* @package metaHTML
*/
class htmlLink extends htmlElement {
/** link text */
private $text = null;
/** link target */
private $target = null;
/** optional image */
private $image = null;
/** title */
private $title = null;
/** target window */
private $targetWindow = null;
/** onClick event */
private $onClick = null;
/**
* Constructor.
*
* @param String $text label
* @param String $target target URL
* @param String $image URL of optional image
*/
function __construct($text, $target, $image = null) {
$this->text = htmlspecialchars($text);
$this->target = htmlspecialchars($target);
$this->image = htmlspecialchars($image);
}
/**
* 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) {
$image = '';
if ($this->image != null) {
$image = ' ';
}
$title = '';
if ($this->title != null) {
$title = ' title="' . $this->title . '"';
}
$targetWindow = '';
if ($this->targetWindow != null) {
$targetWindow = ' target="' . $this->targetWindow . '"';
}
$onClick = '';
if ($this->onClick != null) {
$onClick = ' onclick="' . $this->onClick . '"';
}
echo '' . $image . $this->text . '';
return array();
}
/**
* Sets the link title.
*
* @param String $title title
*/
public function setTitle($title) {
$this->title = htmlspecialchars($title);
}
/**
* Sets the target window (e.g. _blank).
*
* @param String $window target window (e.g. _blank)
*/
public function setTargetWindow($window) {
$this->targetWindow = htmlspecialchars($window);
}
/**
* Sets the onClick event.
*
* @param String $event JavaScript code
*/
public function setOnClick($event) {
$this->onClick = htmlspecialchars($event);
}
}
/**
* Groups multiple htmlElements.
* This is useful if multiple elements should be included in a single table cell.
* The HTML code of the subelements is printed in the order they were added. No additional code is added.
*
* @package metaHTML
*/
class htmlGroup extends htmlElement {
/** link text */
private $subelements = array();
/**
* 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();
for ($i = 0; $i < sizeof($this->subelements); $i++) {
$return = array_merge($return, $this->subelements[$i]->generateHTML($module, $input, $values, $restricted, $tabindex, $scope));
}
return $return;
}
/**
* Adds a subelement.
*
* @param htmlElement $sub subelement
*/
public function addElement($sub) {
$this->subelements[] = $sub;
}
}
/**
* Prints a horizontal line.
*
* @package metaHTML
*/
class htmlHorizontalLine extends htmlElement {
/**
* 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 "\n"; if ($this->image != null) { echo ' '; } echo $this->label; echo "\n"; echo ""; return $return; } } ?> |