[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/mod/book/classes/search/ -> chapter.php (summary)

Search area for mod_book chapters.

Copyright: 2016 Eric Merrill {@link http://www.merrilldigital.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 161 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

chapter:: (5 methods):
  get_recordset_by_timestamp()
  get_document()
  check_access()
  get_doc_url()
  get_context_url()


Class: chapter  - X-Ref

Search area for mod_book chapters.

get_recordset_by_timestamp($modifiedfrom = 0)   X-Ref
Returns a recordset with all required chapter information.

param: int $modifiedfrom
return: moodle_recordset

get_document($record, $options = array()   X-Ref
Returns the document for a particular chapter.

param: \stdClass $record A record containing, at least, the indexed document id and a modified timestamp
param: array     $options Options for document creation
return: \core_search\document

check_access($id)   X-Ref
Can the current user see the document.

param: int $id The internal search area entity id.
return: bool True if the user can see it, false otherwise

get_doc_url(\core_search\document $doc)   X-Ref
Returns a url to the chapter.

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

get_context_url(\core_search\document $doc)   X-Ref
Returns a url to the book.

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



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