Skip to content
Permalink
Browse files

Updating mixed @param documentation to seperate list of accepted types

  • Loading branch information...
Jelle Henkens
Jelle Henkens committed May 13, 2012
1 parent e58e3c5 commit f7ce5262b7779de5a6e4403e4597416754bb4b38
Showing with 462 additions and 462 deletions.
  1. +1 −1 lib/Cake/Cache/Cache.php
  2. +1 −1 lib/Cake/Cache/CacheEngine.php
  3. +1 −1 lib/Cake/Cache/Engine/FileEngine.php
  4. +1 −1 lib/Cake/Console/Command/AclShell.php
  5. +2 −2 lib/Cake/Console/Command/Task/ModelTask.php
  6. +1 −1 lib/Cake/Console/Command/Task/TemplateTask.php
  7. +4 −4 lib/Cake/Console/Command/TestShell.php
  8. +2 −2 lib/Cake/Console/Command/UpgradeShell.php
  9. +1 −1 lib/Cake/Console/ConsoleInputArgument.php
  10. +1 −1 lib/Cake/Console/ConsoleInputOption.php
  11. +2 −2 lib/Cake/Console/ConsoleInputSubcommand.php
  12. +5 −5 lib/Cake/Console/ConsoleOptionParser.php
  13. +2 −2 lib/Cake/Console/ConsoleOutput.php
  14. +5 −5 lib/Cake/Console/Shell.php
  15. +1 −1 lib/Cake/Console/Templates/skel/Controller/PagesController.php
  16. +2 −2 lib/Cake/Controller/Component/Acl/PhpAcl.php
  17. +14 −14 lib/Cake/Controller/Component/AclComponent.php
  18. +2 −2 lib/Cake/Controller/Component/Auth/BaseAuthorize.php
  19. +1 −1 lib/Cake/Controller/Component/Auth/ControllerAuthorize.php
  20. +5 −5 lib/Cake/Controller/Component/AuthComponent.php
  21. +4 −4 lib/Cake/Controller/Component/CookieComponent.php
  22. +1 −1 lib/Cake/Controller/Component/EmailComponent.php
  23. +3 −3 lib/Cake/Controller/Component/PaginatorComponent.php
  24. +10 −10 lib/Cake/Controller/Component/RequestHandlerComponent.php
  25. +13 −13 lib/Cake/Controller/Controller.php
  26. +4 −4 lib/Cake/Core/App.php
  27. +1 −1 lib/Cake/Core/CakePlugin.php
  28. +1 −1 lib/Cake/Core/Object.php
  29. +1 −1 lib/Cake/Error/exceptions.php
  30. +2 −2 lib/Cake/Event/CakeEventManager.php
  31. +4 −4 lib/Cake/I18n/L10n.php
  32. +2 −2 lib/Cake/Log/CakeLog.php
  33. +1 −1 lib/Cake/Model/AclNode.php
  34. +1 −1 lib/Cake/Model/Behavior/AclBehavior.php
  35. +1 −1 lib/Cake/Model/Behavior/ContainableBehavior.php
  36. +2 −2 lib/Cake/Model/Behavior/TranslateBehavior.php
  37. +12 −12 lib/Cake/Model/Behavior/TreeBehavior.php
  38. +3 −3 lib/Cake/Model/CakeSchema.php
  39. +1 −1 lib/Cake/Model/ConnectionManager.php
  40. +2 −2 lib/Cake/Model/Datasource/CakeSession.php
  41. +2 −2 lib/Cake/Model/Datasource/Database/Postgres.php
  42. +1 −1 lib/Cake/Model/Datasource/Database/Sqlite.php
  43. +1 −1 lib/Cake/Model/Datasource/Database/Sqlserver.php
  44. +4 −4 lib/Cake/Model/Datasource/DboSource.php
  45. +1 −1 lib/Cake/Model/Datasource/Session/CacheSession.php
  46. +1 −1 lib/Cake/Model/Datasource/Session/CakeSessionHandlerInterface.php
  47. +1 −1 lib/Cake/Model/Datasource/Session/DatabaseSession.php
  48. +15 −15 lib/Cake/Model/Model.php
  49. +2 −2 lib/Cake/Model/Validator/CakeValidationSet.php
  50. +9 −9 lib/Cake/Network/CakeResponse.php
  51. +53 −53 lib/Cake/Network/Email/CakeEmail.php
  52. +1 −1 lib/Cake/Network/Email/SmtpTransport.php
  53. +5 −5 lib/Cake/Network/Http/HttpResponse.php
  54. +15 −15 lib/Cake/Network/Http/HttpSocket.php
  55. +4 −4 lib/Cake/Routing/Router.php
  56. +2 −2 lib/Cake/Test/Case/Console/ShellDispatcherTest.php
  57. +1 −1 lib/Cake/Test/Case/Controller/Component/Acl/DbAclTest.php
  58. +2 −2 lib/Cake/Test/Case/Controller/Component/AuthComponentTest.php
  59. +1 −1 lib/Cake/Test/Case/Controller/Component/CookieComponentTest.php
  60. +1 −1 lib/Cake/Test/Case/Controller/Component/SecurityComponentTest.php
  61. +2 −2 lib/Cake/Test/Case/Controller/ComponentTest.php
  62. +1 −1 lib/Cake/Test/Case/Controller/ControllerTest.php
  63. +1 −1 lib/Cake/Test/Case/Model/AclNodeTest.php
  64. +21 −21 lib/Cake/Test/Case/Model/BehaviorCollectionTest.php
  65. +4 −4 lib/Cake/Test/Case/Model/Datasource/Database/MysqlTest.php
  66. +6 −6 lib/Cake/Test/Case/Model/models.php
  67. +1 −1 lib/Cake/Test/Case/Network/CakeRequestTest.php
  68. +1 −1 lib/Cake/Test/Case/Network/Http/HttpResponseTest.php
  69. +4 −4 lib/Cake/Test/Case/Network/Http/HttpSocketTest.php
  70. +8 −7 lib/Cake/Test/Case/Routing/DispatcherTest.php
  71. +1 −1 lib/Cake/Test/Case/View/ScaffoldViewTest.php
  72. +3 −3 lib/Cake/Test/Case/View/ThemeViewTest.php
  73. +5 −5 lib/Cake/Test/Case/View/ViewTest.php
  74. +1 −1 lib/Cake/TestSuite/Fixture/CakeTestModel.php
  75. +26 −27 lib/Cake/Utility/CakeTime.php
  76. +3 −3 lib/Cake/Utility/ClassRegistry.php
  77. +2 −2 lib/Cake/Utility/File.php
  78. +4 −4 lib/Cake/Utility/Folder.php
  79. +6 −6 lib/Cake/Utility/Hash.php
  80. +1 −1 lib/Cake/Utility/ObjectCollection.php
  81. +2 −2 lib/Cake/Utility/Sanitize.php
  82. +17 −17 lib/Cake/Utility/Set.php
  83. +1 −1 lib/Cake/Utility/String.php
  84. +17 −17 lib/Cake/Utility/Validation.php
  85. +1 −1 lib/Cake/Utility/Xml.php
  86. +7 −7 lib/Cake/View/Helper.php
  87. +7 −7 lib/Cake/View/Helper/FormHelper.php
  88. +9 −9 lib/Cake/View/Helper/HtmlHelper.php
  89. +1 −1 lib/Cake/View/Helper/JqueryEngineHelper.php
  90. +2 −2 lib/Cake/View/Helper/JsBaseEngineHelper.php
  91. +3 −3 lib/Cake/View/Helper/JsHelper.php
  92. +1 −1 lib/Cake/View/Helper/MootoolsEngineHelper.php
  93. +12 −12 lib/Cake/View/Helper/PaginatorHelper.php
  94. +1 −1 lib/Cake/View/Helper/PrototypeEngineHelper.php
  95. +5 −5 lib/Cake/View/Helper/RssHelper.php
  96. +26 −26 lib/Cake/View/Helper/TimeHelper.php
  97. +2 −2 lib/Cake/View/View.php
  98. +2 −2 lib/Cake/basics.php
@@ -213,7 +213,7 @@ public static function drop($name) {
*
* `Cache::set(null, 'my_config');`
*
* @param mixed $settings Optional string for simple name-value pair or array
* @param string|array $settings Optional string for simple name-value pair or array
* @param string $value Optional for a simple name-value pair
* @param string $config The configuration name you are changing. Defaults to 'default'
* @return array Array of settings.
@@ -77,7 +77,7 @@ public function gc($expires = null) {
*
* @param string $key Identifier for the data
* @param mixed $value Data to be cached
* @param mixed $duration How long to cache for.
* @param integer $duration How long to cache for.
* @return boolean True if the data was successfully cached, false on failure
*/
abstract public function write($key, $value, $duration);
@@ -106,7 +106,7 @@ public function gc($expires = null) {
*
* @param string $key Identifier for the data
* @param mixed $data Data to be cached
* @param mixed $duration How long to cache the data, in seconds
* @param integer $duration How long to cache the data, in seconds
* @return boolean True if the data was successfully cached, false on failure
*/
public function write($key, $data, $duration) {
@@ -549,7 +549,7 @@ public function parseIdentifier($identifier) {
* or an array of properties to use in AcoNode::node()
*
* @param string $class Class type you want (Aro/Aco)
* @param mixed $identifier A mixed identifier for finding the node.
* @param string|array $identifier A mixed identifier for finding the node.
* @return integer Integer of NodeId. Will trigger an error if nothing is found.
*/
protected function _getNodeId($class, $identifier) {
@@ -765,8 +765,8 @@ protected function _generatePossibleKeys() {
/**
* Assembles and writes a Model file.
*
* @param mixed $name Model name or object
* @param mixed $data if array and $name is not an object assume bake data, otherwise boolean.
* @param string|object $name Model name or object
* @param array|boolean $data if array and $name is not an object assume bake data, otherwise boolean.
* @return string
*/
public function bake($name, $data = array()) {
@@ -108,7 +108,7 @@ protected function _findThemes() {
* Set variable values to the template scope
*
* @param string|array $one A string or an array of data.
* @param mixed $two Value in case $one is a string (which then works as the key).
* @param string|array $two Value in case $one is a string (which then works as the key).
* Unused if $one is an associative array, otherwise serves as the values to $one's keys.
* @return void
*/
@@ -334,9 +334,9 @@ public function available() {
/**
* Find the test case for the passed file. The file could itself be a test.
*
* @param mixed $file
* @param mixed $category
* @param mixed $throwOnMissingFile
* @param string $file
* @param string $category
* @param boolean $throwOnMissingFile
* @access protected
* @return array(type, case)
* @throws Exception
@@ -412,7 +412,7 @@ protected function _mapFileToCase($file, $category, $throwOnMissingFile = true)
/**
* For the given file, what category of test is it? returns app, core or the name of the plugin
*
* @param mixed $file
* @param string $file
* @access protected
* @return string
*/
@@ -634,8 +634,8 @@ protected function _moveAppClasses() {
* Find all php files in the folder (honoring recursive) and determine where cake expects the file to be
* If the file is not exactly where cake expects it - move it.
*
* @param mixed $path
* @param mixed $options array(recursive, checkFolder)
* @param string $path
* @param array $options array(recursive, checkFolder)
* @return void
*/
protected function _movePhpFiles($path, $options) {
@@ -55,7 +55,7 @@ class ConsoleInputArgument {
/**
* Make a new Input Argument
*
* @param mixed $name The long name of the option, or an array with all the properties.
* @param string|array $name The long name of the option, or an array with all the properties.
* @param string $help The help text for this option
* @param boolean $required Whether this argument is required. Missing required args will trigger exceptions
* @param array $choices Valid choices for this option.
@@ -70,7 +70,7 @@ class ConsoleInputOption {
/**
* Make a new Input Option
*
* @param mixed $name The long name of the option, or an array with all the properties.
* @param string|array $name The long name of the option, or an array with all the properties.
* @param string $short The short alias for this option
* @param string $help The help text for this option
* @param boolean $boolean Whether this option is a boolean option. Boolean options don't consume extra tokens
@@ -49,9 +49,9 @@ class ConsoleInputSubcommand {
/**
* Make a new Subcommand
*
* @param mixed $name The long name of the subcommand, or an array with all the properties.
* @param string|array $name The long name of the subcommand, or an array with all the properties.
* @param string $help The help text for this option
* @param mixed $parser A parser for this subcommand. Either a ConsoleOptionParser, or an array that can be
* @param ConsoleOptionParser|array $parser A parser for this subcommand. Either a ConsoleOptionParser, or an array that can be
* used with ConsoleOptionParser::buildFromArray()
*/
public function __construct($name, $help = '', $parser = null) {
@@ -232,7 +232,7 @@ public function command($text = null) {
/**
* Get or set the description text for shell/task.
*
* @param mixed $text The text to set, or null if you want to read. If an array the
* @param string|array $text The text to set, or null if you want to read. If an array the
* text will be imploded with "\n"
* @return mixed If reading, the value of the description. If setting $this will be returned
*/
@@ -251,7 +251,7 @@ public function description($text = null) {
* Get or set an epilog to the parser. The epilog is added to the end of
* the options and arguments listing when help is generated.
*
* @param mixed $text Text when setting or null when reading. If an array the text will be imploded with "\n"
* @param string|array $text Text when setting or null when reading. If an array the text will be imploded with "\n"
* @return mixed If reading, the value of the epilog. If setting $this will be returned.
*/
public function epilog($text = null) {
@@ -282,7 +282,7 @@ public function epilog($text = null) {
* - `choices` A list of valid choices for this option. If left empty all values are valid..
* An exception will be raised when parse() encounters an invalid value.
*
* @param mixed $name The long name you want to the value to be parsed out as when options are parsed.
* @param ConsoleInputOption|string $name The long name you want to the value to be parsed out as when options are parsed.
* Will also accept an instance of ConsoleInputOption
* @param array $options An array of parameters that define the behavior of the option
* @return ConsoleOptionParser $this.
@@ -323,7 +323,7 @@ public function addOption($name, $options = array()) {
* - `choices` A list of valid choices for this argument. If left empty all values are valid..
* An exception will be raised when parse() encounters an invalid value.
*
* @param mixed $name The name of the argument. Will also accept an instance of ConsoleInputArgument
* @param ConsoleInputArgument|string $name The name of the argument. Will also accept an instance of ConsoleInputArgument
* @param array $params Parameters for the argument, see above.
* @return ConsoleOptionParser $this.
*/
@@ -389,7 +389,7 @@ public function addOptions(array $options) {
* specific option parsers. When help is generated for a subcommand, if a parser is present
* it will be used.
*
* @param mixed $name Name of the subcommand. Will also accept an instance of ConsoleInputSubcommand
* @param ConsoleInputSubcommand|string $name Name of the subcommand. Will also accept an instance of ConsoleInputSubcommand
* @param array $options Array of params, see above.
* @return ConsoleOptionParser $this.
*/
@@ -156,7 +156,7 @@ public function __construct($stream = 'php://stdout') {
* Outputs a single or multiple messages to stdout. If no parameters
* are passed, outputs just a newline.
*
* @param mixed $message A string or a an array of strings to output
* @param string|array $message A string or a an array of strings to output
* @param integer $newlines Number of newlines to append
* @return integer Returns the number of bytes returned from writing to stdout.
*/
@@ -244,7 +244,7 @@ protected function _write($message) {
* `$this->output->styles('annoy', false);`
*
* @param string $style The style to get or create.
* @param mixed $definition The array definition of the style to change or create a style
* @param array $definition The array definition of the style to change or create a style
* or false to remove a style.
* @return mixed If you are getting styles, the style or null will be returned. If you are creating/modifying
* styles true will be returned.
@@ -454,7 +454,7 @@ public function __get($name) {
* Prompts the user for input, and returns it.
*
* @param string $prompt Prompt text.
* @param mixed $options Array or string of options.
* @param string|array $options Array or string of options.
* @param string $default Default input value.
* @return mixed Either the default value, or the user-provided input.
* @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::in
@@ -492,7 +492,7 @@ public function in($prompt, $options = null, $default = null) {
* Prompts the user for input, and returns it.
*
* @param string $prompt Prompt text.
* @param mixed $options Array or string of options.
* @param string|array $options Array or string of options.
* @param string $default Default input value.
* @return Either the default value, or the user-provided input.
*/
@@ -532,7 +532,7 @@ protected function _getInput($prompt, $options, $default) {
* - `indent` Indent the text with the string provided. Defaults to null.
*
* @param string $text Text the text to format.
* @param mixed $options Array of options to use, or an integer to wrap the text to.
* @param string|integer|array $options Array of options to use, or an integer to wrap the text to.
* @return string Wrapped / indented text
* @see String::wrap()
* @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::wrapText
@@ -552,7 +552,7 @@ public function wrapText($text, $options = array()) {
* present in most shells. Using Shell::QUIET for a message means it will always display.
* While using Shell::VERBOSE means it will only display when verbose output is toggled.
*
* @param mixed $message A string or a an array of strings to output
* @param string|array $message A string or a an array of strings to output
* @param integer $newlines Number of newlines to append
* @param integer $level The message's output level, see above.
* @return integer|boolean Returns the number of bytes returned from writing to stdout.
@@ -576,7 +576,7 @@ public function out($message = null, $newlines = 1, $level = Shell::NORMAL) {
* Outputs a single or multiple error messages to stderr. If no parameters
* are passed outputs just a newline.
*
* @param mixed $message A string or a an array of strings to output
* @param string|array $message A string or a an array of strings to output
* @param integer $newlines Number of newlines to append
* @return void
* @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::err
@@ -39,7 +39,7 @@ class PagesController extends AppController {
/**
* Displays a view
*
* @param mixed What page to display
* @param string What page to display
*/
public function display() {
$path = func_get_args();
@@ -403,7 +403,7 @@ public function __construct(array $aro = array(), array $map = array(), array $a
* index. The resulting array will contain a prioritized list of (list of) roles ordered from
* the most distant AROs to the requested one itself.
*
* @param mixed $aro An ARO identifier
* @param string|array $aro An ARO identifier
* @return array prioritized AROs
*/
public function roles($aro) {
@@ -429,7 +429,7 @@ public function roles($aro) {
* resolve an ARO identifier to an internal ARO string using
* the internal mapping information.
*
* @param mixed $aro ARO identifier (User.jeff, array('User' => ...), etc)
* @param string|array $aro ARO identifier (User.jeff, array('User' => ...), etc)
* @return string internal aro string (e.g. User/jeff, Role/default)
*/
public function resolve($aro) {
@@ -76,8 +76,8 @@ public function __construct(ComponentCollection $collection, $settings = array()
*
* Will call the initialize method on the adapter if setting a new one.
*
* @param mixed $adapter Instance of AclInterface or a string name of the class to use. (optional)
* @return mixed either null, or the adapter implementation.
* @param AclInterface|string $adapter Instance of AclInterface or a string name of the class to use. (optional)
* @return AclInterface|void either null, or the adapter implementation.
* @throws CakeException when the given class is not an instance of AclInterface
*/
public function adapter($adapter = null) {
@@ -99,8 +99,8 @@ public function adapter($adapter = null) {
* Pass-thru function for ACL check instance. Check methods
* are used to check whether or not an ARO can access an ACO
*
* @param mixed $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param mixed $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return boolean Success
*/
@@ -112,8 +112,8 @@ public function check($aro, $aco, $action = "*") {
* Pass-thru function for ACL allow instance. Allow methods
* are used to grant an ARO access to an ACO.
*
* @param mixed $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param mixed $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return boolean Success
*/
@@ -125,8 +125,8 @@ public function allow($aro, $aco, $action = "*") {
* Pass-thru function for ACL deny instance. Deny methods
* are used to remove permission from an ARO to access an ACO.
*
* @param mixed $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param mixed $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return boolean Success
*/
@@ -138,8 +138,8 @@ public function deny($aro, $aco, $action = "*") {
* Pass-thru function for ACL inherit instance. Inherit methods
* modify the permission for an ARO to be that of its parent object.
*
* @param mixed $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param mixed $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return boolean Success
*/
@@ -150,8 +150,8 @@ public function inherit($aro, $aco, $action = "*") {
/**
* Pass-thru function for ACL grant instance. An alias for AclComponent::allow()
*
* @param mixed $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param mixed $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return boolean Success
* @deprecated
@@ -164,8 +164,8 @@ public function grant($aro, $aco, $action = "*") {
/**
* Pass-thru function for ACL grant instance. An alias for AclComponent::deny()
*
* @param mixed $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param mixed $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return boolean Success
* @deprecated
@@ -85,7 +85,7 @@ public function __construct(ComponentCollection $collection, $settings = array()
/**
* Accessor to the controller object.
*
* @param mixed $controller null to get, a controller to set.
* @param Controller $controller null to get, a controller to set.
* @return mixed
* @throws CakeException
*/
@@ -139,7 +139,7 @@ public function action($request, $path = '/:plugin/:controller/:action') {
* permissions lookup. When using with DbAcl, you'll have to add additional _admin type columns
* to the `aros_acos` table.
*
* @param mixed $map Either an array of mappings, or undefined to get current values.
* @param array $map Either an array of mappings, or undefined to get current values.
* @return mixed Either the current mappings or null when setting.
* @see AuthComponent::mapActions()
*/
@@ -40,7 +40,7 @@ class ControllerAuthorize extends BaseAuthorize {
/**
* Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented.
*
* @param mixed $controller null to get, a controller to set.
* @param Controller $controller null to get, a controller to set.
* @return mixed
* @throws CakeException
*/
Oops, something went wrong.

0 comments on commit f7ce526

Please sign in to comment.
You can’t perform that action at this time.