.

ISearchAdapter Interface Reference
[Interfaces]

Defines Interface to abstract search. More...

Inheritance diagram for ISearchAdapter:
IDataObject DataObjectBase DAOCache DAOCoursesTest DAOFormvalidations DAORoomsTest DAOSessions DAOStudentsTest DAOStudentsTest2CoursesTest DAOSystemupdates DAOTeachersTest DataObjectCached

List of all members.

Public Member Functions

  apply_modifier ($modifier)
  Apply a modifier.
  count ()
  Count resulting items.
  execute ()
  Execute search.
  get_filters ()
  Return array of filters.
  get_sort_default_column ()
  Get the column to sort by default.
  get_sortable_columns ()
  Return array of sortable columns.
  limit ($start=0, $number_of_items=0)
  Limit result.
  sort ($column, $order=self::ASC)
  Sort result by colum.

Public Attributes

const  ASC = 'ASC'
const  CLEAR = 'CLEAR_SORT'
const  DESC = 'DESC'

Detailed Description

Defines Interface to abstract search.

Author:
Gerd Riesselmann

Definition at line 8 of file isearchadapter.cls.php.


Member Function Documentation

ISearchAdapter::apply_modifier ( modifier  ) 

Apply a modifier.

Parameters:
IDBQueryModifier  The modifier to be applied

Implemented in DataObjectBase.

ISearchAdapter::count (  ) 

Count resulting items.

Implemented in DataObjectBase.

ISearchAdapter::execute (  ) 

Execute search.

Returns:
array Array of result items

Implemented in DataObjectBase.

ISearchAdapter::get_filters (  ) 

Return array of filters.

Array has filter as key and a readable description as value

Implemented in DataObjectBase.

ISearchAdapter::get_sort_default_column (  ) 

Get the column to sort by default.

Implemented in DataObjectBase.

ISearchAdapter::get_sortable_columns (  ) 

Return array of sortable columns.

Array has column name as key and a sort type (enum) as value

Implemented in DataObjectBase.

ISearchAdapter::limit ( start = 0,
number_of_items = 0  
)

Limit result.

Implemented in DataObjectBase.

ISearchAdapter::sort ( column,
order = self::ASC  
)

Sort result by colum.

Pass self::CLEAR to clear current sort

Parameters:
String  column name
Enum  'asc' or 'desc'

Implemented in DataObjectBase.


Member Data Documentation

Definition at line 9 of file isearchadapter.cls.php.

const ISearchAdapter::CLEAR = 'CLEAR_SORT'

Definition at line 12 of file isearchadapter.cls.php.

Definition at line 10 of file isearchadapter.cls.php.


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