FormHelper.php 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  4. * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * Redistributions of files must retain the above copyright notice.
  8. *
  9. * @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  10. * @link http://cakephp.org CakePHP(tm) Project
  11. * @package Cake.View.Helper
  12. * @since CakePHP(tm) v 0.10.0.1076
  13. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  14. */
  15. App::uses('ClassRegistry', 'Utility');
  16. App::uses('AppHelper', 'View/Helper');
  17. App::uses('Hash', 'Utility');
  18. /**
  19. * Form helper library.
  20. *
  21. * Automatic generation of HTML FORMs from given data.
  22. *
  23. * @package Cake.View.Helper
  24. * @property HtmlHelper $Html
  25. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html
  26. */
  27. class FormHelper extends AppHelper {
  28. /**
  29. * Other helpers used by FormHelper
  30. *
  31. * @var array
  32. */
  33. public $helpers = array('Html');
  34. /**
  35. * Options used by DateTime fields
  36. *
  37. * @var array
  38. */
  39. protected $_options = array(
  40. 'day' => array(), 'minute' => array(), 'hour' => array(),
  41. 'month' => array(), 'year' => array(), 'meridian' => array()
  42. );
  43. /**
  44. * List of fields created, used with secure forms.
  45. *
  46. * @var array
  47. */
  48. public $fields = array();
  49. /**
  50. * Constant used internally to skip the securing process,
  51. * and neither add the field to the hash or to the unlocked fields.
  52. *
  53. * @var string
  54. */
  55. const SECURE_SKIP = 'skip';
  56. /**
  57. * Defines the type of form being created. Set by FormHelper::create().
  58. *
  59. * @var string
  60. */
  61. public $requestType = null;
  62. /**
  63. * The default model being used for the current form.
  64. *
  65. * @var string
  66. */
  67. public $defaultModel = null;
  68. /**
  69. * Persistent default options used by input(). Set by FormHelper::create().
  70. *
  71. * @var array
  72. */
  73. protected $_inputDefaults = array();
  74. /**
  75. * An array of field names that have been excluded from
  76. * the Token hash used by SecurityComponent's validatePost method
  77. *
  78. * @see FormHelper::_secure()
  79. * @see SecurityComponent::validatePost()
  80. * @var array
  81. */
  82. protected $_unlockedFields = array();
  83. /**
  84. * Holds the model references already loaded by this helper
  85. * product of trying to inspect them out of field names
  86. *
  87. * @var array
  88. */
  89. protected $_models = array();
  90. /**
  91. * Holds all the validation errors for models loaded and inspected
  92. * it can also be set manually to be able to display custom error messages
  93. * in the any of the input fields generated by this helper
  94. *
  95. * @var array
  96. */
  97. public $validationErrors = array();
  98. /**
  99. * Copies the validationErrors variable from the View object into this instance
  100. *
  101. * @param View $View The View this helper is being attached to.
  102. * @param array $settings Configuration settings for the helper.
  103. */
  104. public function __construct(View $View, $settings = array()) {
  105. parent::__construct($View, $settings);
  106. $this->validationErrors =& $View->validationErrors;
  107. }
  108. /**
  109. * Guess the location for a model based on its name and tries to create a new instance
  110. * or get an already created instance of the model
  111. *
  112. * @param string $model
  113. * @return Model model instance
  114. */
  115. protected function _getModel($model) {
  116. $object = null;
  117. if (!$model || $model === 'Model') {
  118. return $object;
  119. }
  120. if (array_key_exists($model, $this->_models)) {
  121. return $this->_models[$model];
  122. }
  123. if (ClassRegistry::isKeySet($model)) {
  124. $object = ClassRegistry::getObject($model);
  125. } elseif (isset($this->request->params['models'][$model])) {
  126. $plugin = $this->request->params['models'][$model]['plugin'];
  127. $plugin .= ($plugin) ? '.' : null;
  128. $object = ClassRegistry::init(array(
  129. 'class' => $plugin . $this->request->params['models'][$model]['className'],
  130. 'alias' => $model
  131. ));
  132. } elseif (ClassRegistry::isKeySet($this->defaultModel)) {
  133. $defaultObject = ClassRegistry::getObject($this->defaultModel);
  134. if (in_array($model, array_keys($defaultObject->getAssociated()), true) && isset($defaultObject->{$model})) {
  135. $object = $defaultObject->{$model};
  136. }
  137. } else {
  138. $object = ClassRegistry::init($model, true);
  139. }
  140. $this->_models[$model] = $object;
  141. if (!$object) {
  142. return null;
  143. }
  144. $this->fieldset[$model] = array('fields' => null, 'key' => $object->primaryKey, 'validates' => null);
  145. return $object;
  146. }
  147. /**
  148. * Inspects the model properties to extract information from them.
  149. * Currently it can extract information from the the fields, the primary key and required fields
  150. *
  151. * The $key parameter accepts the following list of values:
  152. *
  153. * - key: Returns the name of the primary key for the model
  154. * - fields: Returns the model schema
  155. * - validates: returns the list of fields that are required
  156. * - errors: returns the list of validation errors
  157. *
  158. * If the $field parameter is passed if will return the information for that sole field.
  159. *
  160. * `$this->_introspectModel('Post', 'fields', 'title');` will return the schema information for title column
  161. *
  162. * @param string $model name of the model to extract information from
  163. * @param string $key name of the special information key to obtain (key, fields, validates, errors)
  164. * @param string $field name of the model field to get information from
  165. * @return mixed information extracted for the special key and field in a model
  166. */
  167. protected function _introspectModel($model, $key, $field = null) {
  168. $object = $this->_getModel($model);
  169. if (!$object) {
  170. return;
  171. }
  172. if ($key === 'key') {
  173. return $this->fieldset[$model]['key'] = $object->primaryKey;
  174. }
  175. if ($key === 'fields') {
  176. if (!isset($this->fieldset[$model]['fields'])) {
  177. $this->fieldset[$model]['fields'] = $object->schema();
  178. foreach ($object->hasAndBelongsToMany as $alias => $assocData) {
  179. $this->fieldset[$object->alias]['fields'][$alias] = array('type' => 'multiple');
  180. }
  181. }
  182. if (empty($field)) {
  183. return $this->fieldset[$model]['fields'];
  184. } elseif (isset($this->fieldset[$model]['fields'][$field])) {
  185. return $this->fieldset[$model]['fields'][$field];
  186. } else {
  187. return isset($object->hasAndBelongsToMany[$field]) ? array('type' => 'multiple') : null;
  188. }
  189. }
  190. if ($key === 'errors' && !isset($this->validationErrors[$model])) {
  191. $this->validationErrors[$model] =& $object->validationErrors;
  192. return $this->validationErrors[$model];
  193. } elseif ($key === 'errors' && isset($this->validationErrors[$model])) {
  194. return $this->validationErrors[$model];
  195. }
  196. if ($key === 'validates' && !isset($this->fieldset[$model]['validates'])) {
  197. $validates = array();
  198. if (!empty($object->validate)) {
  199. foreach ($object->validator() as $validateField => $validateProperties) {
  200. if ($this->_isRequiredField($validateProperties)) {
  201. $validates[$validateField] = true;
  202. }
  203. }
  204. }
  205. $this->fieldset[$model]['validates'] = $validates;
  206. }
  207. if ($key === 'validates') {
  208. if (empty($field)) {
  209. return $this->fieldset[$model]['validates'];
  210. } else {
  211. return isset($this->fieldset[$model]['validates'][$field]) ?
  212. $this->fieldset[$model]['validates'] : null;
  213. }
  214. }
  215. }
  216. /**
  217. * Returns if a field is required to be filled based on validation properties from the validating object.
  218. *
  219. * @param CakeValidationSet $validationRules
  220. * @return boolean true if field is required to be filled, false otherwise
  221. */
  222. protected function _isRequiredField($validationRules) {
  223. if (empty($validationRules) || count($validationRules) === 0) {
  224. return false;
  225. }
  226. foreach ($validationRules as $rule) {
  227. $rule->isUpdate($this->requestType === 'put');
  228. if ($rule->isEmptyAllowed()) {
  229. return false;
  230. }
  231. }
  232. return true;
  233. }
  234. /**
  235. * Returns false if given form field described by the current entity has no errors.
  236. * Otherwise it returns the validation message
  237. *
  238. * @return mixed Either false when there are no errors, or an array of error
  239. * strings. An error string could be ''.
  240. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::tagIsInvalid
  241. */
  242. public function tagIsInvalid() {
  243. $entity = $this->entity();
  244. $model = array_shift($entity);
  245. $errors = array();
  246. if (!empty($entity) && isset($this->validationErrors[$model])) {
  247. $errors = $this->validationErrors[$model];
  248. }
  249. if (!empty($entity) && empty($errors)) {
  250. $errors = $this->_introspectModel($model, 'errors');
  251. }
  252. if (empty($errors)) {
  253. return false;
  254. }
  255. $errors = Hash::get($errors, join('.', $entity));
  256. return $errors === null ? false : $errors;
  257. }
  258. /**
  259. * Returns an HTML FORM element.
  260. *
  261. * ### Options:
  262. *
  263. * - `type` Form method defaults to POST
  264. * - `action` The controller action the form submits to, (optional).
  265. * - `url` The url the form submits to. Can be a string or a url array. If you use 'url'
  266. * you should leave 'action' undefined.
  267. * - `default` Allows for the creation of Ajax forms. Set this to false to prevent the default event handler.
  268. * Will create an onsubmit attribute if it doesn't not exist. If it does, default action suppression
  269. * will be appended.
  270. * - `onsubmit` Used in conjunction with 'default' to create ajax forms.
  271. * - `inputDefaults` set the default $options for FormHelper::input(). Any options that would
  272. * be set when using FormHelper::input() can be set here. Options set with `inputDefaults`
  273. * can be overridden when calling input()
  274. * - `encoding` Set the accept-charset encoding for the form. Defaults to `Configure::read('App.encoding')`
  275. *
  276. * @param string|array $model The model object which the form is being defined for. Should
  277. * include the plugin name for plugin forms. e.g. `ContactManager.Contact`.
  278. * If an array is passed and $options argument is empty, the array will be used as options.
  279. * @param array $options An array of html attributes and options.
  280. * @return string An formatted opening FORM tag.
  281. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-create
  282. */
  283. public function create($model = null, $options = array()) {
  284. $created = $id = false;
  285. $append = '';
  286. if (is_array($model) && empty($options)) {
  287. $options = $model;
  288. $model = null;
  289. }
  290. if (empty($model) && $model !== false && !empty($this->request->params['models'])) {
  291. $model = key($this->request->params['models']);
  292. } elseif (empty($model) && empty($this->request->params['models'])) {
  293. $model = false;
  294. }
  295. $this->defaultModel = $model;
  296. $key = null;
  297. if ($model !== false) {
  298. $key = $this->_introspectModel($model, 'key');
  299. $this->setEntity($model, true);
  300. }
  301. if ($model !== false && $key) {
  302. $recordExists = (
  303. isset($this->request->data[$model]) &&
  304. !empty($this->request->data[$model][$key]) &&
  305. !is_array($this->request->data[$model][$key])
  306. );
  307. if ($recordExists) {
  308. $created = true;
  309. $id = $this->request->data[$model][$key];
  310. }
  311. }
  312. $options = array_merge(array(
  313. 'type' => ($created && empty($options['action'])) ? 'put' : 'post',
  314. 'action' => null,
  315. 'url' => null,
  316. 'default' => true,
  317. 'encoding' => strtolower(Configure::read('App.encoding')),
  318. 'inputDefaults' => array()),
  319. $options);
  320. $this->inputDefaults($options['inputDefaults']);
  321. unset($options['inputDefaults']);
  322. if (!isset($options['id'])) {
  323. $domId = isset($options['action']) ? $options['action'] : $this->request['action'];
  324. $options['id'] = $this->domId($domId . 'Form');
  325. }
  326. if ($options['action'] === null && $options['url'] === null) {
  327. $options['action'] = $this->request->here(false);
  328. } elseif (empty($options['url']) || is_array($options['url'])) {
  329. if (empty($options['url']['controller'])) {
  330. if (!empty($model)) {
  331. $options['url']['controller'] = Inflector::underscore(Inflector::pluralize($model));
  332. } elseif (!empty($this->request->params['controller'])) {
  333. $options['url']['controller'] = Inflector::underscore($this->request->params['controller']);
  334. }
  335. }
  336. if (empty($options['action'])) {
  337. $options['action'] = $this->request->params['action'];
  338. }
  339. $plugin = null;
  340. if ($this->plugin) {
  341. $plugin = Inflector::underscore($this->plugin);
  342. }
  343. $actionDefaults = array(
  344. 'plugin' => $plugin,
  345. 'controller' => $this->_View->viewPath,
  346. 'action' => $options['action'],
  347. );
  348. $options['action'] = array_merge($actionDefaults, (array)$options['url']);
  349. if (empty($options['action'][0]) && !empty($id)) {
  350. $options['action'][0] = $id;
  351. }
  352. } elseif (is_string($options['url'])) {
  353. $options['action'] = $options['url'];
  354. }
  355. unset($options['url']);
  356. switch (strtolower($options['type'])) {
  357. case 'get':
  358. $htmlAttributes['method'] = 'get';
  359. break;
  360. case 'file':
  361. $htmlAttributes['enctype'] = 'multipart/form-data';
  362. $options['type'] = ($created) ? 'put' : 'post';
  363. case 'post':
  364. case 'put':
  365. case 'delete':
  366. $append .= $this->hidden('_method', array(
  367. 'name' => '_method', 'value' => strtoupper($options['type']), 'id' => null,
  368. 'secure' => self::SECURE_SKIP
  369. ));
  370. default:
  371. $htmlAttributes['method'] = 'post';
  372. break;
  373. }
  374. $this->requestType = strtolower($options['type']);
  375. $action = $this->url($options['action']);
  376. unset($options['type'], $options['action']);
  377. if ($options['default'] == false) {
  378. if (!isset($options['onsubmit'])) {
  379. $options['onsubmit'] = '';
  380. }
  381. $htmlAttributes['onsubmit'] = $options['onsubmit'] . 'event.returnValue = false; return false;';
  382. }
  383. unset($options['default']);
  384. if (!empty($options['encoding'])) {
  385. $htmlAttributes['accept-charset'] = $options['encoding'];
  386. unset($options['encoding']);
  387. }
  388. $htmlAttributes = array_merge($options, $htmlAttributes);
  389. $this->fields = array();
  390. $append .= $this->_csrfField();
  391. if (!empty($append)) {
  392. $append = $this->Html->useTag('block', ' style="display:none;"', $append);
  393. }
  394. if ($model !== false) {
  395. $this->setEntity($model, true);
  396. $this->_introspectModel($model, 'fields');
  397. }
  398. return $this->Html->useTag('form', $action, $htmlAttributes) . $append;
  399. }
  400. /**
  401. * Return a CSRF input if the _Token is present.
  402. * Used to secure forms in conjunction with SecurityComponent
  403. *
  404. * @return string
  405. */
  406. protected function _csrfField() {
  407. if (empty($this->request->params['_Token'])) {
  408. return '';
  409. }
  410. if (!empty($this->request['_Token']['unlockedFields'])) {
  411. foreach ((array)$this->request['_Token']['unlockedFields'] as $unlocked) {
  412. $this->_unlockedFields[] = $unlocked;
  413. }
  414. }
  415. return $this->hidden('_Token.key', array(
  416. 'value' => $this->request->params['_Token']['key'], 'id' => 'Token' . mt_rand(),
  417. 'secure' => self::SECURE_SKIP
  418. ));
  419. }
  420. /**
  421. * Closes an HTML form, cleans up values set by FormHelper::create(), and writes hidden
  422. * input fields where appropriate.
  423. *
  424. * If $options is set a form submit button will be created. Options can be either a string or an array.
  425. *
  426. * {{{
  427. * array usage:
  428. *
  429. * array('label' => 'save'); value="save"
  430. * array('label' => 'save', 'name' => 'Whatever'); value="save" name="Whatever"
  431. * array('name' => 'Whatever'); value="Submit" name="Whatever"
  432. * array('label' => 'save', 'name' => 'Whatever', 'div' => 'good') <div class="good"> value="save" name="Whatever"
  433. * array('label' => 'save', 'name' => 'Whatever', 'div' => array('class' => 'good')); <div class="good"> value="save" name="Whatever"
  434. * }}}
  435. *
  436. * @param string|array $options as a string will use $options as the value of button,
  437. * @return string a closing FORM tag optional submit button.
  438. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#closing-the-form
  439. */
  440. public function end($options = null) {
  441. $out = null;
  442. $submit = null;
  443. if ($options !== null) {
  444. $submitOptions = array();
  445. if (is_string($options)) {
  446. $submit = $options;
  447. } else {
  448. if (isset($options['label'])) {
  449. $submit = $options['label'];
  450. unset($options['label']);
  451. }
  452. $submitOptions = $options;
  453. }
  454. $out .= $this->submit($submit, $submitOptions);
  455. }
  456. if (isset($this->request['_Token']) && !empty($this->request['_Token'])) {
  457. $out .= $this->secure($this->fields);
  458. $this->fields = array();
  459. }
  460. $this->setEntity(null);
  461. $out .= $this->Html->useTag('formend');
  462. $this->_View->modelScope = false;
  463. return $out;
  464. }
  465. /**
  466. * Generates a hidden field with a security hash based on the fields used in the form.
  467. *
  468. * @param array $fields The list of fields to use when generating the hash
  469. * @return string A hidden input field with a security hash
  470. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::secure
  471. */
  472. public function secure($fields = array()) {
  473. if (!isset($this->request['_Token']) || empty($this->request['_Token'])) {
  474. return;
  475. }
  476. $locked = array();
  477. $unlockedFields = $this->_unlockedFields;
  478. foreach ($fields as $key => $value) {
  479. if (!is_int($key)) {
  480. $locked[$key] = $value;
  481. unset($fields[$key]);
  482. }
  483. }
  484. sort($unlockedFields, SORT_STRING);
  485. sort($fields, SORT_STRING);
  486. ksort($locked, SORT_STRING);
  487. $fields += $locked;
  488. $locked = implode(array_keys($locked), '|');
  489. $unlocked = implode($unlockedFields, '|');
  490. $fields = Security::hash(serialize($fields) . $unlocked . Configure::read('Security.salt'));
  491. $out = $this->hidden('_Token.fields', array(
  492. 'value' => urlencode($fields . ':' . $locked),
  493. 'id' => 'TokenFields' . mt_rand()
  494. ));
  495. $out .= $this->hidden('_Token.unlocked', array(
  496. 'value' => urlencode($unlocked),
  497. 'id' => 'TokenUnlocked' . mt_rand()
  498. ));
  499. return $this->Html->useTag('block', ' style="display:none;"', $out);
  500. }
  501. /**
  502. * Add to or get the list of fields that are currently unlocked.
  503. * Unlocked fields are not included in the field hash used by SecurityComponent
  504. * unlocking a field once its been added to the list of secured fields will remove
  505. * it from the list of fields.
  506. *
  507. * @param string $name The dot separated name for the field.
  508. * @return mixed Either null, or the list of fields.
  509. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::unlockField
  510. */
  511. public function unlockField($name = null) {
  512. if ($name === null) {
  513. return $this->_unlockedFields;
  514. }
  515. if (!in_array($name, $this->_unlockedFields)) {
  516. $this->_unlockedFields[] = $name;
  517. }
  518. $index = array_search($name, $this->fields);
  519. if ($index !== false) {
  520. unset($this->fields[$index]);
  521. }
  522. unset($this->fields[$name]);
  523. }
  524. /**
  525. * Determine which fields of a form should be used for hash.
  526. * Populates $this->fields
  527. *
  528. * @param boolean $lock Whether this field should be part of the validation
  529. * or excluded as part of the unlockedFields.
  530. * @param string|array $field Reference to field to be secured. Should be dot separated to indicate nesting.
  531. * @param mixed $value Field value, if value should not be tampered with.
  532. * @return void
  533. */
  534. protected function _secure($lock, $field = null, $value = null) {
  535. if (!$field) {
  536. $field = $this->entity();
  537. } elseif (is_string($field)) {
  538. $field = Hash::filter(explode('.', $field));
  539. }
  540. foreach ($this->_unlockedFields as $unlockField) {
  541. $unlockParts = explode('.', $unlockField);
  542. if (array_values(array_intersect($field, $unlockParts)) === $unlockParts) {
  543. return;
  544. }
  545. }
  546. $field = implode('.', $field);
  547. $field = preg_replace('/(\.\d+)+$/', '', $field);
  548. if ($lock) {
  549. if (!in_array($field, $this->fields)) {
  550. if ($value !== null) {
  551. return $this->fields[$field] = $value;
  552. }
  553. $this->fields[] = $field;
  554. }
  555. } else {
  556. $this->unlockField($field);
  557. }
  558. }
  559. /**
  560. * Returns true if there is an error for the given field, otherwise false
  561. *
  562. * @param string $field This should be "Modelname.fieldname"
  563. * @return boolean If there are errors this method returns true, else false.
  564. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::isFieldError
  565. */
  566. public function isFieldError($field) {
  567. $this->setEntity($field);
  568. return (bool)$this->tagIsInvalid();
  569. }
  570. /**
  571. * Returns a formatted error message for given FORM field, NULL if no errors.
  572. *
  573. * ### Options:
  574. *
  575. * - `escape` bool Whether or not to html escape the contents of the error.
  576. * - `wrap` mixed Whether or not the error message should be wrapped in a div. If a
  577. * string, will be used as the HTML tag to use.
  578. * - `class` string The classname for the error message
  579. *
  580. * @param string $field A field name, like "Modelname.fieldname"
  581. * @param string|array $text Error message as string or array of messages.
  582. * If array contains `attributes` key it will be used as options for error container
  583. * @param array $options Rendering options for <div /> wrapper tag
  584. * @return string If there are errors this method returns an error message, otherwise null.
  585. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::error
  586. */
  587. public function error($field, $text = null, $options = array()) {
  588. $defaults = array('wrap' => true, 'class' => 'error-message', 'escape' => true);
  589. $options = array_merge($defaults, $options);
  590. $this->setEntity($field);
  591. $error = $this->tagIsInvalid();
  592. if ($error === false) {
  593. return null;
  594. }
  595. if (is_array($text)) {
  596. if (isset($text['attributes']) && is_array($text['attributes'])) {
  597. $options = array_merge($options, $text['attributes']);
  598. unset($text['attributes']);
  599. }
  600. $tmp = array();
  601. foreach ($error as &$e) {
  602. if (isset($text[$e])) {
  603. $tmp[] = $text[$e];
  604. } else {
  605. $tmp[] = $e;
  606. }
  607. }
  608. $text = $tmp;
  609. }
  610. if ($text !== null) {
  611. $error = $text;
  612. }
  613. if (is_array($error)) {
  614. foreach ($error as &$e) {
  615. if (is_numeric($e)) {
  616. $e = __d('cake', 'Error in field %s', Inflector::humanize($this->field()));
  617. }
  618. }
  619. }
  620. if ($options['escape']) {
  621. $error = h($error);
  622. unset($options['escape']);
  623. }
  624. if (is_array($error)) {
  625. if (count($error) > 1) {
  626. $listParams = array();
  627. if (isset($options['listOptions'])) {
  628. if (is_string($options['listOptions'])) {
  629. $listParams[] = $options['listOptions'];
  630. } else {
  631. if (isset($options['listOptions']['itemOptions'])) {
  632. $listParams[] = $options['listOptions']['itemOptions'];
  633. unset($options['listOptions']['itemOptions']);
  634. } else {
  635. $listParams[] = array();
  636. }
  637. if (isset($options['listOptions']['tag'])) {
  638. $listParams[] = $options['listOptions']['tag'];
  639. unset($options['listOptions']['tag']);
  640. }
  641. array_unshift($listParams, $options['listOptions']);
  642. }
  643. unset($options['listOptions']);
  644. }
  645. array_unshift($listParams, $error);
  646. $error = call_user_func_array(array($this->Html, 'nestedList'), $listParams);
  647. } else {
  648. $error = array_pop($error);
  649. }
  650. }
  651. if ($options['wrap']) {
  652. $tag = is_string($options['wrap']) ? $options['wrap'] : 'div';
  653. unset($options['wrap']);
  654. return $this->Html->tag($tag, $error, $options);
  655. } else {
  656. return $error;
  657. }
  658. }
  659. /**
  660. * Returns a formatted LABEL element for HTML FORMs. Will automatically generate
  661. * a `for` attribute if one is not provided.
  662. *
  663. * ### Options
  664. *
  665. * - `for` - Set the for attribute, if its not defined the for attribute
  666. * will be generated from the $fieldName parameter using
  667. * FormHelper::domId().
  668. *
  669. * Examples:
  670. *
  671. * The text and for attribute are generated off of the fieldname
  672. *
  673. * {{{
  674. * echo $this->Form->label('Post.published');
  675. * <label for="PostPublished">Published</label>
  676. * }}}
  677. *
  678. * Custom text:
  679. *
  680. * {{{
  681. * echo $this->Form->label('Post.published', 'Publish');
  682. * <label for="PostPublished">Publish</label>
  683. * }}}
  684. *
  685. * Custom class name:
  686. *
  687. * {{{
  688. * echo $this->Form->label('Post.published', 'Publish', 'required');
  689. * <label for="PostPublished" class="required">Publish</label>
  690. * }}}
  691. *
  692. * Custom attributes:
  693. *
  694. * {{{
  695. * echo $this->Form->label('Post.published', 'Publish', array(
  696. * 'for' => 'post-publish'
  697. * ));
  698. * <label for="post-publish">Publish</label>
  699. * }}}
  700. *
  701. * @param string $fieldName This should be "Modelname.fieldname"
  702. * @param string $text Text that will appear in the label field. If
  703. * $text is left undefined the text will be inflected from the
  704. * fieldName.
  705. * @param array|string $options An array of HTML attributes, or a string, to be used as a class name.
  706. * @return string The formatted LABEL element
  707. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::label
  708. */
  709. public function label($fieldName = null, $text = null, $options = array()) {
  710. if (empty($fieldName)) {
  711. $fieldName = implode('.', $this->entity());
  712. }
  713. if ($text === null) {
  714. if (strpos($fieldName, '.') !== false) {
  715. $fieldElements = explode('.', $fieldName);
  716. $text = array_pop($fieldElements);
  717. } else {
  718. $text = $fieldName;
  719. }
  720. if (substr($text, -3) == '_id') {
  721. $text = substr($text, 0, -3);
  722. }
  723. $text = __(Inflector::humanize(Inflector::underscore($text)));
  724. }
  725. if (is_string($options)) {
  726. $options = array('class' => $options);
  727. }
  728. if (isset($options['for'])) {
  729. $labelFor = $options['for'];
  730. unset($options['for']);
  731. } else {
  732. $labelFor = $this->domId($fieldName);
  733. }
  734. return $this->Html->useTag('label', $labelFor, $options, $text);
  735. }
  736. /**
  737. * Generate a set of inputs for `$fields`. If $fields is null the current model
  738. * will be used.
  739. *
  740. * In addition to controller fields output, `$fields` can be used to control legend
  741. * and fieldset rendering with the `fieldset` and `legend` keys.
  742. * `$form->inputs(array('legend' => 'My legend'));` Would generate an input set with
  743. * a custom legend. You can customize individual inputs through `$fields` as well.
  744. *
  745. * {{{
  746. * $form->inputs(array(
  747. * 'name' => array('label' => 'custom label')
  748. * ));
  749. * }}}
  750. *
  751. * In addition to fields control, inputs() allows you to use a few additional options.
  752. *
  753. * - `fieldset` Set to false to disable the fieldset. If a string is supplied it will be used as
  754. * the classname for the fieldset element.
  755. * - `legend` Set to false to disable the legend for the generated input set. Or supply a string
  756. * to customize the legend text.
  757. *
  758. * @param array $fields An array of fields to generate inputs for, or null.
  759. * @param array $blacklist a simple array of fields to not create inputs for.
  760. * @return string Completed form inputs.
  761. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::inputs
  762. */
  763. public function inputs($fields = null, $blacklist = null) {
  764. $fieldset = $legend = true;
  765. $model = $this->model();
  766. if (is_array($fields)) {
  767. if (array_key_exists('legend', $fields)) {
  768. $legend = $fields['legend'];
  769. unset($fields['legend']);
  770. }
  771. if (isset($fields['fieldset'])) {
  772. $fieldset = $fields['fieldset'];
  773. unset($fields['fieldset']);
  774. }
  775. } elseif ($fields !== null) {
  776. $fieldset = $legend = $fields;
  777. if (!is_bool($fieldset)) {
  778. $fieldset = true;
  779. }
  780. $fields = array();
  781. }
  782. if (empty($fields)) {
  783. $fields = array_keys($this->_introspectModel($model, 'fields'));
  784. }
  785. if ($legend === true) {
  786. $actionName = __d('cake', 'New %s');
  787. $isEdit = (
  788. strpos($this->request->params['action'], 'update') !== false ||
  789. strpos($this->request->params['action'], 'edit') !== false
  790. );
  791. if ($isEdit) {
  792. $actionName = __d('cake', 'Edit %s');
  793. }
  794. $modelName = Inflector::humanize(Inflector::underscore($model));
  795. $legend = sprintf($actionName, __($modelName));
  796. }
  797. $out = null;
  798. foreach ($fields as $name => $options) {
  799. if (is_numeric($name) && !is_array($options)) {
  800. $name = $options;
  801. $options = array();
  802. }
  803. $entity = explode('.', $name);
  804. $blacklisted = (
  805. is_array($blacklist) &&
  806. (in_array($name, $blacklist) || in_array(end($entity), $blacklist))
  807. );
  808. if ($blacklisted) {
  809. continue;
  810. }
  811. $out .= $this->input($name, $options);
  812. }
  813. if (is_string($fieldset)) {
  814. $fieldsetClass = sprintf(' class="%s"', $fieldset);
  815. } else {
  816. $fieldsetClass = '';
  817. }
  818. if ($fieldset && $legend) {
  819. return $this->Html->useTag('fieldset', $fieldsetClass, $this->Html->useTag('legend', $legend) . $out);
  820. } elseif ($fieldset) {
  821. return $this->Html->useTag('fieldset', $fieldsetClass, $out);
  822. } else {
  823. return $out;
  824. }
  825. }
  826. /**
  827. * Generates a form input element complete with label and wrapper div
  828. *
  829. * ### Options
  830. *
  831. * See each field type method for more information. Any options that are part of
  832. * $attributes or $options for the different **type** methods can be included in `$options` for input().i
  833. * Additionally, any unknown keys that are not in the list below, or part of the selected type's options
  834. * will be treated as a regular html attribute for the generated input.
  835. *
  836. * - `type` - Force the type of widget you want. e.g. `type => 'select'`
  837. * - `label` - Either a string label, or an array of options for the label. See FormHelper::label()
  838. * - `div` - Either `false` to disable the div, or an array of options for the div.
  839. * See HtmlHelper::div() for more options.
  840. * - `options` - for widgets that take options e.g. radio, select
  841. * - `error` - control the error message that is produced
  842. * - `empty` - String or boolean to enable empty select box options.
  843. * - `before` - Content to place before the label + input.
  844. * - `after` - Content to place after the label + input.
  845. * - `between` - Content to place between the label + input.
  846. * - `format` - format template for element order. Any element that is not in the array, will not be in the output.
  847. * - Default input format order: array('before', 'label', 'between', 'input', 'after', 'error')
  848. * - Default checkbox format order: array('before', 'input', 'between', 'label', 'after', 'error')
  849. * - Hidden input will not be formatted
  850. * - Radio buttons cannot have the order of input and label elements controlled with these settings.
  851. *
  852. * @param string $fieldName This should be "Modelname.fieldname"
  853. * @param array $options Each type of input takes different options.
  854. * @return string Completed form widget.
  855. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#creating-form-elements
  856. */
  857. public function input($fieldName, $options = array()) {
  858. $this->setEntity($fieldName);
  859. $options = array_merge(
  860. array('before' => null, 'between' => null, 'after' => null, 'format' => null),
  861. $this->_inputDefaults,
  862. $options
  863. );
  864. $modelKey = $this->model();
  865. $fieldKey = $this->field();
  866. if (!isset($options['type'])) {
  867. $magicType = true;
  868. $options['type'] = 'text';
  869. if (isset($options['options'])) {
  870. $options['type'] = 'select';
  871. } elseif (in_array($fieldKey, array('psword', 'passwd', 'password'))) {
  872. $options['type'] = 'password';
  873. } elseif (isset($options['checked'])) {
  874. $options['type'] = 'checkbox';
  875. } elseif ($fieldDef = $this->_introspectModel($modelKey, 'fields', $fieldKey)) {
  876. $type = $fieldDef['type'];
  877. $primaryKey = $this->fieldset[$modelKey]['key'];
  878. }
  879. if (isset($type)) {
  880. $map = array(
  881. 'string' => 'text', 'datetime' => 'datetime',
  882. 'boolean' => 'checkbox', 'timestamp' => 'datetime',
  883. 'text' => 'textarea', 'time' => 'time',
  884. 'date' => 'date', 'float' => 'number',
  885. 'integer' => 'number'
  886. );
  887. if (isset($this->map[$type])) {
  888. $options['type'] = $this->map[$type];
  889. } elseif (isset($map[$type])) {
  890. $options['type'] = $map[$type];
  891. }
  892. if ($fieldKey == $primaryKey) {
  893. $options['type'] = 'hidden';
  894. }
  895. if (
  896. $options['type'] === 'number' &&
  897. $type === 'float' &&
  898. !isset($options['step'])
  899. ) {
  900. $options['step'] = 'any';
  901. }
  902. }
  903. if (preg_match('/_id$/', $fieldKey) && $options['type'] !== 'hidden') {
  904. $options['type'] = 'select';
  905. }
  906. if ($modelKey === $fieldKey) {
  907. $options['type'] = 'select';
  908. if (!isset($options['multiple'])) {
  909. $options['multiple'] = 'multiple';
  910. }
  911. }
  912. }
  913. $types = array('checkbox', 'radio', 'select');
  914. if (
  915. (!isset($options['options']) && in_array($options['type'], $types)) ||
  916. (isset($magicType) && in_array($options['type'], array('text', 'number')))
  917. ) {
  918. $varName = Inflector::variable(
  919. Inflector::pluralize(preg_replace('/_id$/', '', $fieldKey))
  920. );
  921. $varOptions = $this->_View->getVar($varName);
  922. if (is_array($varOptions)) {
  923. if ($options['type'] !== 'radio') {
  924. $options['type'] = 'select';
  925. }
  926. $options['options'] = $varOptions;
  927. }
  928. if ($options['type'] === 'select' && array_key_exists('step', $options)) {
  929. unset($options['step']);
  930. }
  931. }
  932. $autoLength = (
  933. !array_key_exists('maxlength', $options) &&
  934. isset($fieldDef['length']) &&
  935. is_scalar($fieldDef['length']) &&
  936. $options['type'] !== 'select'
  937. );
  938. if ($autoLength && $options['type'] == 'text') {
  939. $options['maxlength'] = $fieldDef['length'];
  940. }
  941. if ($autoLength && $fieldDef['type'] == 'float') {
  942. $options['maxlength'] = array_sum(explode(',', $fieldDef['length'])) + 1;
  943. }
  944. $divOptions = array();
  945. $div = $this->_extractOption('div', $options, true);
  946. unset($options['div']);
  947. if (!empty($div)) {
  948. $divOptions['class'] = 'input';
  949. $divOptions = $this->addClass($divOptions, $options['type']);
  950. if (is_string($div)) {
  951. $divOptions['class'] = $div;
  952. } elseif (is_array($div)) {
  953. $divOptions = array_merge($divOptions, $div);
  954. }
  955. if ($this->_introspectModel($modelKey, 'validates', $fieldKey)) {
  956. $divOptions = $this->addClass($divOptions, 'required');
  957. }
  958. if (!isset($divOptions['tag'])) {
  959. $divOptions['tag'] = 'div';
  960. }
  961. }
  962. $label = null;
  963. if (isset($options['label']) && $options['type'] !== 'radio') {
  964. $label = $options['label'];
  965. unset($options['label']);
  966. }
  967. if ($options['type'] === 'radio') {
  968. $label = false;
  969. if (isset($options['options'])) {
  970. $radioOptions = (array)$options['options'];
  971. unset($options['options']);
  972. }
  973. }
  974. if ($label !== false) {
  975. $label = $this->_inputLabel($fieldName, $label, $options);
  976. }
  977. $error = $this->_extractOption('error', $options, null);
  978. unset($options['error']);
  979. $selected = $this->_extractOption('selected', $options, null);
  980. unset($options['selected']);
  981. if (isset($options['rows']) || isset($options['cols'])) {
  982. $options['type'] = 'textarea';
  983. }
  984. if ($options['type'] === 'datetime' || $options['type'] === 'date' || $options['type'] === 'time' || $options['type'] === 'select') {
  985. $options += array('empty' => false);
  986. }
  987. if ($options['type'] === 'datetime' || $options['type'] === 'date' || $options['type'] === 'time') {
  988. $dateFormat = $this->_extractOption('dateFormat', $options, 'MDY');
  989. $timeFormat = $this->_extractOption('timeFormat', $options, 12);
  990. unset($options['dateFormat'], $options['timeFormat']);
  991. }
  992. $type = $options['type'];
  993. $out = array_merge(
  994. array('before' => null, 'label' => null, 'between' => null, 'input' => null, 'after' => null, 'error' => null),
  995. array('before' => $options['before'], 'label' => $label, 'between' => $options['between'], 'after' => $options['after'])
  996. );
  997. $format = null;
  998. if (is_array($options['format']) && in_array('input', $options['format'])) {
  999. $format = $options['format'];
  1000. }
  1001. unset($options['type'], $options['before'], $options['between'], $options['after'], $options['format']);
  1002. switch ($type) {
  1003. case 'hidden':
  1004. $input = $this->hidden($fieldName, $options);
  1005. $format = array('input');
  1006. unset($divOptions);
  1007. break;
  1008. case 'checkbox':
  1009. $input = $this->checkbox($fieldName, $options);
  1010. $format = $format ? $format : array('before', 'input', 'between', 'label', 'after', 'error');
  1011. break;
  1012. case 'radio':
  1013. if (isset($out['between'])) {
  1014. $options['between'] = $out['between'];
  1015. $out['between'] = null;
  1016. }
  1017. $input = $this->radio($fieldName, $radioOptions, $options);
  1018. break;
  1019. case 'file':
  1020. $input = $this->file($fieldName, $options);
  1021. break;
  1022. case 'select':
  1023. $options += array('options' => array(), 'value' => $selected);
  1024. $list = $options['options'];
  1025. unset($options['options']);
  1026. $input = $this->select($fieldName, $list, $options);
  1027. break;
  1028. case 'time':
  1029. $options['value'] = $selected;
  1030. $input = $this->dateTime($fieldName, null, $timeFormat, $options);
  1031. break;
  1032. case 'date':
  1033. $options['value'] = $selected;
  1034. $input = $this->dateTime($fieldName, $dateFormat, null, $options);
  1035. break;
  1036. case 'datetime':
  1037. $options['value'] = $selected;
  1038. $input = $this->dateTime($fieldName, $dateFormat, $timeFormat, $options);
  1039. break;
  1040. case 'textarea':
  1041. $input = $this->textarea($fieldName, $options + array('cols' => '30', 'rows' => '6'));
  1042. break;
  1043. case 'url':
  1044. $input = $this->text($fieldName, array('type' => 'url') + $options);
  1045. break;
  1046. default:
  1047. $input = $this->{$type}($fieldName, $options);
  1048. }
  1049. if ($type != 'hidden' && $error !== false) {
  1050. $errMsg = $this->error($fieldName, $error);
  1051. if ($errMsg) {
  1052. $divOptions = $this->addClass($divOptions, 'error');
  1053. $out['error'] = $errMsg;
  1054. }
  1055. }
  1056. $out['input'] = $input;
  1057. $format = $format ? $format : array('before', 'label', 'between', 'input', 'after', 'error');
  1058. $output = '';
  1059. foreach ($format as $element) {
  1060. $output .= $out[$element];
  1061. unset($out[$element]);
  1062. }
  1063. if (!empty($divOptions['tag'])) {
  1064. $tag = $divOptions['tag'];
  1065. unset($divOptions['tag']);
  1066. $output = $this->Html->tag($tag, $output, $divOptions);
  1067. }
  1068. return $output;
  1069. }
  1070. /**
  1071. * Extracts a single option from an options array.
  1072. *
  1073. * @param string $name The name of the option to pull out.
  1074. * @param array $options The array of options you want to extract.
  1075. * @param mixed $default The default option value
  1076. * @return mixed the contents of the option or default
  1077. */
  1078. protected function _extractOption($name, $options, $default = null) {
  1079. if (array_key_exists($name, $options)) {
  1080. return $options[$name];
  1081. }
  1082. return $default;
  1083. }
  1084. /**
  1085. * Generate a label for an input() call.
  1086. *
  1087. * $options can contain a hash of id overrides. These overrides will be
  1088. * used instead of the generated values if present.
  1089. *
  1090. * @param string $fieldName
  1091. * @param string $label
  1092. * @param array $options Options for the label element.
  1093. * @return string Generated label element
  1094. * @deprecated 'NONE' option is deprecated and will be removed in 3.0
  1095. */
  1096. protected function _inputLabel($fieldName, $label, $options) {
  1097. $labelAttributes = $this->domId(array(), 'for');
  1098. $idKey = null;
  1099. if ($options['type'] === 'date' || $options['type'] === 'datetime') {
  1100. $firstInput = 'M';
  1101. if (
  1102. array_key_exists('dateFormat', $options) &&
  1103. ($options['dateFormat'] === null || $options['dateFormat'] === 'NONE')
  1104. ) {
  1105. $firstInput = 'H';
  1106. } elseif (!empty($options['dateFormat'])) {
  1107. $firstInput = substr($options['dateFormat'], 0, 1);
  1108. }
  1109. switch ($firstInput) {
  1110. case 'D':
  1111. $idKey = 'day';
  1112. $labelAttributes['for'] .= 'Day';
  1113. break;
  1114. case 'Y':
  1115. $idKey = 'year';
  1116. $labelAttributes['for'] .= 'Year';
  1117. break;
  1118. case 'M':
  1119. $idKey = 'month';
  1120. $labelAttributes['for'] .= 'Month';
  1121. break;
  1122. case 'H':
  1123. $idKey = 'hour';
  1124. $labelAttributes['for'] .= 'Hour';
  1125. }
  1126. }
  1127. if ($options['type'] === 'time') {
  1128. $labelAttributes['for'] .= 'Hour';
  1129. $idKey = 'hour';
  1130. }
  1131. if (isset($idKey) && isset($options['id']) && isset($options['id'][$idKey])) {
  1132. $labelAttributes['for'] = $options['id'][$idKey];
  1133. }
  1134. if (is_array($label)) {
  1135. $labelText = null;
  1136. if (isset($label['text'])) {
  1137. $labelText = $label['text'];
  1138. unset($label['text']);
  1139. }
  1140. $labelAttributes = array_merge($labelAttributes, $label);
  1141. } else {
  1142. $labelText = $label;
  1143. }
  1144. if (isset($options['id']) && is_string($options['id'])) {
  1145. $labelAttributes = array_merge($labelAttributes, array('for' => $options['id']));
  1146. }
  1147. return $this->label($fieldName, $labelText, $labelAttributes);
  1148. }
  1149. /**
  1150. * Creates a checkbox input widget.
  1151. *
  1152. * ### Options:
  1153. *
  1154. * - `value` - the value of the checkbox
  1155. * - `checked` - boolean indicate that this checkbox is checked.
  1156. * - `hiddenField` - boolean to indicate if you want the results of checkbox() to include
  1157. * a hidden input with a value of ''.
  1158. * - `disabled` - create a disabled input.
  1159. * - `default` - Set the default value for the checkbox. This allows you to start checkboxes
  1160. * as checked, without having to check the POST data. A matching POST data value, will overwrite
  1161. * the default value.
  1162. *
  1163. * @param string $fieldName Name of a field, like this "Modelname.fieldname"
  1164. * @param array $options Array of HTML attributes.
  1165. * @return string An HTML text input element.
  1166. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
  1167. */
  1168. public function checkbox($fieldName, $options = array()) {
  1169. $valueOptions = array();
  1170. if (isset($options['default'])) {
  1171. $valueOptions['default'] = $options['default'];
  1172. unset($options['default']);
  1173. }
  1174. $options = $this->_initInputField($fieldName, $options) + array('hiddenField' => true);
  1175. $value = current($this->value($valueOptions));
  1176. $output = "";
  1177. if (empty($options['value'])) {
  1178. $options['value'] = 1;
  1179. }
  1180. if (
  1181. (!isset($options['checked']) && !empty($value) && $value == $options['value']) ||
  1182. !empty($options['checked'])
  1183. ) {
  1184. $options['checked'] = 'checked';
  1185. }
  1186. if ($options['hiddenField']) {
  1187. $hiddenOptions = array(
  1188. 'id' => $options['id'] . '_',
  1189. 'name' => $options['name'],
  1190. 'value' => ($options['hiddenField'] !== true ? $options['hiddenField'] : '0'),
  1191. 'secure' => false
  1192. );
  1193. if (isset($options['disabled']) && $options['disabled'] == true) {
  1194. $hiddenOptions['disabled'] = 'disabled';
  1195. }
  1196. $output = $this->hidden($fieldName, $hiddenOptions);
  1197. }
  1198. unset($options['hiddenField']);
  1199. return $output . $this->Html->useTag('checkbox', $options['name'], array_diff_key($options, array('name' => '')));
  1200. }
  1201. /**
  1202. * Creates a set of radio widgets. Will create a legend and fieldset
  1203. * by default. Use $options to control this
  1204. *
  1205. * ### Attributes:
  1206. *
  1207. * - `separator` - define the string in between the radio buttons
  1208. * - `between` - the string between legend and input set
  1209. * - `legend` - control whether or not the widget set has a fieldset & legend
  1210. * - `value` - indicate a value that is should be checked
  1211. * - `label` - boolean to indicate whether or not labels for widgets show be displayed
  1212. * - `hiddenField` - boolean to indicate if you want the results of radio() to include
  1213. * a hidden input with a value of ''. This is useful for creating radio sets that non-continuous
  1214. * - `disabled` - Set to `true` or `disabled` to disable all the radio buttons.
  1215. * - `empty` - Set to `true` to create a input with the value '' as the first option. When `true`
  1216. * the radio label will be 'empty'. Set this option to a string to control the label value.
  1217. *
  1218. * @param string $fieldName Name of a field, like this "Modelname.fieldname"
  1219. * @param array $options Radio button options array.
  1220. * @param array $attributes Array of HTML attributes, and special attributes above.
  1221. * @return string Completed radio widget set.
  1222. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
  1223. */
  1224. public function radio($fieldName, $options = array(), $attributes = array()) {
  1225. $attributes = $this->_initInputField($fieldName, $attributes);
  1226. $showEmpty = $this->_extractOption('empty', $attributes);
  1227. if ($showEmpty) {
  1228. $showEmpty = ($showEmpty === true) ? __('empty') : $showEmpty;
  1229. $options = array('' => $showEmpty) + $options;
  1230. }
  1231. unset($attributes['empty']);
  1232. $legend = false;
  1233. if (isset($attributes['legend'])) {
  1234. $legend = $attributes['legend'];
  1235. unset($attributes['legend']);
  1236. } elseif (count($options) > 1) {
  1237. $legend = __(Inflector::humanize($this->field()));
  1238. }
  1239. $label = true;
  1240. if (isset($attributes['label'])) {
  1241. $label = $attributes['label'];
  1242. unset($attributes['label']);
  1243. }
  1244. $separator = null;
  1245. if (isset($attributes['separator'])) {
  1246. $separator = $attributes['separator'];
  1247. unset($attributes['separator']);
  1248. }
  1249. $between = null;
  1250. if (isset($attributes['between'])) {
  1251. $between = $attributes['between'];
  1252. unset($attributes['between']);
  1253. }
  1254. $value = null;
  1255. if (isset($attributes['value'])) {
  1256. $value = $attributes['value'];
  1257. } else {
  1258. $value = $this->value($fieldName);
  1259. }
  1260. $disabled = array();
  1261. if (isset($attributes['disabled'])) {
  1262. $disabled = $attributes['disabled'];
  1263. }
  1264. $out = array();
  1265. $hiddenField = isset($attributes['hiddenField']) ? $attributes['hiddenField'] : true;
  1266. unset($attributes['hiddenField']);
  1267. foreach ($options as $optValue => $optTitle) {
  1268. $optionsHere = array('value' => $optValue);
  1269. if (isset($value) && strval($optValue) === strval($value)) {
  1270. $optionsHere['checked'] = 'checked';
  1271. }
  1272. if ($disabled && (!is_array($disabled) || in_array($optValue, $disabled))) {
  1273. $optionsHere['disabled'] = true;
  1274. }
  1275. $tagName = Inflector::camelize(
  1276. $attributes['id'] . '_' . Inflector::slug($optValue)
  1277. );
  1278. if ($label) {
  1279. $optTitle = $this->Html->useTag('label', $tagName, '', $optTitle);
  1280. }
  1281. $allOptions = array_merge($attributes, $optionsHere);
  1282. $out[] = $this->Html->useTag('radio', $attributes['name'], $tagName,
  1283. array_diff_key($allOptions, array('name' => '', 'type' => '', 'id' => '')),
  1284. $optTitle
  1285. );
  1286. }
  1287. $hidden = null;
  1288. if ($hiddenField) {
  1289. if (!isset($value) || $value === '') {
  1290. $hidden = $this->hidden($fieldName, array(
  1291. 'id' => $attributes['id'] . '_', 'value' => '', 'name' => $attributes['name']
  1292. ));
  1293. }
  1294. }
  1295. $out = $hidden . implode($separator, $out);
  1296. if ($legend) {
  1297. $out = $this->Html->useTag('fieldset', '', $this->Html->useTag('legend', $legend) . $between . $out);
  1298. }
  1299. return $out;
  1300. }
  1301. /**
  1302. * Missing method handler - implements various simple input types. Is used to create inputs
  1303. * of various types. e.g. `$this->Form->text();` will create `<input type="text" />` while
  1304. * `$this->Form->range();` will create `<input type="range" />`
  1305. *
  1306. * ### Usage
  1307. *
  1308. * `$this->Form->search('User.query', array('value' => 'test'));`
  1309. *
  1310. * Will make an input like:
  1311. *
  1312. * `<input type="search" id="UserQuery" name="data[User][query]" value="test" />`
  1313. *
  1314. * The first argument to an input type should always be the fieldname, in `Model.field` format.
  1315. * The second argument should always be an array of attributes for the input.
  1316. *
  1317. * @param string $method Method name / input type to make.
  1318. * @param array $params Parameters for the method call
  1319. * @return string Formatted input method.
  1320. * @throws CakeException When there are no params for the method call.
  1321. */
  1322. public function __call($method, $params) {
  1323. $options = array();
  1324. if (empty($params)) {
  1325. throw new CakeException(__d('cake_dev', 'Missing field name for FormHelper::%s', $method));
  1326. }
  1327. if (isset($params[1])) {
  1328. $options = $params[1];
  1329. }
  1330. if (!isset($options['type'])) {
  1331. $options['type'] = $method;
  1332. }
  1333. $options = $this->_initInputField($params[0], $options);
  1334. return $this->Html->useTag('input', $options['name'], array_diff_key($options, array('name' => '')));
  1335. }
  1336. /**
  1337. * Creates a textarea widget.
  1338. *
  1339. * ### Options:
  1340. *
  1341. * - `escape` - Whether or not the contents of the textarea should be escaped. Defaults to true.
  1342. *
  1343. * @param string $fieldName Name of a field, in the form "Modelname.fieldname"
  1344. * @param array $options Array of HTML attributes, and special options above.
  1345. * @return string A generated HTML text input element
  1346. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::textarea
  1347. */
  1348. public function textarea($fieldName, $options = array()) {
  1349. $options = $this->_initInputField($fieldName, $options);
  1350. $value = null;
  1351. if (array_key_exists('value', $options)) {
  1352. $value = $options['value'];
  1353. if (!array_key_exists('escape', $options) || $options['escape'] !== false) {
  1354. $value = h($value);
  1355. }
  1356. unset($options['value']);
  1357. }
  1358. return $this->Html->useTag('textarea', $options['name'], array_diff_key($options, array('type' => '', 'name' => '')), $value);
  1359. }
  1360. /**
  1361. * Creates a hidden input field.
  1362. *
  1363. * @param string $fieldName Name of a field, in the form of "Modelname.fieldname"
  1364. * @param array $options Array of HTML attributes.
  1365. * @return string A generated hidden input
  1366. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hidden
  1367. */
  1368. public function hidden($fieldName, $options = array()) {
  1369. $secure = true;
  1370. if (isset($options['secure'])) {
  1371. $secure = $options['secure'];
  1372. unset($options['secure']);
  1373. }
  1374. $options = $this->_initInputField($fieldName, array_merge(
  1375. $options, array('secure' => self::SECURE_SKIP)
  1376. ));
  1377. if ($secure && $secure !== self::SECURE_SKIP) {
  1378. $this->_secure(true, null, '' . $options['value']);
  1379. }
  1380. return $this->Html->useTag('hidden', $options['name'], array_diff_key($options, array('name' => '')));
  1381. }
  1382. /**
  1383. * Creates file input widget.
  1384. *
  1385. * @param string $fieldName Name of a field, in the form "Modelname.fieldname"
  1386. * @param array $options Array of HTML attributes.
  1387. * @return string A generated file input.
  1388. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::file
  1389. */
  1390. public function file($fieldName, $options = array()) {
  1391. $options += array('secure' => true);
  1392. $secure = $options['secure'];
  1393. $options['secure'] = self::SECURE_SKIP;
  1394. $options = $this->_initInputField($fieldName, $options);
  1395. $field = $this->entity();
  1396. foreach (array('name', 'type', 'tmp_name', 'error', 'size') as $suffix) {
  1397. $this->_secure($secure, array_merge($field, array($suffix)));
  1398. }
  1399. return $this->Html->useTag('file', $options['name'], array_diff_key($options, array('name' => '')));
  1400. }
  1401. /**
  1402. * Creates a `<button>` tag. The type attribute defaults to `type="submit"`
  1403. * You can change it to a different value by using `$options['type']`.
  1404. *
  1405. * ### Options:
  1406. *
  1407. * - `escape` - HTML entity encode the $title of the button. Defaults to false.
  1408. *
  1409. * @param string $title The button's caption. Not automatically HTML encoded
  1410. * @param array $options Array of options and HTML attributes.
  1411. * @return string A HTML button tag.
  1412. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::button
  1413. */
  1414. public function button($title, $options = array()) {
  1415. $options += array('type' => 'submit', 'escape' => false, 'secure' => false);
  1416. if ($options['escape']) {
  1417. $title = h($title);
  1418. }
  1419. if (isset($options['name'])) {
  1420. $name = str_replace(array('[', ']'), array('.', ''), $options['name']);
  1421. $this->_secure($options['secure'], $name);
  1422. }
  1423. return $this->Html->useTag('button', $options, $title);
  1424. }
  1425. /**
  1426. * Create a `<button>` tag with a surrounding `<form>` that submits via POST.
  1427. *
  1428. * This method creates a `<form>` element. So do not use this method in an already opened form.
  1429. * Instead use FormHelper::submit() or FormHelper::button() to create buttons inside opened forms.
  1430. *
  1431. * ### Options:
  1432. *
  1433. * - `data` - Array with key/value to pass in input hidden
  1434. * - Other options is the same of button method.
  1435. *
  1436. * @param string $title The button's caption. Not automatically HTML encoded
  1437. * @param string|array $url URL as string or array
  1438. * @param array $options Array of options and HTML attributes.
  1439. * @return string A HTML button tag.
  1440. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::postButton
  1441. */
  1442. public function postButton($title, $url, $options = array()) {
  1443. $out = $this->create(false, array('id' => false, 'url' => $url));
  1444. if (isset($options['data']) && is_array($options['data'])) {
  1445. foreach ($options['data'] as $key => $value) {
  1446. $out .= $this->hidden($key, array('value' => $value, 'id' => false));
  1447. }
  1448. unset($options['data']);
  1449. }
  1450. $out .= $this->button($title, $options);
  1451. $out .= $this->end();
  1452. return $out;
  1453. }
  1454. /**
  1455. * Creates an HTML link, but access the url using method POST.
  1456. * Requires javascript to be enabled in browser.
  1457. *
  1458. * This method creates a `<form>` element. So do not use this method inside an existing form.
  1459. * Instead you should add a submit button using FormHelper::submit()
  1460. *
  1461. * ### Options:
  1462. *
  1463. * - `data` - Array with key/value to pass in input hidden
  1464. * - `confirm` - Can be used instead of $confirmMessage.
  1465. * - Other options is the same of HtmlHelper::link() method.
  1466. * - The option `onclick` will be replaced.
  1467. *
  1468. * @param string $title The content to be wrapped by <a> tags.
  1469. * @param string|array $url Cake-relative URL or array of URL parameters, or external URL (starts with http://)
  1470. * @param array $options Array of HTML attributes.
  1471. * @param string $confirmMessage JavaScript confirmation message.
  1472. * @return string An `<a />` element.
  1473. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::postLink
  1474. */
  1475. public function postLink($title, $url = null, $options = array(), $confirmMessage = false) {
  1476. if (!empty($options['confirm'])) {
  1477. $confirmMessage = $options['confirm'];
  1478. unset($options['confirm']);
  1479. }
  1480. $formName = uniqid('post_');
  1481. $formUrl = $this->url($url);
  1482. $out = $this->Html->useTag('form', $formUrl, array('name' => $formName, 'id' => $formName, 'style' => 'display:none;', 'method' => 'post'));
  1483. $out .= $this->Html->useTag('hidden', '_method', ' value="POST"');
  1484. $out .= $this->_csrfField();
  1485. $fields = array();
  1486. if (isset($options['data']) && is_array($options['data'])) {
  1487. foreach ($options['data'] as $key => $value) {
  1488. $fields[$key] = $value;
  1489. $out .= $this->hidden($key, array('value' => $value, 'id' => false));
  1490. }
  1491. unset($options['data']);
  1492. }
  1493. $out .= $this->secure($fields);
  1494. $out .= $this->Html->useTag('formend');
  1495. $url = '#';
  1496. $onClick = 'document.' . $formName . '.submit();';
  1497. if ($confirmMessage) {
  1498. $confirmMessage = str_replace(array("'", '"'), array("\'", '\"'), $confirmMessage);
  1499. $options['onclick'] = "if (confirm('{$confirmMessage}')) { {$onClick} }";
  1500. } else {
  1501. $options['onclick'] = $onClick;
  1502. }
  1503. $options['onclick'] .= ' event.returnValue = false; return false;';
  1504. $out .= $this->Html->link($title, $url, $options);
  1505. return $out;
  1506. }
  1507. /**
  1508. * Creates a submit button element. This method will generate `<input />` elements that
  1509. * can be used to submit, and reset forms by using $options. image submits can be created by supplying an
  1510. * image path for $caption.
  1511. *
  1512. * ### Options
  1513. *
  1514. * - `div` - Include a wrapping div? Defaults to true. Accepts sub options similar to
  1515. * FormHelper::input().
  1516. * - `before` - Content to include before the input.
  1517. * - `after` - Content to include after the input.
  1518. * - `type` - Set to 'reset' for reset inputs. Defaults to 'submit'
  1519. * - Other attributes will be assigned to the input element.
  1520. *
  1521. * ### Options
  1522. *
  1523. * - `div` - Include a wrapping div? Defaults to true. Accepts sub options similar to
  1524. * FormHelper::input().
  1525. * - Other attributes will be assigned to the input element.
  1526. *
  1527. * @param string $caption The label appearing on the button OR if string contains :// or the
  1528. * extension .jpg, .jpe, .jpeg, .gif, .png use an image if the extension
  1529. * exists, AND the first character is /, image is relative to webroot,
  1530. * OR if the first character is not /, image is relative to webroot/img.
  1531. * @param array $options Array of options. See above.
  1532. * @return string A HTML submit button
  1533. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::submit
  1534. */
  1535. public function submit($caption = null, $options = array()) {
  1536. if (!is_string($caption) && empty($caption)) {
  1537. $caption = __d('cake', 'Submit');
  1538. }
  1539. $out = null;
  1540. $div = true;
  1541. if (isset($options['div'])) {
  1542. $div = $options['div'];
  1543. unset($options['div']);
  1544. }
  1545. $options += array('type' => 'submit', 'before' => null, 'after' => null, 'secure' => false);
  1546. $divOptions = array('tag' => 'div');
  1547. if ($div === true) {
  1548. $divOptions['class'] = 'submit';
  1549. } elseif ($div === false) {
  1550. unset($divOptions);
  1551. } elseif (is_string($div)) {
  1552. $divOptions['class'] = $div;
  1553. } elseif (is_array($div)) {
  1554. $divOptions = array_merge(array('class' => 'submit', 'tag' => 'div'), $div);
  1555. }
  1556. if (isset($options['name'])) {
  1557. $name = str_replace(array('[', ']'), array('.', ''), $options['name']);
  1558. $this->_secure($options['secure'], $name);
  1559. }
  1560. unset($options['secure']);
  1561. $before = $options['before'];
  1562. $after = $options['after'];
  1563. unset($options['before'], $options['after']);
  1564. $isUrl = strpos($caption, '://') !== false;
  1565. $isImage = preg_match('/\.(jpg|jpe|jpeg|gif|png|ico)$/', $caption);
  1566. if ($isUrl || $isImage) {
  1567. $unlockFields = array('x', 'y');
  1568. if (isset($options['name'])) {
  1569. $unlockFields = array(
  1570. $options['name'] . '_x', $options['name'] . '_y'
  1571. );
  1572. }
  1573. foreach ($unlockFields as $ignore) {
  1574. $this->unlockField($ignore);
  1575. }
  1576. }
  1577. if ($isUrl) {
  1578. unset($options['type']);
  1579. $tag = $this->Html->useTag('submitimage', $caption, $options);
  1580. } elseif ($isImage) {
  1581. unset($options['type']);
  1582. if ($caption{0} !== '/') {
  1583. $url = $this->webroot(IMAGES_URL . $caption);
  1584. } else {
  1585. $url = $this->webroot(trim($caption, '/'));
  1586. }
  1587. $url = $this->assetTimestamp($url);
  1588. $tag = $this->Html->useTag('submitimage', $url, $options);
  1589. } else {
  1590. $options['value'] = $caption;
  1591. $tag = $this->Html->useTag('submit', $options);
  1592. }
  1593. $out = $before . $tag . $after;
  1594. if (isset($divOptions)) {
  1595. $tag = $divOptions['tag'];
  1596. unset($divOptions['tag']);
  1597. $out = $this->Html->tag($tag, $out, $divOptions);
  1598. }
  1599. return $out;
  1600. }
  1601. /**
  1602. * Returns a formatted SELECT element.
  1603. *
  1604. * ### Attributes:
  1605. *
  1606. * - `showParents` - If included in the array and set to true, an additional option element
  1607. * will be added for the parent of each option group. You can set an option with the same name
  1608. * and it's key will be used for the value of the option.
  1609. * - `multiple` - show a multiple select box. If set to 'checkbox' multiple checkboxes will be
  1610. * created instead.
  1611. * - `empty` - If true, the empty select option is shown. If a string,
  1612. * that string is displayed as the empty element.
  1613. * - `escape` - If true contents of options will be HTML entity encoded. Defaults to true.
  1614. * - `value` The selected value of the input.
  1615. * - `class` - When using multiple = checkbox the classname to apply to the divs. Defaults to 'checkbox'.
  1616. *
  1617. * ### Using options
  1618. *
  1619. * A simple array will create normal options:
  1620. *
  1621. * {{{
  1622. * $options = array(1 => 'one', 2 => 'two);
  1623. * $this->Form->select('Model.field', $options));
  1624. * }}}
  1625. *
  1626. * While a nested options array will create optgroups with options inside them.
  1627. * {{{
  1628. * $options = array(
  1629. * 1 => 'bill',
  1630. * 'fred' => array(
  1631. * 2 => 'fred',
  1632. * 3 => 'fred jr.'
  1633. * )
  1634. * );
  1635. * $this->Form->select('Model.field', $options);
  1636. * }}}
  1637. *
  1638. * In the above `2 => 'fred'` will not generate an option element. You should enable the `showParents`
  1639. * attribute to show the fred option.
  1640. *
  1641. * If you have multiple options that need to have the same value attribute, you can
  1642. * use an array of arrays to express this:
  1643. *
  1644. * {{{
  1645. * $options = array(
  1646. * array('name' => 'United states', 'value' => 'USA'),
  1647. * array('name' => 'USA', 'value' => 'USA'),
  1648. * );
  1649. * }}}
  1650. *
  1651. * @param string $fieldName Name attribute of the SELECT
  1652. * @param array $options Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the
  1653. * SELECT element
  1654. * @param array $attributes The HTML attributes of the select element.
  1655. * @return string Formatted SELECT element
  1656. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
  1657. */
  1658. public function select($fieldName, $options = array(), $attributes = array()) {
  1659. $select = array();
  1660. $style = null;
  1661. $tag = null;
  1662. $attributes += array(
  1663. 'class' => null,
  1664. 'escape' => true,
  1665. 'secure' => true,
  1666. 'empty' => '',
  1667. 'showParents' => false,
  1668. 'hiddenField' => true
  1669. );
  1670. $escapeOptions = $this->_extractOption('escape', $attributes);
  1671. $secure = $this->_extractOption('secure', $attributes);
  1672. $showEmpty = $this->_extractOption('empty', $attributes);
  1673. $showParents = $this->_extractOption('showParents', $attributes);
  1674. $hiddenField = $this->_extractOption('hiddenField', $attributes);
  1675. unset($attributes['escape'], $attributes['secure'], $attributes['empty'], $attributes['showParents'], $attributes['hiddenField']);
  1676. $id = $this->_extractOption('id', $attributes);
  1677. $attributes = $this->_initInputField($fieldName, array_merge(
  1678. (array)$attributes, array('secure' => self::SECURE_SKIP)
  1679. ));
  1680. if (is_string($options) && isset($this->_options[$options])) {
  1681. $options = $this->_generateOptions($options);
  1682. } elseif (!is_array($options)) {
  1683. $options = array();
  1684. }
  1685. if (isset($attributes['type'])) {
  1686. unset($attributes['type']);
  1687. }
  1688. if (!empty($attributes['multiple'])) {
  1689. $style = ($attributes['multiple'] === 'checkbox') ? 'checkbox' : null;
  1690. $template = ($style) ? 'checkboxmultiplestart' : 'selectmultiplestart';
  1691. $tag = $template;
  1692. if ($hiddenField) {
  1693. $hiddenAttributes = array(
  1694. 'value' => '',
  1695. 'id' => $attributes['id'] . ($style ? '' : '_'),
  1696. 'secure' => false,
  1697. 'name' => $attributes['name']
  1698. );
  1699. $select[] = $this->hidden(null, $hiddenAttributes);
  1700. }
  1701. } else {
  1702. $tag = 'selectstart';
  1703. }
  1704. if (!empty($tag) || isset($template)) {
  1705. $hasOptions = (count($options) > 0 || $showEmpty);
  1706. // Secure the field if there are options, or its a multi select.
  1707. // Single selects with no options don't submit, but multiselects do.
  1708. if (
  1709. (!isset($secure) || $secure == true) &&
  1710. empty($attributes['disabled']) &&
  1711. (!empty($attributes['multiple']) || $hasOptions)
  1712. ) {
  1713. $this->_secure(true);
  1714. }
  1715. $select[] = $this->Html->useTag($tag, $attributes['name'], array_diff_key($attributes, array('name' => '', 'value' => '')));
  1716. }
  1717. $emptyMulti = (
  1718. $showEmpty !== null && $showEmpty !== false && !(
  1719. empty($showEmpty) && (isset($attributes) &&
  1720. array_key_exists('multiple', $attributes))
  1721. )
  1722. );
  1723. if ($emptyMulti) {
  1724. $showEmpty = ($showEmpty === true) ? '' : $showEmpty;
  1725. $options = array('' => $showEmpty) + $options;
  1726. }
  1727. if (!$id) {
  1728. $attributes['id'] = Inflector::camelize($attributes['id']);
  1729. }
  1730. $select = array_merge($select, $this->_selectOptions(
  1731. array_reverse($options, true),
  1732. array(),
  1733. $showParents,
  1734. array(
  1735. 'escape' => $escapeOptions,
  1736. 'style' => $style,
  1737. 'name' => $attributes['name'],
  1738. 'value' => $attributes['value'],
  1739. 'class' => $attributes['class'],
  1740. 'id' => $attributes['id']
  1741. )
  1742. ));
  1743. $template = ($style == 'checkbox') ? 'checkboxmultipleend' : 'selectend';
  1744. $select[] = $this->Html->useTag($template);
  1745. return implode("\n", $select);
  1746. }
  1747. /**
  1748. * Returns a SELECT element for days.
  1749. *
  1750. * ### Attributes:
  1751. *
  1752. * - `empty` - If true, the empty select option is shown. If a string,
  1753. * that string is displayed as the empty element.
  1754. * - `value` The selected value of the input.
  1755. *
  1756. * @param string $fieldName Prefix name for the SELECT element
  1757. * @param array $attributes HTML attributes for the select element
  1758. * @return string A generated day select box.
  1759. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::day
  1760. */
  1761. public function day($fieldName = null, $attributes = array()) {
  1762. $attributes += array('empty' => true, 'value' => null);
  1763. $attributes = $this->_dateTimeSelected('day', $fieldName, $attributes);
  1764. if (strlen($attributes['value']) > 2) {
  1765. $attributes['value'] = date('d', strtotime($attributes['value']));
  1766. } elseif ($attributes['value'] === false) {
  1767. $attributes['value'] = null;
  1768. }
  1769. return $this->select($fieldName . ".day", $this->_generateOptions('day'), $attributes);
  1770. }
  1771. /**
  1772. * Returns a SELECT element for years
  1773. *
  1774. * ### Attributes:
  1775. *
  1776. * - `empty` - If true, the empty select option is shown. If a string,
  1777. * that string is displayed as the empty element.
  1778. * - `orderYear` - Ordering of year values in select options.
  1779. * Possible values 'asc', 'desc'. Default 'desc'
  1780. * - `value` The selected value of the input.
  1781. *
  1782. * @param string $fieldName Prefix name for the SELECT element
  1783. * @param integer $minYear First year in sequence
  1784. * @param integer $maxYear Last year in sequence
  1785. * @param array $attributes Attribute array for the select elements.
  1786. * @return string Completed year select input
  1787. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::year
  1788. */
  1789. public function year($fieldName, $minYear = null, $maxYear = null, $attributes = array()) {
  1790. $attributes += array('empty' => true, 'value' => null);
  1791. if ((empty($attributes['value']) || $attributes['value'] === true) && $value = $this->value($fieldName)) {
  1792. if (is_array($value)) {
  1793. extract($value);
  1794. $attributes['value'] = $year;
  1795. } else {
  1796. if (empty($value)) {
  1797. if (!$attributes['empty'] && !$maxYear) {
  1798. $attributes['value'] = 'now';
  1799. } elseif (!$attributes['empty'] && $maxYear && !$attributes['value']) {
  1800. $attributes['value'] = $maxYear;
  1801. }
  1802. } else {
  1803. $attributes['value'] = $value;
  1804. }
  1805. }
  1806. }
  1807. if (strlen($attributes['value']) > 4 || $attributes['value'] === 'now') {
  1808. $attributes['value'] = date('Y', strtotime($attributes['value']));
  1809. } elseif ($attributes['value'] === false) {
  1810. $attributes['value'] = null;
  1811. }
  1812. $yearOptions = array('min' => $minYear, 'max' => $maxYear, 'order' => 'desc');
  1813. if (isset($attributes['orderYear'])) {
  1814. $yearOptions['order'] = $attributes['orderYear'];
  1815. unset($attributes['orderYear']);
  1816. }
  1817. return $this->select(
  1818. $fieldName . '.year', $this->_generateOptions('year', $yearOptions),
  1819. $attributes
  1820. );
  1821. }
  1822. /**
  1823. * Returns a SELECT element for months.
  1824. *
  1825. * ### Attributes:
  1826. *
  1827. * - `monthNames` - If false, 2 digit numbers will be used instead of text.
  1828. * If a array, the given array will be used.
  1829. * - `empty` - If true, the empty select option is shown. If a string,
  1830. * that string is displayed as the empty element.
  1831. * - `value` The selected value of the input.
  1832. *
  1833. * @param string $fieldName Prefix name for the SELECT element
  1834. * @param array $attributes Attributes for the select element
  1835. * @return string A generated month select dropdown.
  1836. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::month
  1837. */
  1838. public function month($fieldName, $attributes = array()) {
  1839. $attributes += array('empty' => true, 'value' => null);
  1840. $attributes = $this->_dateTimeSelected('month', $fieldName, $attributes);
  1841. if (strlen($attributes['value']) > 2) {
  1842. $attributes['value'] = date('m', strtotime($attributes['value']));
  1843. } elseif ($attributes['value'] === false) {
  1844. $attributes['value'] = null;
  1845. }
  1846. $defaults = array('monthNames' => true);
  1847. $attributes = array_merge($defaults, (array)$attributes);
  1848. $monthNames = $attributes['monthNames'];
  1849. unset($attributes['monthNames']);
  1850. return $this->select(
  1851. $fieldName . ".month",
  1852. $this->_generateOptions('month', array('monthNames' => $monthNames)),
  1853. $attributes
  1854. );
  1855. }
  1856. /**
  1857. * Returns a SELECT element for hours.
  1858. *
  1859. * ### Attributes:
  1860. *
  1861. * - `empty` - If true, the empty select option is shown. If a string,
  1862. * that string is displayed as the empty element.
  1863. * - `value` The selected value of the input.
  1864. *
  1865. * @param string $fieldName Prefix name for the SELECT element
  1866. * @param boolean $format24Hours True for 24 hours format
  1867. * @param array $attributes List of HTML attributes
  1868. * @return string Completed hour select input
  1869. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hour
  1870. */
  1871. public function hour($fieldName, $format24Hours = false, $attributes = array()) {
  1872. $attributes += array('empty' => true, 'value' => null);
  1873. $attributes = $this->_dateTimeSelected('hour', $fieldName, $attributes);
  1874. if (strlen($attributes['value']) > 2) {
  1875. if ($format24Hours) {
  1876. $attributes['value'] = date('H', strtotime($attributes['value']));
  1877. } else {
  1878. $attributes['value'] = date('g', strtotime($attributes['value']));
  1879. }
  1880. } elseif ($attributes['value'] === false) {
  1881. $attributes['value'] = null;
  1882. }
  1883. if ($attributes['value'] > 12 && !$format24Hours) {
  1884. $attributes['value'] -= 12;
  1885. }
  1886. return $this->select(
  1887. $fieldName . ".hour",
  1888. $this->_generateOptions($format24Hours ? 'hour24' : 'hour'),
  1889. $attributes
  1890. );
  1891. }
  1892. /**
  1893. * Returns a SELECT element for minutes.
  1894. *
  1895. * ### Attributes:
  1896. *
  1897. * - `empty` - If true, the empty select option is shown. If a string,
  1898. * that string is displayed as the empty element.
  1899. * - `value` The selected value of the input.
  1900. *
  1901. * @param string $fieldName Prefix name for the SELECT element
  1902. * @param string $attributes Array of Attributes
  1903. * @return string Completed minute select input.
  1904. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::minute
  1905. */
  1906. public function minute($fieldName, $attributes = array()) {
  1907. $attributes += array('empty' => true, 'value' => null);
  1908. $attributes = $this->_dateTimeSelected('min', $fieldName, $attributes);
  1909. if (strlen($attributes['value']) > 2) {
  1910. $attributes['value'] = date('i', strtotime($attributes['value']));
  1911. } elseif ($attributes['value'] === false) {
  1912. $attributes['value'] = null;
  1913. }
  1914. $minuteOptions = array();
  1915. if (isset($attributes['interval'])) {
  1916. $minuteOptions['interval'] = $attributes['interval'];
  1917. unset($attributes['interval']);
  1918. }
  1919. return $this->select(
  1920. $fieldName . ".min", $this->_generateOptions('minute', $minuteOptions),
  1921. $attributes
  1922. );
  1923. }
  1924. /**
  1925. * Selects values for dateTime selects.
  1926. *
  1927. * @param string $select Name of element field. ex. 'day'
  1928. * @param string $fieldName Name of fieldName being generated ex. Model.created
  1929. * @param array $attributes Array of attributes, must contain 'empty' key.
  1930. * @return array Attributes array with currently selected value.
  1931. */
  1932. protected function _dateTimeSelected($select, $fieldName, $attributes) {
  1933. if ((empty($attributes['value']) || $attributes['value'] === true) && $value = $this->value($fieldName)) {
  1934. if (is_array($value) && isset($value[$select])) {
  1935. $attributes['value'] = $value[$select];
  1936. } else {
  1937. if (empty($value)) {
  1938. if (!$attributes['empty']) {
  1939. $attributes['value'] = 'now';
  1940. }
  1941. } else {
  1942. $attributes['value'] = $value;
  1943. }
  1944. }
  1945. }
  1946. return $attributes;
  1947. }
  1948. /**
  1949. * Returns a SELECT element for AM or PM.
  1950. *
  1951. * ### Attributes:
  1952. *
  1953. * - `empty` - If true, the empty select option is shown. If a string,
  1954. * that string is displayed as the empty element.
  1955. * - `value` The selected value of the input.
  1956. *
  1957. * @param string $fieldName Prefix name for the SELECT element
  1958. * @param string $attributes Array of Attributes
  1959. * @return string Completed meridian select input
  1960. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::meridian
  1961. */
  1962. public function meridian($fieldName, $attributes = array()) {
  1963. $attributes += array('empty' => true, 'value' => null);
  1964. if ((empty($attributes['value']) || $attributes['value'] === true) && $value = $this->value($fieldName)) {
  1965. if (is_array($value)) {
  1966. extract($value);
  1967. $attributes['value'] = $meridian;
  1968. } else {
  1969. if (empty($value)) {
  1970. if (!$attributes['empty']) {
  1971. $attributes['value'] = date('a');
  1972. }
  1973. } else {
  1974. $attributes['value'] = date('a', strtotime($value));
  1975. }
  1976. }
  1977. }
  1978. if ($attributes['value'] === false) {
  1979. $attributes['value'] = null;
  1980. }
  1981. return $this->select(
  1982. $fieldName . ".meridian", $this->_generateOptions('meridian'),
  1983. $attributes
  1984. );
  1985. }
  1986. /**
  1987. * Returns a set of SELECT elements for a full datetime setup: day, month and year, and then time.
  1988. *
  1989. * ### Attributes:
  1990. *
  1991. * - `monthNames` If false, 2 digit numbers will be used instead of text.
  1992. * If a array, the given array will be used.
  1993. * - `minYear` The lowest year to use in the year select
  1994. * - `maxYear` The maximum year to use in the year select
  1995. * - `interval` The interval for the minutes select. Defaults to 1
  1996. * - `separator` The contents of the string between select elements. Defaults to '-'
  1997. * - `empty` - If true, the empty select option is shown. If a string,
  1998. * that string is displayed as the empty element.
  1999. * - `value` | `default` The default value to be used by the input. A value in `$this->data`
  2000. * matching the field name will override this value. If no default is provided `time()` will be used.
  2001. *
  2002. * @param string $fieldName Prefix name for the SELECT element
  2003. * @param string $dateFormat DMY, MDY, YMD, or null to not generate date inputs.
  2004. * @param string $timeFormat 12, 24, or null to not generate time inputs.
  2005. * @param string $attributes array of Attributes
  2006. * @return string Generated set of select boxes for the date and time formats chosen.
  2007. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::dateTime
  2008. */
  2009. public function dateTime($fieldName, $dateFormat = 'DMY', $timeFormat = '12', $attributes = array()) {
  2010. $attributes += array('empty' => true, 'value' => null);
  2011. $year = $month = $day = $hour = $min = $meridian = null;
  2012. if (empty($attributes['value'])) {
  2013. $attributes = $this->value($attributes, $fieldName);
  2014. }
  2015. if ($attributes['value'] === null && $attributes['empty'] != true) {
  2016. $attributes['value'] = time();
  2017. }
  2018. if (!empty($attributes['value'])) {
  2019. if (is_array($attributes['value'])) {
  2020. extract($attributes['value']);
  2021. if ($meridian === 'pm') {
  2022. $hour += 12;
  2023. }
  2024. } else {
  2025. if (is_numeric($attributes['value'])) {
  2026. $attributes['value'] = strftime('%Y-%m-%d %H:%M:%S', $attributes['value']);
  2027. }
  2028. $meridian = 'am';
  2029. $pos = strpos($attributes['value'], '-');
  2030. if ($pos !== false) {
  2031. $date = explode('-', $attributes['value']);
  2032. $days = explode(' ', $date[2]);
  2033. $day = $days[0];
  2034. $month = $date[1];
  2035. $year = $date[0];
  2036. } else {
  2037. $days[1] = $attributes['value'];
  2038. }
  2039. if (!empty($timeFormat)) {
  2040. $time = explode(':', $days[1]);
  2041. if ($time[0] >= '12' && $timeFormat == '12') {
  2042. $meridian = 'pm';
  2043. } elseif ($time[0] == '00' && $timeFormat == '12') {
  2044. $time[0] = 12;
  2045. } elseif ($time[0] >= 12) {
  2046. $meridian = 'pm';
  2047. }
  2048. if ($time[0] == 0 && $timeFormat == '12') {
  2049. $time[0] = 12;
  2050. }
  2051. $hour = $min = null;
  2052. if (isset($time[1])) {
  2053. $hour = $time[0];
  2054. $min = $time[1];
  2055. }
  2056. }
  2057. }
  2058. }
  2059. $elements = array('Day', 'Month', 'Year', 'Hour', 'Minute', 'Meridian');
  2060. $defaults = array(
  2061. 'minYear' => null, 'maxYear' => null, 'separator' => '-',
  2062. 'interval' => 1, 'monthNames' => true
  2063. );
  2064. $attributes = array_merge($defaults, (array)$attributes);
  2065. if (isset($attributes['minuteInterval'])) {
  2066. $attributes['interval'] = $attributes['minuteInterval'];
  2067. unset($attributes['minuteInterval']);
  2068. }
  2069. $minYear = $attributes['minYear'];
  2070. $maxYear = $attributes['maxYear'];
  2071. $separator = $attributes['separator'];
  2072. $interval = $attributes['interval'];
  2073. $monthNames = $attributes['monthNames'];
  2074. $attributes = array_diff_key($attributes, $defaults);
  2075. if (!empty($interval) && $interval > 1 && !empty($min)) {
  2076. $current = new DateTime();
  2077. if ($year !== null) {
  2078. $current->setDate($year, $month, $day);
  2079. }
  2080. if ($hour !== null) {
  2081. $current->setTime($hour, $min);
  2082. }
  2083. $change = (round($min * (1 / $interval)) * $interval) - $min;
  2084. $current->modify($change > 0 ? "+$change minutes" : "$change minutes");
  2085. $newTime = explode(' ', $current->format('Y m d H i a'));
  2086. list($year, $month, $day, $hour, $min, $meridian) = $newTime;
  2087. }
  2088. if (isset($attributes['id'])) {
  2089. if (is_string($attributes['id'])) {
  2090. // build out an array version
  2091. foreach ($elements as $element) {
  2092. $selectAttrName = 'select' . $element . 'Attr';
  2093. ${$selectAttrName} = $attributes;
  2094. ${$selectAttrName}['id'] = $attributes['id'] . $element;
  2095. }
  2096. } elseif (is_array($attributes['id'])) {
  2097. // check for missing ones and build selectAttr for each element
  2098. $attributes['id'] += array(
  2099. 'month' => '', 'year' => '', 'day' => '',
  2100. 'hour' => '', 'minute' => '', 'meridian' => ''
  2101. );
  2102. foreach ($elements as $element) {
  2103. $selectAttrName = 'select' . $element . 'Attr';
  2104. ${$selectAttrName} = $attributes;
  2105. ${$selectAttrName}['id'] = $attributes['id'][strtolower($element)];
  2106. }
  2107. }
  2108. } else {
  2109. // build the selectAttrName with empty id's to pass
  2110. foreach ($elements as $element) {
  2111. $selectAttrName = 'select' . $element . 'Attr';
  2112. ${$selectAttrName} = $attributes;
  2113. }
  2114. }
  2115. if (is_array($attributes['empty'])) {
  2116. $attributes['empty'] += array(
  2117. 'month' => true, 'year' => true, 'day' => true,
  2118. 'hour' => true, 'minute' => true, 'meridian' => true
  2119. );
  2120. foreach ($elements as $element) {
  2121. $selectAttrName = 'select' . $element . 'Attr';
  2122. ${$selectAttrName}['empty'] = $attributes['empty'][strtolower($element)];
  2123. }
  2124. }
  2125. $selects = array();
  2126. foreach (preg_split('//', $dateFormat, -1, PREG_SPLIT_NO_EMPTY) as $char) {
  2127. switch ($char) {
  2128. case 'Y':
  2129. $selectYearAttr['value'] = $year;
  2130. $selects[] = $this->year(
  2131. $fieldName, $minYear, $maxYear, $selectYearAttr
  2132. );
  2133. break;
  2134. case 'M':
  2135. $selectMonthAttr['value'] = $month;
  2136. $selectMonthAttr['monthNames'] = $monthNames;
  2137. $selects[] = $this->month($fieldName, $selectMonthAttr);
  2138. break;
  2139. case 'D':
  2140. $selectDayAttr['value'] = $day;
  2141. $selects[] = $this->day($fieldName, $selectDayAttr);
  2142. break;
  2143. }
  2144. }
  2145. $opt = implode($separator, $selects);
  2146. $selectMinuteAttr['interval'] = $interval;
  2147. switch ($timeFormat) {
  2148. case '24':
  2149. $selectHourAttr['value'] = $hour;
  2150. $selectMinuteAttr['value'] = $min;
  2151. $opt .= $this->hour($fieldName, true, $selectHourAttr) . ':' .
  2152. $this->minute($fieldName, $selectMinuteAttr);
  2153. break;
  2154. case '12':
  2155. $selectHourAttr['value'] = $hour;
  2156. $selectMinuteAttr['value'] = $min;
  2157. $selectMeridianAttr['value'] = $meridian;
  2158. $opt .= $this->hour($fieldName, false, $selectHourAttr) . ':' .
  2159. $this->minute($fieldName, $selectMinuteAttr) . ' ' .
  2160. $this->meridian($fieldName, $selectMeridianAttr);
  2161. break;
  2162. default:
  2163. $opt .= '';
  2164. break;
  2165. }
  2166. return $opt;
  2167. }
  2168. /**
  2169. * Gets the input field name for the current tag
  2170. *
  2171. * @param array $options
  2172. * @param string $field
  2173. * @param string $key
  2174. * @return array
  2175. */
  2176. protected function _name($options = array(), $field = null, $key = 'name') {
  2177. if ($this->requestType == 'get') {
  2178. if ($options === null) {
  2179. $options = array();
  2180. } elseif (is_string($options)) {
  2181. $field = $options;
  2182. $options = 0;
  2183. }
  2184. if (!empty($field)) {
  2185. $this->setEntity($field);
  2186. }
  2187. if (is_array($options) && isset($options[$key])) {
  2188. return $options;
  2189. }
  2190. $entity = $this->entity();
  2191. $model = $this->model();
  2192. $name = $model === $entity[0] && isset($entity[1]) ? $entity[1] : $entity[0];
  2193. $last = $entity[count($entity) - 1];
  2194. if (in_array($last, $this->_fieldSuffixes)) {
  2195. $name .= '[' . $last . ']';
  2196. }
  2197. if (is_array($options)) {
  2198. $options[$key] = $name;
  2199. return $options;
  2200. } else {
  2201. return $name;
  2202. }
  2203. }
  2204. return parent::_name($options, $field, $key);
  2205. }
  2206. /**
  2207. * Returns an array of formatted OPTION/OPTGROUP elements
  2208. *
  2209. * @param array $elements
  2210. * @param array $parents
  2211. * @param boolean $showParents
  2212. * @param array $attributes
  2213. * @return array
  2214. */
  2215. protected function _selectOptions($elements = array(), $parents = array(), $showParents = null, $attributes = array()) {
  2216. $select = array();
  2217. $attributes = array_merge(
  2218. array('escape' => true, 'style' => null, 'value' => null, 'class' => null),
  2219. $attributes
  2220. );
  2221. $selectedIsEmpty = ($attributes['value'] === '' || $attributes['value'] === null);
  2222. $selectedIsArray = is_array($attributes['value']);
  2223. foreach ($elements as $name => $title) {
  2224. $htmlOptions = array();
  2225. if (is_array($title) && (!isset($title['name']) || !isset($title['value']))) {
  2226. if (!empty($name)) {
  2227. if ($attributes['style'] === 'checkbox') {
  2228. $select[] = $this->Html->useTag('fieldsetend');
  2229. } else {
  2230. $select[] = $this->Html->useTag('optiongroupend');
  2231. }
  2232. $parents[] = $name;
  2233. }
  2234. $select = array_merge($select, $this->_selectOptions(
  2235. $title, $parents, $showParents, $attributes
  2236. ));
  2237. if (!empty($name)) {
  2238. $name = $attributes['escape'] ? h($name) : $name;
  2239. if ($attributes['style'] === 'checkbox') {
  2240. $select[] = $this->Html->useTag('fieldsetstart', $name);
  2241. } else {
  2242. $select[] = $this->Html->useTag('optiongroup', $name, '');
  2243. }
  2244. }
  2245. $name = null;
  2246. } elseif (is_array($title)) {
  2247. $htmlOptions = $title;
  2248. $name = $title['value'];
  2249. $title = $title['name'];
  2250. unset($htmlOptions['name'], $htmlOptions['value']);
  2251. }
  2252. if ($name !== null) {
  2253. if (
  2254. (!$selectedIsArray && !$selectedIsEmpty && (string)$attributes['value'] == (string)$name) ||
  2255. ($selectedIsArray && in_array($name, $attributes['value']))
  2256. ) {
  2257. if ($attributes['style'] === 'checkbox') {
  2258. $htmlOptions['checked'] = true;
  2259. } else {
  2260. $htmlOptions['selected'] = 'selected';
  2261. }
  2262. }
  2263. if ($showParents || (!in_array($title, $parents))) {
  2264. $title = ($attributes['escape']) ? h($title) : $title;
  2265. if ($attributes['style'] === 'checkbox') {
  2266. $htmlOptions['value'] = $name;
  2267. $tagName = $attributes['id'] . Inflector::camelize(Inflector::slug($name));
  2268. $htmlOptions['id'] = $tagName;
  2269. $label = array('for' => $tagName);
  2270. if (isset($htmlOptions['checked']) && $htmlOptions['checked'] === true) {
  2271. $label['class'] = 'selected';
  2272. }
  2273. $name = $attributes['name'];
  2274. if (empty($attributes['class'])) {
  2275. $attributes['class'] = 'checkbox';
  2276. } elseif ($attributes['class'] === 'form-error') {
  2277. $attributes['class'] = 'checkbox ' . $attributes['class'];
  2278. }
  2279. $label = $this->label(null, $title, $label);
  2280. $item = $this->Html->useTag('checkboxmultiple', $name, $htmlOptions);
  2281. $select[] = $this->Html->div($attributes['class'], $item . $label);
  2282. } else {
  2283. $select[] = $this->Html->useTag('selectoption', $name, $htmlOptions, $title);
  2284. }
  2285. }
  2286. }
  2287. }
  2288. return array_reverse($select, true);
  2289. }
  2290. /**
  2291. * Generates option lists for common <select /> menus
  2292. *
  2293. * @param string $name
  2294. * @param array $options
  2295. * @return array
  2296. */
  2297. protected function _generateOptions($name, $options = array()) {
  2298. if (!empty($this->options[$name])) {
  2299. return $this->options[$name];
  2300. }
  2301. $data = array();
  2302. switch ($name) {
  2303. case 'minute':
  2304. if (isset($options['interval'])) {
  2305. $interval = $options['interval'];
  2306. } else {
  2307. $interval = 1;
  2308. }
  2309. $i = 0;
  2310. while ($i < 60) {
  2311. $data[sprintf('%02d', $i)] = sprintf('%02d', $i);
  2312. $i += $interval;
  2313. }
  2314. break;
  2315. case 'hour':
  2316. for ($i = 1; $i <= 12; $i++) {
  2317. $data[sprintf('%02d', $i)] = $i;
  2318. }
  2319. break;
  2320. case 'hour24':
  2321. for ($i = 0; $i <= 23; $i++) {
  2322. $data[sprintf('%02d', $i)] = $i;
  2323. }
  2324. break;
  2325. case 'meridian':
  2326. $data = array('am' => 'am', 'pm' => 'pm');
  2327. break;
  2328. case 'day':
  2329. $min = 1;
  2330. $max = 31;
  2331. if (isset($options['min'])) {
  2332. $min = $options['min'];
  2333. }
  2334. if (isset($options['max'])) {
  2335. $max = $options['max'];
  2336. }
  2337. for ($i = $min; $i <= $max; $i++) {
  2338. $data[sprintf('%02d', $i)] = $i;
  2339. }
  2340. break;
  2341. case 'month':
  2342. if ($options['monthNames'] === true) {
  2343. $data['01'] = __d('cake', 'January');
  2344. $data['02'] = __d('cake', 'February');
  2345. $data['03'] = __d('cake', 'March');
  2346. $data['04'] = __d('cake', 'April');
  2347. $data['05'] = __d('cake', 'May');
  2348. $data['06'] = __d('cake', 'June');
  2349. $data['07'] = __d('cake', 'July');
  2350. $data['08'] = __d('cake', 'August');
  2351. $data['09'] = __d('cake', 'September');
  2352. $data['10'] = __d('cake', 'October');
  2353. $data['11'] = __d('cake', 'November');
  2354. $data['12'] = __d('cake', 'December');
  2355. } elseif (is_array($options['monthNames'])) {
  2356. $data = $options['monthNames'];
  2357. } else {
  2358. for ($m = 1; $m <= 12; $m++) {
  2359. $data[sprintf("%02s", $m)] = strftime("%m", mktime(1, 1, 1, $m, 1, 1999));
  2360. }
  2361. }
  2362. break;
  2363. case 'year':
  2364. $current = intval(date('Y'));
  2365. $min = !isset($options['min']) ? $current - 20 : (int)$options['min'];
  2366. $max = !isset($options['max']) ? $current + 20 : (int)$options['max'];
  2367. if ($min > $max) {
  2368. list($min, $max) = array($max, $min);
  2369. }
  2370. for ($i = $min; $i <= $max; $i++) {
  2371. $data[$i] = $i;
  2372. }
  2373. if ($options['order'] != 'asc') {
  2374. $data = array_reverse($data, true);
  2375. }
  2376. break;
  2377. }
  2378. $this->_options[$name] = $data;
  2379. return $this->_options[$name];
  2380. }
  2381. /**
  2382. * Sets field defaults and adds field to form security input hash
  2383. *
  2384. * ### Options
  2385. *
  2386. * - `secure` - boolean whether or not the field should be added to the security fields.
  2387. * Disabling the field using the `disabled` option, will also omit the field from being
  2388. * part of the hashed key.
  2389. *
  2390. * @param string $field Name of the field to initialize options for.
  2391. * @param array $options Array of options to append options into.
  2392. * @return array Array of options for the input.
  2393. */
  2394. protected function _initInputField($field, $options = array()) {
  2395. if (isset($options['secure'])) {
  2396. $secure = $options['secure'];
  2397. unset($options['secure']);
  2398. } else {
  2399. $secure = (isset($this->request['_Token']) && !empty($this->request['_Token']));
  2400. }
  2401. $result = parent::_initInputField($field, $options);
  2402. if ($this->tagIsInvalid() !== false) {
  2403. $result = $this->addClass($result, 'form-error');
  2404. }
  2405. if (!empty($result['disabled']) || $secure === self::SECURE_SKIP) {
  2406. return $result;
  2407. }
  2408. $fieldName = null;
  2409. if (!empty($options['name'])) {
  2410. preg_match_all('/\[(.*?)\]/', $options['name'], $matches);
  2411. if (isset($matches[1])) {
  2412. $fieldName = $matches[1];
  2413. }
  2414. }
  2415. $this->_secure($secure, $fieldName);
  2416. return $result;
  2417. }
  2418. /**
  2419. * Set/Get inputDefaults for form elements
  2420. *
  2421. * @param array $defaults New default values
  2422. * @param boolean Merge with current defaults
  2423. * @return array inputDefaults
  2424. */
  2425. public function inputDefaults($defaults = null, $merge = false) {
  2426. if (!is_null($defaults)) {
  2427. if ($merge) {
  2428. $this->_inputDefaults = array_merge($this->_inputDefaults, (array)$defaults);
  2429. } else {
  2430. $this->_inputDefaults = (array)$defaults;
  2431. }
  2432. }
  2433. return $this->_inputDefaults;
  2434. }
  2435. }