* Copyright (c) 2006, 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 (c) 2006, Cake Software Foundation, Inc. * @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project * @package cake * @subpackage cake.cake.libs.view.helpers * @since CakePHP v 0.10.0.1076 * @version $Revision$ * @modifiedby $LastChangedBy$ * @lastmodified $Date$ * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ /* Deprecated */ /** * Tag template for a div with a class attribute. * @deprecated */ define('TAG_DIV', '
%s
'); /** * Tag template for a paragraph with a class attribute. */ define('TAG_P_CLASS', '

%s

'); /** * Tag template for a label with a for attribute. */ define('TAG_LABEL', ''); /** * Tag template for a fieldset with a legend tag inside. */ define('TAG_FIELDSET', '
%s%s'); /** * Form helper library. * * Automatic generation of HTML FORMs from given data. * * @package cake * @subpackage cake.cake.libs.view.helpers */ class FormHelper extends AppHelper { var $helpers = array('Html'); var $Html = null; var $__options = array( 'day' => array(), 'minute' => array(), 'hour' => array(), 'month' => array(), 'year' => array(), 'meridian' => array() ); /** * Returns an HTML FORM element. * * @access public * @param string $model The model object which the form is being defined for * @param array $options * @return string An formatted opening FORM tag. */ function create($model = null, $options = array()) { if (is_array($model) && empty($options)) { $options = $model; } if ($model !== false) { $model = $this->params['models'][0]; } if (ClassRegistry::isKeySet($model)) { $object =& ClassRegistry::getObject($model); } $this->setFormTag($model . '/'); $append = ''; $created = false; if(isset($object)) { $fields = $object->loadInfo(); $data = array( 'fields' => array_combine($fields->extract('{n}.name'), $fields->extract('{n}.type')), 'key' => $object->primaryKey, 'validates' => (empty($object->validate) ? array() : array_keys($object->validate)) ); } if (isset($this->data[$model]) && isset($this->data[$model][$data['key']]) && !empty($this->data[$model][$data['key']])) { $created = true; } $options = am(array( 'type' => ($created && empty($options['action'])) ? 'put' : 'post', 'id' => $model . ($created ? 'Edit' : 'Add') . 'Form', 'action' => array(), 'default' => true), $options); if (empty($options['action']) || is_array($options['action'])) { $options = (array)$options; $actionDefaults = array( 'controller' => Inflector::underscore($this->params['controller']), 'action' => $created ? 'edit' : 'add', 'id' => $created ? $this->data[$model][$data['key']] : null ); $options['action'] = am($actionDefaults, $options['action']); } switch (low($options['type'])) { case 'get': $htmlAttributes['method'] = 'get'; break; case 'file': $htmlAttributes['enctype'] = 'multipart/form-data'; $options['type'] = $created ? 'put' : 'post'; case 'post': case 'put': case 'delete': $append .= $this->hidden('method/method', array('value' => up($options['type']))); default: $htmlAttributes['method'] = 'post'; break; } $htmlAttributes['action'] = $this->url($options['action']); unset($options['type'], $options['action']); if ($options['default'] == false) { if (isset($htmlAttributes['onSubmit'])) { $htmlAttributes['onSubmit'] .= ' return false;'; } else { $htmlAttributes['onSubmit'] = 'return false;'; } } unset($options['default']); $htmlAttributes = am($options, $htmlAttributes); if (isset($this->params['_Token']) && !empty($this->params['_Token'])) { $append .= $this->hidden('_Token/key', array('value' => $this->params['_Token']['key'])); } $this->setFormTag($model . '/'); return $this->output(sprintf($this->Html->tags['form'], $this->Html->parseHtmlOptions($htmlAttributes, null, ''))) . $append; } /** * Closes an HTML form. * * @access public * @return string A closing FORM tag. */ function end($model = null) { if (empty($model) && !empty($this->params['models'])) { $models = $this->params['models'][0]; } return $this->output($this->Html->tags['formend']); } /** * Returns true if there is an error for the given field, otherwise false * * @access public * @param string $field This should be "Modelname/fieldname" * @return bool If there are errors this method returns true, else false. */ function isFieldError($field) { $this->setFormTag($field); return (bool)$this->tagIsInvalid(); } /** * Returns a formatted error message for given FORM field, NULL if no errors. * * @param string $field A field name, like "Modelname/fieldname" * @param string $text Error message * @param array $options Rendering options for
wrapper tag * @return string If there are errors this method returns an error message, otherwise null. */ function error($field, $text = null, $options = array()) { $this->setFormTag($field); if ($error == $this->tagIsInvalid()) { if ($text != null) { $error = $text; } elseif (is_numeric($error)) { $error = 'Error in field ' . Inflector::humanize($this->field()); } return $this->Html->div('error-message', $error); } else { return null; } } /** * Returns a formatted LABEL element for HTML FORMs. * * @param string $tagName This should be "Modelname/fieldname" * @param string $text Text that will appear in the label field. * @return string The formatted LABEL element */ function label($tagName = null, $text = null, $attributes = array()) { if (empty($tagName)) { $tagName = implode('/', array_filter(array($this->model(), $this->field()))); } if ($text == null) { if (strpos($tagName, '/') !== false) { list( , $text) = explode('/', $tagName); } else { $text = $tagName; } if (substr($text, -3) == '_id') { $text = substr($text, 0, strlen($text) - 3); } $text = Inflector::humanize($text); } if (strpos($tagName, '/') !== false) { $tagName = Inflector::camelize(r('/', '_', $tagName)); } return $this->output(sprintf($this->Html->tags['label'], $tagName, $this->_parseAttributes($attributes), $text)); } /** * Will display all the fields passed in an array expects tagName as an array key * replaces generateFields * * @access public * @param array $fields works well with Controller::generateFieldNames(); * @return output */ function inputs($fields) { $out = null; foreach($fields as $name => $options) { if (is_numeric($name) && !is_array($options)) { $name = $options; $options = array(); } if(is_array($options) && isset($options['tagName'])) { $name = $options['tagName']; unset($options['tagName']); } $out .= $this->input($name, $options); } return $out; } /** * Generates a form input element complete with label and wrapper div * * @param string $tagName This should be "Modelname/fieldname" * @param array $options * @return string */ function input($tagName, $options = array()) { $this->setFormTag($tagName); if ((!isset($options['type']) || $options['type'] == 'select') && !isset($options['options'])) { if (ClassRegistry::isKeySet($this->model())) { $model =& ClassRegistry::getObject($this->model()); if ($model->isForeignKey($this->field())) { $view =& ClassRegistry::getObject('view'); $varName = Inflector::variable(Inflector::pluralize(preg_replace('/_id$/', '', $this->field()))); $varOptions = $view->getVar($varName); if (is_array($options)) { $options['type'] = 'select'; $options['options'] = $varOptions; } } } } if (!isset($options['type'])) { $options['type'] = 'text'; if (isset($options['options'])) { $options['type'] = 'select'; } elseif (in_array($this->field(), array('passwd', 'password'))) { $options['type'] = 'password'; } elseif (ClassRegistry::isKeySet($this->model())) { $model =& ClassRegistry::getObject($this->model()); $type = $model->getColumnType($this->field()); $map = array( 'string' => 'text', 'datetime' => 'datetime', 'boolean' => 'checkbox', 'timestamp' => 'datetime', 'text' => 'textarea', 'time' => 'time', 'date' => 'date' ); if (isset($map[$type])) { $options['type'] = $map[$type]; } if($this->field() == $model->primaryKey) { $options['type'] = 'hidden'; } } } $out = ''; $div = true; if (isset($options['div'])) { $div = $options['div']; unset($options['div']); } $divOptions = array(); if ($div === true) { $divOptions['class'] = 'input'; } elseif ($div === false) { unset($divOptions); } elseif (is_string($div)) { $divOptions['class'] = $div; } elseif (is_array($div)) { $divOptions = am(array('class' => 'input'), $div); } $label = null; if (isset($options['label'])) { $label = $options['label']; unset($options['label']); } if (is_array($label)) { $labelText = null; if (isset($label['text'])) { $labelText = $label['text']; unset($label['text']); } $out = $this->label(null, $labelText, $label); $label = $labelText; } elseif ($label !== false) { $out = $this->label(null, $label); } $error = null; if (isset($options['error'])) { $error = $options['error']; unset($options['error']); } else { $error = $label . ' is required'; } $selected = null; if (array_key_exists('selected', $options)) { $selected = $options['selected']; unset($options['selected']); } if(isset($options['rows']) || isset($options['cols'])) { $options['type'] = 'textarea'; } $empty = false; if(isset($options['empty'])) { $empty = $options['empty']; unset($options['empty']); } $type = $options['type']; unset($options['type']); switch ($type) { case 'hidden': $out = $this->hidden($tagName, $options); unset($divOptions); break; case 'checkbox': $out = $this->Html->checkbox($tagName, null, $options) . $out; break; case 'text': $out .= $this->text($tagName, $options); break; case 'password': $out .= $this->password($tagName, $options); break; case 'file': $out .= $this->Html->file($tagName); break; case 'select': $list = array(); if(isset($options['options'])) { $list = $options['options']; unset($options['options']); } $out .= $this->select($tagName, $list, $selected, $options, $empty); break; case 'time': $out .= $this->Html->dateTimeOptionTag($tagName, null, '12', $selected, $options, null, $empty); break; case 'date': $out .= $this->Html->dateTimeOptionTag($tagName, 'MDY', null, $selected, $options, null, $empty); break; case 'datetime': $out .= $this->Html->dateTimeOptionTag($tagName, 'MDY', '12', $selected, $options, null, $empty); break; case 'textarea': default: $out .= $this->textarea($tagName, am(array('cols' => '30', 'rows' => '10'), $options)); break; } if ($error != null) { $out .= $this->Html->tagErrorMsg($tagName, $error); } if (isset($divOptions)) { $out = $this->Html->div($divOptions['class'], $out, $divOptions); } return $out; } /** * Creates a text input widget. * * @param string $fieldNamem Name of a field, like this "Modelname/fieldname" * @param array $htmlAttributes Array of HTML attributes. * @return string An HTML text input element */ function text($fieldName, $htmlAttributes = null) { $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->Html->tags['input'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' ', ' '))); } /** * Creates a password input widget. * * @param string $fieldName Name of a field, like this "Modelname/fieldname" * @param array $htmlAttributes Array of HTML attributes. * @return string */ function password($fieldName, $htmlAttributes = array()) { $htmlAttributes = $this->__value($htmlAttributes, $fieldName); $htmlAttributes = $this->domId($htmlAttributes); if ($this->tagIsInvalid()) { $htmlAttributes = $this->addClass($htmlAttributes, 'form-error'); } return $this->output(sprintf($this->Html->tags['password'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' ', ' '))); } /** * Creates a textarea widget. * * @param string $fieldNamem Name of a field, like this "Modelname/fieldname" * @param array $htmlAttributes Array of HTML attributes. * @return string An HTML text input element */ function textarea($fieldName, $htmlAttributes = array()) { $htmlAttributes = $this->__value($htmlAttributes, $fieldName); $htmlAttributes = $this->domId($htmlAttributes); if (isset($htmlAttributes['type'])) { unset($htmlAttributes['type']); } $value = null; if (array_key_exists('value', $htmlAttributes)) { $value = $htmlAttributes['value']; unset($htmlAttributes['value']); } if ($this->tagIsInvalid()) { $htmlAttributes = $this->addClass($htmlAttributes, 'form-error'); } return $this->output(sprintf($this->Html->tags['textarea'], $this->model(), $this->field(), $this->Html->_parseAttributes($htmlAttributes, null, ' '), $value)); } /** * Creates a hidden input field. * * @param string $fieldName Name of a field, like this "Modelname/fieldname" * @param array $htmlAttributes Array of HTML attributes. * @return string * @access public */ function hidden($fieldName, $htmlAttributes = array()) { $htmlAttributes = $this->domId($this->__value($htmlAttributes, $fieldName)); return $this->output(sprintf($this->Html->tags['hidden'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, ' ', ' '))); } /** * Creates file input widget. * * @param string $fieldName Name of a field, like this "Modelname/fieldname" * @param array $htmlAttributes Array of HTML attributes. * @return string * @access public */ function file($fieldName, $htmlAttributes = array()) { $htmlAttributes = $this->domId($this->__value($htmlAttributes, $fieldName)); return $this->output(sprintf($this->Html->tags['file'], $this->model(), $this->field(), $this->_parseAttributes($htmlAttributes, null, '', ' '))); } /** * Creates a button tag. * * @param mixed $params Array of params [content, type, options] or the * content of the button. * @param string $type Type of the button (button, submit or reset). * @param array $options Array of options. * @return string A HTML button tag. * @access public */ function button($params, $type = 'button', $options = array()) { trigger_error(__("Don't use me yet"), E_USER_ERROR); if (isset($options['name'])) { if (strpos($options['name'], "/") !== false) { if ($this->fieldValue($options['name'])) { $options['checked'] = 'checked'; } $this->setFieldName($options['name']); $options['name'] = 'data[' . $this->model() . '][' . $this->field() . ']'; } } $options['type'] = $type; $values = array( 'options' => $this->_parseOptions($options), 'tagValue' => $content ); return $this->_assign('button', $values); } /** * Creates a submit button element. * * @param string $caption The label appearing on the button * @param array $options * @return string A HTML submit button */ function submit($caption = 'Submit', $options = array()) { $options['value'] = $caption; $div = true; if (isset($options['div'])) { $div = $options['div']; unset($options['div']); } $divOptions = array(); if ($div === true) { $divOptions['class'] = 'submit'; } elseif ($div === false) { unset($divOptions); } elseif (is_string($div)) { $divOptions['class'] = $div; } elseif (is_array($div)) { $divOptions = am(array('class' => 'submit'), $div); } $out = $this->output(sprintf($this->Html->tags['submit'], $this->_parseAttributes($options, null, '', ' '))); if (isset($divOptions)) { $out = $this->Html->div($divOptions['class'], $out, $divOptions); } return $out; } /** * Creates an image input widget. * * @param string $path Path to the image file, relative to the webroot/img/ directory. * @param array $htmlAttributes Array of HTML attributes. * @return string HTML submit image element */ function submitImage($path, $htmlAttributes = array()) { if (strpos($path, '://')) { $url = $path; } else { $url = $this->webroot . $this->themeWeb . IMAGES_URL . $path; } return $this->output(sprintf($this->Html->tags['submitimage'], $url, $this->_parseAttributes($htmlAttributes, null, '', ' '))); } /** * Returns a formatted SELECT element. * * @param string $fieldName Name attribute of the SELECT * @param array $options Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the SELECT element * @param mixed $selected The option selected by default. If null, the default value * from POST data will be used when available. * @param array $attributes The HTML attributes of the select element. If * 'showParents' is included in the array and set to true, * an additional option element will be added for the parent * of each option group. * @param mixed $showEmpty If true, the empty select option is shown. If a string, * that string is displayed as the empty element. * @return string Formatted SELECT element */ function select($fieldName, $options = array(), $selected = null, $attributes = array(), $showEmpty = '') { $showParents = false; $this->setFormTag($fieldName); $attributes = $this->domId($attributes); if ($this->tagIsInvalid()) { $attributes = $this->addClass($attributes, 'form-error'); } if (is_string($options) && isset($this->__options[$options])) { $options = $this->__generateOptions($options); } elseif(!is_array($options)) { $options = array(); } if (isset($attributes['type'])) { unset($attributes['type']); } if (in_array('showParents', $attributes)) { $showParents = true; } if (!isset($selected)) { $selected = $this->__value($fieldName); } if (isset($attributes) && array_key_exists("multiple", $attributes)) { $tag = $this->Html->tags['selectmultiplestart']; } else { $tag = $this->Html->tags['selectstart']; } $select[] = sprintf($tag, $this->model(), $this->field(), $this->Html->parseHtmlOptions($attributes)); if ($showEmpty !== null && $showEmpty !== false) { if($showEmpty === true) { $showEmpty = ''; } $options = array_reverse($options, true); $options[''] = $showEmpty; $options = array_reverse($options, true); } $select = am($select, $this->__selectOptions(array_reverse($options, true), $selected, array(), $showParents)); $select[] = sprintf($this->Html->tags['selectend']); return $this->output(implode("\n", $select)); } /** * Returns an array of formatted OPTION/OPTGROUP elements * * @return array */ function __selectOptions($elements = array(), $selected = null, $parents = array(), $showParents = null) { $select = array(); foreach($elements as $name => $title) { $htmlOptions = array(); if (is_array($title) && (!isset($title['name']) || !isset($title['value']))) { if (!empty($name)) { $select[] = $this->Html->tags['optiongroupend']; $parents[] = $name; } $select = am($select, $this->__selectOptions($title, $selected, $parents, $showParents)); if (!empty($name)) { $select[] = sprintf($this->Html->tags['optiongroup'], $name, ''); } $name = null; } elseif (is_array($title)) { $htmlOptions = $title; $name = $title['value']; $title = $title['name']; unset($htmlOptions['name'], $htmlOptions['value']); } if ($name !== null) { if (($selected !== null) && ($selected == $name)) { $htmlOptions['selected'] = 'selected'; } else if(is_array($selected) && in_array($name, $selected)) { $htmlOptions['selected'] = 'selected'; } if($showParents || (!in_array($title, $parents))) { $select[] = sprintf($this->Html->tags['selectoption'], $name, $this->Html->parseHtmlOptions($htmlOptions), h($title)); } } } return array_reverse($select, true); } /** * Generates option lists for common