CakeDC / cakephp-api

tests/TestCase/Service/Action/CrudEditActionTest.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
         $this->Action->execute();
     }
 
+    /**
+     * @param integer $id
+     */
     protected function _initializeAction($id, $post = [])
     {
         $this->_initializeRequest([

Unused Use Statements -1 removed lines

@@ -16,7 +16,6 @@
 use CakeDC\Api\TestSuite\TestCase;
 use CakeDC\Api\Test\ConfigTrait;
 use CakeDC\Api\Test\FixturesTrait;
-
 use Cake\Datasource\EntityInterface;
 
 class CrudEditActionTest extends TestCase

src/Service/Action/Extension/PaginateExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
      * Returns current limit
      *
      * @param Action $action An Action instance
-     * @return mixed
+     * @return Action
      */
     protected function _limit(Action $action)
     {

tests/TestCase/Integration/Service/Action/Auth/ResetPasswordRequestActionTest.php

Unused Use Statements -1 removed lines

@@ -17,7 +17,6 @@
 use CakeDC\Api\Test\Settings;
 use Cake\Core\Configure;
 use Cake\ORM\TableRegistry;
-use Cake\Utility\Hash;
 
 /**
  * Class ResetPasswordRequestActionTest

src/Service/Action/CrudAction.php

Doc Comments +5 added lines, -5 removed lines

@@ -158,7 +158,7 @@ 
     /**
      * Model id getter.
      *
-     * @return mixed|string
+     * @return string
      */
     public function getId()
     {
@@ -178,7 +178,7 @@ 
     /**
      * Parent id getter.
      *
-     * @return mixed|string
+     * @return string
      */
     public function getParentId()
     {
@@ -213,7 +213,7 @@ 
      * @param EntityInterface $entity An Entity instance.
      * @param array $data Entity data.
      * @param array $options Patch entity options.
-     * @return \Cake\Datasource\EntityInterface|mixed
+     * @return EntityInterface
      */
     protected function _patchEntity($entity, $data, $options = [])
     {
@@ -251,7 +251,7 @@ 
     /**
      * Returns single entity by id.
      *
-     * @param mixed $primaryKey Primary key.
+     * @param string $primaryKey Primary key.
      * @return \Cake\Collection\Collection
      */
     protected function _getEntity($primaryKey)
@@ -273,7 +273,7 @@ 
      * Build condition for get entity method.
      *
      * @param string $primaryKey Primary key
-     * @return array
+     * @return callable|null
      */
     protected function _buildViewCondition($primaryKey)
     {

src/Service/Auth/Authenticate/BaseAuthenticate.php

Doc Comments +1 added lines, -1 removed lines

@@ -218,7 +218,7 @@
      * systems like basic and digest auth.
      *
      * @param \Cake\Http\ServerRequest $request Request object.
-     * @return mixed Either false or an array of user information
+     * @return boolean Either false or an array of user information
      */
     public function getUser(ServerRequest $request)
     {

Unused Use Statements -2 removed lines

@@ -26,13 +26,11 @@
 namespace CakeDC\Api\Service\Auth\Authenticate;
 
 use CakeDC\Api\Service\Action\Action;
-
 use Cake\Auth\PasswordHasherFactory;
 use Cake\Core\InstanceConfigTrait;
 use Cake\Event\EventListenerInterface;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest;
-
 use Cake\ORM\TableRegistry;
 
 /**

src/Service/Auth/Authenticate/SocialAuthenticate.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      *
      * @param ServerRequest $request Cake request object.
      * @param Response $response Cake response object.
-     * @return mixed
+     * @return boolean
      */
     public function authenticate(ServerRequest $request, Response $response)
     {

src/Service/Service.php

Doc Comments +3 added lines, -3 removed lines

@@ -295,7 +295,7 @@ 
      *
      * @param int $version Version number.
      * @deprecated 3.4.0 Use setVersion()/getVersion() instead.
-     * @return int|$this
+     * @return null|integer
      */
     public function version($version = null)
     {
@@ -371,7 +371,7 @@ 
      *
      * @param \Cake\Http\ServerRequest $request A Request object.
      * @deprecated 3.4.0 Use getRequest()/setRequest() instead.
-     * @return \Cake\Http\ServerRequest|$this
+     * @return null|ServerRequest
      */
     public function request($request = null)
     {
@@ -441,7 +441,7 @@ 
      * Build router settings.
      * This implementation build action map for resource routes based on Service actions.
      *
-     * @return array
+     * @return callable
      */
     public function routerDefaultOptions()
     {

Unused Use Statements -2 removed lines

@@ -20,11 +20,9 @@
 use CakeDC\Api\Service\Exception\MissingRendererException;
 use CakeDC\Api\Service\Renderer\BaseRenderer;
 use CakeDC\Api\Service\RequestParser\BaseParser;
-
 use Cake\Core\App;
 use Cake\Core\Configure;
 use Cake\Datasource\Exception\RecordNotFoundException;
-
 use Cake\Event\EventDispatcherInterface;
 use Cake\Event\EventDispatcherTrait;
 use Cake\Event\EventListenerInterface;

src/Service/Utility/ReverseRouting.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
      *
      * @param Action $action An Action instance.
      * @param callable $beforeReverse Callback.
-     * @return array|string
+     * @return string|null
      */
     public function indexPath(Action $action, $beforeReverse = null)
     {
@@ -85,7 +85,7 @@ 
      * @param string $parentName Action name.
      * @param Action $action An Action instance.
      * @param string $type Type of action.
-     * @return array
+     * @return string
      */
     public function parentViewPath($parentName, $action, $type)
     {

tests/TestCase/Auth/Authorize/SimpleRbacAuthorizeTest.php

Doc Comments +3 added lines

@@ -116,6 +116,9 @@
         $this->assertEquals($this->defaultPermissions, $this->simpleRbacAuthorize->getConfig('permissions'));
     }
 
+    /**
+     * @param string $instance
+     */
     protected function assertConstructorPermissions($instance, $config, $permissions)
     {
         $reflectedClass = new ReflectionClass($instance);