<?php
/* $Id$ */
namespace MCMS\Interfaces;

(defined('MCMS') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');

/**
 * Interface that has to be implemented by searchable content.
 * 
 * @author Stefan Daurer <s.daurer@q-spot.org>
 * @package MCMS\System
 */
interface iSearchable {

	/**
	 * @return array a list of search area ids
	 */
	public static function getSearchAreas($siteId, $instanceName);
	
	/**
	 * Chechs if a user is allowed to seach in this instance(area)
	 * @param integer $siteId
	 * @param string $instanceName
	 * @param string $area
	 * @return boolean true if allowed
	 */
	public static function isSeachAllowedIn($siteId, $instanceName, $area = NULL);

	/**
	 * @return string a search area name
	 */
	public static function getSearchAreaName($siteId, $instanceName, $area, $locale = NULL);

	/**
	 * Runs a search and returns a result array with result objects (keys: url, title, info, date (optional))
	 * @return \MCMS\Data\SearchResult[] the search results
	 * @see \MCMS\Data\SearchResult
	 */
	public static function search($siteId, $instanceName, $area, $condition);
}