message/classes/search/base_message.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Search area base class for messages.
  19  *
  20  * @package    core_message
  21  * @copyright  2016 Devang Gaur
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 namespace core_message\search;
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 require_once($CFG->dirroot . '/message/lib.php');
  30
  31 /**
  32  * Search area base class for messages.
  33  *
  34  * @package    core_message
  35  * @copyright  2016 Devang Gaur
  36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37  */
  38 abstract class base_message extends \core_search\base {
  39
  40     /**
  41      * The context levels the search area is working on.
  42      * @var array
  43      */
  44     protected static $levels = [CONTEXT_USER];
  45
  46     /**
  47      * Returns the document associated with this message record.
  48      *
  49      * @param stdClass $record
  50      * @param array    $options
  51      * @return \core_search\document
  52      */
  53     public function get_document($record, $options = array()) {
  54         try {
  55             $usercontext = \context_user::instance($options['user1id']);
  56         } catch (\moodle_exception $ex) {
  57             // Notify it as we run here as admin, we should see everything.
  58             debugging('Error retrieving ' . $this->areaid . ' ' . $record->id . ' document, not all required data is available: ' .
  59                     $ex->getMessage(), DEBUG_DEVELOPER);
  60             return false;
  61         }
  62         // Prepare associative array with data from DB.
  63         $doc = \core_search\document_factory::instance($record->id, $this->componentname, $this->areaname);
  64         $doc->set('title', content_to_text($record->subject, false));
  65         $doc->set('itemid', $record->id);
  66         $doc->set('content', content_to_text($record->smallmessage, false));
  67         $doc->set('contextid', $usercontext->id);
  68         $doc->set('courseid', SITEID);
  69         $doc->set('owneruserid', $options['user1id']);
  70         $doc->set('userid', $options['user2id']);
  71         $doc->set('modified', $record->timecreated);
  72
  73         // Check if this document should be considered new.
  74         if (isset($options['lastindexedtime']) && $options['lastindexedtime'] < $record->timecreated) {
  75             // If the document was created after the last index time, it must be new.
  76             $doc->set_is_new(true);
  77         }
  78
  79         return $doc;
  80     }
  81
  82     /**
  83      * Link to the message.
  84      *
  85      * @param \core_search\document $doc
  86      * @return \moodle_url
  87      */
  88     public function get_doc_url(\core_search\document $doc) {
  89         $users = $this->get_current_other_users($doc);
  90         $position = 'm'.$doc->get('itemid');
  91         return new \moodle_url('/message/index.php', array('history' => MESSAGE_HISTORY_ALL,
  92                 'user1' => $users['currentuserid'], 'user2' => $users['otheruserid']), $position);
  93     }
  94
  95     /**
  96      * Link to the conversation.
  97      *
  98      * @param \core_search\document $doc
  99      * @return \moodle_url
 100      */
 101     public function get_context_url(\core_search\document $doc) {
 102         $users = $this->get_current_other_users($doc);
 103         return new \moodle_url('/message/index.php', array('user1' => $users['currentuserid'], 'user2' => $users['otheruserid']));
 104     }
 105
 106     /**
 107      * Sorting the current(user1) and other(user2) user in the conversation.
 108      *
 109      * @param \core_search\document $doc
 110      * @return array()
 111      */
 112     protected function get_current_other_users($doc) {
 113         global $USER;
 114
 115         $users = array();
 116         if (($USER->id == $doc->get('owneruserid')) || (get_class($this) === 'message_sent')) {
 117             $users['currentuserid'] = $doc->get('owneruserid');
 118             $users['otheruserid'] = $doc->get('userid');
 119         } else {
 120             $users['currentuserid'] = $doc->get('userid');
 121             $users['otheruserid'] = $doc->get('owneruserid');
 122         }
 123
 124         return $users;
 125     }
 126
 127 }