Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Search area for Moodle courses.

 *

 * @package    core_course

 * @copyright  2016 Skylar Kelty <S.Kelty@kent.ac.uk>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

namespace core_course\search;

defined('MOODLE_INTERNAL') || die();

/**

 * Search area for Moodle courses.

 *

 * @package    core_course

 * @copyright  2016 Skylar Kelty <S.Kelty@kent.ac.uk>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class course extends \core_search\base {

    /**

     * The context levels the search implementation is working on.

     *

     * @var array

     */

    protected static $levels = [CONTEXT_COURSE];

    /**

     * Returns recordset containing required data for indexing courses.

     *

     * @param int $modifiedfrom timestamp

     * @param \context|null $context Restriction context

     * @return \moodle_recordset|null Recordset or null if no change possible

     */

    public function get_document_recordset($modifiedfrom = 0, \context $context = null) {

        global $DB;

        list ($contextjoin, $contextparams) = $this->get_course_level_context_restriction_sql(

                $context, 'c');

        if ($contextjoin === null) {

            return null;

        }

        return $DB->get_recordset_sql("

                SELECT c.*

                  FROM {course} c

          $contextjoin

                 WHERE c.timemodified >= ?

              ORDER BY c.timemodified ASC", array_merge($contextparams, [$modifiedfrom]));

    }

    /**

     * Returns the document associated with this course.

     *

     * @param \stdClass $record

     * @param array    $options

     * @return \core_search\document

     */

    public function get_document($record, $options = array()) {

        try {

            $context = \context_course::instance($record->id);

        } catch (\moodle_exception $ex) {

            // Notify it as we run here as admin, we should see everything.

            debugging('Error retrieving ' . $this->areaid . ' ' . $record->id . ' document, not all required data is available: ' .

                $ex->getMessage(), DEBUG_DEVELOPER);

            return false;

        }

        // Prepare associative array with data from DB.

        $doc = \core_search\document_factory::instance($record->id, $this->componentname, $this->areaname);

        $doc->set('title', content_to_text($record->fullname, false));

        $doc->set('content', content_to_text($record->summary, $record->summaryformat));

        $doc->set('contextid', $context->id);

        $doc->set('courseid', $record->id);

        $doc->set('owneruserid', \core_search\manager::NO_OWNER_ID);

        $doc->set('modified', $record->timemodified);

        $doc->set('description1', $record->shortname);

        // Check if this document should be considered new.

        if (isset($options['lastindexedtime']) && $options['lastindexedtime'] < $record->timecreated) {

            // If the document was created after the last index time, it must be new.

            $doc->set_is_new(true);

        }

        return $doc;

    }

    /**

     * Whether the user can access the document or not.

     *

     * @param int $id The course instance id.

     * @return int

     */

    public function check_access($id) {

        global $DB;

        $course = $DB->get_record('course', array('id' => $id));

        if (!$course) {

            return \core_search\manager::ACCESS_DELETED;

        }

        if (\core_course_category::can_view_course_info($course)) {

            return \core_search\manager::ACCESS_GRANTED;

        }

        return \core_search\manager::ACCESS_DENIED;

    }

    /**

     * Link to the course.

     *

     * @param \core_search\document $doc

     * @return \moodle_url

     */

    public function get_doc_url(\core_search\document $doc) {

        return $this->get_context_url($doc);

    }

    /**

     * Link to the course.

     *

     * @param \core_search\document $doc

     * @return \moodle_url

     */

    public function get_context_url(\core_search\document $doc) {

        return new \moodle_url('/course/view.php', array('id' => $doc->get('courseid')));

    }

    /**

     * Returns true if this area uses file indexing.

     *

     * @return bool

     */

    public function uses_file_indexing() {

        return true;

    }

    /**

     * Return the context info required to index files for

     * this search area.

     *

     * Should be overridden by each search area.

     *

     * @return array

     */

    public function get_search_fileareas() {

        $fileareas = array(

                'overviewfiles',

                'summary'// Fileareas.

        );

        return $fileareas;

    }

    /**

     * Returns the moodle component name.

     *

     * It might be the plugin name (whole frankenstyle name) or the core subsystem name.

     *

     * @return string

     */

    public function get_component_name() {

        return 'course';

    }

    /**

     * Returns an icon instance for the document.

     *

     * @param \core_search\document $doc

     * @return \core_search\document_icon

     */

    public function get_doc_icon(\core_search\document $doc): \core_search\document_icon {

        return new \core_search\document_icon('i/course');

    }

    /**

     * Returns a list of category names associated with the area.

     *

     * @return array

     */

    public function get_category_names() {

        return [\core_search\manager::SEARCH_AREA_CATEGORY_COURSES];

    }

}