moodle/admin/tool/policy/classes/output/acceptances.php

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

/**
 * Provides {@link tool_policy\output\acceptances} class.
 *
 * @package     tool_policy
 * @category    output
 * @copyright   2018 Marina Glancy
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace tool_policy\output;

use tool_policy\api;

defined('MOODLE_INTERNAL') || die();

use moodle_url;
use renderable;
use renderer_base;
use single_button;
use templatable;
use tool_policy\policy_version;

/**
 * List of users and their acceptances
 *
 * @copyright 2018 Marina Glancy
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class acceptances implements renderable, templatable {

    /** @var id */
    protected $userid;

    /** @var moodle_url */
    protected $returnurl;

    /** @var bool */
    protected $canrevoke;

    /**
     * Contructor.
     *
     * @param int $userid
     * @param string|moodle_url $returnurl
     */
    public function __construct($userid, $returnurl = null) {
        $this->userid = $userid;
        $this->returnurl = $returnurl ? (new moodle_url($returnurl))->out(false) : null;
        $this->canrevoke = \tool_policy\api::can_revoke_policies($this->userid);
    }

    /**
     * Export the page data for the mustache template.
     *
     * @param renderer_base $output renderer to be used to render the page elements.
     * @return stdClass
     */
    public function export_for_template(renderer_base $output) {
        $data = (object)[];
        $data->hasonbehalfagreements = false;
        $data->pluginbaseurl = (new moodle_url('/admin/tool/policy'))->out(false);
        $data->returnurl = $this->returnurl;
        $data->canrevoke = $this->canrevoke;

        // Get the list of policies and versions that current user is able to see
        // and the respective acceptance records for the selected user.
        $policies = api::get_policies_with_acceptances($this->userid);

        $canviewfullnames = has_capability('moodle/site:viewfullnames', \context_system::instance());
        foreach ($policies as $policy) {

            foreach ($policy->versions as $version) {
                unset($version->summary);
                unset($version->content);
                $version->iscurrent = ($version->status == policy_version::STATUS_ACTIVE);
                $version->name = $version->name;
                $version->revision = $version->revision;
                $returnurl = new moodle_url('/admin/tool/policy/user.php', ['userid' => $this->userid]);
                $version->viewurl = (new moodle_url('/admin/tool/policy/view.php', [
                    'policyid' => $policy->id,
                    'versionid' => $version->id,
                    'returnurl' => $returnurl->out(false),
                ]))->out(false);

                if (!empty($version->acceptance->status)) {
                    $acceptance = $version->acceptance;
                    $version->timeaccepted = userdate($acceptance->timemodified, get_string('strftimedatetime'));
                    $onbehalf = $acceptance->usermodified && $acceptance->usermodified != $this->userid;
                    $version->agreement = new user_agreement($this->userid, [$version->id], $returnurl,
                        [$version->id => $version->name], $onbehalf);
                    if ($onbehalf) {
                        $usermodified = (object)['id' => $acceptance->usermodified];
                        username_load_fields_from_object($usermodified, $acceptance, 'mod');
                        $profileurl = new \moodle_url('/user/profile.php', array('id' => $usermodified->id));
                        $version->acceptedby = \html_writer::link($profileurl, fullname($usermodified, $canviewfullnames ||
                            has_capability('moodle/site:viewfullnames', \context_user::instance($acceptance->usermodified))));
                        $data->hasonbehalfagreements = true;
                    }
                    $version->note = format_text($acceptance->note);
                } else if ($version->iscurrent) {
                    $version->agreement = new user_agreement($this->userid, [], $returnurl, [$version->id => $version->name]);
                }
                if (isset($version->agreement)) {
                    $version->agreement = $version->agreement->export_for_template($output);
                }
            }

            if ($policy->versions[0]->status != policy_version::STATUS_ACTIVE) {
                // Add an empty "currentversion" on top.
                $policy->versions = [0 => (object)[]] + $policy->versions;
            }

            $policy->versioncount = count($policy->versions);
            $policy->versions = array_values($policy->versions);
            $policy->versions[0]->isfirst = 1;
            $policy->versions[0]->hasarchived = (count($policy->versions) > 1);
        }

        $data->policies = array_values($policies);
        return $data;
    }
}