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

/**
 * Form for creating/editing a gallery.
 *
 * @package    mod_mediagallery
 * @copyright  NetSpot Pty Ltd
 * @author     Adam Olley <adam.olley@netspot.com.au>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

require_once($CFG->libdir.'/formslib.php');
require_once($CFG->dirroot.'/mod/mediagallery/locallib.php');

use \mod_mediagallery\gallery as gallery;

/**
 * Module instance settings form
 * @copyright Copyright (c) 2017 Blackboard Inc.
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_mediagallery_gallery_form extends moodleform {

    /**
     * Defines forms elements
     */
    public function definition() {
        global $CFG;

        $mform = $this->_form;
        $mg = $this->_customdata['mediagallery'];
        $gallery = $this->_customdata['gallery'];
        $groupmode = $this->_customdata['groupmode'];
        $groups = $this->_customdata['groups'];
        $context = $this->_customdata['context'];

        $lockfields = false;
        if ($gallery && $gallery->mode == 'thebox' && !$gallery->is_thebox_creator_or_agent()) {
            $lockfields = true;
        }

        // General settings.
        $mform->addElement('header', 'general', get_string('general', 'form'));

        $mform->addElement('text', 'name', get_string('galleryname', 'mediagallery'), array('size' => '64'));
        if (!empty($CFG->formatstringstriptags)) {
            $mform->setType('name', PARAM_TEXT);
        } else {
            $mform->setType('name', PARAM_CLEANHTML);
        }
        $mform->addRule('name', null, 'required', null, 'client');
        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
        $mform->addHelpButton('name', 'mediagalleryname', 'mediagallery');

        if ($groupmode != NOGROUPS || $groupmode === 'aag') {
            if (count($groups) > 1) {
                $opts = array();
                $counts = $mg->get_group_gallery_counts();
                foreach ($groups as $group) {
                    $manage = has_capability('mod/mediagallery:manage', $context);
                    if (!isset($counts[$group->id])
                        || $counts[$group->id]->count < $mg->maxgalleries || $mg->maxgalleries == 0 || $manage) {
                        $opts[$group->id] = $group->name;
                    }
                }
                $mform->addElement('select', 'groupid', get_string('group'), $opts);
                $mform->addHelpButton('groupid', 'group', 'mediagallery');
            } else {
                $groupkeys = array_keys($groups);
                $groupid = !empty($groupkeys) ? $groupkeys[0] : 0;
                $mform->addElement('hidden', 'groupid', $groupid);
                $mform->setType('groupid', PARAM_INT);
            }
        }

        // Mode. Normal or YT.
        $opts = array(
            'standard' => get_string('modestandard', 'mod_mediagallery'),
            'youtube' => get_string('modeyoutube', 'mod_mediagallery'),
        );
        if (get_config('mediagallery', 'disablestandardgallery') || $mg->mode != 'standard') {
            unset($opts['standard']);
        }
        $mform->addElement('select', 'mode', get_string('mode', 'mod_mediagallery'), $opts);
        $mform->addHelpButton('mode', 'mode', 'mediagallery');

        if ($mg->colltype != 'instructor') {
            $mform->addElement('checkbox', 'contributable', get_string('contributable', 'mod_mediagallery'));
            $mform->addHelpButton('contributable', 'contributable', 'mediagallery');
        }

        $mform->addElement('tags', 'tags', get_string('tags'),
                            ['itemtype' => 'mediagallery_gallery', 'component' => 'mod_mediagallery']);

        if ($lockfields) {
            $mform->hardFreeze('name');
            $mform->hardFreeze('tags');
        }

        // Gallery settings.
        $mform->addElement('header', 'display', get_string('settingsgallerydisplay', 'mediagallery'));

        $options = array(
            \mod_mediagallery\base::TYPE_ALL => get_string('typeall', 'mediagallery'),
            \mod_mediagallery\base::TYPE_IMAGE => get_string('typeimage', 'mediagallery'),
            \mod_mediagallery\base::TYPE_VIDEO => get_string('typevideo', 'mediagallery'),
            \mod_mediagallery\base::TYPE_AUDIO => get_string('typeaudio', 'mediagallery'),
        );
        $mform->addElement('select', 'galleryfocus', get_string('galleryfocus', 'mediagallery'), $options);
        $mform->addHelpButton('galleryfocus', 'galleryfocus', 'mediagallery');
        $mform->setDefault('galleryfocus', $mg->galleryfocus);
        $mform->disabledIf('galleryfocus', 'mode', 'eq', 'youtube');
        if ($mg->enforcedefaults) {
            $mform->hardFreeze('galleryfocus');
        }

        $options = array();
        if ($mg->grid) {
            $options[gallery::VIEW_GRID] = get_string('gridview', 'mediagallery');
        }
        if ($mg->carousel) {
            $options[gallery::VIEW_CAROUSEL] = get_string('carousel', 'mediagallery');
        }

        $mform->addElement('select', 'galleryview', get_string('galleryviewoptions', 'mediagallery'), $options);
        if ($mg->enforcedefaults && !($mg->grid && $mg->carousel)) {
            $default = $mg->grid ? gallery::VIEW_GRID : gallery::VIEW_CAROUSEL;
            $mform->setDefault('galleryview', $default);
            $mform->hardFreeze('galleryview');
        }

        if (!$mg->enforcedefaults) {
            if (isset($options[gallery::VIEW_GRID])) {
                $coloptions = array(0 => get_string('automatic', 'mediagallery'), 1 => 1, 2 => 2, 3 => 3, 4 => 4);
                $mform->addElement('select', 'gridcolumns', get_string('gridviewcolumns', 'mediagallery'), $coloptions);
                $mform->disabledIf('gridcolumns', 'galleryview', 'ne', gallery::VIEW_GRID);
                $mform->setDefault('gridcolumns', $mg->gridcolumns);

                $rowoptions = array(0 => get_string('automatic', 'mediagallery'), 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5,
                    6 => 6, 7 => 7, 8 => 8, 9 => 9, 10 => 10);
                $mform->addElement('select', 'gridrows', get_string('gridviewrows', 'mediagallery'), $rowoptions);
                $mform->disabledIf('gridrows', 'galleryview', 'ne', gallery::VIEW_GRID);
                $mform->setDefault('gridrows', $mg->gridrows);
            }
        } else {
            if ($mg->grid) {
                $mform->addElement('static', 'gridcolumns', get_string('gridviewcolumns', 'mediagallery'), $mg->gridcolumns);
                $mform->addElement('static', 'gridrows', get_string('gridviewrows', 'mediagallery'), $mg->gridrows);
            }
        }
        $mform->addHelpButton('galleryview', 'galleryviewoptions', 'mediagallery');
        if ($mg->grid) {
            $mform->addHelpButton('gridcolumns', 'gridviewcolumns', 'mediagallery');
            $mform->addHelpButton('gridrows', 'gridviewrows', 'mediagallery');
        }

        // Visibility settings.
        $mform->addElement('header', 'display', get_string('settingsvisibility', 'mediagallery'));

        $mform->addElement('date_time_selector', 'visibleinstructor',
            get_string('visibleinstructor', 'mediagallery'),
            array('optional' => true));
        $mform->addHelpButton('visibleinstructor', 'visibleinstructor', 'mediagallery');

        $mform->addElement('date_time_selector', 'visibleother',
            get_string('visibleother', 'mediagallery'),
            array('optional' => true));
        $mform->addHelpButton('visibleother', 'visibleother', 'mediagallery');
        $mform->setDefault('visibleother', time());

        $mform->addElement('hidden', 'm', $mg->id);
        $mform->setType('m', PARAM_INT);

        $mform->addElement('hidden', 'id');
        $mform->setType('id', PARAM_INT);

        $mform->addElement('hidden', 'source', 'moodle');
        $mform->setType('source', PARAM_ALPHA);
        $mform->hardFreeze('source');

        $this->add_action_buttons();
    }

    /**
     * Pre-process form data.
     *
     * @param array $toform
     * @return void
     */
    public function data_preprocessing(&$toform) {
        $toform['galleryviewoptions'] = array();
        $toform['galleryviewoptions']['carousel'] = $toform['carousel'];
        $toform['galleryviewoptions']['grid'] = $toform['grid'];
    }

    /**
     * Set the forms data.
     *
     * @param stdClass|array $data
     * @return void
     */
    public function set_data($data) {
        if (!empty($data->mode)) {
            $this->_form->hardFreeze('mode');
            if ($data->mode == 'youtube') {
                $data->galleryfocus = \mod_mediagallery\base::TYPE_VIDEO;
                $this->_form->freeze('galleryfocus');
            }
        }
        parent::set_data($data);
    }

    /**
     * Validate form input.
     *
     * @param array $data
     * @param array $files
     * @return array List of errors, if any.
     */
    public function validation($data, $files) {
        $errors = array();
        $collection = new \mod_mediagallery\collection($data['m']);
        return $errors;
    }
}