MDL-55497 mod_forum: Converted quick forum search to a renderable

Part of MDL-55071
This commit is contained in:
Frederic Massart
2016-09-23 10:53:29 +01:00
committed by Dan Poltawski
parent d7c657528a
commit 66bb9eadfe
5 changed files with 116 additions and 16 deletions
@@ -0,0 +1,75 @@
<?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/>.
/**
* Quick search form renderable.
*
* @package mod_forum
* @copyright 2016 Frédéric Massart - FMCorz.net
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_forum\output;
defined('MOODLE_INTERNAL') || die();
use help_icon;
use moodle_url;
use renderable;
use renderer_base;
use templatable;
/**
* Quick search form renderable class.
*
* @package mod_forum
* @copyright 2016 Frédéric Massart - FMCorz.net
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class quick_search_form implements renderable, templatable {
/** @var int The course ID. */
protected $courseid;
/** @var string Current query. */
protected $query;
/** @var moodle_url The form action URL. */
protected $actionurl;
/** @var help_icon The help icon. */
protected $helpicon;
/**
* Constructor.
*
* @param int $courseid The course ID.
* @param string $query The current query.
*/
public function __construct($courseid, $query = '') {
$this->courseid = $courseid;
$this->query = $query;
$this->actionurl = new moodle_url('/mod/forum/search.php');
$this->helpicon = new help_icon('search', 'core');
}
public function export_for_template(renderer_base $output) {
$data = [
'actionurl' => $this->actionurl->out(false),
'courseid' => $this->courseid,
'query' => $this->query,
'helpicon' => $this->helpicon->export_for_template($output),
];
return $data;
}
}
+4 -16
View File
@@ -3928,22 +3928,10 @@ function forum_print_mode_form($id, $mode, $forumtype='') {
* @return string
*/
function forum_search_form($course, $search='') {
global $CFG, $OUTPUT;
$output = '<div class="forumsearch">';
$output .= '<form action="'.$CFG->wwwroot.'/mod/forum/search.php" style="display:inline">';
$output .= '<fieldset class="invisiblefieldset">';
$output .= $OUTPUT->help_icon('search');
$output .= '<label class="accesshide" for="search" >'.get_string('search', 'forum').'</label>';
$output .= '<input id="search" name="search" type="text" size="18" value="'.s($search, true).'" />';
$output .= '<label class="accesshide" for="searchforums" >'.get_string('searchforums', 'forum').'</label>';
$output .= '<input id="searchforums" value="'.get_string('searchforums', 'forum').'" type="submit" />';
$output .= '<input name="id" type="hidden" value="'.$course->id.'" />';
$output .= '</fieldset>';
$output .= '</form>';
$output .= '</div>';
return $output;
global $CFG, $PAGE;
$forumsearch = new \mod_forum\output\quick_search_form($course->id, $search);
$output = $PAGE->get_renderer('mod_forum');
return $output->render($forumsearch);
}
+10
View File
@@ -226,4 +226,14 @@ class mod_forum_renderer extends plugin_renderer_base {
return $editable;
}
/**
* Render quick search form.
*
* @param \mod_forum\output\quick_search_form $form The renderable.
* @return string
*/
public function render_quick_search_form(\mod_forum\output\quick_search_form $form) {
return $this->render_from_template('mod_forum/quick_search_form', $form->export_for_template($this));
}
}
@@ -0,0 +1,14 @@
<div class="forumsearch">
<form action="{{actionurl}}" style="display: inline;">
<fieldset class="invisiblefieldset">
{{#helpicon}}
{{>core/help_icon}}
{{/helpicon}}
<input type="hidden" name="id" value="{{courseid}}">
<label class="accesshide" for="search">{{#str}}search, forum{{/str}}</label>
<input id="search" name="search" type="text" size="18" value="{{query}}">
<label class="accesshide" for="searchforums">{{#str}}searchforums, forum{{/str}}</label>
<input id="searchforums" type="submit" value={{#quote}}{{#str}}searchforums, forum{{/str}}{{/quote}}>
</fieldset>
</form>
</div>
@@ -0,0 +1,13 @@
<div class="forumsearch">
<form action="{{actionurl}}" class="form-inline">
<input type="hidden" name="id" value="{{courseid}}">
<div class="form-group">
{{#helpicon}}
{{>core/help_icon}}
{{/helpicon}}
<label class="sr-only" for="search">{{#str}}search, forum{{/str}}</label>
<input id="search" name="search" type="text" class="form-control" value="{{query}}">
</div>
<button class="btn btn-secondary" id="searchforums" type="submit">{{#str}}searchforums, mod_forum{{/str}}</button>
</form>
</div>