search/documents/label_document.php

   1 <?php
   2 /**
   3 * Global Search Engine for Moodle
   4 *
   5 * @package search
   6 * @category core
   7 * @subpackage document_wrappers
   8 * @author Valery Fremaux [valery.fremaux@club-internet.fr] > 1.9
   9 * @contributor Tatsuva Shirai 20090530
  10 * @date 2008/03/31
  11 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  12 * @version Moodle 2.0
  13 *
  14 * document handling for all resources
  15 * This file contains the mapping between a resource and it's indexable counterpart,
  16 *
  17 * Functions for iterating and retrieving the necessary records are now also included
  18 * in this file, rather than mod/resource/lib.php
  19 */
  20
  21 /**
  22 * requires and includes
  23 */
  24 require_once($CFG->dirroot.'/search/documents/document.php');
  25 require_once($CFG->dirroot.'/mod/resource/lib.php');
  26
  27 /* *
  28 * a class for representing searchable information
  29 *
  30 */
  31 class LabelSearchDocument extends SearchDocument {
  32     public function __construct(&$label, $context_id) {
  33         // generic information; required
  34         $doc->docid     = $label['id'];
  35         $doc->documenttype = SEARCH_TYPE_LABEL;
  36         $doc->itemtype     = 'label';
  37         $doc->contextid    = $context_id;
  38
  39         $doc->title     = strip_tags($label['name']);
  40         $doc->date      = $label['timemodified'];
  41         $doc->author    = '';
  42         $doc->contents  = strip_tags($label['intro']);
  43         $doc->url       = label_make_link($label['course']);
  44
  45         // module specific information; optional
  46         $data = array();
  47
  48         // construct the parent class
  49         parent::__construct($doc, $data, $label['course'], 0, 0, 'mod/'.SEARCH_TYPE_LABEL);
  50     } //constructor
  51 }
  52
  53 /**
  54 * constructs valid access links to information
  55 * @param int $resourceId the of the resource
  56 * @return a full featured link element as a string
  57 */
  58 function label_make_link($course_id) {
  59     global $CFG;
  60
  61     return $CFG->wwwroot.'/course/view.php?id='.$course_id;
  62 }
  63
  64 /**
  65 * part of standard API
  66 *
  67 */
  68 function label_iterator() {
  69     global $DB;
  70
  71     //trick to leave search indexer functionality intact, but allow
  72     //this document to only use the below function to return info
  73     //to be searched
  74     $labels = $DB->get_records('label');
  75     return $labels;
  76 }
  77
  78 /**
  79 * part of standard API
  80 * this function does not need a content iterator, returns all the info
  81 * itself;
  82 * @param $label notneeded to comply API, remember to fake the iterator array though
  83 * @uses $CFG, $DB
  84 * @return an array of searchable documents
  85 */
  86 function label_get_content_for_index(&$label) {
  87     global $CFG, $DB;
  88
  89     // starting with Moodle native resources
  90     $documents = array();
  91
  92     $coursemodule = $DB->get_field('modules', 'id', array('name' => 'label'));
  93     $cm = $DB->get_record('course_modules', array('course' => $label->course, 'module' => $coursemodule, 'instance' => $label->id));
  94     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
  95
  96     $documents[] = new LabelSearchDocument(get_object_vars($label), $context->id);
  97
  98     mtrace("finished label {$label->id}");
  99     return $documents;
 100 }
 101
 102 /**
 103 * part of standard API.
 104 * returns a single resource search document based on a label id
 105 * @uses $CFG, $DB
 106 * @param int $id the id of the accessible document
 107 * @param string $itemtype the nature of the information making the document
 108 * @return a searchable object or null if failure
 109 */
 110 function label_single_document($id, $itemtype) {
 111     global $CFG, $DB;
 112
 113     $label = $DB->get_record('label', array('id' => $id));
 114
 115     if ($label){
 116         $coursemodule = $DB->get_field('modules', 'id', array('name' => 'label'));
 117         $cm = $DB->get_record('course_modules', array('id' => $label->id));
 118         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 119         return new LabelSearchDocument(get_object_vars($label), $context->id);
 120     }
 121     return null;
 122 }
 123
 124 /**
 125 * dummy delete function that aggregates id with itemtype.
 126 * this was here for a reason, but I can't remember it at the moment.
 127 *
 128 */
 129 function label_delete($info, $itemtype) {
 130     $object->id = $info;
 131     $object->itemtype = $itemtype;
 132     return $object;
 133 } //resource_delete
 134
 135 /**
 136 * returns the var names needed to build a sql query for addition/deletions
 137 *
 138 */
 139 function label_db_names() {
 140     //[primary id], [table name], [time created field name], [time modified field name], [docsubtype], [additional where conditions for sql]
 141     return array(array('id', 'label', 'timemodified', 'timemodified', 'label', ''));
 142 }
 143
 144 /**
 145 * this function handles the access policy to contents indexed as searchable documents. If this
 146 * function does not exist, the search engine assumes access is allowed.
 147 * @uses $CFG, $DB
 148 * @param string $path the access path to the module script code
 149 * @param string $itemtype the information subclassing (usefull for complex modules, defaults to 'standard')
 150 * @param int $this_id the item id within the information class denoted by itemtype. In resources, this id
 151 * points to the resource record and not to the module that shows it.
 152 * @param object $user the user record denoting the user who searches
 153 * @param int $group_id the current group used by the user when searching
 154 * @return true if access is allowed, false elsewhere
 155 */
 156 function label_check_text_access($path, $itemtype, $this_id, $user, $group_id, $context_id){
 157     global $CFG, $DB;
 158
 159     $r = $DB->get_record('label', array('id' => $this_id));
 160     $module_context = $DB->get_record('context', array('id' => $context_id));
 161     $cm = $DB->get_record('course_modules', array('id' => $module_context->instanceid));
 162
 163     if (empty($cm)) return false; // Shirai 20090530 - MDL19342 - course module might have been delete
 164
 165     $course_context = get_context_instance(CONTEXT_COURSE, $r->course);
 166
 167     //check if englobing course is visible
 168     if (!is_enrolled($course_context) and !is_viewing($course_context)) {
 169         return false;
 170     }
 171
 172     //check if found course module is visible
 173     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', $module_context)){
 174         return false;
 175     }
 176
 177     return true;
 178 }
 179
 180 /**
 181 * post processes the url for cleaner output.
 182 * @param string $title
 183 */
 184 function label_link_post_processing($title){
 185     global $CFG;
 186
 187     if ($CFG->block_search_utf8dir){
 188         return mb_convert_encoding("(".shorten_text(clean_text($title), 60)."...) ", 'UTF-8', 'auto');
 189     }
 190     return mb_convert_encoding("(".shorten_text(clean_text($title), 60)."...) ", 'auto', 'UTF-8');
 191 }
 192 ?>