CakeDC / cakephp-api

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)
     {

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/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);

src/Service/Auth/Authenticate/TokenAuthenticate.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/Action/Extension/CrudRelationsExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
     /**
      * @param CrudAction $action An Action instance.
      * @param Query $query A Query instance.
-     * @return mixed
+     * @return Query
      */
     protected function _attachAssociations(CrudAction $action, Query $query)
     {

src/Service/Auth/Authorize/SimpleRbacAuthorize.php

Doc Comments +4 added lines, -4 removed lines

@@ -140,7 +140,7 @@ 
      * Set a default role if no role is provided
      *
      * @param array $user user data
-     * @param Request $request request
+     * @param ServerRequest $request request
      * @return bool
      */
     public function authorize($user, ServerRequest $request)
@@ -162,7 +162,7 @@ 
      *
      * @param array $user current user array
      * @param string $role effective role for the current user
-     * @param Request $request request
+     * @param ServerRequest $request request
      * @return bool true if there is a match in permissions
      */
     protected function _checkRules(array $user, $role, ServerRequest $request)
@@ -184,8 +184,8 @@ 
      * @param array $permission configuration
      * @param array $user current user
      * @param string $role effective user role
-     * @param Request $request request
-     * @return bool if rule matched, null if rule not matched
+     * @param ServerRequest $request request
+     * @return boolean|null if rule matched, null if rule not matched
      */
     protected function _matchRule($permission, $user, $role, $request)
     {

src/Service/Locator/LocatorAwareTrait.php

Doc Comments +2 added lines, -2 removed lines

@@ -31,7 +31,7 @@ 
      * If no parameters are passed, it will return the currently used locator.
      *
      * @param \CakeDC\Api\Service\Locator\LocatorInterface|null $serviceLocator LocatorInterface instance.
-     * @return \CakeDC\Api\Service\Locator\LocatorInterface
+     * @return \Cake\ORM\Locator\LocatorInterface
      * @deprecated 3.6.0 Use getTableLocator()/setTableLocator() instead.
      */
     public function serviceLocator(LocatorInterface $serviceLocator = null)
@@ -50,7 +50,7 @@ 
     /**
      * Sets the table locator.
      *
-     * @param \Cake\ORM\Locator\LocatorInterface $tableLocator LocatorInterface instance.
+     * @param LocatorInterface $tableLocator LocatorInterface instance.
      * @return $this
      */
     public function setTableLocator(LocatorInterface $tableLocator)