Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiier/yii2-action-store
Store different kind of actions (Like β€οΈ, Follow π, Star β, Block ...) in one table via ActiveRecord Polymorphic Association.
https://github.com/yiier/yii2-action-store
yii yii2-extension
Last synced: 25 days ago
JSON representation
Store different kind of actions (Like β€οΈ, Follow π, Star β, Block ...) in one table via ActiveRecord Polymorphic Association.
- Host: GitHub
- URL: https://github.com/yiier/yii2-action-store
- Owner: yiier
- Created: 2017-12-14T10:37:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-19T05:55:09.000Z (over 4 years ago)
- Last Synced: 2024-04-14T08:31:39.810Z (7 months ago)
- Topics: yii, yii2-extension
- Language: PHP
- Size: 17.6 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-yii2 - yiier/yii2-action-store
README
ActionStore for Yii2
====================
ActionStore for Yii2
[](https://packagist.org/packages/yiier/yii2-action-store)
[](https://packagist.org/packages/yiier/yii2-action-store)
[](https://packagist.org/packages/yiier/yii2-action-store)
[](https://packagist.org/packages/yiier/yii2-action-store)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yiier/yii2-action-store "*"
```
or add
```
"yiier/yii2-action-store": "*"
```
to the require section of your `composer.json` file.
Migrations
-----------
Run the following command
```shell
$ php yii migrate --migrationPath=@yiier/actionStore/migrations/
```
Usage
-----
**Config**
Configure Controller class as follows : :
```php
[
'class' => ActionAction::className(),
'pairsType' => ['want','own'], // Optional,default ['like', 'dislike']
'counterType' => ['apply'], // Optional,default ['view', 'clap']
'successCallable' => function ($model){ }, // Optional
'returnCallable' => function ($model){ return $model; }, // Optional
]
];
}
}
```
**Url**
```html
POST http://xxxxxxxxxxxxxx/topic/do?type=clap&model=topic&model_id=1
```
`model` recommend use `Model::tableName()`
http response success(code==200) return json:
```json
{"code":200,"data":{"id":156,"type":"apply","value":29,"user_type":"user","user_id":7,"model":"xx","model_id":"256","created_at":1583827902,"updated_at":1583830173,"typeCounter":29},"message":"success"}
```
http response failure(code==500) return json:
```json
{"code":500,"data":"","message":"{\"model_id\":[\"Model IDδΈθ½δΈΊη©Ίγ\"]}"}
```
Demo
------
**ActiveDataProvider Demo 1**
Controller
```php
ActionStore::find()
->where(['user_id' => Yii::$app->user->id, 'type' => 'favorite']),
'pagination' => [
'pageSize' => 10,
],
]);
$ids = ArrayHelper::getColumn($dataProvider->getModels(), 'model_id');
$company = ArrayHelper::index(Company::findAll($ids), 'id');
return $this->render('favorite', [
'dataProvider' => $dataProvider,
'company' => $company,
]);
}
}
```
View
```php
= yii\widgets\ListView::widget([
'dataProvider' => $dataProvider,
'itemOptions' => ['class' => 'list-group-item'],
'summary' => false,
'itemView' => function ($model, $key, $index, $widget) use ($company) {
return $this->render('_favorite', [
'model' => $model,
'key' => $key,
'index' => $index,
'company' => $company[$model->model_id],
]);
},
'options' => ['class' => 'list-group'],
]) ?>
```
**ActiveDataProvider Demo 2**
create ActionStoreSearch.php extends ActionStore
```php
hasOne(Company::className(), ['id' => 'model_id']);
}
}
```
Controller
```php
ActionStoreSearch::find()
->joinWith('company')
->where(['user_id' => Yii::$app->user->id, 'type' => 'favorite']),
'pagination' => [
'pageSize' => 10,
],
]);
return $this->render('favorite', [
'dataProvider' => $dataProvider,
]);
}
}
```
View
```php
= ListView::widget([
'dataProvider' => $dataProvider,
'itemOptions' => ['class' => 'collec-items clearfix'],
'summary' => false,
'itemView' => '_favorite',
'options' => ['class' => 'collection-wrap'],
]) ?>
```
**actionClass Demo**
Controller
```php
[
'class' => ActionAction::className(),
'actionClass' => ActionStoreSearch::className()
]
];
}
}
```
ActionStoreSearch.php
```php
hasOne(Company::className(), ['id' => 'model_id']);
}
public function afterSave($insert, $changedAttributes)
{
parent::afterSave($insert, $changedAttributes);
if ($insert) {
if ($this->type == self::FAVORITE_TYPE && $this->model == Company::tableName()) {
Company::updateAllCounters(['favorite_count' => 1], ['id' => $this->model_id]);
}
}
}
public function afterDelete()
{
parent::afterDelete();
if ($this->type == self::FAVORITE_TYPE && $this->model == Company::tableName()) {
Company::updateAllCounters(['favorite_count' => -1], ['id' => $this->model_id]);
}
}
}
```
**Get Counter**
get user model_id count
```php
ActionStore::getCounter(
ActionStoreSearch::FAVORITE_TYPE,
['model' => Company::tableName(), 'model_id' => $company->id, 'user_id' => \Yii::$app->user->id]
);
```
get all model_id count
```php
ActionStore::getCounter(
ActionStoreSearch::FAVORITE_TYPE,
['model' => Company::tableName(), 'model_id' => $company->id]
);
```
**Use `createUpdateAction`**
```php
$actionStore = new ActionStore();
$actionStore->setAttributes([
'type' => 'download',
'model' => Resource::tableName(),
'model_id' => $id
]);
$actionStore->createUpdateAction($actionStore);
```