Updating doc block on JavascriptHelper::object(). Thanks BrendonKox. Fixes #6540.

git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@8266 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
mark_story 2009-08-01 06:24:55 +00:00
parent 76e50ef625
commit 878f3367d4

View file

@ -572,6 +572,15 @@ class JavascriptHelper extends AppHelper {
* Generates a JavaScript object in JavaScript Object Notation (JSON)
* from an array
*
* ### Options
*
* - block - Wraps the return value in a script tag if true. Default is false
* - prefix - Prepends the string to the returned data. Default is ''
* - postfix - Appends the string to the returned data. Default is ''
* - stringKeys - A list of array keys to be treated as a string.
* - quoteKeys - If false treats $stringKeys as a list of keys **not** to be quoted. Default is true.
* - q - The type of quote to use. Default is "'"
*
* @param array $data Data to be converted
* @param array $options Set of options: block, prefix, postfix, stringKeys, quoteKeys, q
* @param string $prefix DEPRECATED, use $options['prefix'] instead. Prepends the string to the returned data