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

/**
 * The gradebook simple view - base class for the table
 *
 * @package   gradereport_singleview
 * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace gradereport_singleview\local\screen;

use gradereport_singleview\local\ui\be_readonly;
use html_table;
use html_writer;
use stdClass;
use grade_grade;
use gradereport_singleview\local\ui\bulk_insert;

defined('MOODLE_INTERNAL') || die;

/**
 * The gradebook simple view - base class for the table
 *
 * @package   gradereport_singleview
 * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
abstract class tablelike extends screen implements be_readonly {

    /**
     * A list of table headers
     * @var array $headers
     */
    protected $headers = [];

    /**
     * A list of errors that mean we should not show the table
     * @var array $initerrors
     */
    protected $initerrors = [];

    /**
     * Describes the columns in the table
     * @var array $definition
     */
    protected $definition = [];

    /**
     * Total items
     * @var int $total
     */
    protected $total;

    /**
     * Table tab index
     * @var int $index
     */
    protected $index;

    /**
     *  The grade item or user.
     * @var mixed $item
     */
    protected $item;

    /**
     * Format a row of the table
     *
     * @var mixed $item
     * @return array
     */
    abstract public function format_line($item): array;

    /**
     * Get the summary for this table.
     *
     * @return string
     */
    abstract public function summary(): string;

    /**
     * Get the table headers
     *
     * @return array
     */
    public function headers(): array {
        return $this->headers;
    }

    /**
     * Set the table headers
     *
     * @param array $overwrite New headers
     * @return tablelike This
     */
    public function set_headers(array $overwrite): tablelike {
        $this->headers = $overwrite;
        return $this;
    }

    /**
     * Get the list of errors
     *
     * @return array
     */
    public function init_errors(): array {
        return $this->initerrors;
    }

    /**
     * Set an error detected while building the page.
     *
     * @param string $mesg
     */
    public function set_init_error(string $mesg) {
        $this->initerrors[] = $mesg;
    }

    /**
     * Get the table definition
     *
     * @return array The definition.
     */
    public function definition(): array {
        return $this->definition;
    }

    /**
     * Set the table definition
     *
     * @param array $overwrite New definition
     * @return tablelike This
     */
    public function set_definition(array $overwrite): tablelike {
        $this->definition = $overwrite;
        return $this;
    }

    /**
     * Get a element to generate the HTML for this table row
     * @param grade_grade $grade The grade.
     * @return array
     */
    public function format_definition(grade_grade $grade): array {
        $line = [];
        foreach ($this->definition() as $i => $field) {
            // Table tab index.
            $tab = ($i * $this->total) + $this->index;
            $classname = '\\gradereport_singleview\\local\\ui\\' . $field;
            $html = new $classname($grade, $tab);

            if ($field == 'finalgrade' and !empty($this->structure)) {
                $html .= $this->structure->get_grade_action_menu($grade);
            }

            // Singleview users without proper permissions should be presented
            // disabled checkboxes for the Exclude grade attribute.
            if ($field == 'exclude' && !has_capability('moodle/grade:manage', $this->context)) {
                $html->disabled = true;
            }

            $line[$field] = $html;
        }
        return $line;
    }

    /**
     * Get the HTML for the whole table
     * @return string
     */
    public function html(): string {
        global $OUTPUT;

        if (!empty($this->initerrors)) {
            $warnings = '';
            foreach ($this->initerrors as $mesg) {
                $warnings .= $OUTPUT->notification($mesg);
            }
            return $warnings;
        }
        $table = new html_table();
        $table->id = 'singleview-grades';

        $table->head = $this->headers();

        $summary = $this->summary();
        if (!empty($summary)) {
            $table->caption = $summary;
            $table->captionhide = true;
        }

        // To be used for extra formatting.
        $this->index = 0;
        $this->total = count($this->items);

        foreach ($this->items as $item) {
            if ($this->index >= ($this->perpage * $this->page) &&
                $this->index < ($this->perpage * ($this->page + 1))) {
                $table->data[] = $this->format_line($item);
            }
            $this->index++;
        }

        $data = new stdClass();
        $data->table = $table;
        $data->instance = $this;

        $html = html_writer::table($table);

        return html_writer::div($html, 'reporttable position-relative');
    }

    /**
     * Get the HTML for the bulk insert form
     *
     * @return string
     */
    public function bulk_insert() {
        return html_writer::tag(
            'div',
            (new bulk_insert($this->item))->html(),
            ['class' => 'singleview_bulk', 'hidden' => 'hidden']
        );
    }

    /**
     * Return true if this is read-only.
     *
     * @return bool
     */
    public function is_readonly(): bool {
        global $USER;
        return empty($USER->editing);
    }

    /**
     * Get the buttons for saving changes.
     * @param bool $disabled If button is disabled
     *
     * @return array
     */
    public function buttons(bool $disabled = false): array {
        global $OUTPUT;
        $params = ['type' => 'submit', 'value' => get_string('save', 'gradereport_singleview')];
        if ($disabled) {
            $params['disabled'] = 'disabled';
        }
        return [$OUTPUT->render_from_template('gradereport_singleview/button', $params)];
    }
}
