Class: GallerySearchInterface_1_0

Source Location: /modules/search/classes/GallerySearchInterface_1_0.class

Class GallerySearchInterface_1_0

Class Overview

This is an interface for the search module. Modules that wish to work with the Search module must provide a class that implements this interface.

Located in /modules/search/classes/GallerySearchInterface_1_0.class [line 39]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
MultiLangSearch	This is an implementation of the search module's SearchInterface_1_0
GalleryCoreSearch	This is an implementation of the search module's SearchInterface_1_0
GalleryCommentSearch	This is an implementation of the search module's SearchInterface_1_0
CustomFieldSearch	This is an implementation of the search module's SearchInterface_1_0

[ Top ]

Method Summary

array	getSearchModuleInfo()	Return the name, description and searchable options of this searchable subsystem
array	search()	Search the module for the given criteria with the given options

[ Top ]

Methods

getSearchModuleInfo [line 57]

array getSearchModuleInfo(
)

Return the name, description and searchable options of this searchable subsystem

API Tags:

Return:

array GalleryStatus a status code, array('name' => '...', 'description' => '...', 'options' => array('option_key_1' => array('description' => 'Option 1', 'enabled' => 1), 'option_key_2' => array('description' => 'Option 2', 'enabled' => 0), 'option_key_3' => array('description' => 'Option 3', 'enabled' => 1)))

Redefined in descendants as:

[ Top ]

search [line 81]

array search(
array
$options, string
$criteria, [int
$offset = 0], [int
$count = -1] 
)

Search the module for the given criteria with the given options

Parameters:

array	$options:	array('option_key_1', 'option_key_3')
string	$criteria:	search criteria
int	$offset:	(optional) which hit to start with
int	$count:	(optional) how many hits to show

API Tags:

Return:

GalleryStatus a status code, array('start' => 1..#, 'end' => 1..#, 'count' => #, 'results' => array(itemId => id, array(array('key' => 'localized title', 'value' => 'localized text'), array('key' => 'localized title', 'value' => 'localized text'), array('key' => 'localized title', 'value' => 'localized text'))))

Redefined in descendants as:

[ Top ]

Documentation generated on Fri, 03 Oct 2008 05:11:34 -0700 by phpDocumentor 1.3.0RC6

	Search Classes

[ class tree: Search ] [ index: Search ] [ all elements ]