1: <?php
  2: /**
  3:  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  4:  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  5:  *
  6:  * Licensed under The MIT License
  7:  * For full copyright and license information, please see the LICENSE.txt
  8:  * Redistributions of files must retain the above copyright notice.
  9:  *
 10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 11:  * @link          http://cakephp.org CakePHP(tm) Project
 12:  * @package       Cake.View
 13:  * @since         CakePHP(tm) v 0.2.9
 14:  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 15:  */
 16: 
 17: App::uses('Router', 'Routing');
 18: App::uses('Hash', 'Utility');
 19: 
 20: /**
 21:  * Abstract base class for all other Helpers in CakePHP.
 22:  * Provides common methods and features.
 23:  *
 24:  * @package       Cake.View
 25:  */
 26: class Helper extends Object {
 27: 
 28: /**
 29:  * Settings for this helper.
 30:  *
 31:  * @var array
 32:  */
 33:     public $settings = array();
 34: 
 35: /**
 36:  * List of helpers used by this helper
 37:  *
 38:  * @var array
 39:  */
 40:     public $helpers = array();
 41: 
 42: /**
 43:  * A helper lookup table used to lazy load helper objects.
 44:  *
 45:  * @var array
 46:  */
 47:     protected $_helperMap = array();
 48: 
 49: /**
 50:  * The current theme name if any.
 51:  *
 52:  * @var string
 53:  */
 54:     public $theme = null;
 55: 
 56: /**
 57:  * Request object
 58:  *
 59:  * @var CakeRequest
 60:  */
 61:     public $request = null;
 62: 
 63: /**
 64:  * Plugin path
 65:  *
 66:  * @var string
 67:  */
 68:     public $plugin = null;
 69: 
 70: /**
 71:  * Holds the fields array('field_name' => array('type' => 'string', 'length' => 100),
 72:  * primaryKey and validates array('field_name')
 73:  *
 74:  * @var array
 75:  */
 76:     public $fieldset = array();
 77: 
 78: /**
 79:  * Holds tag templates.
 80:  *
 81:  * @var array
 82:  */
 83:     public $tags = array();
 84: 
 85: /**
 86:  * Holds the content to be cleaned.
 87:  *
 88:  * @var mixed
 89:  */
 90:     protected $_tainted = null;
 91: 
 92: /**
 93:  * Holds the cleaned content.
 94:  *
 95:  * @var mixed
 96:  */
 97:     protected $_cleaned = null;
 98: 
 99: /**
100:  * The View instance this helper is attached to
101:  *
102:  * @var View
103:  */
104:     protected $_View;
105: 
106: /**
107:  * A list of strings that should be treated as suffixes, or
108:  * sub inputs for a parent input. This is used for date/time
109:  * inputs primarily.
110:  *
111:  * @var array
112:  */
113:     protected $_fieldSuffixes = array(
114:         'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
115:     );
116: 
117: /**
118:  * The name of the current model entities are in scope of.
119:  *
120:  * @see Helper::setEntity()
121:  * @var string
122:  */
123:     protected $_modelScope;
124: 
125: /**
126:  * The name of the current model association entities are in scope of.
127:  *
128:  * @see Helper::setEntity()
129:  * @var string
130:  */
131:     protected $_association;
132: 
133: /**
134:  * The dot separated list of elements the current field entity is for.
135:  *
136:  * @see Helper::setEntity()
137:  * @var string
138:  */
139:     protected $_entityPath;
140: 
141: /**
142:  * Minimized attributes
143:  *
144:  * @var array
145:  */
146:     protected $_minimizedAttributes = array(
147:         'compact', 'checked', 'declare', 'readonly', 'disabled', 'selected',
148:         'defer', 'ismap', 'nohref', 'noshade', 'nowrap', 'multiple', 'noresize',
149:         'autoplay', 'controls', 'loop', 'muted', 'required', 'novalidate', 'formnovalidate'
150:     );
151: 
152: /**
153:  * Format to attribute
154:  *
155:  * @var string
156:  */
157:     protected $_attributeFormat = '%s="%s"';
158: 
159: /**
160:  * Format to attribute
161:  *
162:  * @var string
163:  */
164:     protected $_minimizedAttributeFormat = '%s="%s"';
165: 
166: /**
167:  * Default Constructor
168:  *
169:  * @param View $View The View this helper is being attached to.
170:  * @param array $settings Configuration settings for the helper.
171:  */
172:     public function __construct(View $View, $settings = array()) {
173:         $this->_View = $View;
174:         $this->request = $View->request;
175:         if ($settings) {
176:             $this->settings = Hash::merge($this->settings, $settings);
177:         }
178:         if (!empty($this->helpers)) {
179:             $this->_helperMap = ObjectCollection::normalizeObjectArray($this->helpers);
180:         }
181:     }
182: 
183: /**
184:  * Provide non fatal errors on missing method calls.
185:  *
186:  * @param string $method Method to invoke
187:  * @param array $params Array of params for the method.
188:  * @return void
189:  */
190:     public function __call($method, $params) {
191:         trigger_error(__d('cake_dev', 'Method %1$s::%2$s does not exist', get_class($this), $method), E_USER_WARNING);
192:     }
193: 
194: /**
195:  * Lazy loads helpers. Provides access to deprecated request properties as well.
196:  *
197:  * @param string $name Name of the property being accessed.
198:  * @return mixed Helper or property found at $name
199:  */
200:     public function __get($name) {
201:         if (isset($this->_helperMap[$name]) && !isset($this->{$name})) {
202:             $settings = array_merge((array)$this->_helperMap[$name]['settings'], array('enabled' => false));
203:             $this->{$name} = $this->_View->loadHelper($this->_helperMap[$name]['class'], $settings);
204:         }
205:         if (isset($this->{$name})) {
206:             return $this->{$name};
207:         }
208:         switch ($name) {
209:             case 'base':
210:             case 'here':
211:             case 'webroot':
212:             case 'data':
213:                 return $this->request->{$name};
214:             case 'action':
215:                 return isset($this->request->params['action']) ? $this->request->params['action'] : '';
216:             case 'params':
217:                 return $this->request;
218:         }
219:     }
220: 
221: /**
222:  * Provides backwards compatibility access for setting values to the request object.
223:  *
224:  * @param string $name Name of the property being accessed.
225:  * @param mixed $value
226:  * @return void
227:  */
228:     public function __set($name, $value) {
229:         switch ($name) {
230:             case 'base':
231:             case 'here':
232:             case 'webroot':
233:             case 'data':
234:                 $this->request->{$name} = $value;
235:                 return;
236:             case 'action':
237:                 $this->request->params['action'] = $value;
238:                 return;
239:         }
240:         $this->{$name} = $value;
241:     }
242: 
243: /**
244:  * Finds URL for specified action.
245:  *
246:  * Returns an URL pointing at the provided parameters.
247:  *
248:  * @param string|array $url Either a relative string url like `/products/view/23` or
249:  *    an array of url parameters. Using an array for URLs will allow you to leverage
250:  *    the reverse routing features of CakePHP.
251:  * @param boolean $full If true, the full base URL will be prepended to the result
252:  * @return string Full translated URL with base path.
253:  * @link http://book.cakephp.org/2.0/en/views/helpers.html
254:  */
255:     public function url($url = null, $full = false) {
256:         return h(Router::url($url, $full));
257:     }
258: 
259: /**
260:  * Checks if a file exists when theme is used, if no file is found default location is returned
261:  *
262:  * @param string $file The file to create a webroot path to.
263:  * @return string Web accessible path to file.
264:  */
265:     public function webroot($file) {
266:         $asset = explode('?', $file);
267:         $asset[1] = isset($asset[1]) ? '?' . $asset[1] : null;
268:         $webPath = "{$this->request->webroot}" . $asset[0];
269:         $file = $asset[0];
270: 
271:         if (!empty($this->theme)) {
272:             $file = trim($file, '/');
273:             $theme = $this->theme . '/';
274: 
275:             if (DS === '\\') {
276:                 $file = str_replace('/', '\\', $file);
277:             }
278: 
279:             if (file_exists(Configure::read('App.www_root') . 'theme' . DS . $this->theme . DS . $file)) {
280:                 $webPath = "{$this->request->webroot}theme/" . $theme . $asset[0];
281:             } else {
282:                 $themePath = App::themePath($this->theme);
283:                 $path = $themePath . 'webroot' . DS . $file;
284:                 if (file_exists($path)) {
285:                     $webPath = "{$this->request->webroot}theme/" . $theme . $asset[0];
286:                 }
287:             }
288:         }
289:         if (strpos($webPath, '//') !== false) {
290:             return str_replace('//', '/', $webPath . $asset[1]);
291:         }
292:         return $webPath . $asset[1];
293:     }
294: 
295: /**
296:  * Generate url for given asset file. Depending on options passed provides full url with domain name.
297:  * Also calls Helper::assetTimestamp() to add timestamp to local files
298:  *
299:  * @param string|array Path string or url array
300:  * @param array $options Options array. Possible keys:
301:  *   `fullBase` Return full url with domain name
302:  *   `pathPrefix` Path prefix for relative URLs
303:  *   `ext` Asset extension to append
304:  *   `plugin` False value will prevent parsing path as a plugin
305:  * @return string Generated url
306:  */
307:     public function assetUrl($path, $options = array()) {
308:         if (is_array($path)) {
309:             return $this->url($path, !empty($options['fullBase']));
310:         }
311:         if (strpos($path, '://') !== false) {
312:             return $path;
313:         }
314:         if (!array_key_exists('plugin', $options) || $options['plugin'] !== false) {
315:             list($plugin, $path) = $this->_View->pluginSplit($path, false);
316:         }
317:         if (!empty($options['pathPrefix']) && $path[0] !== '/') {
318:             $path = $options['pathPrefix'] . $path;
319:         }
320:         if (
321:             !empty($options['ext']) &&
322:             strpos($path, '?') === false &&
323:             substr($path, -strlen($options['ext'])) !== $options['ext']
324:         ) {
325:             $path .= $options['ext'];
326:         }
327:         if (isset($plugin)) {
328:             $path = Inflector::underscore($plugin) . '/' . $path;
329:         }
330:         $path = $this->_encodeUrl($this->assetTimestamp($this->webroot($path)));
331: 
332:         if (!empty($options['fullBase'])) {
333:             $path = rtrim(FULL_BASE_URL, '/') . '/' . ltrim($path, '/');
334:         }
335:         return $path;
336:     }
337: 
338: /**
339:  * Encodes an URL for use in HTML attributes.
340:  *
341:  * @param string $url The url to encode.
342:  * @return string The url encoded for both URL & HTML contexts.
343:  */
344:     protected function _encodeUrl($url) {
345:         $path = parse_url($url, PHP_URL_PATH);
346:         $parts = array_map('urldecode', explode('/', $path));
347:         $parts = array_map('rawurlencode', $parts);
348:         $encoded = implode('/', $parts);
349:         return h(str_replace($path, $encoded, $url));
350:     }
351: 
352: /**
353:  * Adds a timestamp to a file based resource based on the value of `Asset.timestamp` in
354:  * Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp === 'force'
355:  * a timestamp will be added.
356:  *
357:  * @param string $path The file path to timestamp, the path must be inside WWW_ROOT
358:  * @return string Path with a timestamp added, or not.
359:  */
360:     public function assetTimestamp($path) {
361:         $stamp = Configure::read('Asset.timestamp');
362:         $timestampEnabled = $stamp === 'force' || ($stamp === true && Configure::read('debug') > 0);
363:         if ($timestampEnabled && strpos($path, '?') === false) {
364:             $filepath = preg_replace(
365:                 '/^' . preg_quote($this->request->webroot, '/') . '/',
366:                 '',
367:                 urldecode($path)
368:             );
369:             $webrootPath = WWW_ROOT . str_replace('/', DS, $filepath);
370:             if (file_exists($webrootPath)) {
371:                 //@codingStandardsIgnoreStart
372:                 return $path . '?' . @filemtime($webrootPath);
373:                 //@codingStandardsIgnoreEnd
374:             }
375:             $segments = explode('/', ltrim($filepath, '/'));
376:             if ($segments[0] === 'theme') {
377:                 $theme = $segments[1];
378:                 unset($segments[0], $segments[1]);
379:                 $themePath = App::themePath($theme) . 'webroot' . DS . implode(DS, $segments);
380:                 //@codingStandardsIgnoreStart
381:                 return $path . '?' . @filemtime($themePath);
382:                 //@codingStandardsIgnoreEnd
383:             } else {
384:                 $plugin = Inflector::camelize($segments[0]);
385:                 if (CakePlugin::loaded($plugin)) {
386:                     unset($segments[0]);
387:                     $pluginPath = CakePlugin::path($plugin) . 'webroot' . DS . implode(DS, $segments);
388:                     //@codingStandardsIgnoreStart
389:                     return $path . '?' . @filemtime($pluginPath);
390:                     //@codingStandardsIgnoreEnd
391:                 }
392:             }
393:         }
394:         return $path;
395:     }
396: 
397: /**
398:  * Used to remove harmful tags from content. Removes a number of well known XSS attacks
399:  * from content. However, is not guaranteed to remove all possibilities. Escaping
400:  * content is the best way to prevent all possible attacks.
401:  *
402:  * @param string|array $output Either an array of strings to clean or a single string to clean.
403:  * @return string|array cleaned content for output
404:  */
405:     public function clean($output) {
406:         $this->_reset();
407:         if (empty($output)) {
408:             return null;
409:         }
410:         if (is_array($output)) {
411:             foreach ($output as $key => $value) {
412:                 $return[$key] = $this->clean($value);
413:             }
414:             return $return;
415:         }
416:         $this->_tainted = $output;
417:         $this->_clean();
418:         return $this->_cleaned;
419:     }
420: 
421: /**
422:  * Returns a space-delimited string with items of the $options array. If a key
423:  * of $options array happens to be one of those listed in `Helper::$_minimizedAttributes`
424:  *
425:  * And its value is one of:
426:  *
427:  * - '1' (string)
428:  * - 1 (integer)
429:  * - true (boolean)
430:  * - 'true' (string)
431:  *
432:  * Then the value will be reset to be identical with key's name.
433:  * If the value is not one of these 3, the parameter is not output.
434:  *
435:  * 'escape' is a special option in that it controls the conversion of
436:  *  attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
437:  *
438:  * If value for any option key is set to `null` or `false`, that option will be excluded from output.
439:  *
440:  * @param array $options Array of options.
441:  * @param array $exclude Array of options to be excluded, the options here will not be part of the return.
442:  * @param string $insertBefore String to be inserted before options.
443:  * @param string $insertAfter String to be inserted after options.
444:  * @return string Composed attributes.
445:  * @deprecated This method will be moved to HtmlHelper in 3.0
446:  */
447:     protected function _parseAttributes($options, $exclude = null, $insertBefore = ' ', $insertAfter = null) {
448:         if (!is_string($options)) {
449:             $options = (array)$options + array('escape' => true);
450: 
451:             if (!is_array($exclude)) {
452:                 $exclude = array();
453:             }
454: 
455:             $exclude = array('escape' => true) + array_flip($exclude);
456:             $escape = $options['escape'];
457:             $attributes = array();
458: 
459:             foreach ($options as $key => $value) {
460:                 if (!isset($exclude[$key]) && $value !== false && $value !== null) {
461:                     $attributes[] = $this->_formatAttribute($key, $value, $escape);
462:                 }
463:             }
464:             $out = implode(' ', $attributes);
465:         } else {
466:             $out = $options;
467:         }
468:         return $out ? $insertBefore . $out . $insertAfter : '';
469:     }
470: 
471: /**
472:  * Formats an individual attribute, and returns the string value of the composed attribute.
473:  * Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
474:  *
475:  * @param string $key The name of the attribute to create
476:  * @param string $value The value of the attribute to create.
477:  * @param boolean $escape Define if the value must be escaped
478:  * @return string The composed attribute.
479:  * @deprecated This method will be moved to HtmlHelper in 3.0
480:  */
481:     protected function _formatAttribute($key, $value, $escape = true) {
482:         if (is_array($value)) {
483:             $value = implode(' ', $value);
484:         }
485:         if (is_numeric($key)) {
486:             return sprintf($this->_minimizedAttributeFormat, $value, $value);
487:         }
488:         $truthy = array(1, '1', true, 'true', $key);
489:         $isMinimized = in_array($key, $this->_minimizedAttributes);
490:         if ($isMinimized && in_array($value, $truthy, true)) {
491:             return sprintf($this->_minimizedAttributeFormat, $key, $key);
492:         }
493:         if ($isMinimized) {
494:             return '';
495:         }
496:         return sprintf($this->_attributeFormat, $key, ($escape ? h($value) : $value));
497:     }
498: 
499: /**
500:  * Sets this helper's model and field properties to the dot-separated value-pair in $entity.
501:  *
502:  * @param string $entity A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"
503:  * @param boolean $setScope Sets the view scope to the model specified in $tagValue
504:  * @return void
505:  */
506:     public function setEntity($entity, $setScope = false) {
507:         if ($entity === null) {
508:             $this->_modelScope = false;
509:         }
510:         if ($setScope === true) {
511:             $this->_modelScope = $entity;
512:         }
513:         $parts = array_values(Hash::filter(explode('.', $entity)));
514:         if (empty($parts)) {
515:             return;
516:         }
517:         $count = count($parts);
518:         $lastPart = isset($parts[$count - 1]) ? $parts[$count - 1] : null;
519: 
520:         // Either 'body' or 'date.month' type inputs.
521:         if (
522:             ($count === 1 && $this->_modelScope && !$setScope) ||
523:             (
524:                 $count === 2 &&
525:                 in_array($lastPart, $this->_fieldSuffixes) &&
526:                 $this->_modelScope &&
527:                 $parts[0] !== $this->_modelScope
528:             )
529:         ) {
530:             $entity = $this->_modelScope . '.' . $entity;
531:         }
532: 
533:         // 0.name, 0.created.month style inputs. Excludes inputs with the modelScope in them.
534:         if (
535:             $count >= 2 &&
536:             is_numeric($parts[0]) &&
537:             !is_numeric($parts[1]) &&
538:             $this->_modelScope &&
539:             strpos($entity, $this->_modelScope) === false
540:         ) {
541:             $entity = $this->_modelScope . '.' . $entity;
542:         }
543: 
544:         $this->_association = null;
545: 
546:         $isHabtm = (
547:             isset($this->fieldset[$this->_modelScope]['fields'][$parts[0]]['type']) &&
548:             $this->fieldset[$this->_modelScope]['fields'][$parts[0]]['type'] === 'multiple'
549:         );
550: 
551:         // habtm models are special
552:         if ($count === 1 && $isHabtm) {
553:             $this->_association = $parts[0];
554:             $entity = $parts[0] . '.' . $parts[0];
555:         } else {
556:             // check for associated model.
557:             $reversed = array_reverse($parts);
558:             foreach ($reversed as $i => $part) {
559:                 if ($i > 0 && preg_match('/^[A-Z]/', $part)) {
560:                     $this->_association = $part;
561:                     break;
562:                 }
563:             }
564:         }
565:         $this->_entityPath = $entity;
566:     }
567: 
568: /**
569:  * Returns the entity reference of the current context as an array of identity parts
570:  *
571:  * @return array An array containing the identity elements of an entity
572:  */
573:     public function entity() {
574:         return explode('.', $this->_entityPath);
575:     }
576: 
577: /**
578:  * Gets the currently-used model of the rendering context.
579:  *
580:  * @return string
581:  */
582:     public function model() {
583:         if ($this->_association) {
584:             return $this->_association;
585:         }
586:         return $this->_modelScope;
587:     }
588: 
589: /**
590:  * Gets the currently-used model field of the rendering context.
591:  * Strips off field suffixes such as year, month, day, hour, min, meridian
592:  * when the current entity is longer than 2 elements.
593:  *
594:  * @return string
595:  */
596:     public function field() {
597:         $entity = $this->entity();
598:         $count = count($entity);
599:         $last = $entity[$count - 1];
600:         if ($count > 2 && in_array($last, $this->_fieldSuffixes)) {
601:             $last = isset($entity[$count - 2]) ? $entity[$count - 2] : null;
602:         }
603:         return $last;
604:     }
605: 
606: /**
607:  * Generates a DOM ID for the selected element, if one is not set.
608:  * Uses the current View::entity() settings to generate a CamelCased id attribute.
609:  *
610:  * @param array|string $options Either an array of html attributes to add $id into, or a string
611:  *   with a view entity path to get a domId for.
612:  * @param string $id The name of the 'id' attribute.
613:  * @return mixed If $options was an array, an array will be returned with $id set. If a string
614:  *   was supplied, a string will be returned.
615:  */
616:     public function domId($options = null, $id = 'id') {
617:         if (is_array($options) && array_key_exists($id, $options) && $options[$id] === null) {
618:             unset($options[$id]);
619:             return $options;
620:         } elseif (!is_array($options) && $options !== null) {
621:             $this->setEntity($options);
622:             return $this->domId();
623:         }
624: 
625:         $entity = $this->entity();
626:         $model = array_shift($entity);
627:         $dom = $model . implode('', array_map(array('Inflector', 'camelize'), $entity));
628: 
629:         if (is_array($options) && !array_key_exists($id, $options)) {
630:             $options[$id] = $dom;
631:         } elseif ($options === null) {
632:             return $dom;
633:         }
634:         return $options;
635:     }
636: 
637: /**
638:  * Gets the input field name for the current tag. Creates input name attributes
639:  * using CakePHP's data[Model][field] formatting.
640:  *
641:  * @param array|string $options If an array, should be an array of attributes that $key needs to be added to.
642:  *   If a string or null, will be used as the View entity.
643:  * @param string $field
644:  * @param string $key The name of the attribute to be set, defaults to 'name'
645:  * @return mixed If an array was given for $options, an array with $key set will be returned.
646:  *   If a string was supplied a string will be returned.
647:  */
648:     protected function _name($options = array(), $field = null, $key = 'name') {
649:         if ($options === null) {
650:             $options = array();
651:         } elseif (is_string($options)) {
652:             $field = $options;
653:             $options = 0;
654:         }
655: 
656:         if (!empty($field)) {
657:             $this->setEntity($field);
658:         }
659: 
660:         if (is_array($options) && array_key_exists($key, $options)) {
661:             return $options;
662:         }
663: 
664:         switch ($field) {
665:             case '_method':
666:                 $name = $field;
667:                 break;
668:             default:
669:                 $name = 'data[' . implode('][', $this->entity()) . ']';
670:         }
671: 
672:         if (is_array($options)) {
673:             $options[$key] = $name;
674:             return $options;
675:         }
676:         return $name;
677:     }
678: 
679: /**
680:  * Gets the data for the current tag
681:  *
682:  * @param array|string $options If an array, should be an array of attributes that $key needs to be added to.
683:  *   If a string or null, will be used as the View entity.
684:  * @param string $field
685:  * @param string $key The name of the attribute to be set, defaults to 'value'
686:  * @return mixed If an array was given for $options, an array with $key set will be returned.
687:  *   If a string was supplied a string will be returned.
688:  */
689:     public function value($options = array(), $field = null, $key = 'value') {
690:         if ($options === null) {
691:             $options = array();
692:         } elseif (is_string($options)) {
693:             $field = $options;
694:             $options = 0;
695:         }
696: 
697:         if (is_array($options) && isset($options[$key])) {
698:             return $options;
699:         }
700: 
701:         if (!empty($field)) {
702:             $this->setEntity($field);
703:         }
704:         $result = null;
705:         $data = $this->request->data;
706: 
707:         $entity = $this->entity();
708:         if (!empty($data) && is_array($data) && !empty($entity)) {
709:             $result = Hash::get($data, implode('.', $entity));
710:         }
711: 
712:         $habtmKey = $this->field();
713:         if (empty($result) && isset($data[$habtmKey][$habtmKey]) && is_array($data[$habtmKey])) {
714:             $result = $data[$habtmKey][$habtmKey];
715:         } elseif (empty($result) && isset($data[$habtmKey]) && is_array($data[$habtmKey])) {
716:             if (ClassRegistry::isKeySet($habtmKey)) {
717:                 $model = ClassRegistry::getObject($habtmKey);
718:                 $result = $this->_selectedArray($data[$habtmKey], $model->primaryKey);
719:             }
720:         }
721: 
722:         if (is_array($options)) {
723:             if ($result === null && isset($options['default'])) {
724:                 $result = $options['default'];
725:             }
726:             unset($options['default']);
727:         }
728: 
729:         if (is_array($options)) {
730:             $options[$key] = $result;
731:             return $options;
732:         }
733:         return $result;
734:     }
735: 
736: /**
737:  * Sets the defaults for an input tag. Will set the
738:  * name, value, and id attributes for an array of html attributes.
739:  *
740:  * @param string $field The field name to initialize.
741:  * @param array $options Array of options to use while initializing an input field.
742:  * @return array Array options for the form input.
743:  */
744:     protected function _initInputField($field, $options = array()) {
745:         if ($field !== null) {
746:             $this->setEntity($field);
747:         }
748:         $options = (array)$options;
749:         $options = $this->_name($options);
750:         $options = $this->value($options);
751:         $options = $this->domId($options);
752:         return $options;
753:     }
754: 
755: /**
756:  * Adds the given class to the element options
757:  *
758:  * @param array $options Array options/attributes to add a class to
759:  * @param string $class The classname being added.
760:  * @param string $key the key to use for class.
761:  * @return array Array of options with $key set.
762:  */
763:     public function addClass($options = array(), $class = null, $key = 'class') {
764:         if (isset($options[$key]) && trim($options[$key])) {
765:             $options[$key] .= ' ' . $class;
766:         } else {
767:             $options[$key] = $class;
768:         }
769:         return $options;
770:     }
771: 
772: /**
773:  * Returns a string generated by a helper method
774:  *
775:  * This method can be overridden in subclasses to do generalized output post-processing
776:  *
777:  * @param string $str String to be output.
778:  * @return string
779:  * @deprecated This method will be removed in future versions.
780:  */
781:     public function output($str) {
782:         return $str;
783:     }
784: 
785: /**
786:  * Before render callback. beforeRender is called before the view file is rendered.
787:  *
788:  * Overridden in subclasses.
789:  *
790:  * @param string $viewFile The view file that is going to be rendered
791:  * @return void
792:  */
793:     public function beforeRender($viewFile) {
794:     }
795: 
796: /**
797:  * After render callback. afterRender is called after the view file is rendered
798:  * but before the layout has been rendered.
799:  *
800:  * Overridden in subclasses.
801:  *
802:  * @param string $viewFile The view file that was rendered.
803:  * @return void
804:  */
805:     public function afterRender($viewFile) {
806:     }
807: 
808: /**
809:  * Before layout callback. beforeLayout is called before the layout is rendered.
810:  *
811:  * Overridden in subclasses.
812:  *
813:  * @param string $layoutFile The layout about to be rendered.
814:  * @return void
815:  */
816:     public function beforeLayout($layoutFile) {
817:     }
818: 
819: /**
820:  * After layout callback. afterLayout is called after the layout has rendered.
821:  *
822:  * Overridden in subclasses.
823:  *
824:  * @param string $layoutFile The layout file that was rendered.
825:  * @return void
826:  */
827:     public function afterLayout($layoutFile) {
828:     }
829: 
830: /**
831:  * Before render file callback.
832:  * Called before any view fragment is rendered.
833:  *
834:  * Overridden in subclasses.
835:  *
836:  * @param string $viewFile The file about to be rendered.
837:  * @return void
838:  */
839:     public function beforeRenderFile($viewFile) {
840:     }
841: 
842: /**
843:  * After render file callback.
844:  * Called after any view fragment is rendered.
845:  *
846:  * Overridden in subclasses.
847:  *
848:  * @param string $viewFile The file just be rendered.
849:  * @param string $content The content that was rendered.
850:  * @return void
851:  */
852:     public function afterRenderFile($viewFile, $content) {
853:     }
854: 
855: /**
856:  * Transforms a recordset from a hasAndBelongsToMany association to a list of selected
857:  * options for a multiple select element
858:  *
859:  * @param string|array $data
860:  * @param string $key
861:  * @return array
862:  */
863:     protected function _selectedArray($data, $key = 'id') {
864:         if (!is_array($data)) {
865:             $model = $data;
866:             if (!empty($this->request->data[$model][$model])) {
867:                 return $this->request->data[$model][$model];
868:             }
869:             if (!empty($this->request->data[$model])) {
870:                 $data = $this->request->data[$model];
871:             }
872:         }
873:         $array = array();
874:         if (!empty($data)) {
875:             foreach ($data as $row) {
876:                 if (isset($row[$key])) {
877:                     $array[$row[$key]] = $row[$key];
878:                 }
879:             }
880:         }
881:         return empty($array) ? null : $array;
882:     }
883: 
884: /**
885:  * Resets the vars used by Helper::clean() to null
886:  *
887:  * @return void
888:  */
889:     protected function _reset() {
890:         $this->_tainted = null;
891:         $this->_cleaned = null;
892:     }
893: 
894: /**
895:  * Removes harmful content from output
896:  *
897:  * @return void
898:  */
899:     protected function _clean() {
900:         if (get_magic_quotes_gpc()) {
901:             $this->_cleaned = stripslashes($this->_tainted);
902:         } else {
903:             $this->_cleaned = $this->_tainted;
904:         }
905: 
906:         $this->_cleaned = str_replace(array("&amp;", "&lt;", "&gt;"), array("&amp;amp;", "&amp;lt;", "&amp;gt;"), $this->_cleaned);
907:         $this->_cleaned = preg_replace('#(&\#*\w+)[\x00-\x20]+;#u', "$1;", $this->_cleaned);
908:         $this->_cleaned = preg_replace('#(&\#x*)([0-9A-F]+);*#iu', "$1$2;", $this->_cleaned);
909:         $this->_cleaned = html_entity_decode($this->_cleaned, ENT_COMPAT, "UTF-8");
910:         $this->_cleaned = preg_replace('#(<[^>]+[\x00-\x20\"\'\/])(on|xmlns)[^>]*>#iUu', "$1>", $this->_cleaned);
911:         $this->_cleaned = preg_replace('#([a-z]*)[\x00-\x20]*=[\x00-\x20]*([\`\'\"]*)[\\x00-\x20]*j[\x00-\x20]*a[\x00-\x20]*v[\x00-\x20]*a[\x00-\x20]*s[\x00-\x20]*c[\x00-\x20]*r[\x00-\x20]*i[\x00-\x20]*p[\x00-\x20]*t[\x00-\x20]*:#iUu', '$1=$2nojavascript...', $this->_cleaned);
912:         $this->_cleaned = preg_replace('#([a-z]*)[\x00-\x20]*=([\'\"]*)[\x00-\x20]*v[\x00-\x20]*b[\x00-\x20]*s[\x00-\x20]*c[\x00-\x20]*r[\x00-\x20]*i[\x00-\x20]*p[\x00-\x20]*t[\x00-\x20]*:#iUu', '$1=$2novbscript...', $this->_cleaned);
913:         $this->_cleaned = preg_replace('#([a-z]*)[\x00-\x20]*=*([\'\"]*)[\x00-\x20]*-moz-binding[\x00-\x20]*:#iUu', '$1=$2nomozbinding...', $this->_cleaned);
914:         $this->_cleaned = preg_replace('#([a-z]*)[\x00-\x20]*=([\'\"]*)[\x00-\x20]*data[\x00-\x20]*:#Uu', '$1=$2nodata...', $this->_cleaned);
915:         $this->_cleaned = preg_replace('#(<[^>]+)style[\x00-\x20]*=[\x00-\x20]*([\`\'\"]*).*expression[\x00-\x20]*\([^>]*>#iU', "$1>", $this->_cleaned);
916:         $this->_cleaned = preg_replace('#(<[^>]+)style[\x00-\x20]*=[\x00-\x20]*([\`\'\"]*).*behaviour[\x00-\x20]*\([^>]*>#iU', "$1>", $this->_cleaned);
917:         $this->_cleaned = preg_replace('#(<[^>]+)style[\x00-\x20]*=[\x00-\x20]*([\`\'\"]*).*s[\x00-\x20]*c[\x00-\x20]*r[\x00-\x20]*i[\x00-\x20]*p[\x00-\x20]*t[\x00-\x20]*:*[^>]*>#iUu', "$1>", $this->_cleaned);
918:         $this->_cleaned = preg_replace('#</*\w+:\w[^>]*>#i', "", $this->_cleaned);
919:         do {
920:             $oldstring = $this->_cleaned;
921:             $this->_cleaned = preg_replace('#</*(applet|meta|xml|blink|link|style|script|embed|object|iframe|frame|frameset|ilayer|layer|bgsound|title|base)[^>]*>#i', "", $this->_cleaned);
922:         } while ($oldstring !== $this->_cleaned);
923:         $this->_cleaned = str_replace(array("&amp;", "&lt;", "&gt;"), array("&amp;amp;", "&amp;lt;", "&amp;gt;"), $this->_cleaned);
924:     }
925: 
926: }
927: