| [ Index ] |
PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008] |
[Source view] [Print] [Project Stats]
Global Search Engine for Moodle
| Author: | Michael Campanis (mchampan) [cynnical@gmail.com], Valery Fremaux [valery.fremaux@club-internet.fr] > 1.8 |
| License: | http://www.gnu.org/copyleft/gpl.html GNU Public License |
| File Size: | 216 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
LessonPageSearchDocument:: (9 methods):
__construct()
lesson_make_link()
lesson_iterator()
lesson_get_content_for_index()
lesson_single_document()
lesson_delete()
lesson_db_names()
lesson_check_text_access()
lesson_link_post_processing()
Class: LessonPageSearchDocument - X-Ref
a class for representing searchable information| __construct(&$page, $lessonmodule_id, $course_id, $itemtype, $context_id) X-Ref |
| constructor |
| lesson_make_link($lessonmoduleid, $itemid, $itemtype) X-Ref |
| constructs a valid link to a chat content param: int $lessonid the lesson module param: int $itemid the id of a single page return: a well formed link to lesson page |
| lesson_iterator() X-Ref |
| search standard API |
| lesson_get_content_for_index(&$lesson) X-Ref |
| search standard API param: object $lesson a lesson instance (by ref) return: an array of searchable documents |
| lesson_single_document($id, $itemtype) X-Ref |
| returns a single lesson search document based on a lesson page id param: int $id an id for a single information item param: string $itemtype the type of information |
| lesson_delete($info, $itemtype) X-Ref |
| dummy delete function that aggregates id with itemtype. this was here for a reason, but I can't remember it at the moment. |
| lesson_db_names() X-Ref |
| returns the var names needed to build a sql query for addition/deletions |
| lesson_check_text_access($path, $itemtype, $this_id, $user, $group_id, $context_id) X-Ref |
| this function handles the access policy to contents indexed as searchable documents. If this function does not exist, the search engine assumes access is allowed. When this point is reached, we already know that : - user is legitimate in the surrounding context - user may be guest and guest access is allowed to the module - the function may perform local checks within the module information logic param: string $path the access path to the module script code param: string $itemtype the information subclassing (usefull for complex modules, defaults to 'standard') param: int $this_id the item id within the information class denoted by itemtype. In lessons, this id param: object $user the user record denoting the user who searches param: int $group_id the current group used by the user when searching param: int $context_id the id of the context used when indexing return: true if access is allowed, false elsewhere |
| lesson_link_post_processing($title) X-Ref |
| this call back is called when displaying the link for some last post processing |
| Generated: Wed Jan 14 11:33:29 2009 | Cross-referenced by PHPXref 0.7 |