ConstruccionesCNJ_Web/Source/gallery2/modules/search/classes/GallerySearchInterface_1_0.class
2007-10-31 12:30:19 +00:00

79 lines
3.5 KiB
Plaintext

<?php
/*
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2007 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* 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.
*
* @package Search
* @subpackage Classes
* @author Bharat Mediratta <bharat@menalto.com>
* @version $Revision: 15513 $
* @abstract
*/
class GallerySearchInterface_1_0 {
/**
* Return the name, description and searchable options of this searchable subsystem
*
* @return array array(object 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))))
*/
function getSearchModuleInfo() {
return array(GalleryCoreApi::error(ERROR_UNIMPLEMENTED),
null);
}
/**
* Search the module for the given criteria with the given options
*
* @param array $options array('option_key_1', 'option_key_3')
* @param string $criteria search criteria
* @param int $offset (optional) which hit to start with
* @param int $count (optional) how many hits to show
* @return array(object 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')))))
*/
function search($options, $criteria, $offset=0, $count=-1) {
return array(GalleryCoreApi::error(ERROR_UNIMPLEMENTED),
null);
}
}
?>