UNB Components Code Reference

UnbTag::FindByTagName method

Finds one or more tag instances by their tag name.

public static function UnbTag::FindByTagName ($tagName, $caseless = false, $getAll = false);

Parameters

tagName

(string) Tag name (max. 255 characters)

caseless  –  optional, default: false

(bool) Compare tag names case-insensitive (default is case-sensitive)

getAll  –  optional, default: false

(bool) Return all search results instead only the first (default is only the first result)

Return value

A UnbTag object or an array of UnbTag objects, if successful, null otherwise.

Remarks

Note that this method will only return a single tag if the getAll parameter is false. So if the specified name is not unique (which is possible by the application design), it is undetermined, which of the tags is returned.

Exceptions thrown

InvalidArgumentException No description available.
LengthException No description available.
UnbDatabaseException No description available.

Member of class: UnbTag

Implementation file: tag.class.php, line 199

© 2011 Yves Goergen. UNB Components Homepage. Reference generated on 2011-02-22.