Commit 148ba636 by Alexander Makarov

Merge pull request #3911 from creocoder/sluggable-behavior

[READY] \yii\behaviors\SluggableBehavior
parents b2ceceb1 038257e3
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\behaviors;
use yii\base\InvalidConfigException;
use yii\db\BaseActiveRecord;
use yii\helpers\Inflector;
/**
* SluggableBehavior automatically fills the specified attribute with the transliterated and adjusted version to use in URLs.
*
* To use SluggableBehavior, insert the following code to your ActiveRecord class:
*
* ```php
* use yii\behaviors\SluggableBehavior;
*
* public function behaviors()
* {
* return [
* [
* 'class' => SluggableBehavior::className(),
* 'attribute' => 'title',
* ],
* ];
* }
* ```
*
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0
*/
class SluggableBehavior extends AttributeBehavior
{
/**
* @var string
*/
public $slugAttribute = 'slug';
/**
* @var string
*/
public $attribute;
/**
* @inheritdoc
*/
public function init()
{
parent::init();
if (empty($this->attributes)) {
$this->attributes = [BaseActiveRecord::EVENT_BEFORE_VALIDATE => $this->slugAttribute];
}
if ($this->attribute === null && $this->value === null) {
throw new InvalidConfigException('Either "attribute" or "value" properties must be specified.');
}
}
/**
* @inheritdoc
*/
protected function getValue($event)
{
if ($this->attribute !== null) {
$this->value = Inflector::slug($this->owner->{$this->attribute});
}
return parent::getValue($event);
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment