Skip to content

Commit c210744

Browse files
InsolitaInsolita
committed
Add CountForIdentityAction
1 parent a6869d6 commit c210744

File tree

7 files changed

+166
-5
lines changed

7 files changed

+166
-5
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,8 @@
2222

2323
- new CountAction that can count query without loading data. Return X-Pagination-Total-Count with count result
2424

25-
- new ListForIdentityAction and ViewForIdentityAction for show data related to current user
25+
- new ListForIdentityAction and ViewForIdentityAction for show data related to current user
26+
27+
1.3.1
28+
- Add CountForIdentityAction
29+
- remove includes from counter actions

‎src/actions/CountAction.php‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,6 @@ protected function makeQuery()
138138
/* @var $modelClass \yii\db\BaseActiveRecord */
139139
$modelClass = $this->modelClass;
140140
$query = $this->prepareParentQuery($modelClass::find());
141-
$query = $this->prepareIncludeQuery($query);
142141

143142
if (!empty($filter)) {
144143
$query->andWhere($filter);

‎src/actions/CountForIdentityAction.php‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<?php
2+
3+
/**
4+
* @copyright Copyright (c) 2020 Insolita <[email protected]> and contributors
5+
* @license https://github.com/insolita/yii2-fractal/blob/master/LICENSE
6+
*/
7+
8+
namespace insolita\fractal\actions;
9+
10+
use insolita\fractal\exceptions\ValidationException;
11+
use insolita\fractal\providers\JsonApiActiveDataProvider;
12+
use Yii;
13+
use yii\db\ActiveQueryInterface;
14+
15+
/**
16+
* Provide ability for count resource items without data loading related to current user identity
17+
* (with filters support)
18+
* Return header X-Pagination-Total-Count with count value (Use with HEAD request)
19+
* @example
20+
* count posts
21+
* Post::find()->where(['author_id' => Yii::$app->userId])->andWhere([...filter condition])->count();
22+
* 'count' => [
23+
* 'class' => CountAction::class,
24+
* 'modelClass' => Post::class,
25+
* 'dataFilter' => PostDataFilter::class,
26+
* 'userIdAttribute' => 'author_id'
27+
* ],
28+
**/
29+
class CountForIdentityAction extends JsonApiAction
30+
{
31+
/**
32+
* @var string
33+
* user foreign key attribute
34+
*/
35+
public $userIdAttribute = 'user_id';
36+
37+
/**
38+
* @var callable
39+
* @example
40+
* 'queryWrapper' => function(CountAction $action, ActiveQuery Query) {
41+
* Modify $query
42+
* or return own ActiveQuery
43+
* }
44+
*/
45+
public $queryWrapper;
46+
47+
/**
48+
* @var \yii\data\DataFilter
49+
*/
50+
public $dataFilter;
51+
52+
53+
/**
54+
* @return \insolita\fractal\providers\JsonApiActiveDataProvider|object
55+
* @throws \insolita\fractal\exceptions\ValidationException
56+
* @throws \yii\base\InvalidConfigException
57+
*/
58+
public function run()
59+
{
60+
if ($this->checkAccess) {
61+
call_user_func($this->checkAccess, $this->id);
62+
}
63+
64+
$query = $this->makeQuery();
65+
if ($this->queryWrapper !== null) {
66+
$query = \call_user_func($this->queryWrapper, $this, $query);
67+
}
68+
$count = $query->count();
69+
Yii::$app->response->headers->set('X-Pagination-Total-Count', $count);
70+
Yii::$app->response->setStatusCode(204);
71+
}
72+
73+
/**
74+
* @param $requestParams
75+
* @return array|bool|mixed|null
76+
* @throws \insolita\fractal\exceptions\ValidationException
77+
* @throws \yii\base\InvalidConfigException
78+
*/
79+
protected function prepareDataFilter($requestParams)
80+
{
81+
if ($this->dataFilter === null) {
82+
return null;
83+
}
84+
$this->dataFilter = Yii::createObject($this->dataFilter);
85+
if ($this->dataFilter->load($requestParams)) {
86+
$filter = $this->dataFilter->build();
87+
if ($filter === false) {
88+
throw new ValidationException($this->dataFilter->getErrors());
89+
}
90+
return $filter;
91+
}
92+
return null;
93+
}
94+
95+
/**
96+
* Add condition for parent model restriction if needed
97+
* @param \yii\db\ActiveQueryInterface $query
98+
* @return \yii\db\ActiveQueryInterface
99+
*/
100+
protected function prepareParentQuery(ActiveQueryInterface $query):ActiveQueryInterface
101+
{
102+
$condition[$this->modelTable().'.'.$this->userIdAttribute] = Yii::$app->user->id;
103+
$query->where($condition);
104+
return $query;
105+
}
106+
107+
108+
/**
109+
* @return JsonApiActiveDataProvider|object
110+
* @throws \insolita\fractal\exceptions\ValidationException
111+
* @throws \yii\base\InvalidConfigException
112+
*/
113+
protected function makeQuery()
114+
{
115+
$requestParams = Yii::$app->getRequest()->getBodyParams();
116+
if (empty($requestParams)) {
117+
$requestParams = Yii::$app->getRequest()->getQueryParams();
118+
}
119+
$filter = $this->prepareDataFilter($requestParams);
120+
121+
/* @var $modelClass \yii\db\BaseActiveRecord */
122+
$modelClass = $this->modelClass;
123+
$query = $this->prepareParentQuery($modelClass::find());
124+
125+
if (!empty($filter)) {
126+
$query->andWhere($filter);
127+
}
128+
return $query;
129+
}
130+
}

‎tests/codeception/suites/api/ApiUserCest.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,13 @@ public function testMyCommentAction(ApiTester $I)
116116
$I->seeResponseCodeIs(404);
117117
}
118118

119+
public function testPostsCountAction(ApiTester $I)
120+
{
121+
$I->haveValidContentType();
122+
$I->amBearerAuthenticated('Gamma_secret_token');
123+
$I->sendHEAD('/me/posts-count');
124+
$I->seeResponseCodeIsSuccessful();
125+
$I->seeHttpHeader('X-Pagination-Total-Count', 18);
126+
}
127+
119128
}

‎tests/testapp/controllers/MeController.php‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
use app\models\Post;
77
use app\transformers\CommentTransformer;
88
use app\transformers\PostShortTransformer;
9+
use insolita\fractal\actions\CountForIdentityAction;
910
use insolita\fractal\actions\ListForIdentityAction;
1011
use insolita\fractal\actions\ViewForIdentityAction;
1112
use insolita\fractal\JsonApiController;
@@ -58,6 +59,11 @@ public function actions()
5859
'userIdAttribute' => 'user_id',
5960
'modelClass' => Comment::class,
6061
'transformer' => CommentTransformer::class,
62+
],
63+
'posts-count' => [
64+
'class' => CountForIdentityAction::class,
65+
'userIdAttribute' => 'author_id',
66+
'modelClass' => Post::class,
6167
]
6268
];
6369
}

‎tests/testapp/controllers/PostController.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,9 @@ public function actions()
226226
'dataFilter' => [
227227
'class' => ActiveDataFilter::class,
228228
'searchModel' => function () {
229-
return (new DynamicModel(['category_id' => null]))
230-
->addRule('category_id', 'integer');
229+
return (new DynamicModel(['category_id' => null, 'author_id' => null]))
230+
->addRule('category_id', 'integer')
231+
->addRule('author_id', 'integer');
231232
},
232233
]
233234
];

‎tests/tests_phpstorm/posts.http‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,19 @@ HEAD http://127.0.0.1:8400/post/count
257257
Content-Type: application/vnd.api+json
258258
Accept: application/vnd.api+json
259259

260+
### Count posts for user
261+
HEAD http://127.0.0.1:8400/post/count?filter[author_id]=3
262+
Content-Type: application/vnd.api+json
263+
Accept: application/vnd.api+json
264+
265+
### Count posts for identity
266+
HEAD http://127.0.0.1:8400/me/posts-count
267+
Content-Type: application/vnd.api+json
268+
Accept: application/vnd.api+json
269+
Authorization: Bearer Gamma_secret_token
270+
271+
260272
### Count posts for category
261273
HEAD http://127.0.0.1:8400/categories/4/posts-count
262274
Content-Type: application/vnd.api+json
263-
Accept: application/vnd.api+json
275+
Accept: application/vnd.api+json

0 commit comments

Comments
 (0)