Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Backend_Search Class Reference

Static Public Member Functions

static isAvailable ()
 
static processSearch ($search_terms, $restrict_statuses=Array(), $restrict_asset_types=Array())
 

Detailed Description

Definition at line 30 of file backend_search.inc.

Member Function Documentation

static isAvailable ( )
static

Is backend search available?

For backend search to be available, the search manager must be installed.

Returns
boolean public

Definition at line 43 of file backend_search.inc.

static processSearch (   $search_terms,
  $restrict_statuses = Array(),
  $restrict_asset_types = Array() 
)
static

Process a simple search for the backend interface

The $restrict_statuses parameter, if specified, should be an array of statuses, rather than a bitmask, eg. Array(SQ_STATUS_UNDER_CONSTRUCTION, SQ_STATUS_LIVE)

The $restrict_asset_types parameter, if specified, should be specified as an array of (asset type => inherit flag) eg. Array('file' => TRUE, 'folder' => FALSE)

Parameters
string$search_termsThe search term(s) to search upon
array$restrict_statusesIf not empty, restrict statuses to these ones, otherwise search all statuses
array$restrict_asset_typesIf not empty, restrict types searched for to these ones, otherwise search all asset types
Returns
array public

Definition at line 72 of file backend_search.inc.


The documentation for this class was generated from the following file: