Stud.IP  jlu_4.3 Revision 64286
RoomSearch Class Reference
Inheritance diagram for RoomSearch:
Inheritance graph
Collaboration diagram for RoomSearch:
Collaboration graph

Public Member Functions

 __construct ()
 
 getTitle ()
 
 getResults ( $keyword, $contextual_data=[], $limit=PHP_INT_MAX, $offset=0)
 
- Public Member Functions inherited from ResourceSearch
 __construct ()
 
 setAcceptedPermissionLevels ($levels=[])
 
 getAcceptedPermissionLevels ()
 
 setUseOfGlobalPermissions ($use_global_permissions=true)
 
 getUseOfGlobalPermissions ()
 
 setAdditionalDisplayProperties ($properties=[])
 
 getAdditionalDisplayProperties ()
 
 setAdditionalPropertyFormat ($format='[%s]')
 
 getAdditionalPropertyFormat ()
 
 setSearchableResourceClasses ($classes=[])
 
 getSearchableResourceClasses ()
 
 getTitle ()
 
 getResults ( $keyword, $contextual_data=[], $limit=PHP_INT_MAX, $offset=0)
 
 includePath ()
 
- Public Member Functions inherited from SearchType
 getTitle ()
 
 getAvatar ($id)
 
 getAvatarImageTag ($id)
 
 getResults ($keyword, $contextual_data=array(), $limit=PHP_INT_MAX, $offset=0)
 
 includePath ()
 

Additional Inherited Members

- Protected Attributes inherited from ResourceSearch
 $accepted_permission_levels
 
 $use_global_permissions
 
 $additional_display_properties
 
 $additional_property_format
 
 $searchable_resource_classes
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Reimplemented from ResourceSearch.

Member Function Documentation

◆ getResults()

getResults (   $keyword,
  $contextual_data = [],
  $limit = PHP_INT_MAX,
  $offset = 0 
)
Parameters
string$keywordThe name of the room or a part of it.
array$contextual_dataThis parameter is not used at the moment.

Reimplemented from ResourceSearch.

Here is the call graph for this function:

◆ getTitle()

getTitle ( )

title of the search like "search for courses" or just "courses"

Returns
string

Reimplemented from ResourceSearch.


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