Class Ansel_Search_Tag
Ansel_Search_Tags:: class provides logic for dealing with tag searching.
Copyright 2007-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public
Ansel_Search_Tag
|
#
__construct( Ansel_Tagger $tagger, string $tags = null, mixed $owner = null )
Constructor
Parameters
- $tagger
- <p>$tags An array of tag names to match. If null is passed
then the tags will be loaded from the session.</p>
- $tags
- <p>$owner Restrict search to resources owned by specified
owner.</p>
- $owner
-
Returns
|
public
|
#
save( )
Save the current search to the session
Save the current search to the session
|
public
Array
|
#
getSlice( mixed $page, mixed $perpage )
Fetch the matching resources that should appear on the current page
Fetch the matching resources that should appear on the current page
Returns
Array
of Ansel_Images and Ansel_Galleries
|
public
|
#
addTag( string $tag )
Add a tag to the cumulative tag search
Add a tag to the cumulative tag search
Parameters
- $tag
- The tag name to add.
|
public
|
#
removeTag( string $tag )
Remove a tag from the cumulative search
Remove a tag from the cumulative search
Parameters
- $tag
- The tag name to remove.
|
public
array
|
#
getTags( )
Get the list of currently choosen tags
Get the list of currently choosen tags
Returns
array
An array of selected tag_name => tag_id hashes.
|
public
string
|
#
getTagTrail( )
Get breadcrumb style navigation html for choosen tags
Get breadcrumb style navigation html for choosen tags
Returns
string
The html representing the tag trail for browsing tags.
Todo:
Remove the html generation to the view class
|
public
integer
|
#
tagCount( )
Get the total number of tags included in this search.
Get the total number of tags included in this search.
Returns
integer
The number of tags used in the current search.
|
public
array
|
#
count( )
Get the total number of resources that match.
Get the total number of resources that match.
Returns
array
Hash containing totals for both 'galleries' and 'images'.
|
public
array
|
#
getRelatedTags( )
Get a list of tags related to this search
Get a list of tags related to this search
Returns
array
An array tag_id => {tag_name, total}
|
public
|
#
runSearch( )
Perform, and cache the search.
Perform, and cache the search.
|
public static
|
#
clearSearch( )
Clears the session cache of tags currently included in the search.
Clears the session cache of tags currently included in the search.
|