| [ 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: | 274 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WikiSearchDocument:: (13 methods):
__construct()
wiki_name_convert()
wiki_make_link()
wiki_get_latest_page()
wiki_get_pages()
wiki_get_latest_pages()
wiki_iterator()
wiki_get_content_for_index()
wiki_single_document()
wiki_delete()
wiki_db_names()
wiki_check_text_access()
wiki_link_post_processing()
Class: WikiSearchDocument - X-Ref
All the $doc->___ fields are required by the base document class!| __construct(&$page, $wiki_id, $course_id, $group_id, $user_id, $context_id) X-Ref |
| No description |
| wiki_name_convert($str) X-Ref |
| converts a page name to cope Wiki constraints. Transforms spaces in plus. param: str the name to convert return: the converted name |
| wiki_make_link($wikiId, $title, $version) X-Ref |
| constructs a valid link to a wiki content param: int $wikiId param: string $title param: int $version |
| wiki_get_latest_page(&$entry, $pagename, $version = 0) X-Ref |
| rescued and converted from ewikimoodlelib.php retrieves latest version of a page param: object $entry the wiki object as a reference param: string $pagename the name of the page known by the wiki engine param: int $version |
| wiki_get_pages(&$entry) X-Ref |
| fetches all pages, including old versions param: object $entry the wiki object as a reference return: an array of record objects that represents pages of this wiki object |
| wiki_get_latest_pages(&$entry) X-Ref |
| fetches all the latest versions of all the pages param: object $entry |
| wiki_iterator() X-Ref |
| part of search engine API |
| wiki_get_content_for_index(&$wiki) X-Ref |
| part of search engine API param: wiki a wiki instance return: an array of searchable deocuments |
| wiki_single_document($id, $itemtype) X-Ref |
| returns a single wiki search document based on a wiki_entry id param: id the id of the wiki param: itemtype the type of information (standard) return: a searchable document |
| wiki_delete($info, $itemtype) X-Ref |
| dummy delete function that packs id with itemtype. this was here for a reason, but I can't remember it at the moment. |
| wiki_db_names() X-Ref |
| No description |
| wiki_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: path the access path to the module script code param: itemtype the information subclassing (usefull for complex modules, defaults to 'standard') param: this_id the item id within the information class denoted by itemtype. In wikies, this id param: user the user record denoting the user who searches param: group_id the current group used by the user when searching return: true if access is allowed, false elsewhere |
| wiki_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 |