David Monllao
db48207e1a
Introducing both APIs in moodle along with: - search_box widget to add a tiny search box - admin settings with setup steps helper - cache for search results - template for a search result - php unit stuff Many thanks to Tomasz Muras, Prateek Sachan and Daniel Neis for their contributions, for starting this development and for pushing for it to be completed. Also thanks to other contributors: Jonathan Harker and eugeneventer.
107 lines
3.6 KiB
PHP
107 lines
3.6 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/>.
|
|
|
|
/**
|
|
* Search renderer.
|
|
*
|
|
* @package core_search
|
|
* @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_search\output;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Search renderer.
|
|
*
|
|
* @package core_search
|
|
* @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class renderer extends \plugin_renderer_base {
|
|
|
|
/**
|
|
* @var int Max number chars to display of a string value
|
|
*/
|
|
const SEARCH_RESULT_STRING_SIZE = 100;
|
|
|
|
/**
|
|
* @var int Max number chars to display of a text value
|
|
*/
|
|
|
|
const SEARCH_RESULT_TEXT_SIZE = 500;
|
|
|
|
/**
|
|
* Renders search results.
|
|
*
|
|
* @param \core_search\document[] $results
|
|
* @param int $page
|
|
* @param \moodle_url $url
|
|
* @return string HTML
|
|
*/
|
|
public function render_results($results, $page = 0, $url) {
|
|
|
|
// Paging bar.
|
|
$perpage = \core_search\manager::DISPLAY_RESULTS_PER_PAGE;
|
|
$content = $this->output->paging_bar(count($results), $page, $perpage, $url);
|
|
|
|
// Results.
|
|
$resultshtml = array();
|
|
$hits = array_slice($results, $page * $perpage, $perpage, true);
|
|
foreach ($hits as $hit) {
|
|
$resultshtml[] = $this->render_result($hit);
|
|
}
|
|
$content .= \html_writer::tag('div', implode('<hr/>', $resultshtml), array('class' => 'search-results'));
|
|
|
|
// Paging bar.
|
|
$content .= $this->output->paging_bar(count($results), $page, $perpage, $url);
|
|
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
* Displaying search results.
|
|
*
|
|
* @param \core_search\document Containing a single search response to be displayed.a
|
|
* @return string HTML
|
|
*/
|
|
public function render_result(\core_search\document $doc) {
|
|
$docdata = $doc->export_for_template($this);
|
|
|
|
// Limit text fields size.
|
|
$docdata['title'] = shorten_text($docdata['title'], static::SEARCH_RESULT_STRING_SIZE, true);
|
|
$docdata['content'] = $docdata['content'] ? shorten_text($docdata['content'], static::SEARCH_RESULT_TEXT_SIZE, true) : '';
|
|
$docdata['description1'] = $docdata['description1'] ? shorten_text($docdata['description1'], static::SEARCH_RESULT_TEXT_SIZE, true) : '';
|
|
$docdata['description2'] = $docdata['description2'] ? shorten_text($docdata['description2'], static::SEARCH_RESULT_TEXT_SIZE, true) : '';
|
|
|
|
return $this->output->render_from_template('core_search/result', $docdata);
|
|
}
|
|
|
|
/**
|
|
* Returns a box with a search disabled lang string.
|
|
*
|
|
* @return string HTML
|
|
*/
|
|
public function render_search_disabled() {
|
|
$content = $this->output->box_start();
|
|
$content .= $this->output->notification(get_string('globalsearchdisabled', 'search'), 'notifymessage');
|
|
$content .= $this->output->box_end();
|
|
return $content;
|
|
}
|
|
}
|