Proyectos de Subversion Moodle

<?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/>.

namespace core_ai\reportbuilder\local\entities;

use core_reportbuilder\local\entities\base;

use core_reportbuilder\local\filters\date;

use core_reportbuilder\local\helpers\format;

use core_reportbuilder\local\report\column;

use core_reportbuilder\local\report\filter;

use lang_string;

/**

 * AI policy register entity.

 *

 * Defines all the columns and filters that can be added to reports that use this entity.

 *

 * @package    core_ai

 * @copyright  2024 David Woloszyn <david.woloszyn@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class ai_policy_register extends base {

    #[\Override]

    protected function get_default_tables(): array {

        return [

            'ai_policy_register',

        ];

    }

    #[\Override]

    protected function get_default_entity_title(): lang_string {

        return new lang_string('aipolicyregister', 'core_ai');

    }

    #[\Override]

    public function initialise(): base {

        $columns = $this->get_all_columns();

        foreach ($columns as $column) {

            $this->add_column($column);

        }

        // All the filters defined by the entity can also be used as conditions.

        $filters = $this->get_all_filters();

        foreach ($filters as $filter) {

            $this

                ->add_filter($filter)

                ->add_condition($filter);

        }

        return $this;

    }

    /**

     * Returns list of all available columns.

     *

     * @return column[]

     */

    protected function get_all_columns(): array {

        $tablealias = $this->get_table_alias('ai_policy_register');

        // Time accepted column.

        $columns[] = (new column(

            'timeaccepted',

            new lang_string('dateaccepted', 'core_ai'),

            $this->get_entity_name(),

        ))

            ->add_joins($this->get_joins())

            ->set_type(column::TYPE_TIMESTAMP)

            ->add_field("{$tablealias}.timeaccepted")

            ->set_is_sortable(true)

            ->add_callback([format::class, 'userdate']);

        return $columns;

    }

    /**

     * Return list of all available filters.

     *

     * @return filter[]

     */

    protected function get_all_filters(): array {

        $tablealias = $this->get_table_alias('ai_policy_register');

        // Time accepted filter.

        $filters[] = (new filter(

            date::class,

            'timeaccepted',

            new lang_string('dateaccepted', 'core_ai'),

            $this->get_entity_name(),

            "{$tablealias}.timeaccepted",

        ))

            ->add_joins($this->get_joins())

            ->set_limited_operators([

                date::DATE_ANY,

                date::DATE_RANGE,

                date::DATE_PREVIOUS,

                date::DATE_CURRENT,

            ]);

        return $filters;

    }

}