$toolbox
$toolbox : \RedBeanPHP\ToolBox
RedBeanPHP Tag Manager.
The tag manager offers an easy way to quickly implement basic tagging functionality.
Provides methods to tag beans and perform tag-based searches in the bean database.
$toolbox : \RedBeanPHP\ToolBox
$associationManager : \RedBeanPHP\AssociationManager
$redbean : \RedBeanPHP\OODB
__construct(\RedBeanPHP\ToolBox $toolbox)
Constructor.
The tag manager offers an easy way to quickly implement basic tagging functionality.
| \RedBeanPHP\ToolBox | $toolbox | toolbox object |
hasTag(\RedBeanPHP\OODBBean $bean, array|string $tags, boolean $all = FALSE) : boolean
Tests whether a bean has been associated with one or more of the listed tags. If the third parameter is TRUE this method will return TRUE only if all tags that have been specified are indeed associated with the given bean, otherwise FALSE.
If the third parameter is FALSE this method will return TRUE if one of the tags matches, FALSE if none match.
Tag list can be either an array with tag names or a comma separated list of tag names.
Usage:
R::hasTag( $blog, 'horror,movie', TRUE );
The example above returns TRUE if the $blog bean has been tagged as BOTH horror and movie. If the post has only been tagged as 'movie' or 'horror' this operation will return FALSE because the third parameter has been set to TRUE.
| \RedBeanPHP\OODBBean | $bean | bean to check for tags |
| array|string | $tags | list of tags |
| boolean | $all | whether they must all match or just some |
untag(\RedBeanPHP\OODBBean $bean, array|string $tagList) : void
Removes all specified tags from the bean. The tags specified in the second parameter will no longer be associated with the bean.
Tag list can be either an array with tag names or a comma separated list of tag names.
Usage:
R::untag( $blog, 'smart,interesting' );
In the example above, the $blog bean will no longer be associated with the tags 'smart' and 'interesting'.
| \RedBeanPHP\OODBBean | $bean | tagged bean |
| array|string | $tagList | list of tags (names) |
tag(\RedBeanPHP\OODBBean $bean, mixed $tagList = NULL) : string
Part of RedBeanPHP Tagging API.
Tags a bean or returns tags associated with a bean. If $tagList is NULL or omitted this method will return a comma separated list of tags associated with the bean provided. If $tagList is a comma separated list (string) of tags all tags will be associated with the bean. You may also pass an array instead of a string.
Usage:
R::tag( $meal, "TexMex,Mexican" );
$tags = R::tag( $meal );
The first line in the example above will tag the $meal as 'TexMex' and 'Mexican Cuisine'. The second line will retrieve all tags attached to the meal object.
| \RedBeanPHP\OODBBean | $bean | bean to tag |
| mixed | $tagList | tags to attach to the specified bean |
addTags(\RedBeanPHP\OODBBean $bean, array|string|false $tagList) : void
Part of RedBeanPHP Tagging API.
Adds tags to a bean. If $tagList is a comma separated list of tags all tags will be associated with the bean. You may also pass an array instead of a string.
Usage:
R::addTags( $blog, ["halloween"] );
The example adds the tag 'halloween' to the $blog bean.
| \RedBeanPHP\OODBBean | $bean | bean to tag |
| array|string|false | $tagList | list of tags to add to bean |
tagged(string $beanType, array|string $tagList, string $sql = '', array $bindings = array()) : array
Returns all beans that have been tagged with one or more of the specified tags.
Tag list can be either an array with tag names or a comma separated list of tag names.
Usage:
$watchList = R::tagged(
'movie',
'horror,gothic',
' ORDER BY movie.title DESC LIMIT ?',
[ 10 ]
);
The example uses R::tagged() to find all movies that have been tagged as 'horror' or 'gothic', order them by title and limit the number of movies to be returned to 10.
| string | $beanType | type of bean you are looking for |
| array|string | $tagList | list of tags to match |
| string | $sql | additional SQL (use only for pagination) |
| array | $bindings | bindings |
taggedAll(string $beanType, array|string $tagList, string $sql = '', array $bindings = array()) : array
Returns all beans that have been tagged with ALL of the tags given.
This method works the same as R::tagged() except that this method only returns beans that have been tagged with all the specified labels.
Tag list can be either an array with tag names or a comma separated list of tag names.
Usage:
$watchList = R::taggedAll(
'movie',
[ 'gothic', 'short' ],
' ORDER BY movie.id DESC LIMIT ? ',
[ 4 ]
);
The example above returns at most 4 movies (due to the LIMIT clause in the SQL Query Snippet) that have been tagged as BOTH 'short' AND 'gothic'.
| string | $beanType | type of bean you are looking for |
| array|string | $tagList | list of tags to match |
| string | $sql | additional sql snippet |
| array | $bindings | bindings |
countTaggedAll(string $beanType, array|string $tagList, string $sql = '', array $bindings = array()) : integer
Like taggedAll() but only counts.
| string | $beanType | type of bean you are looking for |
| array|string | $tagList | list of tags to match |
| string | $sql | additional sql snippet |
| array | $bindings | bindings |
countTagged(string $beanType, array|string $tagList, string $sql = '', array $bindings = array()) : integer
Like tagged() but only counts.
| string | $beanType | type of bean you are looking for |
| array|string | $tagList | list of tags to match |
| string | $sql | additional sql snippet |
| array | $bindings | bindings |
findTagByTitle(string $title) : \RedBeanPHP\OODBBean|NULL
Finds a tag bean by its title.
Internal method.
| string | $title | title to search for |
extractTagsIfNeeded(array|string|false $tagList) : array
Checks if the argument is a comma separated string, in this case it will split the string into words and return an array instead.
In case of an array the argument will be returned 'as is'.
| array|string|false | $tagList | list of tags |