[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/search/documents/ -> techproject_document.php (summary)

Global Search Engine for Moodle

Author: Michael Campanis, Valery Fremaux [valery.fremaux@club-internet.fr] > 1.8
License: http://www.gnu.org/copyleft/gpl.html GNU Public License
File Size: 301 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

TechprojectEntrySearchDocument:: (11 methods):
  __construct()
  techproject_make_link()
  techproject_iterator()
  techproject_get_content_for_index()
  techproject_single_document()
  techproject_delete()
  techproject_db_names()
  techproject_get_entries()
  techproject_get_tasks()
  techproject_check_text_access()
  techproject_link_post_processing()


Class: TechprojectEntrySearchDocument  - X-Ref

a class for representing searchable information

__construct(&$entry, $course_id, $context_id)   X-Ref
constructor


techproject_make_link($techproject_id, $entry_id, $entry_type, $group_id)   X-Ref
constructs a valid link to a description detail


techproject_iterator()   X-Ref
search standard API


techproject_get_content_for_index(&$techproject)   X-Ref
search standard API

param: techproject a techproject instance
return: an array of collected searchable documents

techproject_single_document($id, $itemtype)   X-Ref
returns a single techproject search document based on a techproject_entry id and itemtype


techproject_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.


techproject_db_names()   X-Ref
returns the var names needed to build a sql query for addition/deletions


techproject_get_entries($techproject_id, $type)   X-Ref
get a complete list of entries of one particular type

param: techprojectId the project instance
param: type the entity type
return: an array of records

techproject_get_tasks($techproject_id)   X-Ref
get the task list for a project instance

param: techprojectId the project
return: an array of records that represent tasks

techproject_check_text_access($path, $entry_type, $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: entry_type the information subclassing (usefull for complex modules, defaults to 'standard')
param: this_id the item id within the information class denoted by entry_type. In techprojects, 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

techproject_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