[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/search/classes/ -> base_activity.php (summary)

Search area base class for activities.

Copyright: 2016 Dan Poltawski
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 192 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  get_recordset_by_timestamp()
  get_document()
  check_access()
  get_doc_url()
  get_context_url()
  get_module_name()
  get_activity()

Functions
Functions that are not part of a class:

get_recordset_by_timestamp($modifiedfrom = 0)   X-Ref
Returns recordset containing required data for indexing activities.

param: int $modifiedfrom timestamp
return: \moodle_recordset

get_document($record, $options = array()   X-Ref
Returns the document associated with this activity.

This default implementation for activities sets the activity name to title and the activity intro to
content. Any activity can overwrite this function if it is interested in setting other fields than the
default ones, or to fill description optional fields with extra stuff.

param: stdClass $record
param: array    $options
return: \core_search\document

check_access($id)   X-Ref
Whether the user can access the document or not.

param: int $id The activity instance id.
return: bool

get_doc_url(\core_search\document $doc)   X-Ref
Link to the module instance.

param: \core_search\document $doc
return: \moodle_url

get_context_url(\core_search\document $doc)   X-Ref
Link to the module instance.

param: \core_search\document $doc
return: \moodle_url

get_module_name()   X-Ref
Returns the module name.

return: string

get_activity($instanceid)   X-Ref
Returns an activity instance. Internally uses the class component to know which activity module should be retrieved.

param: int $instanceid
return: stdClass



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1