Browse Source

Improve IDE compatibility

dereuromark 8 years ago
parent
commit
165f178241

+ 3 - 3
src/Console/ConsoleOptionParser.php

@@ -635,7 +635,7 @@ class ConsoleOptionParser
     /**
      * Gets the arguments defined in the parser.
      *
-     * @return array Array of argument descriptions
+     * @return \Cake\Console\ConsoleInputArgument[]
      */
     public function arguments()
     {
@@ -645,7 +645,7 @@ class ConsoleOptionParser
     /**
      * Get the defined options in the parser.
      *
-     * @return array
+     * @return \Cake\Console\ConsoleInputOption[]
      */
     public function options()
     {
@@ -655,7 +655,7 @@ class ConsoleOptionParser
     /**
      * Get the array of defined subcommands
      *
-     * @return array
+     * @return \Cake\Console\ConsoleInputSubcommand[]
      */
     public function subcommands()
     {

+ 1 - 1
src/Controller/Component/AuthComponent.php

@@ -877,7 +877,7 @@ class AuthComponent extends Component
      *
      * @param \Cake\Auth\Storage\StorageInterface|null $storage Sets provided
      *   object as storage or if null returns configured storage object.
-     * @return \Cake\Auth\Storage\StorageInterface|null
+     * @return \Cake\Auth\Storage\StorageInterface|\Cake\Core\InstanceConfigTrait|null
      */
     public function storage(StorageInterface $storage = null)
     {

+ 1 - 1
src/Controller/Component/CsrfComponent.php

@@ -78,12 +78,12 @@ class CsrfComponent extends Component
      */
     public function startup(Event $event)
     {
+        /* @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $request = $controller->request;
         $response = $controller->response;
         $cookieName = $this->_config['cookieName'];
 
-        /* @var \Cake\Http\ServerRequest $request */
         $cookieData = $request->getCookie($cookieName);
         if ($cookieData) {
             $request->params['_csrfToken'] = $cookieData;

+ 1 - 0
src/Controller/Component/RequestHandlerComponent.php

@@ -189,6 +189,7 @@ class RequestHandlerComponent extends Component
      */
     public function startup(Event $event)
     {
+        /* @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $request = $controller->request;
         $response = $controller->response;

+ 3 - 2
src/Controller/Component/SecurityComponent.php

@@ -99,6 +99,7 @@ class SecurityComponent extends Component
      */
     public function startup(Event $event)
     {
+        /* @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $this->session = $controller->request->getSession();
         $this->_action = $controller->request->getParam('action');
@@ -510,12 +511,12 @@ class SecurityComponent extends Component
             'Missing field \'%s\' in POST data'
         );
         $expectedUnlockedFields = Hash::get($expectedParts, 2);
-        $dataUnlockedFields = Hash::get($hashParts, 2) ?: [];
+        $dataUnlockedFields = Hash::get($hashParts, 2) ?: null;
         if ($dataUnlockedFields) {
             $dataUnlockedFields = explode('|', $dataUnlockedFields);
         }
         $unlockFieldsMessages = $this->_debugCheckFields(
-            $dataUnlockedFields,
+            (array)$dataUnlockedFields,
             $expectedUnlockedFields,
             'Unexpected unlocked field \'%s\' in POST data',
             null,

+ 2 - 3
src/Controller/Controller.php

@@ -320,9 +320,8 @@ class Controller implements EventListenerInterface, EventDispatcherInterface
     public function loadComponent($name, array $config = [])
     {
         list(, $prop) = pluginSplit($name);
-        $this->{$prop} = $this->components()->load($name, $config);
 
-        return $this->{$prop};
+        return $this->{$prop} = $this->components()->load($name, $config);
     }
 
     /**
@@ -689,7 +688,7 @@ class Controller implements EventListenerInterface, EventDispatcherInterface
      * @param \Cake\ORM\Table|string|\Cake\ORM\Query|null $object Table to paginate
      * (e.g: Table instance, 'TableName' or a Query object)
      * @param array $settings The settings/configuration used for pagination.
-     * @return \Cake\ORM\ResultSet Query results
+     * @return \Cake\ORM\ResultSet|\Cake\Datasource\ResultSetInterface Query results
      * @link https://book.cakephp.org/3.0/en/controllers.html#paginating-a-model
      * @throws \RuntimeException When no compatible table object can be found.
      */

+ 1 - 0
src/TestSuite/IntegrationTestCase.php

@@ -556,6 +556,7 @@ abstract class IntegrationTestCase extends TestCase
         if (empty($class) || !class_exists($class)) {
             $class = 'Cake\Error\ExceptionRenderer';
         }
+        /* @var \Cake\Error\ExceptionRenderer $instance */
         $instance = new $class($exception);
         $this->_response = $instance->render();
     }