Page MenuHomeCode
Files F391405

html.inc.php
No OneTemporary
Actions

html.inc.php
View Options

<?php
/**
* html.inc.php
* Generic html element functions
*
* Copyright Gottfried Haider, Danja Vasiliev 2010.
* This source code is licensed under the GNU General Public License.
* See the file COPYING for more details.
*/
@require_once('config.inc.php');
require_once('util.inc.php');
$single_tags = array('link', 'meta', 'hr', 'br', 'img', 'param', 'input');
if (!isset($html)) {
$html = array();
$html['header'] = array('title'=>'');
$html['body'] = array('tag'=>'body');
$html['cache'] = true;
}
/**
* helper function for sorting an array of arrays by key 'prio'
*
* @param array &$a reference to an array
*/
function _array_sort_by_prio(&$a)
{
// usort makes no guarantee what happens when two entries have the same
// prio
usort($a, '_cmp_prio');
}
/**
* helper function for _array_sort_prio()
*
* @param array $a array to compare
* @param array $b array to compare
* @return int comparison result
*/
function _cmp_prio($a, $b)
{
if ($a['prio'] == $b['prio']) {
return 0;
}
return ($a['prio'] < $b['prio']) ? -1 : 1;
}
/**
* get a reference to the body element
*
* @return &array reference to the body element
*/
function &body()
{
global $html;
return $html['body'];
}
/**
* helper function for appending content to the body element
*
* @param mixed $c content (can be either a string or another element)
*/
function body_append($c)
{
global $html;
elem_append($html['body'], $c);
}
/**
* create a element
*
* @param string $tag element tag
* @return array element
*/
function elem($tag)
{
return array('tag'=>$tag);
}
/**
* add a class to an element
*
* @param array &$elem reference to an element
* @param string $c class
*/
function elem_add_class(&$elem, $c)
{
if (!@is_array($elem['class'])) {
$elem['class'] = array();
}
$elem['class'][] = $c;
$elem['class'] = array_unique($elem['class']);
}
/**
* append content to an element
*
* this function is similar to elem_val().
* @param array &$elem reference to an element
* @param mixed $c content (can be either a string or another element)
*/
function elem_append(&$elem, $c)
{
if (!isset($elem['val'])) {
if (is_array($c)) {
$elem['val'] = array($c);
} else {
$elem['val'] = $c;
}
} elseif (is_array($c) && is_array($elem['val'])) {
$elem['val'][] = $c;
} elseif (is_array($c) && is_string($elem['val'])) {
$elem['val'] = array($elem['val'], $c);
} elseif (is_string($c) && is_array($elem['val'])) {
$elem['val'][] = $c;
} elseif (is_string($c) && is_string($elem['val'])) {
$elem['val'] .= $c;
}
}
/**
* get or set an attribute in an element
*
* @param array &$elem reference to an element
* @param string attribute name
* @param mixed attribute value (to set it)
*/
function elem_attr(&$elem)
{
if (func_num_args() == 2) {
if (isset($elem[func_get_arg(1)])) {
return $elem[func_get_arg(1)];
} else {
return NULL;
}
} elseif (2 < func_num_args()) {
$elem[func_get_arg(1)] = func_get_arg(2);
}
}
/**
* get the element's classes in an array
*
* @param array $elem element
* @return array
*/
function elem_classes($elem)
{
if (@is_array($elem['class'])) {
return $elem['class'];
} else {
return array();
}
}
/**
* get or set a css property in an element
*
* @param array &$elem reference to an element
* @param string css property name
* @param mixed css property value (to set it; empty string to clear it)
*/
function elem_css(&$elem)
{
if (func_num_args() == 2) {
if (@is_array($elem['style']) && isset($elem['style'][func_get_arg(1)])) {
return $elem['style'][func_get_arg(1)];
} else {
return NULL;
}
} elseif (2 < func_num_args()) {
if (!@is_array($elem['style'])) {
$elem['style'] = array();
}
if (func_get_arg(2) === '') {
// clear css property
unset($elem['style'][func_get_arg(1)]);
} else {
$elem['style'][func_get_arg(1)] = func_get_arg(2);
}
}
}
/**
* turn an element into a html string
*
* @param array $elem element
* @return string html
*/
function elem_finalize($elem)
{
global $single_tags;
$ret = '<'.$elem['tag'];
if (isset($elem['id'])) {
$ret .= ' id="'.htmlspecialchars($elem['id'], ENT_COMPAT, 'UTF-8').'"';
unset($elem['id']);
}
if (@is_array($elem['class'])) {
$ret .= ' class="'.htmlspecialchars(implode(' ', $elem['class']), ENT_COMPAT, 'UTF-8').'"';
unset($elem['class']);
}
foreach ($elem as $key=>$val) {
if ($key == 'tag' || $key == 'id' || $key == 'class' || $key == 'val') {
continue;
} elseif ($key == 'style') {
$ret .= ' style="';
ksort($val);
foreach ($val as $k=>$v) {
$ret .= htmlspecialchars($k, ENT_COMPAT, 'UTF-8').': '.htmlspecialchars($v, ENT_COMPAT, 'UTF-8').'; ';
}
// strip the last space
$ret = substr($ret, 0, -1);
$ret .= '"';
} else {
$ret .= ' '.htmlspecialchars($key, ENT_NOQUOTES, 'UTF-8').'="'.htmlspecialchars($val, ENT_COMPAT, 'UTF-8').'"';
}
}
$ret .= '>';
// make block elements have a newline after the opening tag
$block_tags = array('body', 'div', 'script', 'p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'ol', 'ul', 'li', 'blockquote', 'hr', 'pre');
if (in_array($elem['tag'], $block_tags)) {
$block_tag = true;
$ret .= nl();
} else {
$block_tag = false;
}
// handle single-type elements
if (in_array(strtolower($elem['tag']), $single_tags)) {
return $ret;
}
// handle text, an element array or an array of both
$content = '';
if (@is_string($elem['val'])) {
$content = $elem['val'];
} elseif (@is_array($elem['val']) && isset($elem['val']['tag'])) {
// this is recursive
$content = elem_finalize($elem['val']);
} elseif (@is_array($elem['val'])) {
foreach ($elem['val'] as $v) {
if (is_string($v)) {
$content .= $v;
} elseif (is_array($v) && isset($v['tag'])) {
// add a newline when appropriate
if (in_array($v['tag'], $block_tags) && 0 < strlen($content) && substr($content, -1) != "\n") {
$content .= nl();
}
// this is recursive
$content .= elem_finalize($v);
}
}
}
// move block element content in by one tab
if ($block_tag && 0 < strlen($content)) {
// if the content ends with a newline character, remove it
if (substr($content, -1) == "\n") {
$content = substr($content, 0, -1);
}
$content = str_replace("\n", "\n\t", $content);
$ret .= tab().$content.nl();
} elseif (0 < strlen($content)) {
$ret .= $content;
}
$ret .= '</'.$elem['tag'].'>';
// make block elements have a newline after the closing tag
if ($block_tag) {
$ret .= nl();
}
return $ret;
}
/**
* check if an element is of a certain class
*
* @param array $elem element
* @param string $c class to check
* @return bool
*/
function elem_has_class($elem, $c)
{
if (@in_array($c, $elem['class'])) {
return true;
} else {
return false;
}
}
/**
* remove an attribute from an element
*
* @param array &$elem reference to an element
* @param string $a attribute name
*/
function elem_remove_attr(&$elem, $a)
{
unset($elem[$a]);
}
/**
* remove a class from an element
*
* @param array &$elem reference to an element
* @param string $c class
*/
function elem_remove_class(&$elem, $c)
{
if (@is_array($elem['class'])) {
if (($k = array_search($c, $elem['class'])) !== false) {
array_splice($elem['class'], $k, 1);
}
}
}
/**
* get the element's tag
*
* the tag is always returned in lowercase characters.
* @param array $elem element
* @return string
*/
function elem_tag($elem)
{
if (isset($elem['tag'])) {
return strtolower($elem['tag']);
} else {
return '';
}
}
/**
* get or set an element's content
*
* this function is similar to elem_append().
* @param array &$elem reference to an element
* @param mixed $c content (to set it, can be either a string or another element)
*/
function elem_val(&$elem)
{
if (func_num_args() == 1) {
if (@is_string($elem['val'])) {
return $elem['val'];
} else {
return '';
}
} elseif (1 < func_num_args()) {
$elem['val'] = func_get_arg(1);
}
}
/**
* add a link-alternate element to the html header
*
* @param string $type type attribute
* @param string $url url attribute (url-encoded if necessary)
* @param string $title title attribute
*/
function html_add_alternate($type, $url, $title)
{
global $html;
if (!@is_array($html['header']['alternate'])) {
$html['header']['alternate'] = array();
}
$html['header']['alternate'][] = array('type'=>$type, 'url'=>$url, 'title'=>$title);
}
/**
* add a reference to a css file to the html header
*
* @param string $url url attribute (url-encoded if necessary)
* @param int $prio when to insert reference (0 - very early to 9 - late)
* @param string $media media attribute (optional)
*/
function html_add_css($url, $prio = 5, $media = '')
{
global $html;
if (!@is_array($html['header']['css'])) {
$html['header']['css'] = array();
}
$html['header']['css'][] = array('url'=>$url, 'prio'=>$prio, 'media'=>$media);
}
/**
* add a reference to a javascript file to the html header
*
* duplicate references will be removed from the output.
* @param string $url url attribute (url-encoded if necessary)
* @param int $prio when to insert reference (0 - very early to 9 - late)
*/
function html_add_js($url, $prio = 5)
{
global $html;
if (!@is_array($html['header']['js'])) {
$html['header']['js'] = array();
}
$html['header']['js'][] = array('url'=>$url, 'prio'=>$prio);
}
/**
* add javascript code to the html header
*
* @param string $code javscript code
* @param int $prio when to insert code (0 - very early to 9 - late)
* @param string $reason (e.g. your module) (optional)
*/
function html_add_js_code($code, $prio = 5, $reason = '')
{
global $html;
if (!@is_array($html['header']['js_code'])) {
$html['header']['js_code'] = array();
}
$html['header']['js_code'][] = array('code'=>$code, 'prio'=>$prio, 'reason'=>$reason);
}
/**
* set a variable in the javascript output
*
* @param string $key variable or object the value will be stored)
* @param mixed $val value
*/
function html_add_js_var($key, $val)
{
global $html;
if (!@is_array($html['header']['js_var'])) {
$html['header']['js_var'] = array();
}
$html['header']['js_var'][$key] = $val;
}
/**
* get or set a css property in the html element
*
* @param string css property name
* @param mixed css property value (to set it; empty string to clear it)
*/
function html_css($prop)
{
global $html;
if (func_num_args() == 1) {
if (@is_array($html['header']['style']) && isset($html['header']['style'][$prop])) {
return $html['header']['style'][$prop];
} else {
return NULL;
}
} elseif (1 < func_num_args()) {
if (!@is_array($html['header']['style'])) {
$html['header']['style'] = array();
}
if (func_get_arg(1) === '') {
// clear css property
unset($html['header']['style'][$prop]);
} else {
$html['header']['style'][$prop] = func_get_arg(1);
}
}
}
/**
* disable caching of output
*
* can be used for modules that need the php to be executed every time.
* @param string $reason (e.g. your module)
*/
function html_disable_caching($reason = '')
{
global $html;
if ($html['cache']) {
log_msg('info', 'html: disabled caching for this request because of '.quot($reason));
$html['cache'] = false;
}
}
/**
* get or set favicon
*
* @param string url (to set it, url-encoded if necessary)
*/
function html_favicon()
{
global $html;
if (func_num_args() == 0) {
if (@is_string($html['header']['favicon'])) {
return $html['header']['favicon'];
} else {
return '';
}
} elseif (0 < func_num_args()) {
$html['header']['favicon'] = func_get_arg(0);
}
}
/**
* turn the page into a html string
*
* @param bool &$cache is output cachable (will only modified if $cache is
* true before)
* @return string html
*/
function html_finalize(&$cache = false)
{
global $html;
// return html5
$ret = '<!DOCTYPE html>'.nl();
$ret .= '<html';
if (@is_array($html['header']['style'])) {
$ret .= ' style="';
ksort($html['header']['style']);
foreach ($html['header']['style'] as $key=>$val) {
$ret .= htmlspecialchars($key, ENT_COMPAT, 'UTF-8').': '.htmlspecialchars($val, ENT_COMPAT, 'UTF-8').'; ';
}
// strip the last space
$ret = substr($ret, 0, -1);
$ret .= '"';
}
$ret .= '>'.nl();
$ret .= '<head>'.nl();
$ret .= '<title>'.htmlspecialchars($html['header']['title'], ENT_NOQUOTES, 'UTF-8').'</title>'.nl();
$ret .= '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'.nl();
if (@is_array($html['header']['alternate'])) {
foreach ($html['header']['alternate'] as $e) {
$ret .= '<link rel="alternate" type="'.htmlspecialchars($e['type'], ENT_COMPAT, 'UTF-8').'" href="'.htmlspecialchars($e['url'], ENT_COMPAT, 'UTF-8').'" title="'.htmlspecialchars($e['title'], ENT_COMPAT, 'UTF-8').'">'.nl();
}
}
if (!empty($html['header']['favicon'])) {
$ret .= '<link rel="shortcut icon" href="'.htmlspecialchars($html['header']['favicon'], ENT_COMPAT, 'UTF-8').'">'.nl();
}
if (@is_array($html['header']['css'])) {
_array_sort_by_prio($html['header']['css']);
// removed the removal of duplicates here as two different media might point to the same url
//array_unique_element($html['header']['css'], 'url');
foreach ($html['header']['css'] as $e) {
$ret .= '<link rel="stylesheet" type="text/css" href="'.htmlspecialchars($e['url'], ENT_COMPAT, 'UTF-8').'"';
if (!empty($e['media'])) {
$ret .= ' media="'.htmlspecialchars($e['media'], ENT_COMPAT, 'UTF-8').'"';
}
$ret .= '>'.nl();
}
}
if (@is_array($html['header']['js'])) {
_array_sort_by_prio($html['header']['js']);
array_unique_element($html['header']['js'], 'url');
foreach ($html['header']['js'] as $e) {
$ret .= '<script type="text/javascript" src="'.htmlspecialchars($e['url'], ENT_COMPAT, 'UTF-8').'"></script>'.nl();
}
}
if (@is_array($html['header']['js_var'])) {
$ret .= array_to_js($html['header']['js_var']);
}
if (@is_array($html['header']['js_code'])) {
_array_sort_by_prio($html['header']['js_code']);
foreach ($html['header']['js_code'] as $c) {
if (!empty($c['reason'])) {
$ret .= '<!-- '.$c['reason'].' -->'.nl();
$ret .= '<script type="text/javascript">'.nl();
// if the code ends with a newline character, remove it
if (substr($c['code'], -1) == "\n") {
$c['code'] = substr($c['code'], 0, -1);
}
// move code in by one tab
$c = str_replace("\n", "\n\t", $c);
$ret .= tab().$c['code'].nl();
$ret .= '</script>'.nl();
}
}
}
$ret .= '</head>'.nl();
$ret .= elem_finalize($html['body']);
$ret .= '</html>';
// pass caching information up if requested
if ($cache) {
if (!$html['cache']) {
$cache = false;
}
}
return $ret;
}
/**
* get or set title
*
* @param string title (to set it)
*/
function html_title()
{
global $html;
if (func_num_args() == 0) {
return $html['header']['title'];
} elseif (0 < func_num_args()) {
$html['header']['title'] = func_get_arg(0);
}
}
?>

File Metadata

Mime Type
text/x-php
Expires
Sat, Feb 22, 20:24 (23 h, 58 m ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
23197
Default Alt Text
html.inc.php (14 KB)

Event Timeline