mirror of
https://github.com/moodle/moodle.git
synced 2025-03-04 08:06:30 +01:00
fc440796e9
Implements a mechanism by which search engines can provide different result orderings, and implements a 'by location' ordering within the Solr search engine (available whenever the user starts their search from within a course or activity).
116 lines
4.4 KiB
PHP
116 lines
4.4 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Global search search form definition
|
|
*
|
|
* @package core_search
|
|
* @copyright Prateek Sachan {@link http://prateeksachan.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_search\output\form;
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
require_once($CFG->libdir . '/formslib.php');
|
|
|
|
class search extends \moodleform {
|
|
|
|
/**
|
|
* Form definition.
|
|
*
|
|
* @return void
|
|
*/
|
|
function definition() {
|
|
global $CFG;
|
|
|
|
$mform =& $this->_form;
|
|
$mform->disable_form_change_checker();
|
|
$mform->addElement('header', 'search', get_string('search', 'search'));
|
|
|
|
// Help info depends on the selected search engine.
|
|
$mform->addElement('text', 'q', get_string('enteryoursearchquery', 'search'));
|
|
$mform->addHelpButton('q', 'searchinfo', $this->_customdata['searchengine']);
|
|
$mform->setType('q', PARAM_TEXT);
|
|
$mform->addRule('q', get_string('required'), 'required', null, 'client');
|
|
|
|
// Show the 'search within' option if the user came from a particular context.
|
|
if (!empty($this->_customdata['searchwithin'])) {
|
|
$mform->addElement('select', 'searchwithin', get_string('searchwithin', 'search'),
|
|
$this->_customdata['searchwithin']);
|
|
$mform->setDefault('searchwithin', '');
|
|
}
|
|
|
|
// If the search engine provides multiple ways to order results, show options.
|
|
if (!empty($this->_customdata['orderoptions']) &&
|
|
count($this->_customdata['orderoptions']) > 1) {
|
|
|
|
$mform->addElement('select', 'order', get_string('order', 'search'),
|
|
$this->_customdata['orderoptions']);
|
|
$mform->setDefault('order', 'relevance');
|
|
}
|
|
|
|
$mform->addElement('header', 'filtersection', get_string('filterheader', 'search'));
|
|
$mform->setExpanded('filtersection', false);
|
|
|
|
$mform->addElement('text', 'title', get_string('title', 'search'));
|
|
$mform->setType('title', PARAM_TEXT);
|
|
|
|
$search = \core_search\manager::instance();
|
|
|
|
$searchareas = \core_search\manager::get_search_areas_list(true);
|
|
$areanames = array();
|
|
foreach ($searchareas as $areaid => $searcharea) {
|
|
$areanames[$areaid] = $searcharea->get_visible_name();
|
|
}
|
|
|
|
// Sort the array by the text.
|
|
\core_collator::asort($areanames);
|
|
|
|
$options = array(
|
|
'multiple' => true,
|
|
'noselectionstring' => get_string('allareas', 'search'),
|
|
);
|
|
$mform->addElement('autocomplete', 'areaids', get_string('searcharea', 'search'), $areanames, $options);
|
|
|
|
$options = array(
|
|
'multiple' => true,
|
|
'limittoenrolled' => !is_siteadmin(),
|
|
'noselectionstring' => get_string('allcourses', 'search'),
|
|
);
|
|
$mform->addElement('course', 'courseids', get_string('courses', 'core'), $options);
|
|
$mform->setType('courseids', PARAM_INT);
|
|
|
|
// Course options should be hidden if we choose to search within a specific location.
|
|
if (!empty($this->_customdata['searchwithin'])) {
|
|
$mform->hideIf('courseids', 'searchwithin', 'ne', '');
|
|
}
|
|
|
|
$mform->addElement('date_time_selector', 'timestart', get_string('fromtime', 'search'), array('optional' => true));
|
|
$mform->setDefault('timestart', 0);
|
|
|
|
$mform->addElement('date_time_selector', 'timeend', get_string('totime', 'search'), array('optional' => true));
|
|
$mform->setDefault('timeend', 0);
|
|
|
|
// Source context i.e. the page they came from when they clicked search.
|
|
$mform->addElement('hidden', 'context');
|
|
$mform->setType('context', PARAM_INT);
|
|
|
|
$this->add_action_buttons(false, get_string('search', 'search'));
|
|
}
|
|
}
|