cakephp / cakephp

src/Console/Shell.php

Doc Comments +4 added lines, -4 removed lines

@@ -624,7 +624,7 @@ 
      * Safely access the values in $this->params.
      *
      * @param string $name The name of the parameter to get.
-     * @return string|bool|null Value. Will return null if it doesn't exist.
+     * @return string|boolean Value. Will return null if it doesn't exist.
      */
     public function param($name)
     {
@@ -641,7 +641,7 @@ 
      * @param string $prompt Prompt text.
      * @param string|array|null $options Array or string of options.
      * @param string|null $default Default input value.
-     * @return mixed Either the default value, or the user-provided input.
+     * @return string|null Either the default value, or the user-provided input.
      * @link https://book.cakephp.org/3.0/en/console-and-shells.html#Shell::in
      */
     public function in($prompt, $options = null, $default = null)
@@ -680,7 +680,7 @@ 
     /**
      * Output at the verbose level.
      *
-     * @param string|array $message A string or an array of strings to output
+     * @param string $message A string or an array of strings to output
      * @param int $newlines Number of newlines to append
      * @return int|bool The number of bytes returned from writing to stdout.
      */
@@ -976,7 +976,7 @@ 
      * Stop execution of the current script.
      * Raises a StopException to try and halt the execution.
      *
-     * @param int|string $status see https://secure.php.net/exit for values
+     * @param integer $status see https://secure.php.net/exit for values
      * @throws \Cake\Console\Exception\StopException
      * @return void
      */

src/Controller/Component/RequestHandlerComponent.php

Doc Comments +4 added lines, -4 removed lines

@@ -314,7 +314,7 @@ 
      *   set that Content-type in the response header.
      *
      * @param \Cake\Event\Event $event The Controller.beforeRender event.
-     * @return bool false if the render process should be aborted
+     * @return false|null false if the render process should be aborted
      */
     public function beforeRender(Event $event)
     {
@@ -416,7 +416,7 @@ 
      *
      * Returns true if the client accepts xml.
      *
-     * @param string|array|null $type Can be null (or no parameter), a string type name, or an
+     * @param string $type Can be null (or no parameter), a string type name, or an
      *   array of types
      * @return mixed If null or no parameter is passed, returns an array of content
      *   types the client accepts. If a string is passed, returns true
@@ -500,7 +500,7 @@ 
      *
      * @param string|array|null $type An optional array of 'friendly' content-type names, i.e.
      *   'html', 'xml', 'js', etc.
-     * @return mixed If $type is null or not provided, the first content-type in the
+     * @return string If $type is null or not provided, the first content-type in the
      *    list, based on preference, is returned. If a single type is provided
      *    a boolean will be returned if that type is preferred.
      *    If an array of types are provided then the first preferred type is returned.
@@ -618,7 +618,7 @@ 
      * Sets the response header based on type map index name. This wraps several methods
      * available on Cake\Http\Response. It also allows you to use Content-Type aliases.
      *
-     * @param string|array $type Friendly type name, i.e. 'html' or 'xml', or a full content-type,
+     * @param string $type Friendly type name, i.e. 'html' or 'xml', or a full content-type,
      *    like 'application/x-shockwave'.
      * @param array $options If $type is a friendly type name that is associated with
      *    more than one type of content, $index is used to select which content-type to use.

src/Database/SchemaCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /**
      * Constructor
      *
-     * @param string|\Cake\Datasource\ConnectionInterface $connection Connection name to get the schema for or a connection instance
+     * @param \Cake\Datasource\ConnectionInterface $connection Connection name to get the schema for or a connection instance
      */
     public function __construct($connection)
     {

src/Http/Client/Adapter/Stream.php

Doc Comments +2 added lines, -2 removed lines

@@ -67,7 +67,7 @@ 
      *
      * @param \Cake\Http\Client\Request $request The request object to send.
      * @param array $options Array of options for the stream.
-     * @return array Array of populated Response objects
+     * @return Response[] Array of populated Response objects
      */
     public function send(Request $request, array $options)
     {
@@ -238,7 +238,7 @@ 
      * Open the stream and send the request.
      *
      * @param \Cake\Http\Client\Request $request The request object.
-     * @return array Array of populated Response objects
+     * @return Response[] Array of populated Response objects
      * @throws \Cake\Http\Exception\HttpException
      */
     protected function _send(Request $request)

src/Routing/Router.php

Doc Comments +1 added lines, -1 removed lines

@@ -393,7 +393,7 @@
      * Will accept either a Cake\Http\ServerRequest object or an array of arrays. Support for
      * accepting arrays may be removed in the future.
      *
-     * @param \Cake\Http\ServerRequest|array $request Parameters and path information or a Cake\Http\ServerRequest object.
+     * @param ServerRequest $request Parameters and path information or a Cake\Http\ServerRequest object.
      * @return void
      * @deprecatd 3.6.0 Support for arrays will be removed in 4.0.0
      */

src/Utility/Security.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
      * @param string|null $algorithm Hashing algo to use (i.e. sha1, sha256 etc.).
      *   Can be any valid algo included in list returned by hash_algos().
      *   If no value is passed the type specified by `Security::$hashType` is used.
-     * @param mixed $salt If true, automatically prepends the application's salt
+     * @param boolean $salt If true, automatically prepends the application's salt
      *   value to $string (Security.salt).
      * @return string Hash
      * @link https://book.cakephp.org/3.0/en/core-libraries/security.html#hashing-data

src/Core/functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -110,7 +110,7 @@ 
      * Commonly used like `list($namespace, $className) = namespaceSplit($class);`.
      *
      * @param string $class The full class name, ie `Cake\Core\App`.
-     * @return array Array with 2 indexes. 0 => namespace, 1 => classname.
+     * @return string[] Array with 2 indexes. 0 => namespace, 1 => classname.
      */
     function namespaceSplit($class)
     {
@@ -133,7 +133,7 @@ 
      *
      * This function returns the same variable that was passed.
      *
-     * @param mixed $var Variable to print out.
+     * @param string $var Variable to print out.
      * @return mixed the same $var that was passed to this function
      * @link https://book.cakephp.org/3.0/en/core-libraries/global-constants-and-functions.html#pr
      * @see debug()

src/Cache/Engine/FileEngine.php

Doc Comments +1 added lines, -1 removed lines

@@ -444,7 +444,7 @@
      * Generates a safe key for use with cache engine storage engines.
      *
      * @param string $key the key passed over
-     * @return mixed string $key or false
+     * @return false|string string $key or false
      */
     public function key($key)
     {

src/Database/Query.php

Doc Comments +4 added lines, -4 removed lines

@@ -392,7 +392,7 @@ 
      * $query->distinct('name', true);
      * ```
      *
-     * @param array|\Cake\Database\ExpressionInterface|string|bool $on Enable/disable distinct class
+     * @param boolean $on Enable/disable distinct class
      * or list of fields to be filtered on
      * @param bool $overwrite whether to reset fields with passed list or not
      * @return $this
@@ -1403,7 +1403,7 @@ 
      * $query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1)
      * ```
      *
-     * @param int|\Cake\Database\ExpressionInterface $num number of records to be returned
+     * @param null|integer $num number of records to be returned
      * @return $this
      */
     public function limit($num)
@@ -1501,7 +1501,7 @@ 
      *
      * `SELECT id, name FROM things d UNION ALL SELECT id, title FROM articles a`
      *
-     * @param string|\Cake\Database\Query $query full SQL query to be used in UNION operator
+     * @param \Cake\ORM\Query $query full SQL query to be used in UNION operator
      * @param bool $overwrite whether to reset the list of queries to be operated or not
      * @return $this
      */
@@ -1739,7 +1739,7 @@ 
      *
      * Epliog content is raw SQL and not suitable for use with user supplied data.
      *
-     * @param string|\Cake\Database\Expression\QueryExpression|null $expression The expression to be appended
+     * @param string $expression The expression to be appended
      * @return $this
      */
     public function epilog($expression = null)