SWAMPy

✎ CARVE FLESH

EDITING: cohort.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/>.

/**
 * Course selector field.
 *
 * Allows auto-complete ajax searching for cohort.
 *
 * @package   core_form
 * @copyright 2015 Damyon Wiese <damyon@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

global $CFG;
require_once($CFG->libdir . '/form/autocomplete.php');
require_once($CFG->dirroot . '/cohort/lib.php');

/**
 * Form field type for choosing a cohort.
 *
 * Allows auto-complete ajax searching for cohort.
 *
 * @package   core_form
 * @copyright 2016 Damyon Wiese <damyon@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class MoodleQuickForm_cohort extends MoodleQuickForm_autocomplete {

/**
     * @var array $exclude Exclude a list of cohorts from the list (e.g. the current cohort).
     */
    protected $exclude = array();

/**
     * @var string $includes One of self/parents/all
     */
    protected $includes = 'parents';

/**
     * @var int $contextid The context id to fetch cohorts in.
     */
    protected $contextid = 0;

/**
     * @var boolean $allowmultiple Allow selecting more than one cohort.
     */
    protected $multiple = false;

/**
     * @var array $requiredcapabilities Array of extra capabilities to check at the cohort context.
     */
    protected $requiredcapabilities = array();

/**
     * Constructor
     *
     * @param string $elementname Element name
     * @param mixed $elementlabel Label(s) for an element
     * @param array $options Options to control the element's display
     *                       Valid options are:
     *                       'multiple' - boolean multi select
     *                       'exclude' - array or int, list of course ids to never show
     *                       'requiredcapabilities' - array of capabilities. Uses ANY to combine them.
     */
    public function __construct($elementname = null, $elementlabel = null, $options = array()) {
        if (isset($options['multiple'])) {
            $this->multiple = $options['multiple'];
        }
        if (isset($options['contextid'])) {
            $this->contextid = $options['contextid'];
        } else {
            $this->contextid = context_system::instance()->id;
        }
        if (isset($options['exclude'])) {
            $this->exclude = $options['exclude'];
            if (!is_array($this->exclude)) {
                $this->exclude = array($this->exclude);
            }
        }
        if (isset($options['includes'])) {
            $this->includes = $options['includes'];
        }
        if (isset($options['requiredcapabilities'])) {
            $this->requiredcapabilities = $options['requiredcapabilities'];
        }

$validattributes = array(
            'ajax' => 'core/form-cohort-selector',
            'data-exclude' => implode(',', $this->exclude),
            'data-includes' => $this->includes,
            'data-contextid' => (int)$this->contextid
        );
        if ($this->multiple) {
            $validattributes['multiple'] = 'multiple';
        }
        if (isset($options['noselectionstring'])) {
            $validattributes['noselectionstring'] = $options['noselectionstring'];
        }
        if (isset($options['placeholder'])) {
            $validattributes['placeholder'] = $options['placeholder'];
        }

parent::__construct($elementname, $elementlabel, array(), $validattributes);
    }

/**
     * Set the value of this element. If values can be added or are unknown, we will
     * make sure they exist in the options array.
     * @param string|array $value The value to set.
     * @return boolean
     */
    public function setValue($value) {
        global $DB;
        $values = (array) $value;
        $cohortstofetch = array();

foreach ($values as $onevalue) {
            if ($onevalue && !$this->optionExists($onevalue) &&
                    ($onevalue !== '_qf__force_multiselect_submission')) {
                array_push($cohortstofetch, $onevalue);
            }
        }

if (empty($cohortstofetch)) {
            $this->setSelected($values);
            return true;
        }

list($whereclause, $params) = $DB->get_in_or_equal($cohortstofetch, SQL_PARAMS_NAMED, 'id');

$list = $DB->get_records_select('cohort', 'id ' . $whereclause, $params, 'name');

$currentcontext = context_helper::instance_by_id($this->contextid);
        foreach ($list as $cohort) {
            // Make sure we can see the cohort.
            if (!cohort_can_view_cohort($cohort, $currentcontext)) {
                continue;
            }
            $label = format_string($cohort->name, true, ['context' => $currentcontext]);
            $this->addOption($label, $cohort->id);
        }

$this->setSelected($values);
        return true;
    }
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 amd/	DIR	—	2026-02-11 01:44
📁 classes/	DIR	—	2026-02-11 01:44
📁 templates/	DIR	—	2026-02-11 01:44
📁 tests/	DIR	—	2026-02-11 01:44
📁 yui/	DIR	—	2026-02-11 01:44
📄 advcheckbox.php	PHP	5 KB	2026-02-11 01:44	EDIT
📄 autocomplete.php	PHP	9.6 KB	2026-02-11 01:44	EDIT
📄 button.php	PHP	4.2 KB	2026-02-11 01:44	EDIT
📄 cancel.php	PHP	3.6 KB	2026-02-11 01:44	EDIT
📄 checkbox.php	PHP	5.2 KB	2026-02-11 01:44	EDIT
📄 choicedropdown.php	PHP	6.6 KB	2026-02-11 01:44	EDIT
📄 cohort.php	PHP	5.4 KB	2026-02-11 01:44	EDIT
📄 course.php	PHP	6.6 KB	2026-02-11 01:44	EDIT
📄 dateselector.php	PHP	12.8 KB	2026-02-11 01:44	EDIT
📄 datetimeselector.php	PHP	14.8 KB	2026-02-11 01:44	EDIT
📄 defaultcustom.php	PHP	11.8 KB	2026-02-11 01:44	EDIT
📄 dndupload.js	JS	43.4 KB	2026-02-11 01:44	EDIT
📄 duration.php	PHP	12 KB	2026-02-11 01:44	EDIT
📄 editor.php	PHP	17.2 KB	2026-02-11 01:44	EDIT
📄 filemanager.js	JS	58.8 KB	2026-02-11 01:44	EDIT
📄 filemanager.php	PHP	15.5 KB	2026-02-11 01:44	EDIT
📄 filepicker.js	JS	2.3 KB	2026-02-11 01:44	EDIT
📄 filepicker.php	PHP	9.8 KB	2026-02-11 01:44	EDIT
📄 filetypes.php	PHP	9 KB	2026-02-11 01:44	EDIT
📄 float.php	PHP	6.6 KB	2026-02-11 01:44	EDIT
📄 form.js	JS	31.1 KB	2026-02-11 01:44	EDIT
📄 grading.php	PHP	6 KB	2026-02-11 01:44	EDIT
📄 group.php	PHP	10.4 KB	2026-02-11 01:44	EDIT
📄 header.php	PHP	2.4 KB	2026-02-11 01:44	EDIT
📄 hidden.php	PHP	2.3 KB	2026-02-11 01:44	EDIT
📄 listing.php	PHP	6.3 KB	2026-02-11 01:44	EDIT
📄 modgrade.php	PHP	26.9 KB	2026-02-11 01:44	EDIT
📄 modvisible.php	PHP	6.4 KB	2026-02-11 01:44	EDIT
📄 password.php	PHP	3.6 KB	2026-02-11 01:44	EDIT
📄 passwordunmask.php	PHP	3.5 KB	2026-02-11 01:44	EDIT
📄 questioncategory.php	PHP	3 KB	2026-02-11 01:44	EDIT
📄 radio.php	PHP	3.9 KB	2026-02-11 01:44	EDIT
📄 recaptcha.php	PHP	3.9 KB	2026-02-11 01:44	EDIT
📄 searchableselector.php	PHP	2.3 KB	2026-02-11 01:44	EDIT
📄 select.php	PHP	7.9 KB	2026-02-11 01:44	EDIT
📄 selectgroups.php	PHP	18.1 KB	2026-02-11 01:44	EDIT
📄 selectwithlink.php	PHP	8.8 KB	2026-02-11 01:44	EDIT
📄 selectyesno.php	PHP	3 KB	2026-02-11 01:44	EDIT
📄 static.php	PHP	2.9 KB	2026-02-11 01:44	EDIT
📄 submit.php	PHP	5.4 KB	2026-02-11 01:44	EDIT
📄 tags.php	PHP	10 KB	2026-02-11 01:44	EDIT
📄 templatable_form_element.php	PHP	3.7 KB	2026-02-11 01:44	EDIT
📄 text.php	PHP	4.9 KB	2026-02-11 01:44	EDIT
📄 textarea.php	PHP	5.1 KB	2026-02-11 01:44	EDIT
📄 upgrade.txt	TXT	1.2 KB	2026-02-11 01:44	EDIT
📄 UPGRADING.md	MD	817 B	2026-02-11 01:44	EDIT
📄 url.js	JS	744 B	2026-02-11 01:44	EDIT
📄 url.php	PHP	7 KB	2026-02-11 01:44	EDIT
📄 warning.php	PHP	3.4 KB	2026-02-11 01:44	EDIT