ROAResearch / yii2-roa

src/actions/View.php

Doc Comments +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
 class View extends Action
 {
     /**
-     * @return ActiveDataProvider
+     * @return \yii\db\ActiveRecordInterface
      * @param mixed $id
      */
     public function run($id)

src/test/AbstractAccessTokenCest.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
      * Generates and stores an auth token.
      *
      * @param Tester $I
-     * @param Example $example must contain keys:
+     * @param \Codeception\Example $example must contain keys:
      * - client: string http client.
      * - clientPass: string http password.
      * - user: string system user.

src/test/AbstractResourceCest.php

Doc Comments +13 added lines, -13 removed lines

@@ -33,7 +33,7 @@ 
      * Authenticates a user identified by 'authUser' index in the `$example`.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - tokenName: (optional) string name of the token used to authenticate.
      */
     protected function authUser(Tester $I, Example $example)
@@ -46,7 +46,7 @@ 
     /**
      * Parses the Route for the test using `$urlManager` and `getRoutePattern()`
      *
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - url: (optional) string if provided it will be used directly.
      * - urlParams: (optional) string[] GET params to parse the url rule with
      *   `getRoutePattern()`.
@@ -67,7 +67,7 @@ 
      * Handles the internal logic when running a test on a collection resource.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - tokenName: (optional) string name of the token used to authenticate.
      * - url: (optional) string if provided it will be used directly.
      * - urlParams: (optional) string[] GET params to parse the url rule with
@@ -94,7 +94,7 @@ 
      * Handles the internal logic when running a test on a creating a record.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - tokenName: (optional) string name of the token used to authenticate.
      * - url: (optional) string if provided it will be used directly.
      * - urlParams: (optional) string[] GET params to parse the url rule with
@@ -125,7 +125,7 @@ 
      * Handles the internal logic when running a test on a record resource.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - tokenName: (optional) string name of the token used to authenticate.
      * - url: string if provided it will be used directly.
      * - urlParams: string[] GET params to parse the url rule with
@@ -156,7 +156,7 @@ 
      * Handles the internal logic when running a test on a updating a record.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - tokenName: (optional) string name of the token used to authenticate.
      * - url: (optional) string if provided it will be used directly.
      * - urlParams: (optional) string[] GET params to parse the url rule with
@@ -189,7 +189,7 @@ 
      * Handles the internal logic when running a test on a updating a record.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - tokenName: (optional) string name of the token used to authenticate.
      * - url: (optional) string if provided it will be used directly.
      * - urlParams: (optional) string[] GET params to parse the url rule with
@@ -219,7 +219,7 @@ 
      * @param array $responses pairs of 'httpCode' => 'responseMethod' which
      * will determine how to check the response.
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - httpCode: integer expected Http Code response. If the httpCode is
      *   a key in `$responses` parameter then the method defined there will be
      *   used to analyze the response. Otherwise `checkErrorResponse()` will be
@@ -251,7 +251,7 @@ 
      * Checks an expected success collection response.
      *
      * @param Tester $I
-     * @param Example $example
+     * @param \Codeception\Example $example
      */
     protected function checkSuccessIndexResponse(Tester $I, Example $example)
     {
@@ -264,7 +264,7 @@ 
      * Checks an expected success record response.
      *
      * @param Tester $I
-     * @param Example $example
+     * @param \Codeception\Example $example
      */
     protected function checkSuccessViewResponse(Tester $I, Example $example)
     {
@@ -276,7 +276,7 @@ 
      * Checks an expected success record creation response.
      *
      * @param Tester $I
-     * @param Example $example
+     * @param \Codeception\Example $example
      */
     protected function checkSuccessCreateResponse(Tester $I, Example $example)
     {
@@ -289,7 +289,7 @@ 
      * Checks an expected response containing validation errors.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - validationErrors: string[] (optional) pairs of field => message
      *   validation errors.
      */
@@ -317,7 +317,7 @@ 
      * Checks an expected error response from user input.
      *
      * @param Tester $I
-     * @param Example $example data used for the testing. It uses the keys
+     * @param \Codeception\Example $example data used for the testing. It uses the keys
      * - error: (optional) mixed expected json being contained in the response.
      */
     protected function checkErrorResponse(Tester $I, Example $example)

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace roaresearch\yii2\roa\test;
 
 use Codeception\{Example, Util\HttpCode};
-use roaresearch\yii2\roa\urlRules\Resource as ResourceUrlRule;
 use yii\web\UrlManager;
 
 abstract class AbstractResourceCest

src/test/TesterTrait.php

Doc Comments -1 removed lines

@@ -19,7 +19,6 @@
      *
      * @param string $tokenName unique name to index the tokens and models
      * @param string $token oauth2 authorization token
-     * @param UserIdentity $user
      */
     public function storeToken($tokenName, $token)
     {

src/behaviors/Slug.php

Doc Comments +2 added lines, -2 removed lines

@@ -87,7 +87,7 @@ 
     /**
      * Ensures the parent record is attached to the behavior.
      *
-     * @param BaseActiveRecord $owner
+     * @param \yii\db\BaseActiveRecord $owner
      * @param bool $force whether to force finding the slug parent record
      * when `$parentSlugRelation` is defined
      */
@@ -104,7 +104,7 @@ 
 
     /**
      * This populates the slug to the parentSlug
-     * @param BaseActiveRecord $owner
+     * @param \yii\db\BaseActiveRecord $owner
      */
     private function populateSlugParent(BaseActiveRecord $owner)
     {

src/controllers/Resource.php

Doc Comments +5 added lines, -5 removed lines

@@ -167,7 +167,7 @@ 
     /**
      * Creates a data provider for the request.
      *
-     * @return ActiveDataProvider
+     * @return \yii\data\ActiveDataProvider
      */
     public function indexProvider(): ActiveDataProvider
     {
@@ -177,7 +177,7 @@ 
     /**
      * Finds the record based on the provided id or throws an exception.
      * @param int $id the unique identifier for the record.
-     * @return ActiveRecordInterface
+     * @return \yii\db\ActiveRecordInterface
      * @throws NotFoundHttpException if the record can't be found.
      */
     public function findModel($id): ActiveRecordInterface
@@ -195,7 +195,7 @@ 
      * Creates the query to be used by the `findOne()` method.
      *
      * @param int $id the unique identifier
-     * @return ActiveQuery
+     * @return \yii\db\ActiveQuery
      */
     public function findQuery($id): ActiveQuery
     {
@@ -206,7 +206,7 @@ 
      * Creates the query to be used by the `index` action when `$searchClass` is
      * not set.
      *
-     * @return ActiveQuery
+     * @return \yii\db\ActiveQuery
      */
     public function indexQuery(): ActiveQuery
     {
@@ -214,7 +214,7 @@ 
     }
 
     /**
-     * @return ActiveQuery
+     * @return \yii\db\ActiveQuery
      */
     protected function baseQuery(): ActiveQuery
     {

src/modules/ApiContainer.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace roaresearch\yii2\roa\modules;
 
-use roaresearch\yii2\oauth2server\filters\auth\CompositeAuth;
 use roaresearch\yii2\oauth2server\Module as OAuth2Module;
+use roaresearch\yii2\oauth2server\filters\auth\CompositeAuth;
 use roaresearch\yii2\roa\{
     controllers\ApiContainerController,
     urlRules\Composite as CompositeUrlRule,

src/urlRules/Composite.php

Doc Comments +3 added lines, -3 removed lines

@@ -117,7 +117,7 @@ 
     }
 
     /**
-     * @param UrlManager $manager the URL manager
+     * @param \yii\web\UrlManager $manager the URL manager
      * @return bool
      */
     protected function hasNormalizer($manager): bool
@@ -126,7 +126,7 @@ 
     }
 
     /**
-     * @param UrlManager $manager the URL manager
+     * @param \yii\web\UrlManager $manager the URL manager
      * @return ?UrlNormalizer
      */
     protected function getNormalizer(UrlManager $manager): ?UrlNormalizer
@@ -141,7 +141,7 @@ 
     }
 
     /**
-     * @return NotFoundHttpException
+     * @return \yii\web\NotFoundHttpException
      */
     protected function createNotFoundException(): NotFoundHttpException
     {