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

namespace core_badges\output;

use moodle_page;
use moodle_url;
use renderer_base;
use single_button;

/**
 * Class standard_action_bar - Display the action bar
 *
 * @package   core_badges
 * @copyright 2021 Peter Dias
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class standard_action_bar extends base_action_bar {
    /** @var bool $showmanage Whether or not to show the manage badges button. */
    protected $showmanage;

    /** @var bool $showaddbadge Whether or not to show the add badges button. */
    protected $showaddbadge;

    /** @var moodle_url $backurl BackURL to be used when the back button is required. */
    protected $backurl;

    /**
     * standard_action_bar constructor
     *
     * @param moodle_page $page The page object
     * @param int $type The type of badge we are operating with
     * @param bool $showmanage Whether or not to show the manage badges button
     * @param bool $showaddbadge Whether or not to show the add badges button
     * @param moodle_url|null $backurl The backurl to be used
     */
    public function __construct(moodle_page $page, int $type, bool $showmanage = true,
            $showaddbadge = true, ?moodle_url $backurl = null) {
        parent::__construct($page, $type);

        $this->showmanage = $showmanage;
        $this->showaddbadge = $showaddbadge;
        $this->backurl = $backurl;
    }

    /**
     * The template that this tertiary nav should use.
     *
     * @return string
     */
    public function get_template(): string {
        return 'core_badges/manage_badges';
    }

    /**
     * Export the action bar
     *
     * @param renderer_base $output
     * @return array The buttons to be rendered
     */
    public function export_for_template(renderer_base $output): array {
        $buttons = [];
        if ($this->backurl) {
            $buttons[] = new single_button($this->backurl, get_string('back'), 'get');
        }

        $params = ['type' => $this->type];
        if ($this->page->context->contextlevel == CONTEXT_COURSE) {
            $params['id'] = $this->page->context->instanceid;
        }

        if ($this->showmanage) {
            $buttons[] = new single_button(new moodle_url('/badges/index.php', $params),
                get_string('managebadges', 'core_badges'), 'get');
        }

        if ($this->showaddbadge && has_capability('moodle/badges:createbadge', $this->page->context)) {
            $buttons[] = new single_button(new moodle_url('/badges/newbadge.php', $params),
< get_string('newbadge', 'core_badges'), 'post', true);
> get_string('newbadge', 'core_badges'), 'post', single_button::BUTTON_PRIMARY);
} foreach ($buttons as $key => $button) { $buttons[$key] = $button->export_for_template($output); } $data = ['buttons' => $buttons]; $additional = $this->get_third_party_nav_action($output); $data += $additional ?: []; return $data; } }