diff --git a/lib/outputcomponents.php b/lib/outputcomponents.php
index 30284ef3dac..eb3da9c37d3 100644
--- a/lib/outputcomponents.php
+++ b/lib/outputcomponents.php
@@ -3061,6 +3061,121 @@ class paging_bar implements renderable, templatable {
}
}
+/**
+ * Component representing initials bar.
+ *
+ * @copyright 2017 Ilya Tregubov
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 3.3
+ * @package core
+ * @category output
+ */
+class initials_bar implements renderable, templatable {
+
+ /**
+ * @var string Currently selected letter.
+ */
+ public $current;
+
+ /**
+ * @var string Class name to add to this initial bar.
+ */
+ public $class;
+
+ /**
+ * @var string The name to put in front of this initial bar.
+ */
+ public $title;
+
+ /**
+ * @var string URL parameter name for this initial.
+ */
+ public $urlvar;
+
+ /**
+ * @var string URL object.
+ */
+ public $url;
+
+ /**
+ * @var array An array of letters in the alphabet.
+ */
+ public $alpha;
+
+ /**
+ * Constructor initials_bar with only the required params.
+ *
+ * @param string $current the currently selected letter.
+ * @param string $class class name to add to this initial bar.
+ * @param string $title the name to put in front of this initial bar.
+ * @param string $urlvar URL parameter name for this initial.
+ * @param string $url URL object.
+ * @param array $alpha of letters in the alphabet.
+ */
+ public function __construct($current, $class, $title, $urlvar, $url, $alpha = null) {
+ $this->current = $current;
+ $this->class = $class;
+ $this->title = $title;
+ $this->urlvar = $urlvar;
+ $this->url = $url;
+ $this->alpha = $alpha;
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = new stdClass();
+
+ if ($this->alpha == null) {
+ $this->alpha = explode(',', get_string('alphabet', 'langconfig'));
+ }
+
+ if ($this->current == 'all') {
+ $this->current = '';
+ }
+
+ // We want to find a letter grouping size which suits the language so
+ // find the largest group size which is less than 15 chars.
+ // The choice of 15 chars is the largest number of chars that reasonably
+ // fits on the smallest supported screen size. By always using a max number
+ // of groups which is a factor of 2, we always get nice wrapping, and the
+ // last row is always the shortest.
+ $groupsize = count($this->alpha);
+ $groups = 1;
+ while ($groupsize > 15) {
+ $groups *= 2;
+ $groupsize = ceil(count($this->alpha) / $groups);
+ }
+
+ $groupsizelimit = 0;
+ $groupnumber = 0;
+ foreach ($this->alpha as $letter) {
+ if ($groupsizelimit++ > 0 && $groupsizelimit % $groupsize == 1) {
+ $groupnumber++;
+ }
+ $groupletter = new stdClass();
+ $groupletter->name = $letter;
+ $groupletter->url = $this->url->out(false, array($this->urlvar => $letter));
+ if ($letter == $this->current) {
+ $groupletter->selected = $this->current;
+ }
+ $data->group[$groupnumber]->letter[] = $groupletter;
+ }
+
+ $data->class = $this->class;
+ $data->title = $this->title;
+ $data->url = $this->url->out(false, array($this->urlvar => ''));
+ $data->current = $this->current;
+ $data->all = get_string('all');
+
+ return $data;
+ }
+}
+
/**
* This class represents how a block appears on a page.
*
diff --git a/lib/outputrenderers.php b/lib/outputrenderers.php
index 22eaf1e9812..c57bb73bec3 100644
--- a/lib/outputrenderers.php
+++ b/lib/outputrenderers.php
@@ -2925,6 +2925,32 @@ EOD;
return html_writer::tag('div', $output, array('class' => 'paging'));
}
+ /**
+ * Returns HTML to display initials bar to provide access to other pages (usually in a search)
+ *
+ * @param string $current the currently selected letter.
+ * @param string $class class name to add to this initial bar.
+ * @param string $title the name to put in front of this initial bar.
+ * @param string $urlvar URL parameter name for this initial.
+ * @param string $url URL object.
+ * @param array $alpha of letters in the alphabet.
+ * @return string the HTML to output.
+ */
+ public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null) {
+ $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha);
+ return $this->render($ib);
+ }
+
+ /**
+ * Internal implementation of initials bar rendering.
+ *
+ * @param initials_bar $initialsbar
+ * @return string
+ */
+ protected function render_initials_bar(initials_bar $initialsbar) {
+ return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
+ }
+
/**
* Output the place a skip link goes to.
*
diff --git a/lib/tablelib.php b/lib/tablelib.php
index 59c17a190c7..84d077b5011 100644
--- a/lib/tablelib.php
+++ b/lib/tablelib.php
@@ -907,8 +907,12 @@ class flexible_table {
/**
* This function is not part of the public api.
* @return string initial of first name we are currently filtering by
+ *
+ * @deprecated since Moodle 3.3
*/
function get_initial_first() {
+ debugging('Method get_initial_first() is no longer used and has been deprecated, ' .
+ 'to print initials bar call print_initials_bar()', DEBUG_DEVELOPER);
if (!$this->use_initials) {
return NULL;
}
@@ -919,8 +923,12 @@ class flexible_table {
/**
* This function is not part of the public api.
* @return string initial of last name we are currently filtering by
+ *
+ * @deprecated since Moodle 3.3
*/
function get_initial_last() {
+ debugging('Method get_initial_last() is no longer used and has been deprecated, ' .
+ 'to print initials bar call print_initials_bar()', DEBUG_DEVELOPER);
if (!$this->use_initials) {
return NULL;
}
@@ -935,44 +943,29 @@ class flexible_table {
* @param string $class class name to add to this initial bar.
* @param string $title the name to put in front of this initial bar.
* @param string $urlvar URL parameter name for this initial.
+ *
+ * @deprecated since Moodle 3.3
*/
protected function print_one_initials_bar($alpha, $current, $class, $title, $urlvar) {
+
+ debugging('Method print_one_initials_bar() is no longer used and has been deprecated, ' .
+ 'to print initials bar call print_initials_bar()', DEBUG_DEVELOPER);
+
echo html_writer::start_tag('div', array('class' => 'initialbar ' . $class)) .
- html_writer::tag('span', $title . ': ', array('class' => 'initialbarlabel'));
+ $title . ' : ';
if ($current) {
- echo html_writer::link($this->baseurl->out(false, array($urlvar => '')),
- get_string('all'), array('class' => 'initialbarall'));
+ echo html_writer::link($this->baseurl->out(false, array($urlvar => '')), get_string('all'));
} else {
- echo html_writer::tag('strong', get_string('all'), array('class' => 'initialbarall'));
+ echo html_writer::tag('strong', get_string('all'));
}
- // We want to find a letter grouping size which suits the language so
- // find the largest group size which is less than 15 chars. By always
- // using a max number of groups which is a factor of 2, we always get
- // nice wrapping, and the last row is always the shortest.
- $groupsize = count($alpha);
- $groups = 1;
- while ($groupsize > 15) {
- $groups *= 2;
- $groupsize = ceil(count($alpha) / $groups);
- }
-
- echo html_writer::start_tag('span', array('class' => 'initialbargroups'));
- echo html_writer::start_tag('span', array('class' => 'initialbargroup'));
- $c = 0;
foreach ($alpha as $letter) {
- if ($c++ > 0 && $c % $groupsize == 1) {
- echo html_writer::end_tag('span') . ' ';
- echo html_writer::start_tag('span', array('class' => 'initialbargroup'));
- }
if ($letter === $current) {
echo html_writer::tag('strong', $letter);
} else {
echo html_writer::link($this->baseurl->out(false, array($urlvar => $letter)), $letter);
}
}
- echo html_writer::end_tag('span');
- echo html_writer::end_tag('span');
echo html_writer::end_tag('div');
}
@@ -981,29 +974,29 @@ class flexible_table {
* This function is not part of the public api.
*/
function print_initials_bar() {
+ global $OUTPUT;
+
if ((!empty($this->prefs['i_last']) || !empty($this->prefs['i_first']) ||$this->use_initials)
- && isset($this->columns['fullname'])) {
+ && isset($this->columns['fullname'])) {
- $alpha = explode(',', get_string('alphabet', 'langconfig'));
-
- // Bar of first initials
if (!empty($this->prefs['i_first'])) {
$ifirst = $this->prefs['i_first'];
} else {
$ifirst = '';
}
- $this->print_one_initials_bar($alpha, $ifirst, 'firstinitial',
- get_string('firstname'), $this->request[TABLE_VAR_IFIRST]);
- // Bar of last initials
if (!empty($this->prefs['i_last'])) {
$ilast = $this->prefs['i_last'];
} else {
$ilast = '';
}
- $this->print_one_initials_bar($alpha, $ilast, 'lastinitial',
- get_string('lastname'), $this->request[TABLE_VAR_ILAST]);
+
+ $prefixfirst = $this->request[TABLE_VAR_IFIRST];
+ $prefixlast = $this->request[TABLE_VAR_ILAST];
+ echo $OUTPUT->initials_bar($ifirst, 'firstinitial', get_string('firstname'), $prefixfirst, $this->baseurl);
+ echo $OUTPUT->initials_bar($ilast, 'lastinitial', get_string('lastname'), $prefixlast, $this->baseurl);
}
+
}
/**
diff --git a/lib/templates/initials_bar.mustache b/lib/templates/initials_bar.mustache
new file mode 100644
index 00000000000..dcb7001c2b3
--- /dev/null
+++ b/lib/templates/initials_bar.mustache
@@ -0,0 +1,100 @@
+{{!
+ 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 .
+}}
+{{!
+ @template core/initials_bar
+
+ Initials bar.
+
+ Example context (json):
+ {
+ "title": "First name",
+ "class": "firstinitial",
+ "current": "A",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst",
+ "all": "All",
+ "group": [
+ {
+ "letter": [
+ {
+ "name": "A",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=A"
+ },
+ {
+ "name": "B",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=B"
+ },
+ {
+ "name": "C",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=C"
+ },
+ {
+ "name": "D",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=D"
+ }
+
+ ]
+ },
+ {
+ "letter": [
+ {
+ "name": "W",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=W",
+ "selected": "W"
+ },
+ {
+ "name": "X",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=X"
+ },
+ {
+ "name": "Y",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=Y"
+ },
+ {
+ "name": "Z",
+ "url": "http://moodle.generic32/report/progress/index.php?course=2&sifirst=Z"
+ }
+
+ ]
+ }
+ ]
+ }
+}}
+
+
{{title}}
+ {{#current}}
+
{{all}}
+ {{/current}}
+ {{^current}}
+
{{all}}
+ {{/current}}
+
+
+ {{#group}}
+
+ {{#letter}}
+ {{#selected}}
+ - {{name}}
+ {{/selected}}
+ {{^selected}}
+ - {{name}}
+ {{/selected}}
+ {{/letter}}
+
+ {{/group}}
+
+
';
- $pagingbar .= get_string($initial.'name').': ';
-
- if ($$var == 'all') {
- $pagingbar .= '
'.get_string('all').' ';
- }
- else {
- $pagingbar .= "
".get_string('all').' ';
- }
-
- foreach ($alphabet as $letter) {
- if ($$var === $letter) {
- $pagingbar .= '
'.$letter.' ';
- }
- else {
- $pagingbar .= "
$letter ";
- }
- }
-
- $pagingbar .= '
';
- $pagingbar .= get_string($initial.'name').': ';
-
- if ($$var == 'all') {
- $pagingbar .= '
'.get_string('all').' ';
- }
- else {
- $pagingbar .= "
".get_string('all').' ';
- }
-
- foreach ($alphabet as $letter) {
- if ($$var === $letter) {
- $pagingbar .= '
'.$letter.' ';
- }
- else {
- $pagingbar .= "
$letter ";
- }
- }
-
- $pagingbar .= '
'.get_string('firstname').' : ';
- if (!empty($firstinitial)) {
- echo '
'.$strall.'';
- } else {
- echo '
'.$strall.'';
- }
- foreach ($alpha as $letter) {
- if ($letter == $firstinitial) {
- echo '
'.$letter.'';
- } else {
- echo '
'.$letter.'';
- }
- }
- echo '
'.get_string('lastname').' : ';
- if (!empty($lastinitial)) {
- echo '
'.$strall.'';
- } else {
- echo '
'.$strall.'';
- }
- foreach ($alpha as $letter) {
- if ($letter == $lastinitial) {
- echo '
'.$letter.'';
- } else {
- echo '
'.$letter.'';
- }
- }
- echo '