mirror of
https://github.com/roundcube/roundcubemail.git
synced 2026-02-20 09:31:18 +01:00
983 lines
28 KiB
PHP
983 lines
28 KiB
PHP
<?php
|
|
|
|
/*
|
|
+-----------------------------------------------------------------------+
|
|
| This file is part of the Roundcube Webmail client |
|
|
| |
|
|
| Copyright (C) The Roundcube Dev Team |
|
|
| |
|
|
| Licensed under the GNU General Public License version 3 or |
|
|
| any later version with exceptions for skins & plugins. |
|
|
| See the README file for a full license statement. |
|
|
| |
|
|
| PURPOSE: |
|
|
| Helper class to create valid XHTML code |
|
|
+-----------------------------------------------------------------------+
|
|
| Author: Thomas Bruederli <roundcube@gmail.com> |
|
|
+-----------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
* Class for HTML code creation
|
|
*/
|
|
class html
|
|
{
|
|
protected $tagname;
|
|
protected $content;
|
|
protected $attrib = [];
|
|
protected $allowed = [];
|
|
|
|
public static $doctype = 'xhtml';
|
|
public static $lc_tags = true;
|
|
public static $common_attrib = ['id', 'class', 'style', 'title', 'align', 'unselectable', 'tabindex', 'role'];
|
|
public static $containers = ['iframe', 'div', 'span', 'p', 'h1', 'h2', 'h3', 'ul', 'form', 'textarea', 'table', 'thead', 'tbody', 'tr', 'th', 'td', 'style', 'script', 'a'];
|
|
public static $bool_attrib = ['checked', 'multiple', 'disabled', 'selected', 'autofocus', 'readonly', 'required'];
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param array $attrib Hash array with tag attributes
|
|
*/
|
|
public function __construct($attrib = [])
|
|
{
|
|
// @phpstan-ignore-next-line
|
|
if (is_array($attrib)) {
|
|
$this->attrib = $attrib;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the tag code
|
|
*
|
|
* @return string The finally composed HTML tag
|
|
*/
|
|
public function show()
|
|
{
|
|
return self::tag($this->tagname, $this->attrib, $this->content, array_merge(self::$common_attrib, $this->allowed));
|
|
}
|
|
|
|
// STATIC METHODS
|
|
|
|
/**
|
|
* Generic method to create a HTML tag
|
|
*
|
|
* @param string $tagname Tag name
|
|
* @param array|string $attrib Tag attributes as key/value pairs, or 'class' attribute value
|
|
* @param array|string $content Optional Tag content (creates a container tag)
|
|
* @param array $allowed List with allowed attributes, omit to allow all
|
|
*
|
|
* @return string The XHTML tag
|
|
*/
|
|
public static function tag($tagname, $attrib = [], $content = null, $allowed = null)
|
|
{
|
|
if (is_string($attrib)) {
|
|
$attrib = ['class' => $attrib];
|
|
}
|
|
|
|
$inline_tags = ['a', 'span', 'img'];
|
|
$suffix = (isset($attrib['nl']) && $content && $attrib['nl'] && !in_array($tagname, $inline_tags)) ? "\n" : '';
|
|
|
|
$tagname = self::$lc_tags ? strtolower($tagname) : $tagname;
|
|
if (isset($content) || in_array($tagname, self::$containers)) {
|
|
$suffix = !empty($attrib['noclose']) ? $suffix : '</' . $tagname . '>' . $suffix;
|
|
unset($attrib['noclose'], $attrib['nl']);
|
|
if (is_array($content)) {
|
|
$content = implode('', $content);
|
|
}
|
|
|
|
return '<' . $tagname . self::attrib_string($attrib, $allowed) . '>' . $content . $suffix;
|
|
}
|
|
|
|
return '<' . $tagname . self::attrib_string($attrib, $allowed) . '>' . $suffix;
|
|
}
|
|
|
|
/**
|
|
* Return DOCTYPE tag of specified type
|
|
*
|
|
* @param string $type Document type (html5, xhtml, 'xhtml-trans, xhtml-strict)
|
|
*/
|
|
public static function doctype($type)
|
|
{
|
|
$doctypes = [
|
|
'html5' => '<!DOCTYPE html>',
|
|
'xhtml' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
|
|
'xhtml-trans' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
|
|
'xhtml-strict' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
|
|
];
|
|
|
|
if (!empty($doctypes[$type])) {
|
|
self::$doctype = preg_replace('/-\w+$/', '', $type);
|
|
return $doctypes[$type];
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Derived method for <div> containers
|
|
*
|
|
* @param mixed $attr Hash array with tag attributes or string with class name
|
|
* @param string $cont Div content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function div($attr = null, $cont = null)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
return self::tag('div', $attr, $cont, array_merge(self::$common_attrib, ['onclick']));
|
|
}
|
|
|
|
/**
|
|
* Derived method for <p> blocks
|
|
*
|
|
* @param mixed $attr Hash array with tag attributes or string with class name
|
|
* @param string $cont Paragraph content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function p($attr = null, $cont = null)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
return self::tag('p', $attr, $cont, self::$common_attrib);
|
|
}
|
|
|
|
/**
|
|
* Derived method to create <img />
|
|
*
|
|
* @param string|array $attr Hash array with tag attributes or string with image source (src)
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function img($attr = null)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['src' => $attr];
|
|
}
|
|
|
|
$allowed = ['src', 'alt', 'width', 'height', 'border', 'usemap', 'onclick', 'onerror', 'onload'];
|
|
|
|
return self::tag('img', $attr + ['alt' => ''], null, array_merge(self::$common_attrib, $allowed));
|
|
}
|
|
|
|
/**
|
|
* Derived method for link tags
|
|
*
|
|
* @param string|array $attr Hash array with tag attributes or string with link location (href)
|
|
* @param string $cont Link content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function a($attr, $cont)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['href' => $attr];
|
|
}
|
|
|
|
$allowed = ['href', 'target', 'name', 'rel', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup'];
|
|
|
|
return self::tag('a', $attr, $cont, array_merge(self::$common_attrib, $allowed));
|
|
}
|
|
|
|
/**
|
|
* Derived method for inline span tags
|
|
*
|
|
* @param string|array $attr Hash array with tag attributes or string with class name
|
|
* @param string $cont Tag content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function span($attr, $cont)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
return self::tag('span', $attr, $cont, self::$common_attrib);
|
|
}
|
|
|
|
/**
|
|
* Derived method for form element labels
|
|
*
|
|
* @param string|array $attr Hash array with tag attributes or string with 'for' attrib
|
|
* @param string $cont Tag content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function label($attr, $cont)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['for' => $attr];
|
|
}
|
|
|
|
return self::tag('label', $attr, $cont, array_merge(self::$common_attrib, ['for', 'onkeypress']));
|
|
}
|
|
|
|
/**
|
|
* Derived method to create <iframe></iframe>
|
|
*
|
|
* @param string|array $attr Hash array with tag attributes or string with frame source (src)
|
|
* @param string $cont Tag content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function iframe($attr = null, $cont = null)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['src' => $attr];
|
|
}
|
|
|
|
$allowed = ['src', 'name', 'width', 'height', 'border', 'frameborder', 'onload', 'allowfullscreen', 'sandbox'];
|
|
|
|
return self::tag('iframe', $attr, $cont, array_merge(self::$common_attrib, $allowed));
|
|
}
|
|
|
|
/**
|
|
* Derived method to create <script> tags
|
|
*
|
|
* @param string|array $attr Hash array with tag attributes or string with script source (src)
|
|
* @param string $cont Javascript code to be placed as tag content
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function script($attr, $cont = null)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['src' => $attr];
|
|
}
|
|
|
|
if ($cont) {
|
|
if (self::$doctype == 'xhtml') {
|
|
$cont = "/* <![CDATA[ */\n{$cont}\n/* ]]> */";
|
|
}
|
|
|
|
$cont = "\n{$cont}\n";
|
|
}
|
|
|
|
if (self::$doctype == 'xhtml') {
|
|
$attr += ['type' => 'text/javascript'];
|
|
}
|
|
|
|
return self::tag('script', $attr + ['nl' => true], $cont,
|
|
array_merge(self::$common_attrib, ['src', 'type', 'charset']));
|
|
}
|
|
|
|
/**
|
|
* Derived method for line breaks
|
|
*
|
|
* @param array $attrib Associative array with tag attributes
|
|
*
|
|
* @return string HTML code
|
|
*
|
|
* @see html::tag()
|
|
*/
|
|
public static function br($attrib = [])
|
|
{
|
|
return self::tag('br', $attrib);
|
|
}
|
|
|
|
/**
|
|
* Create string with attributes
|
|
*
|
|
* @param array $attrib Associative array with tag attributes
|
|
* @param array $allowed List of allowed attributes
|
|
*
|
|
* @return string Valid attribute string
|
|
*/
|
|
public static function attrib_string($attrib = [], $allowed = null)
|
|
{
|
|
if (empty($attrib)) {
|
|
return '';
|
|
}
|
|
|
|
$allowed_f = array_flip((array) $allowed);
|
|
$attrib_arr = [];
|
|
|
|
foreach ($attrib as $key => $value) {
|
|
// skip size if not numeric
|
|
if ($key == 'size' && !is_numeric($value)) {
|
|
continue;
|
|
}
|
|
|
|
// ignore "internal" or empty attributes
|
|
if ($key == 'nl' || $value === null) {
|
|
continue;
|
|
}
|
|
|
|
// ignore not allowed attributes, except aria-* and data-*
|
|
if (!empty($allowed)) {
|
|
if (!isset($allowed_f[$key]) && !str_starts_with($key, 'data-') && !str_starts_with($key, 'aria-')) {
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// skip empty eventhandlers
|
|
if (preg_match('/^on[a-z]+/', $key) && !$value) {
|
|
continue;
|
|
}
|
|
|
|
// attributes with no value
|
|
if (in_array($key, self::$bool_attrib)) {
|
|
if (!empty($value)) {
|
|
$value = $key;
|
|
if (self::$doctype == 'xhtml') {
|
|
$value .= '="' . $value . '"';
|
|
}
|
|
|
|
$attrib_arr[] = $value;
|
|
}
|
|
} else {
|
|
$attrib_arr[] = $key . '="' . self::quote((string) $value) . '"';
|
|
}
|
|
}
|
|
|
|
return count($attrib_arr) ? ' ' . implode(' ', $attrib_arr) : '';
|
|
}
|
|
|
|
/**
|
|
* Convert a HTML attribute string attributes to an associative array (name => value)
|
|
*
|
|
* @param string $str Input string
|
|
*
|
|
* @return array Key-value pairs of parsed attributes
|
|
*/
|
|
public static function parse_attrib_string($str)
|
|
{
|
|
$attrib = [];
|
|
$html = '<html>'
|
|
. '<head><meta http-equiv="Content-Type" content="text/html; charset=' . RCUBE_CHARSET . '" /></head>'
|
|
. '<body><div ' . rtrim($str, '/ ') . ' /></body>'
|
|
. '</html>';
|
|
|
|
$document = new \DOMDocument('1.0', RCUBE_CHARSET);
|
|
@$document->loadHTML($html);
|
|
|
|
if ($node = $document->getElementsByTagName('div')->item(0)) {
|
|
foreach ($node->attributes as $name => $attr) {
|
|
$attrib[strtolower($name)] = $attr->nodeValue;
|
|
}
|
|
}
|
|
|
|
return $attrib;
|
|
}
|
|
|
|
/**
|
|
* Replacing specials characters in html attribute value
|
|
*
|
|
* @param string $str Input string
|
|
*
|
|
* @return string The quoted string
|
|
*/
|
|
public static function quote(string $str)
|
|
{
|
|
return @htmlspecialchars($str, \ENT_COMPAT | \ENT_SUBSTITUTE, RCUBE_CHARSET);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class to create an HTML input field
|
|
*/
|
|
class html_inputfield extends html
|
|
{
|
|
protected $tagname = 'input';
|
|
protected $type = 'text';
|
|
protected $allowed = [
|
|
'type', 'name', 'value', 'size', 'tabindex', 'autocapitalize', 'required',
|
|
'autocomplete', 'checked', 'onchange', 'onclick', 'disabled', 'readonly',
|
|
'spellcheck', 'results', 'maxlength', 'src', 'multiple', 'accept',
|
|
'placeholder', 'autofocus', 'pattern', 'oninput',
|
|
];
|
|
|
|
/**
|
|
* Object constructor
|
|
*
|
|
* @param array $attrib Associative array with tag attributes
|
|
*/
|
|
public function __construct($attrib = [])
|
|
{
|
|
parent::__construct($attrib);
|
|
|
|
if (!empty($attrib['type'])) {
|
|
$this->type = $attrib['type'];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Compose input tag
|
|
*
|
|
* @param string $value Field value
|
|
* @param array $attrib Additional attributes to override
|
|
*
|
|
* @return string HTML output
|
|
*/
|
|
#[\Override]
|
|
public function show($value = null, $attrib = null)
|
|
{
|
|
// overwrite object attributes
|
|
if (is_array($attrib)) {
|
|
$this->attrib = array_merge($this->attrib, $attrib);
|
|
}
|
|
|
|
// set value attribute
|
|
if ($value !== null) {
|
|
$this->attrib['value'] = $value;
|
|
}
|
|
// set type
|
|
$this->attrib['type'] = $this->type;
|
|
|
|
return parent::show();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class to create an HTML password field
|
|
*/
|
|
class html_passwordfield extends html_inputfield
|
|
{
|
|
protected $type = 'password';
|
|
}
|
|
|
|
/**
|
|
* Class to create an hidden HTML input field
|
|
*/
|
|
class html_hiddenfield extends html
|
|
{
|
|
protected $tagname = 'input';
|
|
protected $type = 'hidden';
|
|
protected $allowed = ['type', 'name', 'value', 'onchange', 'disabled', 'readonly'];
|
|
protected $fields = [];
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param array $attrib Named tag attributes
|
|
*/
|
|
public function __construct($attrib = null)
|
|
{
|
|
parent::__construct();
|
|
|
|
if (is_array($attrib)) {
|
|
$this->add($attrib);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a hidden field to this instance
|
|
*
|
|
* @param array $attrib Named tag attributes
|
|
*/
|
|
public function add($attrib)
|
|
{
|
|
$this->fields[] = $attrib;
|
|
}
|
|
|
|
/**
|
|
* Create HTML code for the hidden fields
|
|
*
|
|
* @return string Final HTML code
|
|
*/
|
|
#[\Override]
|
|
public function show()
|
|
{
|
|
$out = '';
|
|
|
|
foreach ($this->fields as $attrib) {
|
|
$out .= self::tag($this->tagname, ['type' => $this->type] + $attrib);
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class to create HTML checkboxes
|
|
*/
|
|
class html_checkbox extends html_inputfield
|
|
{
|
|
protected $type = 'checkbox';
|
|
|
|
/**
|
|
* Get HTML code for this object
|
|
*
|
|
* @param string $value Value of the checked field
|
|
* @param array $attrib Additional attributes to override
|
|
*
|
|
* @return string HTML output
|
|
*/
|
|
#[\Override]
|
|
public function show($value = '', $attrib = null)
|
|
{
|
|
// overwrite object attributes
|
|
if (is_array($attrib)) {
|
|
$this->attrib = array_merge($this->attrib, $attrib);
|
|
}
|
|
|
|
// set 'checked' attribute
|
|
$this->attrib['checked'] = (string) $value === (string) ($this->attrib['value'] ?? '');
|
|
|
|
return parent::show();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class to create HTML radio buttons
|
|
*/
|
|
class html_radiobutton extends html_checkbox
|
|
{
|
|
protected $type = 'radio';
|
|
}
|
|
|
|
/**
|
|
* Class to create HTML button
|
|
*/
|
|
class html_button extends html_inputfield
|
|
{
|
|
protected $tagname = 'button';
|
|
protected $type = 'button';
|
|
|
|
/**
|
|
* Get HTML code for this object
|
|
*
|
|
* @param string $content Text Content of the button
|
|
* @param array $attrib Additional attributes to override
|
|
*
|
|
* @return string HTML output
|
|
*/
|
|
#[\Override]
|
|
public function show($content = '', $attrib = null)
|
|
{
|
|
// overwrite object attributes
|
|
if (is_array($attrib)) {
|
|
$this->attrib = array_merge($this->attrib, $attrib);
|
|
}
|
|
|
|
$this->content = $content;
|
|
|
|
return parent::show();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class to create an HTML textarea
|
|
*/
|
|
class html_textarea extends html
|
|
{
|
|
protected $tagname = 'textarea';
|
|
protected $allowed = ['name', 'rows', 'cols', 'wrap', 'tabindex',
|
|
'onchange', 'disabled', 'readonly', 'spellcheck'];
|
|
|
|
/**
|
|
* Get HTML code for this object
|
|
*
|
|
* @param string $value Textbox value
|
|
* @param array $attrib Additional attributes to override
|
|
*
|
|
* @return string HTML output
|
|
*/
|
|
#[\Override]
|
|
public function show($value = '', $attrib = null)
|
|
{
|
|
// overwrite object attributes
|
|
if (is_array($attrib)) {
|
|
$this->attrib = array_merge($this->attrib, $attrib);
|
|
}
|
|
|
|
// take value attribute as content
|
|
if (empty($value) && !empty($this->attrib['value'])) {
|
|
$value = $this->attrib['value'];
|
|
}
|
|
|
|
// make shure we don't print the value attribute
|
|
if (isset($this->attrib['value'])) {
|
|
unset($this->attrib['value']);
|
|
}
|
|
|
|
if (!empty($value) && empty($this->attrib['is_escaped'])) {
|
|
$value = self::quote($value);
|
|
}
|
|
|
|
return self::tag($this->tagname, $this->attrib, $value,
|
|
array_merge(self::$common_attrib, $this->allowed));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Builder for HTML drop-down menus.
|
|
*/
|
|
class html_select extends html
|
|
{
|
|
protected $tagname = 'select';
|
|
protected $options = [];
|
|
protected $allowed = ['name', 'size', 'tabindex', 'autocomplete',
|
|
'multiple', 'onchange', 'disabled', 'rel'];
|
|
|
|
/**
|
|
* Add a new option to this drop-down
|
|
*
|
|
* @param mixed $names Option name or array with option names
|
|
* @param mixed $values Option value or array with option values
|
|
* @param array $attrib Additional attributes for the option entry
|
|
*/
|
|
public function add($names, $values = null, $attrib = [])
|
|
{
|
|
if (is_array($names)) {
|
|
foreach ($names as $i => $text) {
|
|
$this->options[] = [
|
|
'text' => $text,
|
|
'value' => $values[$i] ?? $i,
|
|
] + $attrib;
|
|
}
|
|
} else {
|
|
$this->options[] = ['text' => $names, 'value' => $values] + $attrib;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get HTML code for this object
|
|
*
|
|
* @param string|array $select Value of the selection option
|
|
* @param ?array $attrib Additional attributes to override
|
|
*
|
|
* @return string HTML output
|
|
*/
|
|
#[\Override]
|
|
public function show($select = [], $attrib = null)
|
|
{
|
|
// overwrite object attributes
|
|
if (is_array($attrib)) {
|
|
$this->attrib = array_merge($this->attrib, $attrib);
|
|
}
|
|
|
|
$this->content = "\n";
|
|
$select = (array) $select;
|
|
foreach ($this->options as $option) {
|
|
$attr = [
|
|
'value' => $option['value'],
|
|
'selected' => (in_array($option['value'], $select, true)
|
|
|| in_array($option['text'], $select, true)) ? 1 : null,
|
|
];
|
|
|
|
$option_content = $option['text'];
|
|
if (empty($this->attrib['is_escaped'])) {
|
|
$option_content = self::quote($option_content);
|
|
}
|
|
|
|
$allowed = ['value', 'label', 'class', 'style', 'title', 'disabled', 'selected'];
|
|
|
|
$this->content .= self::tag('option', $attr + $option, $option_content, $allowed);
|
|
}
|
|
|
|
return parent::show();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class to build an HTML table
|
|
*/
|
|
class html_table extends html
|
|
{
|
|
protected $tagname = 'table';
|
|
protected $allowed = ['id', 'class', 'style', 'width', 'summary',
|
|
'cellpadding', 'cellspacing', 'border'];
|
|
|
|
private $header;
|
|
private $rows = [];
|
|
private $rowindex = 0;
|
|
private $colindex = 0;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param array $attrib Named tag attributes
|
|
*/
|
|
public function __construct($attrib = [])
|
|
{
|
|
parent::__construct($attrib);
|
|
|
|
if (self::$doctype == 'xhtml') {
|
|
$this->attrib['border'] = '0';
|
|
}
|
|
|
|
if (!empty($attrib['tagname']) && $attrib['tagname'] != 'table') {
|
|
$this->tagname = $attrib['tagname'];
|
|
$this->allowed = self::$common_attrib;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a table cell
|
|
*
|
|
* @param array|string $attr Cell attributes or 'class' attribute value
|
|
* @param string $cont Cell content
|
|
*/
|
|
public function add($attr, $cont)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
$cell = new \stdClass();
|
|
$cell->attrib = $attr;
|
|
$cell->content = $cont;
|
|
|
|
if (!isset($this->rows[$this->rowindex])) {
|
|
$this->rows[$this->rowindex] = new \stdClass();
|
|
$this->rows[$this->rowindex]->attrib = [];
|
|
}
|
|
|
|
$this->rows[$this->rowindex]->cells[$this->colindex] = $cell;
|
|
$this->colindex += max(1, isset($attr['colspan']) ? intval($attr['colspan']) : 0);
|
|
|
|
if (!empty($this->attrib['cols']) && $this->colindex >= $this->attrib['cols']) {
|
|
$this->add_row();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a table header cell
|
|
*
|
|
* @param string|array $attr Cell attributes array or class name
|
|
* @param string $cont Cell content
|
|
*/
|
|
public function add_header($attr, $cont)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
$cell = new \stdClass();
|
|
$cell->attrib = $attr;
|
|
$cell->content = $cont;
|
|
|
|
if (empty($this->header)) {
|
|
$this->header = new \stdClass();
|
|
$this->header->attrib = [];
|
|
}
|
|
|
|
$this->header->cells[] = $cell;
|
|
}
|
|
|
|
/**
|
|
* Remove a column from a table
|
|
* Useful for plugins making alterations
|
|
*
|
|
* @param string $class Class name
|
|
*/
|
|
public function remove_column($class)
|
|
{
|
|
// Remove the header
|
|
foreach ($this->header->cells as $index => $header) {
|
|
if ($header->attrib['class'] == $class) {
|
|
unset($this->header[$index]);
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Remove cells from rows
|
|
foreach ($this->rows as $i => $row) {
|
|
foreach ($row->cells as $j => $cell) {
|
|
if ($cell->attrib['class'] == $class) {
|
|
unset($this->rows[$i]->cells[$j]);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Jump to next row
|
|
*
|
|
* @param array $attr Row attributes
|
|
*/
|
|
public function add_row($attr = [])
|
|
{
|
|
$this->rowindex++;
|
|
$this->colindex = 0;
|
|
$this->rows[$this->rowindex] = new \stdClass();
|
|
$this->rows[$this->rowindex]->attrib = $attr;
|
|
$this->rows[$this->rowindex]->cells = [];
|
|
}
|
|
|
|
/**
|
|
* Set header attributes
|
|
*
|
|
* @param string|array $attr Row attributes array or class name
|
|
*/
|
|
public function set_header_attribs($attr = [])
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
if (empty($this->header)) {
|
|
$this->header = new \stdClass();
|
|
}
|
|
|
|
$this->header->attrib = $attr;
|
|
}
|
|
|
|
/**
|
|
* Set row attributes
|
|
*
|
|
* @param string|array $attr Row attributes array or class name
|
|
* @param int $index Optional row index (default current row index)
|
|
*/
|
|
public function set_row_attribs($attr = [], $index = null)
|
|
{
|
|
if (is_string($attr)) {
|
|
$attr = ['class' => $attr];
|
|
}
|
|
|
|
if ($index === null) {
|
|
$index = $this->rowindex;
|
|
}
|
|
|
|
// make sure row object exists (#1489094)
|
|
if (empty($this->rows[$index])) {
|
|
$this->rows[$index] = new \stdClass();
|
|
}
|
|
|
|
$this->rows[$index]->attrib = $attr;
|
|
}
|
|
|
|
/**
|
|
* Get row attributes
|
|
*
|
|
* @param int $index Row index
|
|
*
|
|
* @return array Row attributes
|
|
*/
|
|
public function get_row_attribs($index = null)
|
|
{
|
|
if ($index === null) {
|
|
$index = $this->rowindex;
|
|
}
|
|
|
|
return !empty($this->rows[$index]) ? $this->rows[$index]->attrib : null;
|
|
}
|
|
|
|
/**
|
|
* Build HTML output of the table data
|
|
*
|
|
* @param array $attrib Table attributes
|
|
*
|
|
* @return string The final table HTML code
|
|
*/
|
|
#[\Override]
|
|
public function show($attrib = null)
|
|
{
|
|
if (is_array($attrib)) {
|
|
$this->attrib = array_merge($this->attrib, $attrib);
|
|
}
|
|
|
|
$thead = '';
|
|
$tbody = '';
|
|
$col_tagname = $this->_col_tagname();
|
|
$row_tagname = $this->_row_tagname();
|
|
$head_tagname = $this->_head_tagname();
|
|
|
|
// include <thead>
|
|
if (!empty($this->header)) {
|
|
$rowcontent = '';
|
|
foreach ($this->header->cells as $c => $col) {
|
|
$rowcontent .= self::tag($head_tagname, $col->attrib, $col->content);
|
|
}
|
|
$thead = $this->tagname == 'table' ? self::tag('thead', null, self::tag('tr', $this->header->attrib ?: null, $rowcontent, parent::$common_attrib))
|
|
: self::tag($row_tagname, ['class' => 'thead'], $rowcontent, parent::$common_attrib);
|
|
}
|
|
|
|
foreach ($this->rows as $r => $row) {
|
|
$rowcontent = '';
|
|
foreach ($row->cells as $c => $col) {
|
|
if ($row_tagname == 'li' && empty($col->attrib) && count($row->cells) == 1) {
|
|
$rowcontent .= $col->content;
|
|
} else {
|
|
$rowcontent .= self::tag($col_tagname, $col->attrib, $col->content);
|
|
}
|
|
}
|
|
|
|
if ($r < $this->rowindex || count($row->cells)) {
|
|
$tbody .= self::tag($row_tagname, $row->attrib, $rowcontent, parent::$common_attrib);
|
|
}
|
|
}
|
|
|
|
if (!empty($this->attrib['rowsonly'])) {
|
|
return $tbody;
|
|
}
|
|
|
|
// add <tbody>
|
|
$this->content = $thead . ($this->tagname == 'table' ? self::tag('tbody', null, $tbody) : $tbody);
|
|
|
|
unset($this->attrib['cols'], $this->attrib['rowsonly']);
|
|
|
|
return parent::show();
|
|
}
|
|
|
|
/**
|
|
* Count number of rows
|
|
*
|
|
* @return int The number of rows
|
|
*/
|
|
public function size()
|
|
{
|
|
return count($this->rows);
|
|
}
|
|
|
|
/**
|
|
* Remove table body (all rows)
|
|
*/
|
|
public function remove_body()
|
|
{
|
|
$this->rows = [];
|
|
$this->rowindex = 0;
|
|
}
|
|
|
|
/**
|
|
* Getter for the corresponding tag name for table row elements
|
|
*/
|
|
private function _row_tagname()
|
|
{
|
|
static $row_tagnames = ['table' => 'tr', 'ul' => 'li', '*' => 'div'];
|
|
return !empty($row_tagnames[$this->tagname]) ? $row_tagnames[$this->tagname] : $row_tagnames['*'];
|
|
}
|
|
|
|
/**
|
|
* Getter for the corresponding tag name for table row elements
|
|
*/
|
|
private function _head_tagname()
|
|
{
|
|
static $head_tagnames = ['table' => 'th', '*' => 'span'];
|
|
return !empty($head_tagnames[$this->tagname]) ? $head_tagnames[$this->tagname] : $head_tagnames['*'];
|
|
}
|
|
|
|
/**
|
|
* Getter for the corresponding tag name for table cell elements
|
|
*/
|
|
private function _col_tagname()
|
|
{
|
|
static $col_tagnames = ['table' => 'td', '*' => 'span'];
|
|
return !empty($col_tagnames[$this->tagname]) ? $col_tagnames[$this->tagname] : $col_tagnames['*'];
|
|
}
|
|
}
|