<?php
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.

namespace enrol_programs\local\notification;

use stdClass;

/**
 * Program de-allocation notification.
 *
 * @package    enrol_programs
 * @copyright  2023 Open LMS (https://www.openlms.net/)
 * @author     Petr Skoda
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
final class deallocation extends base {
    /**
     * Send notifications.
     *
     * @param stdClass|null $program
     * @param stdClass|null $user
     * @return void
     */
    public static function notify_users(?stdClass $program, ?stdClass $user): void {
        // We notify during de-allocation and then delete all notifications,
        // this cannot be triggered from cron later.
    }

    /**
     * Returns program de-allocation placeholders.
     *
     * @param stdClass $program
     * @param stdClass $source
     * @param stdClass $allocation
     * @param stdClass $user
     * @param stdClass|null $relateduser
     * @return array
     */
    public static function get_allocation_placeholders(stdClass $program, stdClass $source, stdClass $allocation,
                                                       stdClass $user, ?stdClass $relateduser = null): array {
        $a = parent::get_allocation_placeholders($program, $source, $allocation, $user, $relateduser);
        $context = \context::instance_by_id($program->contextid);
        if (has_capability('enrol/programs:view', $context)) {
            $a['program_url'] = (new \moodle_url('/enrol/programs/management/program.php', ['id' => $program->id]))->out(false);
        } else {
            $a['program_url'] = (new \moodle_url('/enrol/programs/catalogue/program.php', ['id' => $program->id]))->out(false);
        }
        return $a;
    }

    /**
     * Notify users about de-allocation.
     *
     * @param stdClass $user
     * @param stdClass $program
     * @param stdClass $source
     * @param stdClass $allocation
     * @return void
     */
    public static function notify_now(stdClass $user, stdClass $program, stdClass $source, stdClass $allocation): void {
        self::notify_allocated_user($program, $source, $allocation, $user);
    }
}
