MDL-44070 Conditional availability enhancements (2): subsystem, API
This commit defines the new /availability root folder, with
/availability/classes, /availability/tests, and
/availability/condition where the condition plugins will live.
Condition plugin prefix is availability_, e.g. availability_date.
Rationale for this organisation:
1. I was originally going to put this in /lib/availability but
it has been pointed out that putting even more junk in lib
is probably bad.
2. 'availability' and 'condition' are the two names used in code
to refer to this system ($CFG->enableavailability).
3. The prefix has to be short enough to allow database tables
(although in practice I assume that condition plugins will not
normally contain database tables).
The new API includes a Boolean tree structure that controls the
availability of an item.
AMOS BEGIN
CPY [availabilityconditions,core_condition],[restrictaccess,core_availability]
CPY [enableavailability,core_condition],[enableavailability,core_availability]
CPY [configenableavailability,core_condition],[enableavailability_desc,core_availability]
AMOS END
2014-03-26 12:02:30 +00:00
|
|
|
<?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/>.
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Renderer for availability display.
|
|
|
|
*
|
|
|
|
* @package core_availability
|
|
|
|
* @copyright 2014 The Open University
|
|
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Renderer for availability display.
|
|
|
|
*
|
|
|
|
* @package core_availability
|
|
|
|
* @copyright 2014 The Open University
|
|
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
|
*/
|
|
|
|
class core_availability_renderer extends plugin_renderer_base {
|
|
|
|
/**
|
|
|
|
* Renders HTML for the result of two or more availability restriction
|
|
|
|
* messages being combined in a list.
|
|
|
|
*
|
|
|
|
* The supplied messages should already take account of the 'not' option,
|
|
|
|
* e.g. an example message could be 'User profile field Department must
|
|
|
|
* not be set to Maths'.
|
|
|
|
*
|
|
|
|
* This function will not be called unless there are at least two messages.
|
|
|
|
*
|
2021-10-14 15:05:22 +02:00
|
|
|
* @deprecated since Moodle 4.0 MDL-716916 - please do not use this function any more.
|
2015-03-20 17:52:35 +00:00
|
|
|
* @param core_availability_multiple_messages $renderable Multiple messages
|
MDL-44070 Conditional availability enhancements (2): subsystem, API
This commit defines the new /availability root folder, with
/availability/classes, /availability/tests, and
/availability/condition where the condition plugins will live.
Condition plugin prefix is availability_, e.g. availability_date.
Rationale for this organisation:
1. I was originally going to put this in /lib/availability but
it has been pointed out that putting even more junk in lib
is probably bad.
2. 'availability' and 'condition' are the two names used in code
to refer to this system ($CFG->enableavailability).
3. The prefix has to be short enough to allow database tables
(although in practice I assume that condition plugins will not
normally contain database tables).
The new API includes a Boolean tree structure that controls the
availability of an item.
AMOS BEGIN
CPY [availabilityconditions,core_condition],[restrictaccess,core_availability]
CPY [enableavailability,core_condition],[enableavailability,core_availability]
CPY [configenableavailability,core_condition],[enableavailability_desc,core_availability]
AMOS END
2014-03-26 12:02:30 +00:00
|
|
|
* @return string Combined HTML
|
|
|
|
*/
|
2015-03-20 17:52:35 +00:00
|
|
|
public function render_core_availability_multiple_messages(
|
|
|
|
core_availability_multiple_messages $renderable) {
|
2021-10-14 15:05:22 +02:00
|
|
|
|
|
|
|
debugging(
|
|
|
|
'render_core_availability_multiple_messages is deprecated. Use core_availability\\output\\multiple_messages instead',
|
|
|
|
DEBUG_DEVELOPER
|
|
|
|
);
|
MDL-44070 Conditional availability enhancements (2): subsystem, API
This commit defines the new /availability root folder, with
/availability/classes, /availability/tests, and
/availability/condition where the condition plugins will live.
Condition plugin prefix is availability_, e.g. availability_date.
Rationale for this organisation:
1. I was originally going to put this in /lib/availability but
it has been pointed out that putting even more junk in lib
is probably bad.
2. 'availability' and 'condition' are the two names used in code
to refer to this system ($CFG->enableavailability).
3. The prefix has to be short enough to allow database tables
(although in practice I assume that condition plugins will not
normally contain database tables).
The new API includes a Boolean tree structure that controls the
availability of an item.
AMOS BEGIN
CPY [availabilityconditions,core_condition],[restrictaccess,core_availability]
CPY [enableavailability,core_condition],[enableavailability,core_availability]
CPY [configenableavailability,core_condition],[enableavailability_desc,core_availability]
AMOS END
2014-03-26 12:02:30 +00:00
|
|
|
// Get initial message.
|
2015-03-20 17:52:35 +00:00
|
|
|
$out = get_string('list_' . ($renderable->root ? 'root_' : '') .
|
|
|
|
($renderable->andoperator ? 'and' : 'or') . ($renderable->treehidden ? '_hidden' : ''),
|
MDL-44070 Conditional availability enhancements (2): subsystem, API
This commit defines the new /availability root folder, with
/availability/classes, /availability/tests, and
/availability/condition where the condition plugins will live.
Condition plugin prefix is availability_, e.g. availability_date.
Rationale for this organisation:
1. I was originally going to put this in /lib/availability but
it has been pointed out that putting even more junk in lib
is probably bad.
2. 'availability' and 'condition' are the two names used in code
to refer to this system ($CFG->enableavailability).
3. The prefix has to be short enough to allow database tables
(although in practice I assume that condition plugins will not
normally contain database tables).
The new API includes a Boolean tree structure that controls the
availability of an item.
AMOS BEGIN
CPY [availabilityconditions,core_condition],[restrictaccess,core_availability]
CPY [enableavailability,core_condition],[enableavailability,core_availability]
CPY [configenableavailability,core_condition],[enableavailability_desc,core_availability]
AMOS END
2014-03-26 12:02:30 +00:00
|
|
|
'availability');
|
|
|
|
|
|
|
|
// Make the list.
|
|
|
|
$out .= html_writer::start_tag('ul');
|
2015-03-20 17:52:35 +00:00
|
|
|
foreach ($renderable->items as $item) {
|
|
|
|
if (is_string($item)) {
|
|
|
|
$str = $item;
|
|
|
|
} else {
|
|
|
|
$str = $this->render($item);
|
|
|
|
}
|
|
|
|
$out .= html_writer::tag('li', $str);
|
MDL-44070 Conditional availability enhancements (2): subsystem, API
This commit defines the new /availability root folder, with
/availability/classes, /availability/tests, and
/availability/condition where the condition plugins will live.
Condition plugin prefix is availability_, e.g. availability_date.
Rationale for this organisation:
1. I was originally going to put this in /lib/availability but
it has been pointed out that putting even more junk in lib
is probably bad.
2. 'availability' and 'condition' are the two names used in code
to refer to this system ($CFG->enableavailability).
3. The prefix has to be short enough to allow database tables
(although in practice I assume that condition plugins will not
normally contain database tables).
The new API includes a Boolean tree structure that controls the
availability of an item.
AMOS BEGIN
CPY [availabilityconditions,core_condition],[restrictaccess,core_availability]
CPY [enableavailability,core_condition],[enableavailability,core_availability]
CPY [configenableavailability,core_condition],[enableavailability_desc,core_availability]
AMOS END
2014-03-26 12:02:30 +00:00
|
|
|
}
|
|
|
|
$out .= html_writer::end_tag('ul');
|
|
|
|
return $out;
|
|
|
|
}
|
|
|
|
}
|