Updating documentation.

This commit is contained in:
mark_story 2009-10-16 22:53:38 -04:00
parent 6bb53a5c9d
commit fc4df2bb64

View file

@ -269,33 +269,38 @@ class Helper extends Overloadable {
/** /**
* Returns a space-delimited string with items of the $options array. If a * Returns a space-delimited string with items of the $options array. If a
* key of $options array happens to be one of: * key of $options array happens to be one of:
* + 'compact' *
* + 'checked' * - 'compact'
* + 'declare' * - 'checked'
* + 'readonly' * - 'declare'
* + 'disabled' * - 'readonly'
* + 'selected' * - 'disabled'
* + 'defer' * - 'selected'
* + 'ismap' * - 'defer'
* + 'nohref' * - 'ismap'
* + 'noshade' * - 'nohref'
* + 'nowrap' * - 'noshade'
* + 'multiple' * - 'nowrap'
* + 'noresize' * - 'multiple'
* - 'noresize'
* *
* And its value is one of: * And its value is one of:
* + 1 *
* + true * - 1
* + 'true' * - true
* - 'true'
* *
* Then the value will be reset to be identical with key's name. * 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. * If the value is not one of these 3, the parameter is not output.
* *
* @param array $options Array of options. * 'escape' is a special option in that it controls the conversion of
* @param array $exclude Array of options to be excluded. * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
* @param string $insertBefore String to be inserted before options. *
* @param string $insertAfter String to be inserted ater options. * @param array $options Array of options.
* @return string * @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) { function _parseAttributes($options, $exclude = null, $insertBefore = ' ', $insertAfter = null) {
if (is_array($options)) { if (is_array($options)) {
@ -320,9 +325,11 @@ class Helper extends Overloadable {
} }
/** /**
* @param string $key * Formats an individual attribute, and returns the string value of the composed attribute.
* @param string $value *
* @return string * @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 * @access private
*/ */
function __formatAttribute($key, $value, $escape = true) { function __formatAttribute($key, $value, $escape = true) {