* Copyright 2005-2007, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2005-2007, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.libs.view.helpers
* @since CakePHP(tm) v 0.9.1
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Html Helper class for easy use of HTML widgets.
*
* HtmlHelper encloses all methods needed while working with HTML pages.
*
* @package cake
* @subpackage cake.cake.libs.view.helpers
*/
class HtmlHelper extends AppHelper {
/*************************************************************************
* Public variables
*************************************************************************/
/**#@+
* @access public
*/
/**
* html tags used by this helper.
*
* @var array
*/
var $tags = array(
'metalink' => ' ',
'link' => '%s ',
'mailto' => '%s ',
'form' => '
',
'input' => ' ',
'textarea' => '',
'hidden' => ' ',
'textarea' => '',
'checkbox' => ' ',
'radio' => ' %s',
'selectstart' => '',
'selectmultiplestart' => '',
'selectempty' => ' ',
'selectoption' => '%s ',
'selectend' => ' ',
'optiongroup' => '',
'optiongroupend' => ' ',
'password' => ' ',
'file' => ' ',
'file_no_model' => ' ',
'submit' => ' ',
'submitimage' => ' ',
'image' => ' ',
'tableheader' => '%s ',
'tableheaderrow' => '%s ',
'tablecell' => '%s ',
'tablerow' => '%s ',
'block' => '%s
',
'blockstart' => '',
'blockend' => '
',
'para' => '%s
',
'parastart' => '',
'label' => '%s ',
'fieldset' => '
%s %s ',
'fieldsetstart' => '%s ',
'fieldsetend' => ' ',
'legend' => '%s ',
'css' => ' ',
'style' => '',
'charset' => ' '
);
/**
* Base URL
*
* @var string
*/
var $base = null;
/**
* URL to current action.
*
* @var string
*/
var $here = null;
/**
* Parameter array.
*
* @var array
*/
var $params = array();
/**
* Current action.
*
* @var string
*/
var $action = null;
/**
* Enter description here...
*
* @var array
*/
var $data = null;
/**#@-*/
/*************************************************************************
* Private variables
*************************************************************************/
/**#@+
* @access private
*/
/**
* Breadcrumbs.
*
* @var array
* @access private
*/
var $_crumbs = array();
/**
* Document type definitions
*
* @var array
* @access private
*/
var $__docTypes = array(
'html4-strict' => '',
'html4-trans' => '',
'html4-frame' => '',
'xhtml-strict' => '',
'xhtml-trans' => '',
'xhtml-frame' => '',
'xhtml11' => ''
);
/**
* Adds a link to the breadcrumbs array.
*
* @param string $name Text for link
* @param string $link URL for link
*/
function addCrumb($name, $link) {
$this->_crumbs[] = array($name, $link);
}
/**
* Returns a doctype string.
*
* Possible doctypes:
* + html4-strict: HTML4 Strict.
* + html4-trans: HTML4 Transitional.
* + html4-frame: HTML4 Frameset.
* + xhtml-strict: XHTML1 Strict.
* + xhtml-trans: XHTML1 Transitional.
* + xhtml-frame: XHTML1 Frameset.
* + xhtml11: XHTML1.1.
*
* @param string $type Doctype to use.
* @return string Doctype.
*/
function docType($type = 'xhtml-strict') {
if (isset($this->__docTypes[$type])) {
return $this->output($this->__docTypes[$type]);
}
}
/**
* Creates a link to an external resource
*
* @param string $title The title of the external resource
* @param mixed $url The address of the external resource
* @param array $attributes Other attributes for the generated tag. If the type attribute is html, rss, atom, or icon, the mime-type is returned.
* @param boolean $inline If set to false, the generated tag appears in the head tag of the layout.
* @return string
*/
function meta($title = null, $url = null, $attributes = array(), $inline = true) {
$types = array(
'html' => 'text/html',
'rss' => 'application/rss+xml',
'atom' => 'application/atom+xml',
'icon' => 'image/x-icon'
);
if (!isset($attributes['type']) && is_array($url) && isset($url['ext'])) {
if (in_array($url['ext'], array_keys($types))) {
$attributes['type'] = $url['ext'];
} else {
$attributes['type'] = 'rss';
}
} elseif (!isset($attributes['type'])) {
$attributes['type'] = 'rss';
}
if (isset($attributes['type']) && in_array($attributes['type'], array_keys($types))) {
$attributes['type'] = $types[$attributes['type']];
}
if (!isset($attributes['rel'])) {
$attributes['rel'] = 'alternate';
}
$out = $this->output(sprintf($this->tags['metalink'], $this->url($url, true), $title, $this->_parseAttributes($attributes)));
if ($inline) {
return $out;
} else {
$view =& ClassRegistry::getObject('view');
$view->addScript($out);
}
}
/**
* Returns a charset META-tag.
*
* @param string $charset The character set to be used in the meta tag. Example: "utf-8".
* @return string A meta tag containing the specified character set.
*/
function charset($charset = null) {
if (is_null($charset)){
$charset = Configure::read('charset');
if (is_null($charset)){
$charset = 'utf-8';
}
}
return $this->output(sprintf($this->tags['charset'], $charset));
}
/**
* Creates an HTML link.
*
* If $url starts with "http://" this is treated as an external link. Else,
* it is treated as a path to controller/action and parsed with the
* HtmlHelper::url() method.
*
* If the $url is empty, $title is used instead.
*
* @param string $title The content to be wrapped by tags.
* @param mixed $url Cake-relative URL or array of URL parameters, or external URL (starts with http://)
* @param array $htmlAttributes Array of HTML attributes.
* @param string $confirmMessage JavaScript confirmation message.
* @param boolean $escapeTitle Whether or not $title should be HTML escaped.
* @return string An element.
*/
function link($title, $url = null, $htmlAttributes = array(), $confirmMessage = false, $escapeTitle = true) {
if ($url !== null) {
$url = $this->url($url);
} else {
$url = $this->url($title);
$title = $url;
$escapeTitle = false;
}
if (isset($htmlAttributes['escape'])) {
$escapeTitle = $htmlAttributes['escape'];
unset($htmlAttributes['escape']);
}
if ($escapeTitle === true) {
$title = htmlspecialchars($title, ENT_QUOTES);
} elseif (is_string($escapeTitle)) {
$title = htmlentities($title, ENT_QUOTES, $escapeTitle);
}
if (!empty($htmlAttributes['confirm'])) {
$confirmMessage = $htmlAttributes['confirm'];
unset($htmlAttributes['confirm']);
}
if ($confirmMessage) {
$confirmMessage = str_replace("'", "\'", $confirmMessage);
$confirmMessage = str_replace('"', '\"', $confirmMessage);
$htmlAttributes['onclick'] = "return confirm('{$confirmMessage}');";
} elseif (isset($htmlAttributes['default'])) {
if ($htmlAttributes['default'] == false) {
if (isset($htmlAttributes['onclick'])) {
$htmlAttributes['onclick'] .= ' return false;';
} else {
$htmlAttributes['onclick'] = 'return false;';
}
unset($htmlAttributes['default']);
}
}
return $this->output(sprintf($this->tags['link'], $url, $this->_parseAttributes($htmlAttributes), $title));
}
/**
* Creates a link element for CSS stylesheets.
*
* @param mixed $path The name of a CSS style sheet in /app/webroot/css, or an array containing names of CSS stylesheets in that directory.
* @param string $rel Rel attribute. Defaults to "stylesheet".
* @param array $htmlAttributes Array of HTML attributes.
* @param boolean $inline If set to false, the generated tag appears in the head tag of the layout.
* @return string CSS or tag, depending on the type of link.
*/
function css($path, $rel = null, $htmlAttributes = array(), $inline = true) {
if (is_array($path)) {
$out = '';
foreach ($path as $i) {
$out .= "\n\t" . $this->css($i, $rel, $htmlAttributes, $inline);
}
if ($inline) {
return $out . "\n";
}
return;
}
$url = $this->webroot((COMPRESS_CSS ? 'c' : '') . CSS_URL . $path . ".css");
if ($rel == 'import') {
$out = sprintf($this->tags['style'], $this->_parseAttributes($htmlAttributes, null, '', ' '), '@import url(' . $url . ');');
} else {
if ($rel == null) {
$rel = 'stylesheet';
}
$out = sprintf($this->tags['css'], $rel, $url, $this->_parseAttributes($htmlAttributes, null, '', ' '));
}
$out = $this->output($out);
if ($inline) {
return $out;
} else {
$view =& ClassRegistry::getObject('view');
$view->addScript($out);
}
}
/**
* Builds CSS style data from an array of CSS properties
*
* @param array $data
* @return string CSS styling data
*/
function style($data, $inline = true) {
if (!is_array($data)) {
return $data;
}
$out = array();
foreach ($data as $key=> $value) {
$out[] = $key.':'.$value.';';
}
if ($inline) {
return 'style="'.join(' ', $out).'"';
}
return join("\n", $out);
}
/**
* Returns the breadcrumb trail as a sequence of »-separated links.
*
* @param string $separator Text to separate crumbs.
* @param string $startText This will be the first crumb, if false it defaults to first crumb in array
* @return string
*/
function getCrumbs($separator = '»', $startText = false) {
if (count($this->_crumbs)) {
$out = array();
if ($startText) {
$out[] = $this->link($startText, '/');
}
foreach ($this->_crumbs as $crumb) {
if (!empty($crumb[1])){
$out[] = $this->link($crumb[0], $crumb[1]);
} else {
$out[] = $crumb[0];
}
}
return $this->output(join($separator, $out));
} else {
return null;
}
}
/**
* Creates a formatted IMG element.
*
* @param string $path Path to the image file, relative to the app/webroot/img/ directory.
* @param array $htmlAttributes Array of HTML attributes.
* @return string
*/
function image($path, $htmlAttributes = array()) {
if (strpos($path, '://')) {
$url = $path;
} else {
$url = $this->webroot(IMAGES_URL . $path);
}
if (!isset($htmlAttributes['alt'])) {
$htmlAttributes['alt'] = '';
}
return $this->output(sprintf($this->tags['image'], $url, $this->_parseAttributes($htmlAttributes, null, '', ' ')));
}
/**
* Creates a set of radio widgets.
*
* @param string $fieldName Name of a field, like this "Modelname/fieldname"
* @param array $options Radio button options array
* @param array $inbetween String that separates the radio buttons.
* @param array $htmlAttributes Array of HTML attributes.
* @return string
*/
function radio($fieldName, $options, $inbetween = null, $htmlAttributes = array()) {
$this->setFormTag($fieldName);
$value = isset($htmlAttributes['value']) ? $htmlAttributes['value'] : $this->value($fieldName);
$out = array();
foreach ($options as $optValue => $optTitle) {
$optionsHere = array('value' => $optValue);
if (!empty($value) && $optValue == $value) {
$optionsHere['checked'] = 'checked';
}
$parsedOptions = $this->_parseAttributes(array_merge($htmlAttributes, $optionsHere), null, '', ' ');
$individualTagName = $this->field() . "_{$optValue}";
$out[] = sprintf($this->tags['radio'], $this->model(), $this->field(), $individualTagName, $parsedOptions, $optTitle);
}
$out = join($inbetween, $out);
return $this->output($out ? $out : null);
}
/**
* Returns a row of formatted and named TABLE headers.
*
* @param array $names Array of tablenames.
* @param array $trOptions HTML options for TR elements.
* @param array $thOptions HTML options for TH elements.
* @return string
*/
function tableHeaders($names, $trOptions = null, $thOptions = null) {
$out = array();
foreach ($names as $arg) {
$out[] = sprintf($this->tags['tableheader'], $this->_parseAttributes($thOptions), $arg);
}
$data = sprintf($this->tags['tablerow'], $this->_parseAttributes($trOptions), join(' ', $out));
return $this->output($data);
}
/**
* Returns a formatted string of table rows (TR's with TD's in them).
*
* @param array $data Array of table data
* @param array $oddTrOptionsHTML options for odd TR elements
* @param array $evenTrOptionsHTML options for even TR elements
* @return string Formatted HTML
*/
function tableCells($data, $oddTrOptions = null, $evenTrOptions = null) {
if (empty($data[0]) || !is_array($data[0])) {
$data = array($data);
}
static $count = 0;
foreach ($data as $line) {
$count++;
$cellsOut = array();
foreach ($line as $cell) {
$cellsOut[] = sprintf($this->tags['tablecell'], null, $cell);
}
$options = $this->_parseAttributes($count % 2 ? $oddTrOptions : $evenTrOptions);
$out[] = sprintf($this->tags['tablerow'], $options, join(' ', $cellsOut));
}
return $this->output(join("\n", $out));
}
/**
* Returns a formatted DIV tag for HTML FORMs.
*
* @param string $class CSS class name of the div element.
* @param string $text String content that will appear inside the div element.
* If null, only a start tag will be printed
* @param array $attributes Additional HTML attributes of the DIV tag
* @param boolean $escape If true, $text will be HTML-escaped
* @return string The formatted DIV element
*/
function div($class = null, $text = null, $attributes = array(), $escape = false) {
if ($escape) {
$text = h($text);
}
if ($class != null && !empty($class)) {
$attributes['class'] = $class;
}
if ($text === null) {
$tag = 'blockstart';
} else {
$tag = 'block';
}
return $this->output(sprintf($this->tags[$tag], $this->_parseAttributes($attributes, null, ' ', ''), $text));
}
/**
* Returns a formatted P tag.
*
* @param string $class CSS class name of the p element.
* @param string $text String content that will appear inside the p element.
* @param array $attributes Additional HTML attributes of the P tag
* @param boolean $escape If true, $text will be HTML-escaped
* @return string The formatted P element
*/
function para($class, $text, $attributes = array(), $escape = false) {
if ($escape) {
$text = h($text);
}
if ($class != null && !empty($class)) {
$attributes['class'] = $class;
}
if ($text === null) {
$tag = 'parastart';
} else {
$tag = 'para';
}
return $this->output(sprintf($this->tags[$tag], $this->_parseAttributes($attributes, null, ' ', ''), $text));
}
/**
* Creates a password input widget.
*
* @deprecated 1.2.0.5147
* @see FormHelper::input or FormHelper::password
*/
function password($fieldName, $htmlAttributes = array()) {
trigger_error(sprintf(__('Method password() is deprecated in %s: see FormHelper::input or FormHelper::password', true), get_class($this)), E_USER_NOTICE);
$htmlAttributes = $this->value($htmlAttributes, $fieldName);
$htmlAttributes = $this->domId($htmlAttributes);
if ($this->tagIsInvalid()) {
$htmlAttributes = $this->addClass($htmlAttributes, 'form_error');
}
return $this->output(sprintf($this->tags['password'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' ', ' ')));
}
/**
* Creates a textarea widget.
*
* @deprecated 1.2.0.5147
* @see FormHelper::input or FormHelper::textarea
*/
function textarea($fieldName, $htmlAttributes = array()) {
trigger_error(sprintf(__('Method textarea() is deprecated in %s: see FormHelper::input or FormHelper::textarea', true), get_class($this)), E_USER_NOTICE);
$htmlAttributes = $this->value($htmlAttributes, $fieldName);
$value = null;
if (isset($htmlAttributes['value']) && !empty($htmlAttributes['value'])) {
$value = $htmlAttributes['value'];
unset($htmlAttributes['value']);
}
$htmlAttributes = $this->domId($htmlAttributes);
if ($this->tagIsInvalid()) {
$htmlAttributes = $this->addClass($htmlAttributes, 'form_error');
}
return $this->output(sprintf($this->tags['textarea'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' '), $value));
}
/**
* Creates a checkbox widget.
*
* @deprecated 1.2.0.5147
* @see FormHelper::input or FormHelper::checkbox
*/
function checkbox($fieldName, $title = null, $htmlAttributes = array()) {
trigger_error(sprintf(__('Method checkbox() is deprecated in %s: see FormHelper::input or FormHelper::checkbox', true), get_class($this)), E_USER_NOTICE);
$value = $this->tagValue($fieldName);
$notCheckedValue = 0;
if (isset($htmlAttributes['checked'])) {
if ($htmlAttributes['checked'] == 'checked' || intval($htmlAttributes['checked']) === 1 || $htmlAttributes['checked'] === true) {
$htmlAttributes['checked'] = 'checked';
} else {
$htmlAttributes['checked'] = null;
$notCheckedValue = -1;
}
} else {
$model = $this->model();
if (isset($htmlAttributes['value']) || (!class_exists($model) && !loadModel($model))) {
if (isset($htmlAttributes['value']) && $htmlAttributes['value'] == $value){
$htmlAttributes['checked'] = 'checked';
} else {
$htmlAttributes['checked'] = null;
}
if (isset($htmlAttributes['value']) && $htmlAttributes['value'] == '0') {
$notCheckedValue = -1;
}
} else {
$model = new $model;
$db =& ConnectionManager::getDataSource($model->useDbConfig);
$value = $db->boolean($value);
$htmlAttributes['checked'] = $value ? 'checked' : null;
$htmlAttributes['value'] = 1;
}
}
$htmlAttributes = $this->domId($htmlAttributes);
$output = $this->hidden($fieldName, array('value' => $notCheckedValue, 'id' => $htmlAttributes['id'] . '_'), true);
$output .= sprintf($this->tags['checkbox'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, '', ' '));
return $this->output($output);
}
/**
* Creates a hidden input field.
*
* @deprecated 1.2.0.5147
* @see FormHelper::input or FormHelper::hidden
*/
function hidden($fieldName, $htmlAttributes = array()) {
trigger_error(sprintf(__('Method hidden() is deprecated in %s: see FormHelper::input or FormHelper::hidden', true), get_class($this)), E_USER_NOTICE);
$htmlAttributes = $this->value($htmlAttributes, $fieldName);
$htmlAttributes = $this->domId($htmlAttributes);
return $this->output(sprintf($this->tags['hidden'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' ', ' ')));
}
/**
* Creates a text input widget.
*
* @deprecated 1.2.0.5147
* @see FormHelper::input or FormHelper::text
*/
function input($fieldName, $htmlAttributes = array()) {
trigger_error(sprintf(__('Method input() is deprecated in %s: see FormHelper::input or FormHelper::text', true), get_class($this)), E_USER_NOTICE);
$htmlAttributes = $this->value($htmlAttributes, $fieldName);
$htmlAttributes = $this->domId($htmlAttributes);
if (!isset($htmlAttributes['type'])) {
$htmlAttributes['type'] = 'text';
}
if ($this->tagIsInvalid()) {
$htmlAttributes = $this->addClass($htmlAttributes, 'form_error');
}
return $this->output(sprintf($this->tags['input'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' ', ' ')));
}
/**
* Returns value of $fieldName. False if the tag does not exist.
*
* @deprecated 1.2.0.5147
* @see FormHelper::errors
*/
function tagValue($fieldName) {
trigger_error(sprintf(__('Method tagValue() is deprecated in %s: see HtmlHelper::value', true), get_class($this)), E_USER_NOTICE);
$this->setFormTag($fieldName);
if (isset($this->data[$this->model()][$this->field()])) {
return h($this->data[$this->model()][$this->field()]);
}
return false;
}
/**
* Returns number of errors in a submitted FORM.
*
* @deprecated 1.2.0.5147
* @see FormHelper::errors
*/
function validate() {
trigger_error(sprintf(__('Method validate() is deprecated in %s: see FormHelper::errors', true), get_class($this)), E_USER_NOTICE);
$args = func_get_args();
$errors = call_user_func_array(array(&$this, 'validateErrors'), $args);
return count($errors);
}
/**
* Validates a FORM according to the rules set up in the Model.
*
* @deprecated 1.2.0.5147
* @see FormHelper::errors
*/
function validateErrors() {
trigger_error(sprintf(__('Method validateErrors() is deprecated in %s: see FormHelper::errors', true), get_class($this)), E_USER_NOTICE);
$objects = func_get_args();
if (!count($objects)) {
return false;
}
$errors = array();
foreach ($objects as $object) {
$errors = array_merge($errors, $object->invalidFields($object->data));
}
return $this->validationErrors = (count($errors) ? $errors : false);
}
/**
* Returns a formatted error message for given FORM field, NULL if no errors.
*
* @deprecated 1.2.0.5147
* @see FormHelper::error
*/
function tagErrorMsg($field, $text) {
trigger_error(sprintf(__('Method tagErrorMsg() is deprecated in %s: see FormHelper::error', true), get_class($this)), E_USER_NOTICE);
$error = 1;
$this->setFormTag($field);
if ($error == $this->tagIsInvalid()) {
return sprintf('%s
', is_array($text) ? (empty($text[$error - 1]) ? 'Error in field' : $text[$error - 1]) : $text);
} else {
return null;
}
}
}
?>