Logo Search packages:      
Sourcecode: cakephp1.2 version File versions  Download package

form.php

<?php
/* SVN FILE: $Id: form.php 5875 2007-10-23 00:25:51Z phpnut $ */
/**
 * Automatic generation of HTML FORMs from given data.
 *
 * Used for scaffolding.
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) :  Rapid Development Framework <http://www.cakephp.org/>
 * 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.10.0.1076
 * @version             $Revision: 5875 $
 * @modifiedby          $LastChangedBy: phpnut $
 * @lastmodified  $Date: 2007-10-22 19:25:51 -0500 (Mon, 22 Oct 2007) $
 * @license             http://www.opensource.org/licenses/mit-license.php The MIT License
 */
/**
 * Form helper library.
 *
 * Automatic generation of HTML FORMs from given data.
 *
 * @package       cake
 * @subpackage    cake.cake.libs.view.helpers
 */
00037 class FormHelper extends AppHelper {
/**
 * Other helpers used by FormHelper
 *
 * @var array
 * @access public
 */
      var $helpers = array('Html');
/**
 * Holds the fields array('field_name' => 'type'), sizes array('field_name' => 'size'),
 * primaryKey and validates array('field_name')
 *
 * @access public
 */
00051       var $fieldset = array('fields' => array(), 'sizes' => array(), 'key' => 'id', 'validates' => array());
/**
 * Enter description here...
 *
 * @var array
 */
      var $__options = array(
            'day' => array(), 'minute' => array(), 'hour' => array(),
            'month' => array(), 'year' => array(), 'meridian' => array()
      );
/**
 * Enter description here...
 *
 * @var array
 * @access public
 */
      var $fields = array();
/**
 * Defines the type of form being created.  Set by FormHelper::create().
 *
 * @var string
 * @access public
 */
      var $requestType = null;
/**
 * 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.
 */
00083       function create($model = null, $options = array()) {
            $defaultModel = null;
            $data = $this->fieldset;
            $view =& ClassRegistry::getObject('view');

            if (is_array($model) && empty($options)) {
                  $options = $model;
                  $model = null;
            }

            if (empty($model) && $model !== false && !empty($this->params['models'])) {
                  $model = $this->params['models'][0];
                  $defaultModel = $this->params['models'][0];
            } elseif (empty($model) && empty($this->params['models'])) {
                  $model = false;
            } elseif (is_string($model) && (strpos($model, '/') !== false || strpos($model, '.') !== false)) {
                  $path = preg_split('/\/|\./', $model);
                  $model = $path[count($path) - 1];
            }

            if (ClassRegistry::isKeySet($model)) {
                  $object =& ClassRegistry::getObject($model);
            }

            $models = ClassRegistry::keys();
            foreach ($models as $currentModel) {
                  if (ClassRegistry::isKeySet($currentModel)) {
                        $currentObject =& ClassRegistry::getObject($currentModel);
                        if (is_a($currentObject, 'Model') && !empty($currentObject->validationErrors)) {
                              $this->validationErrors[Inflector::camelize($currentModel)] =& $currentObject->validationErrors;
                        }
                  }
            }

            $this->setFormTag($model . '.');
            $append = '';
            $created = $id = false;

            if (isset($object)) {
                  $fields = $object->loadInfo();
                  $fieldNames = $fields->extract('{n}.name');
                  $fieldTypes = $fields->extract('{n}.type');
                  $fieldLengths = $fields->extract('{n}.length');
                  if (!count($fieldNames) || !count($fieldTypes)) {
                         trigger_error(__('(FormHelper::create) Unable to use model field data. If you are using a model without a database table, try implementing loadInfo()', true), E_USER_WARNING);
                  }
                  if (!count($fieldNames) || !count($fieldLengths) || (count($fieldNames) != count($fieldTypes))) {
                         trigger_error(__('(FormHelper::create) Unable to use model field data. If you are using a model without a database table, try implementing loadInfo()', true), E_USER_WARNING);
                  }
                  $data = array(
                        'fields' => array_combine($fieldNames, $fieldTypes),
                        'sizes' => array_combine($fieldNames, $fieldLengths),
                        'key' => $object->primaryKey,
                        'validates' => (ife(empty($object->validate), array(), array_keys($object->validate)))
                  );

                  $habtm = array();
                  if (!empty($object->hasAndBelongsToMany)) {
                        $habtm = array_combine(array_keys($object->hasAndBelongsToMany), array_keys($object->hasAndBelongsToMany));
                  }
                  $data['fields'] = am($data['fields'], $habtm);
                  $this->fieldset = $data;
            }

            if (isset($this->data[$model]) && isset($this->data[$model][$data['key']]) && !empty($this->data[$model][$data['key']])) {
                  $created = true;
                  $id = $this->data[$model][$data['key']];
            }
            $options = am(array(
                  'type' => ($created && empty($options['action'])) ? 'put' : 'post',
                  'action' => null,
                  'url' => null,
                  'default' => true),
            $options);

            if (empty($options['url']) || is_array($options['url'])) {
                  $options = (array)$options;
                  if (!isset($this->params['controller']) && !empty($model) && $model != $defaultModel) {
                        $controller = Inflector::underscore(Inflector::pluralize($model));
                  } else {
                        $controller = Inflector::underscore($this->params['controller']);
                  }
                  if (empty($options['action'])) {
                        $options['action'] = ife($created, 'edit', 'add');
                  }

                  $actionDefaults = array(
                        'plugin' => $this->plugin,
                        'controller' => $controller,
                        'action' => $options['action'],
                        'id' => $id
                  );
                  if (!empty($options['action']) && !isset($options['id'])) {
                        $options['id'] = $model . Inflector::camelize($options['action']) . 'Form';
                  }
                  $options['action'] = am($actionDefaults, (array)$options['url']);
            } elseif (is_string($options['url'])) {
                  $options['action'] = $options['url'];
            }
            unset($options['url']);

            switch (low($options['type'])) {
                  case 'get':
                        $htmlAttributes['method'] = 'get';
                  break;
                  case 'file':
                        $htmlAttributes['enctype'] = 'multipart/form-data';
                        $options['type'] = ife($created, 'put', 'post');
                  case 'post':
                  case 'put':
                  case 'delete':
                        //$append .= $this->hidden('_method', array('name' => '_method', 'value' => up($options['type']), 'id' => $options['id'] . 'Method'));
                  default:
                        $htmlAttributes['method'] = 'post';
                  break;
            }
            $this->requestType = low($options['type']);

            $htmlAttributes['action'] = $this->url($options['action']);
            unset($options['type'], $options['action']);

            if ($options['default'] == false) {
                  if (isset($htmlAttributes['onSubmit'])) {
                        $htmlAttributes['onSubmit'] .= ' event.returnValue = false; return false;';
                  } else {
                        $htmlAttributes['onSubmit'] = 'event.returnValue = false; return false;';
                  }
            }
            unset($options['default']);
            $htmlAttributes = am($options, $htmlAttributes);

            if (isset($this->params['_Token']) && !empty($this->params['_Token'])) {
                  $append .= '<p style="display: none;">';
                  $append .= $this->hidden('_Token/key', array('value' => $this->params['_Token']['key'], 'id' => 'Token' . mt_rand()));
                  $append .= '</p>';
            }

            return $this->output(sprintf($this->Html->tags['form'], $this->Html->_parseAttributes($htmlAttributes, null, ''))) . $append;
      }
/**
 * Closes an HTML form, cleans up values set by FormHelper::create(), and writes hidden
 * input fields where appropriate.
 *
 * @return string A closing FORM tag.
 * @access public
 */
00229       function end($options = null) {
            if (!empty($this->params['models'])) {
                  $models = $this->params['models'][0];
            }

            $submitOptions = true;
            if (!is_array($options)) {
                  $submitOptions = $options;
            } elseif (isset($options['submit'])) {
                  $submitOptions = $options['submit'];
                  unset($options['submit']);

                  if (isset($options['label'])) {
                        $submit = $options['label'];
                        unset($options['label']);
                  }
            }

            if ($submitOptions === true) {
                  $submit = __('Submit', true);
            } elseif (is_string($submitOptions)) {
                  $submit = $submitOptions;
            }

            if (!is_array($submitOptions)) {
                  $submitOptions = array();
            }
            $out = null;

            if (isset($submit)) {
                  $out .= $this->submit($submit, $submitOptions);
            } elseif (isset($this->params['_Token']) && !empty($this->params['_Token'])) {
                  $out .= $this->secure($this->fields);
                  $this->fields = array();
            }
            $this->setFormTag(null);
            $out .= $this->Html->tags['formend'];
            return $this->output($out);
      }

/**
 * Generates a hidden field with a security hash based on the fields used in the form.
 *
 * @param array $fields The list of fields to use when generating the hash
 * @return string A hidden input field with a security hash
 * @access public
 */
00276       function secure($fields) {
            if (!empty($fields)) {
                  $append = '<p style="display: none;">';

                  foreach ($fields as $key => $value) {
                        if (strpos($key, '_') !== 0) {
                              sort($fields[$key]);
                        }
                  }
                  ksort($fields);
                  $append .= $this->hidden('_Token.fields', array('value' => urlencode(Security::hash(serialize($fields) . Configure::read('Security.salt'))), 'id' => 'TokenFields' . mt_rand()));
                  $append .= '</p>';
                  return $append;
            }
            return null;
      }
/**
 * Generates a field list
 *
 * @param string $model Model name
 * @param array $options Options
 * @access private
 */
00299       function __secure($model = null, $options = null) {
            if (!$model) {
                  $model = $this->model();
            }

            if (isset($this->params['_Token']) && !empty($this->params['_Token'])) {
                  if (!empty($this->params['_Token']['disabledFields'])) {
                        foreach ($this->params['_Token']['disabledFields'] as $value) {
                              $parts = preg_split('/\/|\./', $value);
                              if (count($parts) == 1) {
                                    if ($parts[0] === $this->field()) {
                                          return;
                                    }
                              } elseif (count($parts) == 2) {
                                    if ($parts[0] === $this->model() && $parts[1] === $this->field()) {
                                          return;
                                    }
                              }
                        }
                        if (!is_null($options)) {
                              $this->fields[$model][$this->field()] = $options;
                              return;
                        }
                        $this->fields[$model][] = $this->field();
                        return;
                  }
                  if (!is_null($options)) {
                        $this->fields[$model][$this->field()] = $options;
                        return;
                  }
                  $this->fields[$model][] = $this->field();
                  return;
            }
      }
/**
 * Returns true if there is an error for the given field, otherwise false
 *
 * @param string $field This should be "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @return boolean If there are errors this method returns true, else false.
 * @access public
 */
00340       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", "Modelname/fieldname" is deprecated
 * @param string $text        Error message
 * @param array $options      Rendering options for <div /> wrapper tag
 * @return string If there are errors this method returns an error message, otherwise null.
 * @access public
 */
00353       function error($field, $text = null, $options = array()) {
            $this->setFormTag($field);
            $options = am(array('wrap' => true, 'class' => 'error-message', 'escape' => true), $options);

            if ($error = $this->tagIsInvalid()) {
                  if (is_array($text) && is_numeric($error) && $error > 0) {
                        $error--;
                  }
                  if (is_array($text) && isset($text[$error])) {
                        $text = $text[$error];
                  } elseif (is_array($text)) {
                        $text = null;
                  }

                  if ($text != null) {
                        $error = $text;
                  } elseif (is_numeric($error)) {
                        $error = 'Error in field ' . Inflector::humanize($this->field());
                  }
                  if ($options['escape']) {
                        $error = h($error);
                  }
                  if ($options['wrap'] === true) {
                        return $this->Html->div($options['class'], $error);
                  } else {
                        return $error;
                  }
            } else {
                  return null;
            }
      }
/**
 * Returns a formatted LABEL element for HTML FORMs.
 *
 * @param string $fieldName This should be "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param string $text Text that will appear in the label field.
 * @return string The formatted LABEL element
 */
00391       function label($fieldName = null, $text = null, $attributes = array()) {
            if (empty($fieldName)) {
                  $fieldName = implode('.', array_filter(array($this->model(), $this->field())));
            }

            if ($text === null) {
                  if (strpos($fieldName, '/') !== false || strpos($fieldName, '.') !== false) {
                        list( , $text) = preg_split('/[\/\.]+/', $fieldName);
                  } else {
                        $text = $fieldName;
                  }
                  if (substr($text, -3) == '_id') {
                        $text = substr($text, 0, strlen($text) - 3);
                  }
                  $text = Inflector::humanize(Inflector::underscore($text));
            }

            if (isset($attributes['for'])) {
                  $labelFor = $attributes['for'];
                  unset($attributes['for']);
            } else {
                  $labelFor = $this->domId($fieldName);
            }
            if (!empty($text)) {
                  $text = __($text, true);
            }
            return $this->output(sprintf($this->Html->tags['label'], $labelFor, $this->_parseAttributes($attributes), $text));
      }
/**
 * Will display all the fields passed in an array expects fieldName as an array key
 * replaces generateFields
 *
 * @access public
 * @param array $fields works well with Controller::generateFields() or on its own;
 * @param array $blacklist a simple array of fields to skip
 * @return output
 */
00428       function inputs($fields = null, $blacklist = null) {
            $fieldset = $legend = true;

            if (is_array($fields)) {
                  if (array_key_exists('legend', $fields)) {
                        $legend = $fields['legend'];
                        unset($fields['legend']);
                  }

                  if (isset($fields['fieldset'])) {
                        $fieldset = $fields['fieldset'];
                        unset($fields['fieldset']);
                  }
            } elseif ($fields !== null) {
                  $legend = $fields;
                  unset($fields);
            }

            if (empty($fields)) {
                  $fields = array_keys($this->fieldset['fields']);
            }

            if ($legend === true) {
                  $actionName = __('New', true);
                  if (strpos($this->action, 'update') !== false || strpos($this->action, 'edit') !== false) {
                        $actionName = __('Edit', true);
                  }
                  $modelName = Inflector::humanize(Inflector::underscore($this->model()));
                  $legend = $actionName .' '. __($modelName, true);
            }

            $out = null;
            foreach ($fields as $name => $options) {
                  if (is_numeric($name) && !is_array($options)) {
                              $name = $options;
                              $options = array();
                  }
                  if (is_array($blacklist) && in_array($name, $blacklist)) {
                        continue;
                  }
                  $out .= $this->input($name, $options);
            }

            if ($fieldset) {
                  return sprintf($this->Html->tags['fieldset'], $legend, $out);
            } else {
                  return $out;
            }
      }
/**
 * Generates a form input element complete with label and wrapper div
 *
 * @param string $fieldName This should be "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param array $options
 * @return string
 */
00484       function input($fieldName, $options = array()) {
            $this->setFormTag($fieldName);
            $options = am(
                  array(
                        'before' => null,
                        'between' => null,
                        'after' => null
                  ),
            $options);

            if (!isset($options['type'])) {
                  $options['type'] = 'text';
                  if (isset($options['options'])) {
                        $options['type'] = 'select';
                  } elseif (in_array($this->field(), array('psword', 'passwd', 'password'))) {
                        $options['type'] = 'password';
                  } elseif (isset($this->fieldset['fields'][$this->field()])) {
                        $type = $this->fieldset['fields'][$this->field()];
                        $primaryKey = $this->fieldset['key'];
                  } elseif (ClassRegistry::isKeySet($this->model())) {
                        $model =& ClassRegistry::getObject($this->model());
                        $type = $model->getColumnType($this->field());
                        $primaryKey = $model->primaryKey;
                  }

                  if (isset($type)) {
                        $map = array(
                              'string'    => 'text',  'datetime'  => 'datetime',
                              'boolean'   => 'checkbox',    'timestamp' => 'datetime',
                              'text'            => 'textarea',    'time'            => 'time',
                              'date'            => 'date'
                        );
                        if (isset($map[$type])) {
                              $options['type'] = $map[$type];
                        } elseif ($type ===  $this->field()) {
                              $this->setFormTag($this->field().'.'.$this->field());
                              $fieldName = $this->field().'.'.$this->field();
                        }
                        if ($this->field() == $primaryKey) {
                              $options['type'] = 'hidden';
                        }
                  }
            }

            if ($this->model() === $this->field()) {
                  $options['type'] = 'select';
                  $options['multiple'] = 'multiple';
            }

            if (!isset($options['options']) && in_array($options['type'], array('text', 'radio', 'select'))) {
                  $view =& ClassRegistry::getObject('view');
                  $varName = Inflector::variable(Inflector::pluralize(preg_replace('/_id$/', '', $this->field())));
                  $varOptions = $view->getVar($varName);
                  if (is_array($varOptions)) {
                        if ($options['type'] === 'text') {
                              $options['type'] = 'select';
                        }
                        $options['options'] = $varOptions;
                  }
            }

            if (!array_key_exists('maxlength', $options) && $options['type'] == 'text') {
                  if (isset($this->fieldset['sizes'][$this->field()])) {
                        $options['maxlength'] = $this->fieldset['sizes'][$this->field()];
                  }
            }

            $out = '';
            $div = true;
            if (array_key_exists('div', $options)) {
                  $div = $options['div'];
                  unset($options['div']);
            }

            if (!empty($div)) {
                  $divOptions = array('class' => 'input');
                  if (is_string($div)) {
                        $divOptions['class'] = $div;
                  } elseif (is_array($div)) {
                        $divOptions = am($divOptions, $div);
                  }
                  if (in_array($this->field(), $this->fieldset['validates'])) {
                        $divOptions = $this->addClass($divOptions, 'required');
                  }
            }

            $label = null;
            if (isset($options['label']) && $options['type'] !== 'radio') {
                  $label = $options['label'];
                  unset($options['label']);
            }

            if ($options['type'] === 'radio') {
                  $label = false;
                  if (isset($options['options'])) {
                        if (is_array($options['options'])) {
                              $radioOptions = $options['options'];
                        } else {
                              $radioOptions = array($options['options']);
                        }
                        unset($options['options']);
                  }
            }

            if ($label !== false) {
                  $labelAttributes = array();

                  if (in_array($options['type'], array('date', 'datetime'))) {
                        $labelFor = $this->domId(implode('.', array_filter(array($this->model(), $this->field()))));
                        $labelAttributes = array('for' => $labelFor . 'Month');
                  }

                  if (is_array($label)) {
                        $labelText = null;
                        if (isset($label['text'])) {
                              $labelText = $label['text'];
                              unset($label['text']);
                        }

                        $labelAttributes = am($labelAttributes, $label);
                  } else {
                        $labelText = $label;
                  }

                  $out = $this->label(null, $labelText, $labelAttributes);
            }

            $error = null;
            if (isset($options['error'])) {
                  $error = $options['error'];
                  unset($options['error']);
            }

            $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']);
            }

            $timeFormat = 12;
            if (isset($options['timeFormat'])) {
                  $timeFormat = $options['timeFormat'];
                  unset($options['timeFormat']);
            }

            $type  = $options['type'];
            $before      = $options['before'];
            $between = $options['between'];
            $after       = $options['after'];
            unset($options['type'], $options['before'], $options['between'], $options['after']);

            switch ($type) {
                  case 'hidden':
                        $out = $this->hidden($fieldName, $options);
                        unset($divOptions);
                  break;
                  case 'checkbox':
                        $out = $before . $this->checkbox($fieldName, $options) . $between . $out;
                  break;
                  case 'radio':
                        $out = $before . $out . $this->radio($fieldName, $radioOptions, $options) . $between;
                  break;
                  case 'text':
                  case 'password':
                        $out = $before . $out . $between . $this->{$type}($fieldName, $options);
                  break;
                  case 'file':
                        $out = $before . $out . $between . $this->file($fieldName, $options);
                  break;
                  case 'select':
                        $options = am(array('options' => array()), $options);
                        $list = $options['options'];
                        unset($options['options']);
                        $out = $before . $out . $between . $this->select($fieldName, $list, $selected, $options, $empty);
                  break;
                  case 'time':
                        $out = $before . $out . $between . $this->dateTime($fieldName, null, $timeFormat, $selected, $options, $empty);
                  break;
                  case 'date':
                        $out = $before . $out . $between . $this->dateTime($fieldName, 'MDY', null, $selected, $options, $empty);
                  break;
                  case 'datetime':
                        $out = $before . $out . $between . $this->dateTime($fieldName, 'MDY', $timeFormat, $selected, $options, $empty);
                  break;
                  case 'textarea':
                  default:
                        $out = $before . $out . $between . $this->textarea($fieldName, am(array('cols' => '30', 'rows' => '6'), $options));
                  break;
            }

            if ($type != 'hidden') {
                  $out .= $after;
                  if ($error !== false) {
                        $out .= $this->error($fieldName, $error);
                  }
            }
            if (isset($divOptions)) {
                  $out = $this->Html->div($divOptions['class'], $out, $divOptions);
            }
            return $out;
      }
/**
 * Creates a checkbox input widget.
 *
 * @param string $fieldNamem Name of a field, like this "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param array $options Array of HTML attributes.
 * @return string An HTML text input element
 */
00701       function checkbox($fieldName, $options = array()) {
            $value = 1;
            if (isset($options['value'])) {
                  $value = $options['value'];
                  unset($options['value']);
            }

            $options = $this->__initInputField($fieldName, $options);
            $this->__secure();

            $model = $this->model();
            if (ClassRegistry::isKeySet($model)) {
                  $object =& ClassRegistry::getObject($model);
            }

            $output = null;
            if (isset($object) && isset($options['value']) && ($options['value'] == 0 || $options['value'] == 1)) {
                  $db =& ConnectionManager::getDataSource($object->useDbConfig);
                  $value = $db->boolean($options['value'], false);
                  $options['value'] = 1;
            }
            $output = $this->hidden($fieldName, array('value' => '0', 'id' => $options['id'] . '_'), true);

            if (isset($options['value']) && $value == $options['value']) {
                  $options['checked'] = 'checked';
            } elseif (!empty($value)) {
                  $options['value'] = $value;
            }

            $output .= sprintf($this->Html->tags['checkbox'], $options['name'], $this->_parseAttributes($options, array('name'), null, ' '));
            return $this->output($output);
      }
/**
 * 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  $attributes       Array of HTML attributes. Use the 'separator' key to
 *                                  define the string in between the radio buttons
 * @return string
 */
00742       function radio($fieldName, $options = array(), $attributes = array()) {
            $attributes = $this->__initInputField($fieldName, $attributes);
            $this->__secure();

            $legend = false;
            if (isset($attributes['legend'])) {
                  $legend = $attributes['legend'];
                  unset($attributes['legend']);
            } elseif (count($options) > 1) {
                  $legend = Inflector::humanize($this->field());
            }

            $label = true;
            if (isset($attributes['label'])) {
                  $label = $attributes['label'];
                  unset($attributes['label']);
            }

            $inbetween = null;
            if (isset($attributes['separator'])) {
                  $inbetween = $attributes['separator'];
                  unset($attributes['separator']);
            }

            if (isset($attributes['value'])) {
                  $value = $attributes['value'];
            } else {
                  $value =  $this->value($fieldName);
            }

            $out = array();
            foreach ($options as $optValue => $optTitle) {
                  $optionsHere = array('value' => $optValue);
                  if (isset($value) && $optValue == $value) {
                        $optionsHere['checked'] = 'checked';
                  }
                  $parsedOptions = $this->_parseAttributes(array_merge($attributes, $optionsHere), array('name', 'type', 'id'), '', ' ');
                  $tagName = Inflector::camelize($this->field() . '_'.Inflector::underscore($optValue));
                  if ($label) {
                        $optTitle =  sprintf($this->Html->tags['label'], $tagName, null, $optTitle);
                  }
                  $out[] =  sprintf($this->Html->tags['radio'], $attributes['name'], $tagName, $parsedOptions, $optTitle);
            }
            $hidden = null;
            if (!isset($value)) {
                  $hidden = $this->hidden($fieldName, array('value' => '', 'id' => $attributes['id'] . '_'), true);
            }
            $out = $hidden . join($inbetween, $out);
            if ($legend) {
                  $out = sprintf($this->Html->tags['fieldset'], $legend, $out);
            }
            return $this->output($out);
      }
/**
 * Creates a text input widget.
 *
 * @param string $fieldNamem Name of a field, like this "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param array $options Array of HTML attributes.
 * @return string An HTML text input element
 */
00802       function text($fieldName, $options = array()) {
            $options = $this->__initInputField($fieldName, am(array('type' => 'text'), $options));
            $this->__secure();
            return $this->output(sprintf($this->Html->tags['input'], $options['name'], $this->_parseAttributes($options, array('name'), null, ' ')));
      }
/**
 * Creates a password input widget.
 *
 * @param  string  $fieldName Name of a field, like this "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param  array  $options Array of HTML attributes.
 * @return string
 */
00814       function password($fieldName, $options = array()) {
            $options = $this->__initInputField($fieldName, $options);
            $this->__secure();
            return $this->output(sprintf($this->Html->tags['password'], $options['name'], $this->_parseAttributes($options, array('name'), null, ' ')));
      }
/**
 * Creates a textarea widget.
 *
 * @param string $fieldNamem Name of a field, like this "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param array $options Array of HTML attributes.
 * @return string An HTML text input element
 */
00826       function textarea($fieldName, $options = array()) {
            $options = $this->__initInputField($fieldName, $options);
            $this->__secure();
            $value = null;

            if (array_key_exists('value', $options)) {
                  $value = $options['value'];
                  if (!array_key_exists('escape', $options) || $options['escape'] !== false) {
                        $value = h($value);
                  }
                  unset($options['value']);
            }
            return $this->output(sprintf($this->Html->tags['textarea'], $options['name'], $this->_parseAttributes($options, array('type', 'name'), null, ' '), $value));
      }
/**
 * Creates a hidden input field.
 *
 * @param  string  $fieldName Name of a field, like this "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param  array  $options Array of HTML attributes.
 * @return string
 * @access public
 */
00848       function hidden($fieldName, $options = array()) {
            $options = $this->__initInputField($fieldName, $options);
            $model = $this->model();
            $value = '';
            $key = '_' . $model;

            if (isset($this->params['_Token']) && !empty($this->params['_Token'])) {
                  $options['name'] = str_replace($model, $key, $options['name']);
            }

            if (!empty($options['value']) || $options['value'] === '0') {
                  $value = $options['value'];
            }
            $this->__secure($key, $value);

            /*if (in_array($fieldName, array('_method', '_fields'))) {
                  $model = null;
            }*/
            return $this->output(sprintf($this->Html->tags['hidden'], $options['name'], $this->_parseAttributes($options, array('name', 'class'), '', ' ')));
      }
/**
 * Creates file input widget.
 *
 * @param string $fieldName Name of a field, like this "Modelname.fieldname", "Modelname/fieldname" is deprecated
 * @param array $options Array of HTML attributes.
 * @return string
 * @access public
 */
00876       function file($fieldName, $options = array()) {
            $options = $this->__initInputField($fieldName, $options);
            $this->__secure();
            return $this->output(sprintf($this->Html->tags['file'], $options['name'], $this->_parseAttributes($options, array('name'), '', ' ')));
      }
/**
 * 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
 */
00891       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 || strpos($options['name'], ".") !== false) {
                        if ($this->value($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
 */
00919       function submit($caption = null, $options = array()) {
            if (!$caption) {
                  $caption = __('Submit', true);
            }
            $options['value'] = $caption;
            $secured = null;

            if (isset($this->params['_Token']) && !empty($this->params['_Token'])) {
                  $secured = $this->secure($this->fields);
                  $this->fields = array();
            }
            $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 = $secured . $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   $options Array of HTML attributes.
 * @return string  HTML submit image element
 */
00961       function submitImage($path, $options = array()) {
            if (strpos($path, '://')) {
                  $url = $path;
            } else {
                  $url = $this->webroot(IMAGES_URL . $path);
            }
            return $this->output(sprintf($this->Html->tags['submitimage'], $url, $this->_parseAttributes($options, 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
 */
00984       function select($fieldName, $options = array(), $selected = null, $attributes = array(), $showEmpty = '') {
            $showParents = false;
            $escapeOptions = true;

            if (isset($attributes['escape'])) {
                  $escapeOptions = $attributes['escape'];
                  unset($attributes['escape']);
            }
            $attributes = $this->__initInputField($fieldName, $attributes);

            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;
                  unset($attributes['showParents']);
            }

            if (!isset($selected)) {
                  $selected = $attributes['value'];
            }

            if (isset($attributes) && array_key_exists('multiple', $attributes)) {
                  $tag = $this->Html->tags['selectmultiplestart'];
            } else {
                  $tag = $this->Html->tags['selectstart'];
                  $this->__secure();
            }
            $select[] = sprintf($tag, $attributes['name'], $this->_parseAttributes($attributes, array('name', 'value')));

            if ($showEmpty !== null && $showEmpty !== false && !(empty($showEmpty) && (isset($attributes) && array_key_exists('multiple', $attributes)))) {
                  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, array('escape' => $escapeOptions)));
            $select[] = sprintf($this->Html->tags['selectend']);
            return $this->output(implode("\n", $select));
      }
/**
 * Returns a SELECT element for days.
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param string $selected Option which is selected.
 * @param array    $attributes HTML attributes for the select element
 * @param mixed $showEmpty Show/hide the empty select option
 * @return string
 */
01040       function day($fieldName, $selected = null, $attributes = array(), $showEmpty = true) {
            $value = $this->value($fieldName);

            if (empty($value)) {
                  if (!$showEmpty && !$selected) {
                        $value = 'now';
                  } elseif (strlen($selected) > 2) {
                        $value = $selected;
                  } elseif ($selected === false) {
                        $selected = null;
                  }
            }

            if (!empty($value)) {
                  $selected = date('d', strtotime($value));
            }
            return $this->select($fieldName . "_day", $this->__generateOptions('day'), $selected, $attributes, $showEmpty);
      }
/**
 * Returns a SELECT element for years
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param integer $minYear First year in sequence
 * @param integer $maxYear Last year in sequence
 * @param string $selected Option which is selected.
 * @param array $attributes Attribute array for the select elements.
 * @param boolean $showEmpty Show/hide the empty select option
 * @return string
 */
01069       function year($fieldName, $minYear = null, $maxYear = null, $selected = null, $attributes = array(), $showEmpty = true) {
            $value = $this->value($fieldName);

            if (empty($value)) {
                  if (!$showEmpty && !$maxYear && !$selected) {
                        $value = 'now';
                  } elseif (!$showEmpty && $maxYear && !$selected) {
                        $selected = $maxYear;
                  } elseif (strlen($selected) > 4) {
                        $value = $selected;
                  } elseif ($selected === false) {
                        $selected = null;
                  }
            }

            if (!empty($value)) {
                  $selected = date('Y', strtotime($value));
            }
            return $this->select($fieldName . "_year", $this->__generateOptions('year', $minYear, $maxYear), $selected, $attributes, $showEmpty);
      }
/**
 * Returns a SELECT element for months.
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param string $selected Option which is selected.
 * @param boolean $showEmpty Show/hide the empty select option
 * @return string
 */
01097       function month($fieldName, $selected = null, $attributes = array(), $showEmpty = true) {
            $value = $this->value($fieldName);

            if (empty($value)) {
                  if (!$showEmpty && !$selected) {
                        $value = 'now';
                  } elseif (strlen($selected) > 2) {
                        $value = $selected;
                  } elseif ($selected === false) {
                        $selected = null;
                  }
            }

            if (!empty($value)) {
                  $selected = date('m', strtotime($value));
            }
            return $this->select($fieldName . "_month", $this->__generateOptions('month'), $selected, $attributes, $showEmpty);
      }
/**
 * Returns a SELECT element for hours.
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param boolean $format24Hours True for 24 hours format
 * @param string $selected Option which is selected.
 * @param array $attributes List of HTML attributes
 * @param mixed $showEmpty True to show an empty element, or a string to provide default empty element text
 * @return string
 */
01125       function hour($fieldName, $format24Hours = false, $selected = null, $attributes = array(), $showEmpty = true) {
            $value = $this->value($fieldName);

            if (empty($value)) {
                  if (!$showEmpty && !$selected) {
                        $value = 'now';
                  } elseif (strlen($selected) > 2) {
                        $value = $selected;
                  } elseif ($selected === false) {
                        $selected = null;
                  }
            }

            if (!empty($value) && $format24Hours) {
                  $selected = date('H', strtotime($value));
            } elseif (!empty($value) && !$format24Hours) {
                  $selected = date('g', strtotime($value));
            }
            return $this->select($fieldName . "_hour", $this->__generateOptions($format24Hours ? 'hour24' : 'hour'), $selected, $attributes, $showEmpty);
      }
/**
 * Returns a SELECT element for minutes.
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param string $selected Option which is selected.
 * @return string
 */
01152       function minute($fieldName, $selected = null, $attributes = array(), $showEmpty = true) {
            $value = $this->value($fieldName);

            if (empty($value)) {
                  if (!$showEmpty  && !$selected) {
                        $value = 'now';
                  } elseif (strlen($selected) > 2) {
                        $value = $selected;
                  } elseif ($selected === false) {
                        $selected = null;
                  }
            }

            if (!empty($value)) {
                  $selected = date('i', strtotime($value));
            }
            return $this->select($fieldName . "_min", $this->__generateOptions('minute'), $selected, $attributes, $showEmpty);
      }
/**
 * Returns a SELECT element for AM or PM.
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param string $selected Option which is selected.
 * @return string
 */
01177       function meridian($fieldName, $selected = null, $attributes = array(), $showEmpty = true) {
            if (empty($selected) && $value = $this->value($fieldName)) {
                  $selected = date('a', strtotime($value));
            }
            $selected = empty($selected) ? ($showEmpty ? null : date('a')) : $selected;
            return $this->select($fieldName . "_meridian", $this->__generateOptions('meridian'), $selected, $attributes, $showEmpty);
      }
/**
 * Returns a set of SELECT elements for a full datetime setup: day, month and year, and then time.
 *
 * @param string $fieldName Prefix name for the SELECT element
 * @param string $dateFormat DMY, MDY, YMD or NONE.
 * @param string $timeFormat 12, 24, NONE
 * @param string $selected Option which is selected.
 * @return string The HTML formatted OPTION element
 */
01193       function dateTime($fieldName, $dateFormat = 'DMY', $timeFormat = '12', $selected = null, $attributes = array(), $showEmpty = true) {
            $day    = null;
            $month        = null;
            $year   = null;
            $hour   = null;
            $min    = null;
            $meridian = null;

            if (empty($selected)) {
                  $selected = $this->value($fieldName);
            }

            if (!empty($selected)) {

                  if (is_int($selected)) {
                        $selected = strftime('%Y-%m-%d %H:%M:%S', $selected);
                  }

                  $meridian = 'am';
                  $pos = strpos($selected, '-');
                  if ($pos !== false) {
                        $date = explode('-', $selected);
                        $days = explode(' ', $date[2]);
                        $day = $days[0];
                        $month = $date[1];
                        $year = $date[0];
                  } else {
                        $days[1] = $selected;
                  }

                  if ($timeFormat != 'NONE' && !empty($timeFormat)) {
                        $time = explode(':', $days[1]);
                        $check = str_replace(':', '', $days[1]);

                        if (($check > 115959) && $timeFormat == '12') {
                              $time[0] = $time[0] - 12;
                              $meridian = 'pm';
                        } elseif ($time[0] > 12) {
                              $meridian = 'pm';
                        }

                        $hour = $time[0];
                        $min = $time[1];
                  }
            }

            $elements = array('Day','Month','Year','Hour','Minute','Meridian');
            if (isset($attributes['id'])) {
                  if (is_string($attributes['id'])) {
                        // build out an array version
                        foreach ($elements as $element) {
                              $selectAttrName = 'select' . $element . 'Attr';
                              ${$selectAttrName} = $selectAttr;
                              ${$selectAttrName}['id'] = $attributes['id'] . $element;
                        }
                  } elseif (is_array($attributes['id'])) {
                        // check for missing ones and build selectAttr for each element
                        foreach ($elements as $element) {
                              $selectAttrName = 'select' . $element . 'Attr';
                              ${$selectAttrName} = $attributes;
                              ${$selectAttrName}['id'] = $attributes['id'][strtolower($element)];
                        }
                  }
            } else {
                  // build the selectAttrName with empty id's to pass
                  foreach ($elements as $element) {
                        $selectAttrName = 'select' . $element . 'Attr';
                        ${$selectAttrName} = $attributes;
                  }
            }

            $attributes = am(array('minYear' => null, 'maxYear' => null), $attributes);

            switch($dateFormat) {
                  case 'DMY': // so uses the new selex
                        $opt = $this->day($fieldName, $day, $selectDayAttr, $showEmpty) . '-' .
                        $this->month($fieldName, $month, $selectMonthAttr, $showEmpty) . '-' . $this->year($fieldName, $attributes['minYear'], $attributes['maxYear'], $year, $selectYearAttr, $showEmpty);
                  break;
                  case 'MDY':
                        $opt = $this->month($fieldName, $month, $selectMonthAttr, $showEmpty) . '-' .
                        $this->day($fieldName, $day, $selectDayAttr, $showEmpty) . '-' . $this->year($fieldName, $attributes['minYear'], $attributes['maxYear'], $year, $selectYearAttr, $showEmpty);
                  break;
                  case 'YMD':
                        $opt = $this->year($fieldName, $attributes['minYear'], $attributes['maxYear'], $year, $selectYearAttr, $showEmpty) . '-' .
                        $this->month($fieldName, $month, $selectMonthAttr, $showEmpty) . '-' .
                        $this->day($fieldName, $day, $selectDayAttr, $showEmpty);
                  break;
                  case 'Y':
                        $opt = $this->year($fieldName, $attributes['minYear'], $attributes['maxYear'], $selected, $selectYearAttr, $showEmpty);
                  break;
                  case 'NONE':
                  default:
                        $opt = '';
                  break;
            }

            switch($timeFormat) {
                  case '24':
                        $opt .= $this->hour($fieldName, true, $hour, $selectHourAttr, $showEmpty) . ':' .
                        $this->minute($fieldName, $min, $selectMinuteAttr, $showEmpty);
                  break;
                  case '12':
                        $opt .= $this->hour($fieldName, false, $hour, $selectHourAttr, $showEmpty) . ':' .
                        $this->minute($fieldName, $min, $selectMinuteAttr, $showEmpty) . ' ' .
                        $this->meridian($fieldName, $meridian, $selectMeridianAttr, $showEmpty);
                  break;
                  case 'NONE':
                  default:
                        $opt .= '';
                  break;
            }
            return $opt;
      }
/**
 * Gets the input field name for the current tag
 *
 * @param array $options
 * @param string $key
 * @return array
 */
01313       function __name($options = array(), $field = null, $key = 'name') {
            if ($this->requestType == 'get') {
                  if ($options === null) {
                        $options = array();
                  } elseif (is_string($options)) {
                        $field = $options;
                        $options = 0;
                  }

                  if (!empty($field)) {
                        $this->setFormTag($field);
                  }

                  if (is_array($options) && isset($options[$key])) {
                        return $options;
                  }
                  $name = $this->field();

                  if (is_array($options)) {
                        $options[$key] = $name;
                        return $options;
                  } else {
                        return $name;
                  }
            }
            return parent::__name($options, $field, $key);
      }
/**
 * Returns an array of formatted OPTION/OPTGROUP elements
 *
 * @return array
 */
01345       function __selectOptions($elements = array(), $selected = null, $parents = array(), $showParents = null, $attributes = array()) {

            $select = array();
            $attributes = am(array('escape' => true), $attributes);
            $selectedIsEmpty = ($selected === '' || $selected === null);
            $selectedIsArray = is_array($selected);
            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, $attributes));
                        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 ((!$selectedIsEmpty && ($selected == $name)) || ($selectedIsArray && in_array($name, $selected))) {
                              $htmlOptions['selected'] = 'selected';
                        }
                        if ($showParents || (!in_array($title, $parents))) {
                              $title = ife($attributes['escape'], h($title), $title);
                              $select[] = sprintf($this->Html->tags['selectoption'], $name, $this->Html->_parseAttributes($htmlOptions), $title);
                        }
                  }
            }

            return array_reverse($select, true);
      }
/**
 * Generates option lists for common <select /> menus
 *
 */
01386       function __generateOptions($name, $min = null, $max = null) {
            if (!empty($this->options[$name])) {
                  return $this->options[$name];
            }
            $data = array();

            switch ($name) {
                  case 'minute':
                        for ($i = 0; $i < 60; $i++) {
                              $data[$i] = sprintf('%02d', $i);
                        }
                  break;
                  case 'hour':
                        for ($i = 1; $i <= 12; $i++) {
                              $data[sprintf('%02d', $i)] = $i;
                        }
                  break;
                  case 'hour24':
                        for ($i = 0; $i <= 23; $i++) {
                              $data[sprintf('%02d', $i)] = $i;
                        }
                  break;
                  case 'meridian':
                        $data = array('am' => 'am', 'pm' => 'pm');
                  break;
                  case 'day':
                        if (empty($min)) {
                              $min = 1;
                        }
                        if (empty($max)) {
                              $max = 31;
                        }
                        for ($i = $min; $i <= $max; $i++) {
                              $data[sprintf('%02d', $i)] = $i;
                        }
                  break;
                  case 'month':
                        for ($i = 1; $i <= 12; $i++) {
                              $data[sprintf("%02s", $i)] = strftime("%B", mktime(1,1,1,$i,1,1999));
                        }
                  break;
                  case 'year':
                        $current = intval(date('Y'));
                        if (empty($min)) {
                              $min = $current - 20;
                        }
                        if (empty($max)) {
                              $max = $current + 20;
                        }
                        if ($min > $max) {
                              list($min, $max) = array($max, $min);
                        }
                        for ($i = $min; $i <= $max; $i++) {
                              $data[$i] = $i;
                        }
                  break;
            }
            $this->__options[$name] = $data;
            return $this->__options[$name];
      }
}
?>

Generated by  Doxygen 1.6.0   Back to index