Permalink
Browse files

Updating documentation.

  • Loading branch information...
1 parent 6bb53a5 commit fc4df2bb6445a2d9196c85e3dc5e7e72ca2da397 @markstory markstory committed Oct 17, 2009
Showing with 31 additions and 24 deletions.
  1. +31 −24 cake/libs/view/helper.php
View
55 cake/libs/view/helper.php
@@ -269,33 +269,38 @@ function clean($output) {
/**
* Returns a space-delimited string with items of the $options array. If a
* key of $options array happens to be one of:
- * + 'compact'
- * + 'checked'
- * + 'declare'
- * + 'readonly'
- * + 'disabled'
- * + 'selected'
- * + 'defer'
- * + 'ismap'
- * + 'nohref'
- * + 'noshade'
- * + 'nowrap'
- * + 'multiple'
- * + 'noresize'
+ *
+ * - 'compact'
+ * - 'checked'
+ * - 'declare'
+ * - 'readonly'
+ * - 'disabled'
+ * - 'selected'
+ * - 'defer'
+ * - 'ismap'
+ * - 'nohref'
+ * - 'noshade'
+ * - 'nowrap'
+ * - 'multiple'
+ * - 'noresize'
*
* And its value is one of:
- * + 1
- * + true
- * + 'true'
+ *
+ * - 1
+ * - true
+ * - 'true'
*
* Then the value will be reset to be identical with key's name.
* If the value is not one of these 3, the parameter is not output.
*
- * @param array $options Array of options.
- * @param array $exclude Array of options to be excluded.
- * @param string $insertBefore String to be inserted before options.
- * @param string $insertAfter String to be inserted ater options.
- * @return string
+ * 'escape' is a special option in that it controls the conversion of
+ * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
+ *
+ * @param array $options Array of options.
+ * @param array $exclude Array of options to be excluded, the options here will not be part of the return.
+ * @param string $insertBefore String to be inserted before options.
+ * @param string $insertAfter String to be inserted ater options.
+ * @return string Composed attributes.
*/
function _parseAttributes($options, $exclude = null, $insertBefore = ' ', $insertAfter = null) {
if (is_array($options)) {
@@ -320,9 +325,11 @@ function _parseAttributes($options, $exclude = null, $insertBefore = ' ', $inser
}
/**
- * @param string $key
- * @param string $value
- * @return string
+ * Formats an individual attribute, and returns the string value of the composed attribute.
+ *
+ * @param string $key The name of the attribute to create
+ * @param string $value The value of the attribute to create.
+ * @return string The composed attribute.
* @access private
*/
function __formatAttribute($key, $value, $escape = true) {

0 comments on commit fc4df2b

Please sign in to comment.