https://github.com/thyseus/yii2-favorites
General Favorites Manager for the Yii 2 framework.
https://github.com/thyseus/yii2-favorites
favorites yii2 yii2-extension yii2-favorites
Last synced: 3 months ago
JSON representation
General Favorites Manager for the Yii 2 framework.
- Host: GitHub
- URL: https://github.com/thyseus/yii2-favorites
- Owner: thyseus
- Created: 2016-11-17T08:14:58.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-06T08:18:04.000Z (over 7 years ago)
- Last Synced: 2025-04-04T14:38:15.122Z (6 months ago)
- Topics: favorites, yii2, yii2-extension, yii2-favorites
- Language: PHP
- Size: 27.3 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
Awesome Lists containing this project
README
# ATTENTION:
github has been bought by Microsoft. This repository is orphaned and has been moved to:
https://gitlab.com/thyseus/yii2-favorites
Thanks a lot for your understanding and blame Microsoft.
# Yii2-favorites
A General Favorites Manager for the Yii 2 framework.
Every ActiveRecord Model can be bookmarked and accessed later by an authorized user.
Contains only one table 'favorites' where everything is stored.
## Installation
```bash
$ composer require thyseus/yii2-favorites
$ php yii migrate/up --migrationPath=@vendor/thyseus/yii2-favorites/migrations
```
## Configuration
Add following lines to your main configuration file:
```php
'modules' => [
'favorites' => [
'class' => 'thyseus\favorites\Module',
],
],
```
## Integration in your application:
use
```php
use thyseus\favorites\models\Favorite;
$model = CurrentModel::findOne(57);
echo $this->render('@vendor/thyseus/yii2-favorites/views/favorites/_button', [
'model' => CurrentModel::className(),
'target' => $model->slug
]);
```
to display a "Set as Favorite" / "Remove Favorite" toggle Button in the view files
of the models you want to make your users to be able to add favorites to.
Note that you can shorten the call if you set an alias like this in your application configuration:
```php
'aliases' => [
'@favorites' => '@app/vendor/thyseus/yii2-favorites'
],
```
And call the view like:
```php
echo $this->render('@favorites/views/favorites/_button', [
```
If the model is not identified by the column 'id' by default, for example if you are
using slugs, you can define the indentifierAttribute inside the model like this:
```php
public function identifierAttribute()
{
return 'slug';
}
```
If the automatic URL creation if yii2-favorites fails, you can append the URL manually:
```php
use thyseus\favorites\models\Favorite;
$model = CurrentModel::findOne(57);
echo $this->render('@vendor/thyseus/yii2-favorites/views/favorites/_button', [
'model' => CurrentModel::className(),
'target' => $model->id,
'icon' => '', // optional
'url' => Url::to(['fancy-url', 'id' => 1337]) ,
]);
```
Use the fourth parameter to set an custom target_attribute:
```php
use thyseus\favorites\models\Favorite;
$model = CurrentModel::findOne(57);
echo $this->render('@vendor/thyseus/yii2-favorites/views/favorites/_button', [
'model' => CurrentModel::className(),
'target' => $model->id,
'target_attribute' => 'i-am-referenced-by-this-column',
]);
```
If you want to use composite label identifiers, you can do it like this:
```php
public function getName()
{
return $this->firstname . ' ' . $this->lastname;
}
```
You can use this code example to make an dynamic menu containing your favorites in the NavBar:
```php
echo Nav::widget([
'options' => ['class' => 'navbar-nav navbar-right'],
'encodeLabels' => false,
'items' => [
['label' => '', 'options' => ['class' => 'favorites-menu clickable', 'style' => 'cursor: pointer;'], 'url' => false, 'visible' => !$user->isGuest, 'items' => ['' => '']],
]
]);
```
```js
$this->registerJs("
$('.favorites-menu').click(function() {
$.getJSON('".Url::to(['//favorites/favorites/json'])."', function (data) {
dd = $('.favorites-menu').find('.dropdown-menu');
dd.html('');
dd.append('
data.forEach(function(elem) {
dd.append('
});
});
});
");
```
```css
.favorites-menu li a { display: inline; padding: 0; }
.favorites-menu .dropdown-menu { padding: 10px; }
```
## Routes
You can use the following routes to access the favorites module:
* list all favorites of the current logged in user: https://your-domain/favorites/favorites/index
* view: https://your-domain/favorites/favorites/view?id=
* update: 'favorites/update/' => 'favorites/favorites/update',
* delete: 'favorites/delete/' => 'favorites/favorites/delete',
* view: 'favorites/' => 'favorites/favorites/view',
## License
Yii2-favorites is released under the GPLv3 License.