Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/locustv2/yii2-linkable-behavior
Yii2 behavior to help creating urls easier
https://github.com/locustv2/yii2-linkable-behavior
behavior linkable urls yii2 yii2-behaviors yii2-extension
Last synced: 6 days ago
JSON representation
Yii2 behavior to help creating urls easier
- Host: GitHub
- URL: https://github.com/locustv2/yii2-linkable-behavior
- Owner: Locustv2
- License: bsd-3-clause
- Created: 2017-03-31T15:25:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-04-07T18:27:01.000Z (over 7 years ago)
- Last Synced: 2024-09-23T22:32:44.545Z (10 days ago)
- Topics: behavior, linkable, urls, yii2, yii2-behaviors, yii2-extension
- Language: PHP
- Size: 13.7 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Linkable Behavior for Yii2 Components
This extension help creating urls easier in yii2. This behavior provides support for components that have a page to display its contents. The page can be an action in a Module or simply in a Controller. It will be easier to get links related to this record without having to write Url Route over and over again.
[](https://packagist.org/packages/locustv2/yii2-linkable-behavior)
[](https://packagist.org/packages/locustv2/yii2-linkable-behavior)
[](https://packagist.org/packages/locustv2/yii2-linkable-behavior)
[](https://packagist.org/packages/locustv2/yii2-linkable-behavior)
## Installation
The preferred way to install the library is through [composer](https://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist locustv2/yii2-linkable-behavior
```
or add
```json
{
"require": {
"locustv2/yii2-linkable-behavior": "~1.0.0"
}
}
```
to your `composer.json` file.
## Usage
Add the behavior to your ActiveRecord that can he hotlinked:
```php
namespace app\models;
use yii\db\ActiveRecord;
use locustv2\behaviors\LinkableBehavior;
class User extends ActiveRecord
{
//...
public function behaviors()
{
return ArrayHelper::merge(parent::behaviors(), [
[
'class' => LinkableBehavior::className(),
'route' => '/user',
'defaultAction' => 'view',
'hotlinkTextAttr' => 'username',
'defaultParams' => function ($record) {
return [
'id' => $record->id,
];
},
]
]);
}
}
```
```php
namespace app\models;
use yii\db\ActiveRecord;
use locustv2\behaviors\LinkableBehavior;
class Photo extends ActiveRecord
{
//...
public function behaviors()
{
return ArrayHelper::merge(parent::behaviors(), [
[
'class' => LinkableBehavior::className(),
'route' => '/photo',
'defaultAction' => 'view',
'linkableParams' => function ($record) {
return [
'photoid' => $record->id,
];
},
'useAbsoluteUrl' => true,
'defaultParams' => function ($record) {
return [
'id' => $record->id,
'slug' => $record->slug
];
},
]
]);
}
}
```
With that code in place, you can now use 4 available methods in your `User` and `Photo` ActiveRecord:
- `getUrlRoute($action = null, array $params = [])`
- `getUrlRouteTo(Component $component, $action = null)`
- `getHotlink($action = null, array $params = [], array $options = [])`
- `getHotlinkTo(Component $component, $action = null, array $params = [], array $options = [])`
### Examples (assuming that you use [pretty urls](http://www.yiiframework.com/doc-2.0/guide-runtime-routing.html#using-pretty-urls))
#### `getUrlRoute($action = null, array $params = [])`
```php
use yii\helpers\Url;
use app\models\User;
$user = User::findOne(['id' => 123]);
// /user/view?id=123
echo Url::to($user->urlRoute);
// /user/update?id=123
echo Url::to($user->getUrlRoute('update'));
// http://www.yoursite.com/user/profile?id=123&ref=facebook
echo Url::to($user->getUrlRoute('profile', ['ref' => 'facebook']), true);
```
#### `getUrlRouteTo(Component $component, $action = null)`
```php
use yii\helpers\Url;
use app\models\User;
$user = User::findOne(['id' => 123]);
$photo = $user->getPhotos()->one();
// /user/photo/view?id=123&photoid=456&slug=my-first-photo
echo Url::to($user->getUrlRouteTo($photo));
// /photo/user/view?id=456&slug=my-first-photo&uid=123
echo Url::to($photo->getUrlRouteTo($user));
// /user/photo/update?id=123&photoid=456&slug=my-first-photo
echo Url::to($user->getUrlRouteTo($photo, 'update'));
```
#### `getHotlink($action = null, array $params = [], array $options = [])`
```php
use yii\helpers\Url;
use app\models\User;
$user = User::findOne(['id' => 123]);
// Locustv2
echo $user->hotLink;
// Locustv2
echo $user->getHotlink('update');
// Locustv2
echo $user->getHotlink('profile', ['ref' => 'facebook'], ['class' => 'text-bold']);
```
If you want to use absolute urls, you should set `LinkableBehavior::$useAbsoluteUrl` to `true`.
If you want to disable hotlinks, you should set `LinkableBehavior::$disableHotlink` to `true`. `` will be used instead of ``
#### `getHotlinkTo(Component $component, $action = null, array $params = [], array $options = [])`
```php
use yii\helpers\Url;
use app\models\User;
$user = User::findOne(['id' => 123]);
$photo = $user->getPhotos()->one();
// Locustv2
echo $user->getHotlinkTo($photo);
// http://www.yoursite.com/photo/user/view?id=456&slug=my-first-photo&uid=123
echo $photo->getHotlinkTo($user);
// Locustv2
echo Url::to($user->getHotlinkTo($photo, 'update', ['ref' => homepage], ['class' => 'font-bold']));
```
## To do
- Add unit tests
## Contributing
Feel free to send pull requests.
## License
For license information check the [LICENSE](LICENSE.md)-file.