| [ 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: | 308 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ForumSearchDocument:: (11 methods):
__construct()
forum_make_link()
forum_iterator()
forum_get_content_for_index()
forum_single_document()
forum_delete()
forum_db_names()
forum_get_discussions_fast()
forum_get_child_posts_fast()
forum_check_text_access()
forum_link_post_processing()
Class: ForumSearchDocument - X-Ref
a class for representing searchable information| __construct(&$post, $forum_id, $course_id, $itemtype, $context_id) X-Ref |
| constructor |
| forum_make_link($discussion_id, $post_id) X-Ref |
| constructs a valid link to a chat content param: discussion_id the discussion param: post_id the id of a single post return: a well formed link to forum message display |
| forum_iterator() X-Ref |
| search standard API |
| forum_get_content_for_index(&$forum) X-Ref |
| search standard API param: forum a forum instance return: an array of searchable documents |
| forum_single_document($id, $itemtype) X-Ref |
| returns a single forum search document based on a forum entry id param: id an id for a single information stub param: itemtype the type of information |
| forum_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. |
| forum_db_names() X-Ref |
| returns the var names needed to build a sql query for addition/deletions |
| forum_get_discussions_fast($forum_id) X-Ref |
| reworked faster version from /mod/forum/lib.php param: forum_id a forum identifier return: an array of posts |
| forum_get_child_posts_fast($parent, $forum_id) X-Ref |
| reworked faster version from /mod/forum/lib.php param: parent the id of the first post within the discussion param: forum_id the forum identifier return: an array of posts |
| forum_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 forums, 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 |
| forum_link_post_processing($title) X-Ref |
| post processes the url for cleaner output. param: string $title |
| Generated: Wed Jan 14 11:33:29 2009 | Cross-referenced by PHPXref 0.7 |