moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 08:56:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-44985 libraries: Final deprecation of conditional classes and apis

Browse source
This commit is contained in:
Ankit Agarwal 2014-12-10 10:23:31 +05:30
parent 2d84748c26
commit e56e8e3a0e
10 changed files with 8 additions and 749 deletions
Download patch file Download diff file Expand all files Collapse all files

515
lib/conditionlib.php
View file

@ -15,12 +15,7 @@
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Used to be used for tracking conditions that apply before activities are
* displayed to students ('conditional availability').
*
* Now replaced by the availability API. This library is a stub; some functions
* still work while others throw exceptions. New code should not rely on the
* classes, functions, or constants defined here.
* DO NOT INCLUDE THIS FILE.
*
* @package core_availability
* @copyright 2014 The Open University
@ -30,509 +25,5 @@
defined('MOODLE_INTERNAL') || die();
/**
* CONDITION_STUDENTVIEW_HIDE - The activity is not displayed to students at all when conditions aren't met.
*/
define('CONDITION_STUDENTVIEW_HIDE', 0);
/**
* CONDITION_STUDENTVIEW_SHOW - The activity is displayed to students as a greyed-out name, with
* informational text that explains the conditions under which it will be available.
*/
define('CONDITION_STUDENTVIEW_SHOW', 1);
/**
* CONDITION_MISSING_NOTHING - The $item variable is expected to contain all completion-related data
*/
define('CONDITION_MISSING_NOTHING', 0);
/**
* CONDITION_MISSING_EXTRATABLE - The $item variable is expected to contain the fields from
* the relevant table (course_modules or course_sections) but not the _availability data
*/
define('CONDITION_MISSING_EXTRATABLE', 1);
/**
* CONDITION_MISSING_EVERYTHING - The $item variable is expected to contain nothing except the ID
*/
define('CONDITION_MISSING_EVERYTHING', 2);
/**
* OP_CONTAINS - comparison operator that determines whether a specified user field contains
* a provided variable
*/
define('OP_CONTAINS', 'contains');
/**
* OP_DOES_NOT_CONTAIN - comparison operator that determines whether a specified user field does not
* contain a provided variable
*/
define('OP_DOES_NOT_CONTAIN', 'doesnotcontain');
/**
* OP_IS_EQUAL_TO - comparison operator that determines whether a specified user field is equal to
* a provided variable
*/
define('OP_IS_EQUAL_TO', 'isequalto');
/**
* OP_STARTS_WITH - comparison operator that determines whether a specified user field starts with
* a provided variable
*/
define('OP_STARTS_WITH', 'startswith');
/**
* OP_ENDS_WITH - comparison operator that determines whether a specified user field ends with
* a provided variable
*/
define('OP_ENDS_WITH', 'endswith');
/**
* OP_IS_EMPTY - comparison operator that determines whether a specified user field is empty
*/
define('OP_IS_EMPTY', 'isempty');
/**
* OP_IS_NOT_EMPTY - comparison operator that determines whether a specified user field is not empty
*/
define('OP_IS_NOT_EMPTY', 'isnotempty');
require_once($CFG->libdir.'/completionlib.php');
/**
* Core class to handle conditional activities.
*
* This class is now deprecated and partially functional. Public functions either
* work and output deprecated messages or (in the case of the more obscure ones
* which weren't really for public use, or those which can't be implemented in
* the new API) throw exceptions.
*
* @copyright 2014 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @deprecated Since Moodle 2.7
*/
class condition_info extends condition_info_base {
/**
* Constructs with course-module details.
*
* @global moodle_database $DB
* @uses CONDITION_MISSING_NOTHING
* @param object $cm Moodle course-module object. Required ->id, ->course
* will save time, using a full cm_info will save more time
* @param int $expectingmissing Used to control whether or not a developer
* debugging message (performance warning) will be displayed if some of
* the above data is missing and needs to be retrieved; a
* CONDITION_MISSING_xx constant
* @param bool $loaddata If you need a 'write-only' object, set this value
* to false to prevent database access from constructor
* @deprecated Since Moodle 2.7
*/
public function __construct($cm, $expectingmissing = CONDITION_MISSING_NOTHING,
$loaddata=true) {
global $DB;
debugging('The condition_info class is deprecated; change to \core_availability\info_module',
DEBUG_DEVELOPER);
// Check ID as otherwise we can't do the other queries.
if (empty($cm->id)) {
throw new coding_exception('Invalid parameters; item ID not included');
}
// Load cm_info object.
if (!($cm instanceof cm_info)) {
// Get modinfo.
if (empty($cm->course)) {
$modinfo = get_fast_modinfo(
$DB->get_field('course_modules', 'course', array('id' => $cm->id), MUST_EXIST));
} else {
$modinfo = get_fast_modinfo($cm->course);
}
// Get $cm object.
$cm = $modinfo->get_cm($cm->id);
}
$this->item = $cm;
}
/**
* Adds the extra availability conditions (if any) into the given
* course-module (or section) object.
*
* This function may be called statically (for the editing form) or
* dynamically.
*
* @param object $cm Moodle course-module data object
* @deprecated Since Moodle 2.7 (does nothing)
*/
public static function fill_availability_conditions($cm) {
debugging('Calls to condition_info::fill_availability_conditions should be removed',
DEBUG_DEVELOPER);
}
/**
* Gets the course-module object with full necessary data to determine availability.
*
* @return object Course-module object with full data
* @deprecated Since Moodle 2.7
*/
public function get_full_course_module() {
debugging('Calls to condition_info::get_full_course_module should be removed',
DEBUG_DEVELOPER);
return $this->item;
}
/**
* Used to update a table (which no longer exists) based on form data
* (which is no longer used).
*
* Should only have been called from core code. Now removed (throws exception).
*
* @param object $cm Course-module with as much data as necessary, min id
* @param object $fromform Data from form
* @param bool $wipefirst If true, wipes existing conditions
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public static function update_cm_from_form($cm, $fromform, $wipefirst=true) {
throw new coding_exception('Function no longer available');
}
/**
* Used to be used in course/lib.php because we needed to disable the
* completion JS if a completion value affects a conditional activity.
*
* Should only have been called from core code. Now removed (throws exception).
*
* @global stdClass $CONDITIONLIB_PRIVATE
* @param object $course Moodle course object
* @param object $item Moodle course-module
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public static function completion_value_used_as_condition($course, $cm) {
throw new coding_exception('Function no longer available');
}
}
/**
* Handles conditional access to sections.
*
* This class is now deprecated and partially functional. Public functions either
* work and output deprecated messages or (in the case of the more obscure ones
* which weren't really for public use, or those which can't be implemented in
* the new API) throw exceptions.
*
* @copyright 2014 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @deprecated Since Moodle 2.7
*/
class condition_info_section extends condition_info_base {
/**
* Constructs with course-module details.
*
* @global moodle_database $DB
* @uses CONDITION_MISSING_NOTHING
* @param object $section Moodle section object. Required ->id, ->course
* will save time, using a full section_info will save more time
* @param int $expectingmissing Used to control whether or not a developer
* debugging message (performance warning) will be displayed if some of
* the above data is missing and needs to be retrieved; a
* CONDITION_MISSING_xx constant
* @param bool $loaddata If you need a 'write-only' object, set this value
* to false to prevent database access from constructor
* @deprecated Since Moodle 2.7
*/
public function __construct($section, $expectingmissing = CONDITION_MISSING_NOTHING,
$loaddata=true) {
global $DB;
debugging('The condition_info_section class is deprecated; change to \core_availability\info_section',
DEBUG_DEVELOPER);
// Check ID as otherwise we can't do the other queries.
if (empty($section->id)) {
throw new coding_exception('Invalid parameters; item ID not included');
}
// Load cm_info object.
if (!($section instanceof section_info)) {
// Get modinfo.
if (empty($section->course)) {
$modinfo = get_fast_modinfo(
$DB->get_field('course_sections', 'course', array('id' => $section->id), MUST_EXIST));
} else {
$modinfo = get_fast_modinfo($section->course);
}
// Get $cm object.
foreach ($modinfo->get_section_info_all() as $possible) {
if ($possible->id === $section->id) {
$section = $possible;
break;
}
}
}
$this->item = $section;
}
/**
* Adds the extra availability conditions (if any) into the given
* course-module (or section) object.
*
* This function may be called statically (for the editing form) or
* dynamically.
*
* @param object $section Moodle section data object
* @deprecated Since Moodle 2.7 (does nothing)
*/
public static function fill_availability_conditions($section) {
debugging('Calls to condition_info_section::fill_availability_conditions should be removed',
DEBUG_DEVELOPER);
}
/**
* Gets the section object with full necessary data to determine availability.
*
* @return section_info Section object with full data
* @deprecated Since Moodle 2.7
*/
public function get_full_section() {
debugging('Calls to condition_info_section::get_full_section should be removed',
DEBUG_DEVELOPER);
return $this->item;
}
/**
* Utility function that used to be called by modedit.php; updated a
* table (that no longer exists) based on the module form data.
*
* Should only have been called from core code. Now removed (throws exception).
*
* @param object $section Section object, must at minimum contain id
* @param object $fromform Data from form
* @param bool $wipefirst If true, wipes existing conditions
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public static function update_section_from_form($section, $fromform, $wipefirst=true) {
throw new coding_exception('Function no longer available');
}
}
/**
* Base class to handle conditional items (course_modules or sections).
*
* This class is now deprecated and partially functional. Public functions either
* work and output deprecated messages or (in the case of the more obscure ones
* which weren't really for public use, or those which can't be implemented in
* the new API) throw exceptions.
*
* @copyright 2012 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @deprecated Since Moodle 2.7
*/
abstract class condition_info_base {
/** @var cm_info|section_info Item with availability data */
protected $item;
/**
* The operators that provide the relationship
* between a field and a value.
*
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public static function get_condition_user_field_operators() {
throw new coding_exception('Function no longer available');
}
/**
* Returns list of user fields that can be compared.
*
* If you specify $formatoptions, then format_string will be called on the
* custom field names. This is necessary for multilang support to work so
* you should include this parameter unless you are going to format the
* text later.
*
* @param array $formatoptions Passed to format_string if provided
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public static function get_condition_user_fields($formatoptions = null) {
throw new coding_exception('Function no longer available');
}
/**
* Adds to the database a condition based on completion of another module.
*
* Should only have been called from core and test code. Now removed
* (throws exception).
*
* @global moodle_database $DB
* @param int $cmid ID of other module
* @param int $requiredcompletion COMPLETION_xx constant
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public function add_completion_condition($cmid, $requiredcompletion) {
throw new coding_exception('Function no longer available');
}
/**
* Adds user fields condition
*
* Should only have been called from core and test code. Now removed
* (throws exception).
*
* @param mixed $field numeric if it is a user profile field, character
* if it is a column in the user table
* @param int $operator specifies the relationship between field and value
* @param char $value the value of the field
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public function add_user_field_condition($field, $operator, $value) {
throw new coding_exception('Function no longer available');
}
/**
* Adds to the database a condition based on the value of a grade item.
*
* Should only have been called from core and test code. Now removed
* (throws exception).
*
* @global moodle_database $DB
* @param int $gradeitemid ID of grade item
* @param float $min Minimum grade (>=), up to 5 decimal points, or null if none
* @param float $max Maximum grade (<), up to 5 decimal points, or null if none
* @param bool $updateinmemory If true, updates data in memory; otherwise,
* memory version may be out of date (this has performance consequences,
* so don't do it unless it really needs updating)
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public function add_grade_condition($gradeitemid, $min, $max, $updateinmemory=false) {
throw new coding_exception('Function no longer available');
}
/**
* Erases from the database all conditions for this activity.
*
* Should only have been called from core and test code. Now removed
* (throws exception).
*
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public function wipe_conditions() {
throw new coding_exception('Function no longer available');
}
/**
* Integration point with new API; obtains the new class for this item.
*
* @return \core_availability\info Availability info for item
*/
protected function get_availability_info() {
if ($this->item instanceof section_info) {
return new \core_availability\info_section($this->item);
} else {
return new \core_availability\info_module($this->item);
}
}
/**
* Obtains a string describing all availability restrictions (even if
* they do not apply any more).
*
* @param course_modinfo|null $modinfo Usually leave as null for default. Specify when
* calling recursively from inside get_fast_modinfo()
* @return string Information string (for admin) about all restrictions on
* this item
* @deprecated Since Moodle 2.7
*/
public function get_full_information($modinfo=null) {
debugging('condition_info*::get_full_information() is deprecated, replace ' .
'with new \core_availability\info_module($cm)->get_full_information()',
DEBUG_DEVELOPER);
return $this->get_availability_info()->get_full_information($modinfo);
}
/**
* Determines whether this particular item is currently available
* according to these criteria.
*
* - This does not include the 'visible' setting (i.e. this might return
* true even if visible is false); visible is handled independently.
* - This does not take account of the viewhiddenactivities capability.
* That should apply later.
*
* @uses COMPLETION_COMPLETE
* @uses COMPLETION_COMPLETE_FAIL
* @uses COMPLETION_COMPLETE_PASS
* @param string $information If the item has availability restrictions,
* a string that describes the conditions will be stored in this variable;
* if this variable is set blank, that means don't display anything
* @param bool $grabthelot Performance hint: if true, caches information
* required for all course-modules, to make the front page and similar
* pages work more quickly (works only for current user)
* @param int $userid If set, specifies a different user ID to check availability for
* @param course_modinfo|null $modinfo Usually leave as null for default. Specify when
* calling recursively from inside get_fast_modinfo()
* @return bool True if this item is available to the user, false otherwise
* @deprecated Since Moodle 2.7
*/
public function is_available(&$information, $grabthelot=false, $userid=0, $modinfo=null) {
debugging('condition_info*::is_available() is deprecated, replace ' .
'with new \core_availability\info_module($cm)->is_available()',
DEBUG_DEVELOPER);
return $this->get_availability_info()->is_available(
$information, $grabthelot, $userid, $modinfo);
}
/**
* Checks whether availability information should be shown to normal users.
*
* This information no longer makes sense with the new system because there
* are multiple show options. (I doubt anyone much used this function anyhow!)
*
* @return bool True if information about availability should be shown to
* normal users
* @deprecated Since Moodle 2.7
*/
public function show_availability() {
debugging('condition_info*::show_availability() is deprecated and there ' .
'is no direct replacement (this is no longer a boolean value), ' .
'please refactor code',
DEBUG_DEVELOPER);
return false;
}
/**
* Used to be called by grade code to inform the completion system when a
* grade was changed.
*
* This function should not have ever been used outside the grade API, so
* it now just throws an exception.
*
* @param grade_grade $grade
* @param bool $deleted
* @deprecated Since Moodle 2.7 (not available)
* @throws Always throws a coding_exception
*/
public static function inform_grade_changed($grade, $deleted) {
throw new coding_exception('Function no longer available');
}
/**
* Used to be used for testing.
*
* @deprecated since 2.6
*/
public static function wipe_session_cache() {
debugging('Calls to completion_info::wipe_session_cache should be removed', DEBUG_DEVELOPER);
}
/**
* Initialises the global cache
*
* @deprecated Since Moodle 2.7
*/
public static function init_global_cache() {
debugging('Calls to completion_info::init_globa_cache should be removed', DEBUG_DEVELOPER);
}
}
throw new coding_exception('condition_info,condition_info_section,condition_info_base classes can not be used any more,
please use respective classes from \core_availability namespace');