+-----------------------------------------------------------------------+
| program/include/html.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2005-2008, RoundCube Dev, - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2005-2010, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: $
+ $Id: html.php 4867 2011-06-18 11:28:43Z alec $
*/
{
protected $tagname;
protected $attrib = array();
- protected $allowed;
+ protected $allowed = array();
protected $content;
- public static $common_attrib = array('id','class','style','title','align');
- public static $containers = array('div','span','p','h1','h2','h3','form','textarea');
public static $lc_tags = true;
+ public static $common_attrib = array('id','class','style','title','align');
+ public static $containers = array('iframe','div','span','p','h1','h2','h3','form','textarea','table','thead','tbody','tr','th','td','style','script');
/**
* Constructor
*
- * @param array Hash array with tag attributes
+ * @param array $attrib Hash array with tag attributes
*/
public function __construct($attrib = array())
{
*/
public function show()
{
- return self::tag($this->tagname, $this->attrib, $this->content, $this->allowed);
+ 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 Tag name
- * @param array Tag attributes as key/value pairs
- * @param string Optinal Tag content (creates a container tag)
- * @param array List with allowed attributes, omit to allow all
+ * @param string $tagname Tag name
+ * @param array $attrib Tag attributes as key/value pairs
+ * @param string $content Optinal Tag content (creates a container tag)
+ * @param array $allowed_attrib List with allowed attributes, omit to allow all
* @return string The XHTML tag
*/
public static function tag($tagname, $attrib = array(), $content = null, $allowed_attrib = null)
{
+ if (is_string($attrib))
+ $attrib = array('class' => $attrib);
+
$inline_tags = array('a','span','img');
$suffix = $attrib['nl'] || ($content && $attrib['nl'] !== false && !in_array($tagname, $inline_tags)) ? "\n" : '';
$tagname = self::$lc_tags ? strtolower($tagname) : $tagname;
- if ($content || in_array($tagname, self::$containers)) {
+ if (isset($content) || in_array($tagname, self::$containers)) {
$templ = $attrib['noclose'] ? "<%s%s>%s" : "<%s%s>%s</%s>%s";
unset($attrib['noclose']);
return sprintf($templ, $tagname, self::attrib_string($attrib, $allowed_attrib), $content, $tagname, $suffix);
/**
* Derrived method for <div> containers
*
- * @param mixed Hash array with tag attributes or string with class name
- * @param string Div content
+ * @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()
*/
if (is_string($attr)) {
$attr = array('class' => $attr);
}
- return self::tag('div', $attr, $cont, self::$common_attrib);
+ return self::tag('div', $attr, $cont, array_merge(self::$common_attrib, array('onclick')));
}
/**
* Derrived method for <p> blocks
*
- * @param mixed Hash array with tag attributes or string with class name
- * @param string Paragraph content
+ * @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()
*/
/**
* Derrived method to create <img />
*
- * @param mixed Hash array with tag attributes or string with image source (src)
+ * @param mixed $attr Hash array with tag attributes or string with image source (src)
* @return string HTML code
* @see html::tag()
*/
if (is_string($attr)) {
$attr = array('src' => $attr);
}
- return self::tag('img', $attr + array('alt' => ''), null, array_merge(self::$common_attrib, array('src','alt','width','height','border','usemap')));
+ return self::tag('img', $attr + array('alt' => ''), null, array_merge(self::$common_attrib,
+ array('src','alt','width','height','border','usemap')));
}
/**
* Derrived method for link tags
*
- * @param mixed Hash array with tag attributes or string with link location (href)
- * @param string Link content
+ * @param mixed $attr Hash array with tag attributes or string with link location (href)
+ * @param string $cont Link content
* @return string HTML code
* @see html::tag()
*/
if (is_string($attr)) {
$attr = array('href' => $attr);
}
- return self::tag('a', $attr, $cont, array_merge(self::$common_attrib, array('href','target','name','onclick','onmouseover','onmouseout')));
+ return self::tag('a', $attr, $cont, array_merge(self::$common_attrib,
+ array('href','target','name','rel','onclick','onmouseover','onmouseout','onmousedown','onmouseup')));
}
/**
* Derrived method for inline span tags
*
- * @param mixed Hash array with tag attributes or string with class name
- * @param string Tag content
+ * @param mixed $attr Hash array with tag attributes or string with class name
+ * @param string $cont Tag content
* @return string HTML code
* @see html::tag()
*/
/**
* Derrived method for form element labels
*
- * @param mixed Hash array with tag attributes or string with 'for' attrib
- * @param string Tag content
+ * @param mixed $attr Hash array with tag attributes or string with 'for' attrib
+ * @param string $cont Tag content
* @return string HTML code
* @see html::tag()
*/
return self::tag('label', $attr, $cont, array_merge(self::$common_attrib, array('for')));
}
+ /**
+ * Derrived method to create <iframe></iframe>
+ *
+ * @param mixed $attr Hash array with tag attributes or string with frame source (src)
+ * @return string HTML code
+ * @see html::tag()
+ */
+ public static function iframe($attr = null, $cont = null)
+ {
+ if (is_string($attr)) {
+ $attr = array('src' => $attr);
+ }
+ return self::tag('iframe', $attr, $cont, array_merge(self::$common_attrib,
+ array('src','name','width','height','border','frameborder')));
+ }
+
/**
* Derrived method for line breaks
*
/**
* Create string with attributes
*
- * @param array Associative arry with tag attributes
- * @param array List of allowed attributes
+ * @param array $attrib Associative arry with tag attributes
+ * @param array $allowed List of allowed attributes
* @return string Valid attribute string
*/
public static function attrib_string($attrib = array(), $allowed = null)
{
protected $tagname = 'input';
protected $type = 'text';
+ protected $allowed = array('type','name','value','size','tabindex',
+ 'autocomplete','checked','onchange','onclick','disabled','readonly',
+ 'spellcheck','results','maxlength','src','multiple');
+ /**
+ * Object constructor
+ *
+ * @param array $attrib Associative array with tag attributes
+ */
public function __construct($attrib = array())
{
if (is_array($attrib)) {
/**
* Compose input tag
*
- * @param string Field value
- * @param array Additional attributes to override
+ * @param string $value Field value
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = null, $attrib = null)
/**
* Constructor
*
- * @param array Named tag attributes
+ * @param array $attrib Named tag attributes
*/
public function __construct($attrib = null)
{
/**
* Add a hidden field to this instance
*
- * @param array Named tag attributes
+ * @param array $attrib Named tag attributes
*/
public function add($attrib)
{
/**
* Get HTML code for this object
*
- * @param string Value of the checked field
- * @param array Additional attributes to override
+ * @param string $value Value of the checked field
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = '', $attrib = null)
/**
* Get HTML code for this object
*
- * @param string Value of the checked field
- * @param array Additional attributes to override
+ * @param string $value Value of the checked field
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = '', $attrib = null)
class html_textarea extends html
{
protected $tagname = 'textarea';
- protected $allowed_attrib = array('name','rows','cols','wrap','tabindex');
+ protected $allowed = array('name','rows','cols','wrap','tabindex',
+ 'onchange','disabled','readonly','spellcheck');
/**
* Get HTML code for this object
*
- * @param string Textbox value
- * @param array Additional attributes to override
+ * @param string $value Textbox value
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = '', $attrib = null)
unset($this->attrib['value']);
}
- if (!empty($value) && !isset($this->attrib['mce_editable'])) {
+ if (!empty($value) && !preg_match('/mce_editor/', $this->attrib['class'])) {
$value = Q($value, 'strict', false);
}
- return self::tag($this->tagname, $this->attrib, $value, array_merge(self::$common_attrib, $this->allowed_attrib));
+
+ return self::tag($this->tagname, $this->attrib, $value,
+ array_merge(self::$common_attrib, $this->allowed));
}
}
{
protected $tagname = 'select';
protected $options = array();
+ protected $allowed = array('name','size','tabindex','autocomplete',
+ 'multiple','onchange','disabled','rel');
/**
* Add a new option to this drop-down
*
- * @param mixed Option name or array with option names
- * @param mixed Option value or array with option values
+ * @param mixed $names Option name or array with option names
+ * @param mixed $values Option value or array with option values
*/
public function add($names, $values = null)
{
}
}
-
/**
* Get HTML code for this object
*
- * @param string Value of the selection option
- * @param array Additional attributes to override
+ * @param string $select Value of the selection option
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($select = array(), $attrib = null)
$attr = array(
'value' => $option['value'],
'selected' => (in_array($option['value'], $select, true) ||
- in_array($option['text'], $select, true)) ? 1 : null);
+ in_array($option['text'], $select, true)) ? 1 : null);
$this->content .= self::tag('option', $attr, Q($option['text']));
}
class html_table extends html
{
protected $tagname = 'table';
- protected $allowed = array('id','class','style','width','summary','cellpadding','cellspacing','border');
+ protected $allowed = array('id','class','style','width','summary',
+ 'cellpadding','cellspacing','border');
+
private $header = array();
private $rows = array();
private $rowindex = 0;
private $colindex = 0;
-
+ /**
+ * Constructor
+ *
+ * @param array $attrib Named tag attributes
+ */
public function __construct($attrib = array())
{
$this->attrib = array_merge($attrib, array('summary' => '', 'border' => 0));
/**
* Add a table cell
*
- * @param array Cell attributes
- * @param string Cell content
+ * @param array $attr Cell attributes
+ * @param string $cont Cell content
*/
public function add($attr, $cont)
{
/**
* Add a table header cell
*
- * @param array Cell attributes
- * @param string Cell content
+ * @param array $attr Cell attributes
+ * @param string $cont Cell content
*/
- private function add_header($attr, $cont)
+ public function add_header($attr, $cont)
{
if (is_string($attr))
- $attr = array('class' => $attr);
+ $attr = array('class' => $attr);
$cell = new stdClass;
$cell->attrib = $attr;
$this->header[] = $cell;
}
+ /**
+ * Remove a column from a table
+ * Useful for plugins making alterations
+ *
+ * @param string $class
+ */
+ public function remove_column($class)
+ {
+ // Remove the header
+ foreach ($this->header 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 Row attributes
+ * @param array $attr Row attributes
*/
- private function add_row($attr = array())
+ public function add_row($attr = array())
{
$this->rowindex++;
$this->colindex = 0;
$this->rows[$this->rowindex]->cells = array();
}
+ /**
+ * Set row attributes
+ *
+ * @param array $attr Row attributes
+ * @param int $index Optional row index (default current row index)
+ */
+ public function set_row_attribs($attr = array(), $index = null)
+ {
+ if (is_string($attr))
+ $attr = array('class' => $attr);
+
+ if ($index === null)
+ $index = $this->rowindex;
+
+ $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 $this->rows[$index] ? $this->rows[$index]->attrib : null;
+ }
/**
* Build HTML output of the table data
*
- * @param array Table attributes
+ * @param array $attrib Table attributes
* @return string The final table HTML code
*/
- public function show($attr = array())
+ public function show($attrib = null)
{
- $this->attrib = array_merge($this->attrib, $attr);
+ if (is_array($attrib))
+ $this->attrib = array_merge($this->attrib, $attrib);
+
$thead = $tbody = "";
// include <thead>
if (!empty($this->header)) {
$rowcontent = '';
foreach ($this->header as $c => $col) {
- $rowcontent .= self::tag('th', $col->attrib, $col->content);
+ $rowcontent .= self::tag('td', $col->attrib, $col->content);
}
- $thead = self::tag('thead', null, self::tag('tr', null, $rowcontent));
+ $thead = self::tag('thead', null, self::tag('tr', null, $rowcontent, parent::$common_attrib));
}
foreach ($this->rows as $r => $row) {
}
if ($r < $this->rowindex || count($row->cells)) {
- $tbody .= self::tag('tr', $rows->attrib, $rowcontent);
+ $tbody .= self::tag('tr', $row->attrib, $rowcontent, parent::$common_attrib);
}
}
unset($this->attrib['cols'], $this->attrib['rowsonly']);
return parent::show();
}
+
+ /**
+ * Count number of rows
+ *
+ * @return The number of rows
+ */
+ public function size()
+ {
+ return count($this->rows);
+ }
+
+ /**
+ * Remove table body (all rows)
+ */
+ public function remove_body()
+ {
+ $this->rows = array();
+ $this->rowindex = 0;
+ }
+
}
-?>
\ No newline at end of file
projects / roundcube.git / blobdiff