Skip to content

Commit d7d7f05

Browse files
committed
Added TaggableBehavior phpDoc
1 parent 5bb5ce7 commit d7d7f05

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/TaggableBehavior.php

+10-4
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@
2121
class TaggableBehavior extends Behavior
2222
{
2323
/**
24-
* @var boolean
24+
* @var boolean whether to return the tag names as array instead of string
2525
*/
2626
public $tagNamesAsArray = false;
2727
/**
28-
* @var string
28+
* @var string the tags relation name
2929
*/
3030
public $tagRelation = 'tags';
3131
/**
32-
* @var string
32+
* @var string the tags model name attribute name
3333
*/
3434
public $tagNameAttribute = 'name';
3535
/**
36-
* @var string|false
36+
* @var string|false the tags model frequency attribute name
3737
*/
3838
public $tagFrequencyAttribute = 'frequency';
3939
/**
@@ -55,6 +55,7 @@ public function events()
5555
}
5656

5757
/**
58+
* Returns the tag names.
5859
* @param boolean|null $asArray
5960
* @return string|string[]
6061
*/
@@ -78,6 +79,7 @@ public function getTagNames($asArray = null)
7879
}
7980

8081
/**
82+
* Sets the tag names.
8183
* @param string|string[] $names
8284
*/
8385
public function setTagNames($names)
@@ -86,6 +88,7 @@ public function setTagNames($names)
8688
}
8789

8890
/**
91+
* Adds the tag names.
8992
* @param string|string[] $names
9093
*/
9194
public function addTagNames($names)
@@ -94,6 +97,7 @@ public function addTagNames($names)
9497
}
9598

9699
/**
100+
* Removes the tag names.
97101
* @param string|string[] $names
98102
*/
99103
public function removeTagNames($names)
@@ -102,6 +106,7 @@ public function removeTagNames($names)
102106
}
103107

104108
/**
109+
* Returns a value indicating whether the tag names exists.
105110
* @param string|string[] $names
106111
* @return boolean
107112
*/
@@ -206,6 +211,7 @@ public function beforeDelete()
206211
}
207212

208213
/**
214+
* Filters the tag names.
209215
* @param string|string[] $names
210216
* @return string[]
211217
*/

0 commit comments

Comments
 (0)