Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?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/>.

/**
 * Template plans table.
 *
 * @package    tool_lp
 * @copyright  2015 Frédéric Massart - FMCorz.net
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace tool_lp\output;
defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/tablelib.php');

use html_writer;
use moodle_url;
use table_sql;
use core_competency\template;

/**
 * Template plans table class.
 *
 * Note that presently this table may display some rows although the current user
 * does not have permission to view those plans.
 *
 * @package    tool_lp
 * @copyright  2015 Frédéric Massart - FMCorz.net
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class template_plans_table extends table_sql {

    /** @var context The context. */
    protected $context;

    /** @var \core_competency\template The template. */
    protected $template;

    /**
     * Sets up the table.
     *
     * @param string $uniqueid Unique id of table.
     * @param \core_competency\template $template The template.
     */
    public function __construct($uniqueid, \core_competency\template $template) {
        parent::__construct($uniqueid);

        // This object should not be used without the right permissions.
        if (!$template->can_read()) {
            throw new \required_capability_exception($template->get_context(), 'moodle/competency:templateview',
                'nopermissions', '');
        }

        // Set protected properties.
        $this->template = $template;
        $this->context = $this->template->get_context();
        $this->useridfield = 'userid';

        // Define columns in the table.
        $this->define_table_columns();

        // Define configs.
        $this->define_table_configs();
    }

    /**
     * Format column name.
     *
     * @param  stdClass $row
     * @return string
     */
    protected function col_name($row) {
        return html_writer::link(new moodle_url('/admin/tool/lp/plan.php', array('id' => $row->id)),
            format_string($row->name, true, array('context' => $this->context)));
    }

    /**
     * Setup the headers for the table.
     */
    protected function define_table_columns() {
< $extrafields = get_extra_user_fields($this->context);
> // TODO Does not support custom user profile fields (MDL-70456). > $extrafields = \core_user\fields::get_identity_fields($this->context, false);
// Define headers and columns. $cols = array( 'name' => get_string('planname', 'tool_lp'), 'fullname' => get_string('name') ); // Add headers for extra user fields. foreach ($extrafields as $field) { if (get_string_manager()->string_exists($field, 'moodle')) { $cols[$field] = get_string($field); } else { $cols[$field] = $field; } } // Add remaining headers. $cols = array_merge($cols, array()); $this->define_columns(array_keys($cols)); $this->define_headers(array_values($cols)); } /** * Define table configs. */ protected function define_table_configs() { $this->collapsible(false); $this->sortable(true, 'lastname', SORT_ASC); $this->pageable(true); } /** * Builds the SQL query. * * @param bool $count When true, return the count SQL. * @return array containing sql to use and an array of params. */ protected function get_sql_and_params($count = false) {
< $fields = 'p.id, p.userid, p.name, ';
> $fields = 'p.id, p.userid, p.name';
// Add extra user fields that we need for the graded user.
< $extrafields = get_extra_user_fields($this->context); < foreach ($extrafields as $field) { < $fields .= 'u.' . $field . ', '; < } < $fields .= get_all_user_name_fields(true, 'u');
> // TODO Does not support custom user profile fields (MDL-70456). > $userfieldsapi = \core_user\fields::for_identity($this->context, false)->with_name(); > $fields .= $userfieldsapi->get_sql('u')->selects;
if ($count) { $select = "COUNT(1)"; } else { $select = "$fields"; } $sql = "SELECT $select FROM {" . \core_competency\plan::TABLE . "} p JOIN {user} u ON u.id = p.userid WHERE p.templateid = :templateid"; $params = array('templateid' => $this->template->get('id')); // Add order by if needed. if (!$count && $sqlsort = $this->get_sql_sort()) { $sql .= " ORDER BY " . $sqlsort; } return array($sql, $params); } /** * Override the default implementation to set a decent heading level. */ public function print_nothing_to_display() { global $OUTPUT; echo $this->render_reset_button(); $this->print_initials_bar(); echo $OUTPUT->heading(get_string('nothingtodisplay'), 4); } /** * Query the DB. * * @param int $pagesize size of page for paginated displayed table. * @param bool $useinitialsbar do you want to use the initials bar. */ public function query_db($pagesize, $useinitialsbar = true) { global $DB; list($countsql, $countparams) = $this->get_sql_and_params(true); list($sql, $params) = $this->get_sql_and_params(); $total = $DB->count_records_sql($countsql, $countparams); $this->pagesize($pagesize, $total); $this->rawdata = $DB->get_records_sql($sql, $params, $this->get_page_start(), $this->get_page_size()); // Set initial bars. if ($useinitialsbar) { $this->initialbars($total > $pagesize); } } }