| Property | Type | Description | |
|---|---|---|---|
| $_app | string | The application this browser is for. | |
| $_dirty | boolean | Dirty flag | |
| $_owner | string | The user whose resources we are searching. | |
| $_results | array | Results cache. Holds the results of the current search. | |
| $_tagger | Horde_Core_Tagger | The Tagger object. | |
| $_tags | array | Tags are always added to the search by name and stored by name=>id. | |
| $_totalCount | integer | Total count of matches. |
| Method | Description | |
|---|---|---|
| __construct ( Horde_Core_Tagger $tagger, array $tags = null, string $owner = null ) | Const'r | |
| addTag ( string $tag ) | Add a tag to the cumulative tag search | |
| clearSearch ( ) | Clears the session cache of tags currently included in the search. | |
| count ( ) : integer | Get the total number of resources that match. | |
| getRelatedTags ( array $default_results = null ) : array | Get a list of tags related to this search. Concrete tagger classes can override the _getRelatedTagsWith* methods if they can perform them more efficiently. | |
| getSlice ( integer $page, integer $perpage = null ) : array | Fetch the matching resources that should appear on the current page | |
| getTagTrail ( ) : Return | Get breadcrumb style navigation html for choosen tags | |
| getTags ( ) : array | Get the list of currently choosen tags | |
| removeTag ( string $tag ) | Remove a tag from the cumulative search | |
| runSearch ( ) | Perform, and cache the search. | |
| save ( ) | Saves current state to the session. | |
| tagCount ( ) : integer | Get the total number of tags included in this search. |
| Method | Description | |
|---|---|---|
| _getRelatedTagsWithNoResults ( ) : array | Default implementation for getting related tags when we don't have any current search in effect. This is very inefficent and should only be used as a very last resort. Better to have concrete classes provide the full result set. See _getRelatedTagsWithResults(). | |
| _getRelatedTagsWithResults ( array $default_results = null ) : array | Default implementation for getRelatedTags | |
| _runSearch ( ) : array | Default implementation for runSearch. | |
| _sortTagInfo ( $a, $b ) | Helper for uasort. Sorts the results by count. |
| public __construct ( Horde_Core_Tagger $tagger, array $tags = null, string $owner = null ) | ||
| $tagger | Horde_Core_Tagger | The tagger object. |
| $tags | array | Tags to add to initially search on. |
| $owner | string | Restrict to resources owned by owner. |
| protected _getRelatedTagsWithNoResults ( ) : array | ||
| return | array | An array of tag_id => [tag_name, total] |
| protected _getRelatedTagsWithResults ( array $default_results = null ) : array | ||
| $default_results | array | A default list of object ids to use to fetch tags from. Used when the current search results are empty. |
| return | array | An array of tag_id => [tag_name, total]. |
| protected _runSearch ( ) : array | ||
| return | array | An array of search results. Either a one dimensional array containing local object uids, or a multi dimensional array of object_type => array_of_uids, .... |
| protected _sortTagInfo ( $a, $b ) |
| public clearSearch ( ) |
| public getRelatedTags ( array $default_results = null ) : array | ||
| $default_results | array | A default list of object ids to use to fetch tags from. Used when the current search results are empty. |
| return | array | An array tag_id => {tag_name, total} |
| abstract public getTagTrail ( ) : Return | ||
| return | Return | information useful for building a tag trail. |
| protected string $_app | ||
| return | string | |
| protected string $_owner | ||
| return | string | |
| protected array $_results | ||
| return | array | |
| protected Horde_Core_Tagger $_tagger | ||
| return | Horde_Core_Tagger | |
| protected array $_tags | ||
| return | array | |
| protected int $_totalCount | ||
| return | integer | |