cakephp / cakephp

src/Filesystem/Folder.php

Doc Comments +5 added lines, -5 removed lines

@@ -131,7 +131,7 @@ 
      *
      * @param string|null $path Path to folder
      * @param bool $create Create folder if not found
-     * @param int|false $mode Mode (CHMOD) to apply to created folder, false to ignore
+     * @param integer $mode Mode (CHMOD) to apply to created folder, false to ignore
      */
     public function __construct($path = null, $create = false, $mode = false)
     {
@@ -167,7 +167,7 @@ 
      * Change directory to $path.
      *
      * @param string $path Path to the directory to change to
-     * @return string|bool The new path. Returns false on failure
+     * @return string|false The new path. Returns false on failure
      */
     public function cd($path)
     {
@@ -185,7 +185,7 @@ 
      *
      * @param string|bool $sort Whether you want the results sorted, set this and the sort property
      *   to false to get unsorted results.
-     * @param array|bool $exceptions Either an array or boolean true will not grab dot files
+     * @param boolean $exceptions Either an array or boolean true will not grab dot files
      * @param bool $fullPath True returns the full path
      * @return array Contents of current directory as an array, an empty array on failure
      */
@@ -253,7 +253,7 @@ 
      *
      * @param string $regexpPattern Preg_match pattern (Defaults to: .*)
      * @param bool $sort Whether results should be sorted.
-     * @return array Files that match given pattern
+     * @return string[] Files that match given pattern
      */
     public function find($regexpPattern = '.*', $sort = false)
     {
@@ -536,7 +536,7 @@ 
      * Returns an array of nested directories and files in each directory
      *
      * @param string|null $path the directory path to build the tree from
-     * @param array|bool $exceptions Either an array of files/folder to exclude
+     * @param boolean $exceptions Either an array of files/folder to exclude
      *   or boolean true to not grab dot files/folders
      * @param string|null $type either 'file' or 'dir'. Null returns both files and directories
      * @return array Array of nested directories and files in each directory

src/Http/Client/FormData.php

Doc Comments +1 added lines, -1 removed lines

@@ -133,7 +133,7 @@
      * or a file handle.
      *
      * @param string $name The name to use.
-     * @param mixed $value Either a string filename, or a filehandle.
+     * @param resource $value Either a string filename, or a filehandle.
      * @return \Cake\Http\Client\FormDataPart
      */
     public function addFile($name, $value)

src/Http/Response.php

Doc Comments +5 added lines, -5 removed lines

@@ -843,7 +843,7 @@ 
      * if $content is null the current buffer is returned
      *
      * @param string|callable|null $content the string or callable message to be sent
-     * @return string|null Current message buffer if $content param is passed as null
+     * @return null|callable Current message buffer if $content param is passed as null
      * @deprecated 3.4.0 Mutable response methods are deprecated. Use `withBody()`/`withStringBody()` and `getBody()` instead.
      */
     public function body($content = null)
@@ -1577,7 +1577,7 @@ 
      * `$response->expires(new DateTime('+1 day'))` Will set the expiration in next 24 hours
      * `$response->expires()` Will return the current expiration header value
      *
-     * @param string|\DateTime|null $time Valid time string or \DateTime instance.
+     * @param integer $time Valid time string or \DateTime instance.
      * @return string|null
      * @deprecated 3.4.0 Use withExpires() instead.
      */
@@ -1613,7 +1613,7 @@ 
      * $response->withExpires(new DateTime('+1 day'))
      * ```
      *
-     * @param string|\DateTime $time Valid time string or \DateTime instance.
+     * @param integer $time Valid time string or \DateTime instance.
      * @return static
      */
     public function withExpires($time)
@@ -1633,7 +1633,7 @@ 
      * `$response->modified(new DateTime('+1 day'))` Will set the modification date in the past 24 hours
      * `$response->modified()` Will return the current Last-Modified header value
      *
-     * @param string|\DateTime|null $time Valid time string or \DateTime instance.
+     * @param string $time Valid time string or \DateTime instance.
      * @return string|null
      * @deprecated 3.4.0 Use withModified() instead.
      */
@@ -2769,7 +2769,7 @@ 
      * Stop execution of the current script. Wraps exit() making
      * testing easier.
      *
-     * @param int|string $status See https://secure.php.net/exit for values
+     * @param integer $status See https://secure.php.net/exit for values
      * @return void
      * @deprecated 3.4.0 Will be removed in 4.0.0
      */

src/Http/ServerRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -626,7 +626,7 @@ 
      *
      * @param string $name The method called
      * @param array $params Array of parameters for the method call
-     * @return mixed
+     * @return boolean
      * @throws \BadMethodCallException when an invalid method is called.
      */
     public function __call($name, $params)
@@ -2170,7 +2170,7 @@ 
      * Get the uploaded file from a dotted path.
      *
      * @param string $path The dot separated path to the file you want.
-     * @return null|\Psr\Http\Message\UploadedFileInterface
+     * @return null|UploadedFile
      */
     public function getUploadedFile($path)
     {

src/ORM/Association/BelongsToMany.php

Doc Comments +2 added lines, -1 removed lines

@@ -490,6 +490,7 @@ 
 
     /**
      * {@inheritDoc}
+     * @param Query $query
      */
     protected function _appendNotMatching($query, $options)
     {
@@ -1025,7 +1026,7 @@ 
      * Any string expressions, or expression objects will
      * also be returned in this list.
      *
-     * @return mixed Generally an array. If the conditions
+     * @return callable Generally an array. If the conditions
      *   are not an array, the association conditions will be
      *   returned unmodified.
      */

src/ORM/Exception/PersistenceFailedException.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
      * Constructor.
      *
      * @param \Cake\Datasource\EntityInterface $entity The entity on which the persistence operation failed
-     * @param string|array $message Either the string of the error message, or an array of attributes
+     * @param string[] $message Either the string of the error message, or an array of attributes
      *   that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
      * @param int $code The code of the error, is also the HTTP status code for the error.
      * @param \Exception|null $previous the previous exception.

src/ORM/Query.php

Doc Comments +2 added lines, -2 removed lines

@@ -414,11 +414,11 @@
      * previous list will be emptied.
      *
      * @param array|string|null $associations List of table aliases to be queried.
-     * @param callable|bool $override The query builder for the association, or
+     * @param boolean $override The query builder for the association, or
      *   if associations is an array, a bool on whether to override previous list
      *   with the one passed
      * defaults to merging previous list with the new one.
-     * @return array|$this
+     * @return Table
      */
     public function contain($associations = null, $override = false)
     {

src/View/Helper/FormHelper.php

Doc Comments +4 added lines, -4 removed lines

@@ -306,7 +306,7 @@ 
      *
      * @param \Cake\View\Widget\WidgetRegistry|null $instance The registry instance to set.
      * @param array $widgets An array of widgets
-     * @return \Cake\View\Widget\WidgetRegistry
+     * @return WidgetLocator
      * @deprecated 3.6.0 Use FormHelper::widgetLocator() instead.
      */
     public function widgetRegistry(WidgetRegistry $instance = null, $widgets = [])
@@ -391,7 +391,7 @@ 
      * - `valueSources` The sources that values should be read from. See FormHelper::setValueSources()
      * - `templateVars` Provide template variables for the formStart template.
      *
-     * @param mixed $context The context for which the form is being defined.
+     * @param false|null $context The context for which the form is being defined.
      *   Can be a ContextInterface instance, ORM entity, ORM resultset, or an
      *   array of meta data. You can use false or null to make a context-less form.
      * @param array $options An array of html attributes and options.
@@ -716,7 +716,7 @@ 
      *   or excluded as part of the unlockedFields.
      * @param string|array $field Reference to field to be secured. Can be dot
      *   separated string to indicate nesting or array of fieldname parts.
-     * @param mixed $value Field value, if value should not be tampered with.
+     * @param string $value Field value, if value should not be tampered with.
      * @return void
      */
     protected function _secure($lock, $field, $value = null)
@@ -1331,7 +1331,7 @@ 
      *
      * @param string $fieldName The name of the field to parse options for.
      * @param array $options Options list.
-     * @return array Options
+     * @return string Options
      */
     protected function _parseOptions($fieldName, $options)
     {

src/View/Helper/HtmlHelper.php

Doc Comments +2 added lines, -2 removed lines

@@ -227,9 +227,9 @@
      * - `block` - Set to true to append output to view block "meta" or provide
      *   custom block name.
      *
-     * @param string|array $type The title of the external resource, Or an array of attributes for a
+     * @param string $type The title of the external resource, Or an array of attributes for a
      *   custom meta tag.
-     * @param string|array|null $content The address of the external resource or string for content attribute
+     * @param string $content The address of the external resource or string for content attribute
      * @param array $options Other attributes for the generated tag. If the type attribute is html,
      *    rss, atom, or icon, the mime-type is returned.
      * @return string|null A completed `<link />` element, or null if the element was sent to a block.