CMS  Version 3.9
Searchable Interface Reference

The Searchable interface must be implemented by any DataItem classes that want to be searchable via the unified site search. More...

+ Inheritance diagram for Searchable:

Public Member Functions

 search ($params, $range=null)
 DataItems must implement this method to provide search functionality. More...
 

Detailed Description

The Searchable interface must be implemented by any DataItem classes that want to be searchable via the unified site search.

Author
andy

Definition at line 44 of file searchable.inc.

Member Function Documentation

◆ search()

Searchable::search (   $params,
  $range = null 
)

DataItems must implement this method to provide search functionality.

Parameters
mixed$paramseither search text or a SearchParameters object
array$rangean array of primary key IDs to which the search must be constrained

Implemented in Page, Document, and Article.


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