Stud.IP  5.4
TreeSearch Class Reference
Inheritance diagram for TreeSearch:
StandardSearch SQLSearch SearchType

Public Member Functions

 __construct ($search, $search_settings=[])
 
 getTitle ()
 
 includePath ()
 
- Public Member Functions inherited from SearchType
 getTitle ()
 
 getAvatar ($id)
 
 getAvatarImageTag ($id)
 
 getResults ($keyword, $contextual_data=[], $limit=PHP_INT_MAX, $offset=0)
 
 __toString ()
 
 includePath ()
 

Additional Inherited Members

- Data Fields inherited from SearchType
 $extendedLayout = false
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $search,
  $search_settings = [] 
)
Parameters
string$searchThe search type.
Array$search_settingsSettings for the selected seach type. Depending on the search type different settings are possible which can change the output or the display of the output of the search. The array must be an associative array with the setting as array key. The following settings are implemented: Search type 'room':
  • display_seats: If set to true, the seats will be displayed after the name of the room.
Returns
void

Member Function Documentation

◆ getTitle()

getTitle ( )

returns the title/description of the searchfield

Returns
string title/description

◆ includePath()

includePath ( )

A very simple overwrite of the same method from SearchType class. returns the absolute path to this class for autoincluding this class.

Returns
: path to this class

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