Improve sluggable behavior documentation (yiisoft#13747) [skip ci]

lirnbo · Mar 10, 2017 · ad1ce9e · ad1ce9e
1 parent 7d4b33a
commit ad1ce9e
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/framework/behaviors/SluggableBehavior.php b/framework/behaviors/SluggableBehavior.php
@@ -65,12 +65,14 @@ class SluggableBehavior extends AttributeBehavior
      */
     public $slugAttribute = 'slug';
     /**
-     * @var string|array the attribute or list of attributes whose value will be converted into a slug
+     * @var string|array|null the attribute or list of attributes whose value will be converted into a slug
+     * or `null` meaning that the `$value` property will be used to generate a slug. 
      */
     public $attribute;
     /**
-     * @var string|callable the value that will be used as a slug. This can be an anonymous function
-     * or an arbitrary value. If the former, the return value of the function will be used as a slug.
+     * @var callable|string|null the value that will be used as a slug. This can be an anonymous function
+     * or an arbitrary value or null. If the former, the return value of the function will be used as a slug.
+     * If `null` then the `$attribute` property will be used to generate a slug.
      * The signature of the function should be as follows,
      *
      * ```php