Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is 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/>.

declare(strict_types=1);

namespace core_reportbuilder\local\models;

use context;
use lang_string;
use core\persistent;
> use core_reportbuilder\datasource;
/** * Persistent class to represent a report column * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class column extends persistent { /** @var string The table name. */ public const TABLE = 'reportbuilder_column'; /** * Return the definition of the properties of this model. * * @return array */ protected static function define_properties(): array { return [ 'reportid' => [ 'type' => PARAM_INT, ], 'uniqueidentifier' => [ 'type' => PARAM_RAW, ], 'aggregation' => [ 'type' => PARAM_ALPHANUMEXT, 'default' => null, 'null' => NULL_ALLOWED, ], 'heading' => [ 'type' => PARAM_TEXT, 'default' => null, 'null' => NULL_ALLOWED, ], 'columnorder' => [ 'type' => PARAM_INT, ], 'sortenabled' => [ 'type' => PARAM_BOOL, 'default' => false, ], 'sortdirection' => [ 'type' => PARAM_INT, 'choices' => [SORT_ASC, SORT_DESC], 'default' => SORT_ASC, ], 'sortorder' => [ 'type' => PARAM_INT, 'default' => null, 'null' => NULL_ALLOWED, ], 'usercreated' => [ 'type' => PARAM_INT, 'default' => static function(): int { global $USER; return (int) $USER->id; }, ], ]; } /** * Validate reportid property * * @param int $reportid * @return bool|lang_string */ protected function validate_reportid(int $reportid) { if (!report::record_exists($reportid)) { return new lang_string('invaliddata', 'error'); } return true; } /** * Return the report this column belongs to * * @return report */ public function get_report(): report { return new report($this->get('reportid'));
> } } > > /** /** > * Ensure report source is notified of new column * Helper method to return the current maximum column order value for a report > */ * > protected function after_create(): void { * @param int $reportid > datasource::report_elements_modified($this->get('reportid')); * @param string $columnname > } * @return int > */ > /** public static function get_max_columnorder(int $reportid, string $columnname): int { > * Ensure report source is notified of updated column global $DB; > * > * @param bool $result return (int) $DB->get_field(static::TABLE, "MAX({$columnname})", ['reportid' => $reportid], MUST_EXIST); > */ } > protected function after_update($result): void { > if ($result) { /** > datasource::report_elements_modified($this->get('reportid')); * Return formatted column name > } * > } * @param context|null $context If the context of the report is already known, it should be passed here > * @return string > /** */ > * Ensure report source is notified of deleted column public function get_formatted_heading(?context $context = null): string { > * if ($context === null) { > * @param bool $result $context = $this->get_report()->get_context(); > */ } > protected function after_delete($result): void { > if ($result) { return format_string($this->raw_get('heading'), true, ['context' => $context]); > datasource::report_elements_modified($this->get('reportid')); } > }
}