Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Classes | |
class | action_link |
Data structure describing html link with special action attached. More... | |
class | action_menu |
An action menu. More... | |
class | action_menu_filler |
An action menu filler. More... | |
class | action_menu_link |
An action menu action. More... | |
class | action_menu_link_primary |
A primary action menu action. More... | |
class | action_menu_link_secondary |
A secondary action menu action. More... | |
class | admin_category |
The object used to represent folders (a.k.a. More... | |
class | admin_externalpage |
Links external PHP pages into the admin tree. More... | |
class | admin_page_manageblocks |
Blocks manage page. More... | |
class | admin_page_managefilters |
Special class for filter administration. More... | |
class | admin_page_managemessageoutputs |
Message outputs configuration. More... | |
class | admin_page_managemods |
Module manage page. More... | |
class | admin_page_manageportfolios |
class | admin_page_manageqbehaviours |
Manage question behaviours page. More... | |
class | admin_page_manageqtypes |
Question type manage page. More... | |
class | admin_page_managerepositories |
class | admin_page_pluginsoverview |
General plugins manager. More... | |
class | admin_root |
Root of admin settings tree, does not have any parent. More... | |
class | admin_setting |
Admin settings class. More... | |
class | admin_setting_agedigitalconsentmap |
Used to validate the content and format of the age of digital consent map and ensuring it is parsable. More... | |
class | admin_setting_bloglevel |
Select for blog's bloglevel setting: if set to 0, will set blog_menu block to hidden. More... | |
class | admin_setting_configcheckbox |
Checkbox. More... | |
class | admin_setting_configcheckbox_with_advanced |
Checkbox with an advanced checkbox that controls an additional $name. More... | |
class | admin_setting_configcheckbox_with_lock |
Checkbox with an advanced checkbox that controls an additional $name. More... | |
class | admin_setting_configcolourpicker |
Colour picker. More... | |
class | admin_setting_configdirectory |
Path to directory. More... | |
class | admin_setting_configduration |
Seconds duration setting. More... | |
class | admin_setting_configduration_with_advanced |
Seconds duration setting with an advanced checkbox, that controls a additional $name. More... | |
class | admin_setting_configempty |
Empty setting used to allow flags (advanced) on settings that can have no sensible default. More... | |
class | admin_setting_configexecutable |
Path to executable file. More... | |
class | admin_setting_configfile |
Path to directory. More... | |
class | admin_setting_confightmleditor |
General text area with html editor. More... | |
class | admin_setting_configiplist |
Used to validate a textarea used for ip addresses. More... | |
class | admin_setting_configmixedhostiplist |
Used to validate a textarea used for domain names, wildcard domain names and IP addresses/ranges (both IPv4 and IPv6 format). More... | |
class | admin_setting_configmulticheckbox |
Multiple checkboxes, each represents different value, stored in csv format. More... | |
class | admin_setting_configmulticheckbox2 |
Multiple checkboxes 2, value stored as string 00101011. More... | |
class | admin_setting_configmultiselect |
Select multiple items from list. More... | |
class | admin_setting_configmultiselect_modules |
Multiselect for current modules. More... | |
class | admin_setting_configpasswordunmask |
Password field, allows unmasking of password. More... | |
class | admin_setting_configpasswordunmask_with_advanced |
Password field, allows unmasking of password, with an advanced checkbox that controls an additional $name. More... | |
class | admin_setting_configportlist |
Used to validate a textarea used for port numbers. More... | |
class | admin_setting_configselect |
Select one value from list. More... | |
class | admin_setting_configselect_autocomplete |
Autocomplete as you type form element. More... | |
class | admin_setting_configselect_with_advanced |
Dropdown menu with an advanced checkbox, that controls a additional $name. More... | |
class | admin_setting_configselect_with_lock |
Select with an advanced checkbox that controls an additional $name. More... | |
class | admin_setting_configstoredfile |
Class used for uploading of one file into file storage, the file name is stored in config table. More... | |
class | admin_setting_configtext |
The most flexible setting, the user enters text. More... | |
class | admin_setting_configtext_with_advanced |
Text field with an advanced checkbox, that controls a additional $name. More... | |
class | admin_setting_configtext_with_maxlength |
Text input with a maximum length constraint. More... | |
class | admin_setting_configtextarea |
General text area without html editor. More... | |
class | admin_setting_configthemepreset |
Used to validate theme presets code and ensuring they compile well. More... | |
class | admin_setting_configtime |
Time selector. More... | |
class | admin_setting_countrycodes |
Allows to specify comma separated list of known country codes. More... | |
class | admin_setting_courselist_frontpage |
Special select - lists on the frontpage - hacky. More... | |
class | admin_setting_description |
No setting - just name and description in same row. More... | |
class | admin_setting_devicedetectregex |
Administration interface for user specified regular expressions for device detection. More... | |
class | admin_setting_emoticons |
Administration interface for emoticon_manager settings. More... | |
class | admin_setting_enablemobileservice |
Special checkbox for enable mobile web service If enable then we store the service id of the mobile service into config table If disable then we unstore the service id from the config table. More... | |
class | admin_setting_encryptedpassword |
Admin setting class for encrypted values using secure encryption. More... | |
class | admin_setting_filetypes |
Administration setting to define a list of file types. More... | |
class | admin_setting_flag |
An additional option that can be applied to an admin setting. More... | |
class | admin_setting_forcetimezone |
Forced user timezone setting. More... | |
class | admin_setting_grade_profilereport |
Selection of grade report in user profiles. More... | |
class | admin_setting_gradecat_combo |
Grade category settings. More... | |
class | admin_setting_heading |
No setting - just heading and text. More... | |
class | admin_setting_langlist |
Special setting for limiting of the list of available languages. More... | |
class | admin_setting_manage_fileconverter_plugins |
Generic class for managing plugins in a table that allows re-ordering and enable/disable of each plugin. More... | |
class | admin_setting_manage_plugins |
Generic class for managing plugins in a table that allows re-ordering and enable/disable of each plugin. More... | |
class | admin_setting_manageantiviruses |
Special class for antiviruses administration. More... | |
class | admin_setting_manageauths |
Special class for authentication administration. More... | |
class | admin_setting_managecontentbankcontenttypes |
Content bank content types manager. More... | |
class | admin_setting_managecustomfields |
Custom fields manager. More... | |
class | admin_setting_managedataformats |
Data formats manager. More... | |
class | admin_setting_manageenrols |
Special class for enrol plugins management. More... | |
class | admin_setting_manageexternalservices |
Special class for management of external services. More... | |
class | admin_setting_manageformats |
Course formats manager. More... | |
class | admin_setting_managemediaplayers |
Special class for media player plugins management. More... | |
class | admin_setting_managerepository |
Manage repository settings. More... | |
class | admin_setting_managewebserviceprotocols |
Special class for web service protocol administration. More... | |
class | admin_setting_my_grades_report |
Provides a selection of grade reports to be used for "grades". More... | |
class | admin_setting_php_extension_enabled |
Admin setting to show if a php extension is enabled or not. More... | |
class | admin_setting_pickfilters |
Admin setting that is a list of installed filter plugins. More... | |
class | admin_setting_pickroles |
Admin setting that allows a user to pick appropriate roles for something. More... | |
class | admin_setting_question_behaviour |
Admin setting that allows a user to pick a behaviour. More... | |
class | admin_setting_regradingcheckbox |
class | admin_setting_requiredtext |
This type of field should be used for mandatory config settings. More... | |
class | admin_setting_scsscode |
Used to validate the contents of SCSS code and ensuring they are parsable. More... | |
class | admin_setting_searchsetupinfo |
Search setup steps info. More... | |
class | admin_setting_servertimezone |
Server timezone setting. More... | |
class | admin_setting_sitesetcheckbox |
Special checkbox for frontpage - stores data in course table. More... | |
class | admin_setting_sitesetselect |
Special select for frontpage - stores data in course table. More... | |
class | admin_setting_sitesettext |
Special text for frontpage - stores data in course table. More... | |
class | admin_setting_special_adminseesall |
Special checkbox for calendar - resets SESSION vars. More... | |
class | admin_setting_special_backup_auto_destination |
Special setting for backup auto destination. More... | |
class | admin_setting_special_backupdays |
Special control for selecting days to backup. More... | |
class | admin_setting_special_calendar_weekend |
Special admin control. More... | |
class | admin_setting_special_coursecontact |
Which roles to show on course description page. More... | |
class | admin_setting_special_debug |
Special debug setting. More... | |
class | admin_setting_special_frontpagedesc |
Special text editor for site description. More... | |
class | admin_setting_special_gradebookroles |
Graded roles in gradebook. More... | |
class | admin_setting_special_gradeexport |
Primary grade export plugin - has state tracking. More... | |
class | admin_setting_special_gradelimiting |
class | admin_setting_special_grademinmaxtouse |
Special setting for $CFG->grade_minmaxtouse. More... | |
class | admin_setting_special_gradepointdefault |
A setting for setting the default grade point value. More... | |
class | admin_setting_special_gradepointmax |
A setting for setting the maximum grade value. More... | |
class | admin_setting_special_registerauth |
Special class for register auth selection. More... | |
class | admin_setting_special_selectsetup |
Special select for settings that are altered in setup.php and can not be altered on the fly. More... | |
class | admin_setting_users_with_capability |
An admin setting for selecting one or more users who have a capability in the system context. More... | |
class | admin_setting_webservicesoverview |
Special class for overview of external services. More... | |
class | admin_settingdependency |
Used to store details of the dependency between two settings elements. More... | |
class | admin_settingpage |
Used to group a number of admin_setting objects into a page and add them to the admin tree. More... | |
class | admin_settings_country_select |
Selection of one of the recognised countries using the list returned by get_list_of_countries(). More... | |
class | admin_settings_coursecat_select |
Course category selection. More... | |
class | admin_settings_h5plib_handler_select |
Selection of plugins that can work as H5P libraries handlers. More... | |
class | admin_settings_num_course_sections |
admin_setting_configselect for the default number of sections in a course, simply so we can lazy-load the choices. More... | |
class | admin_settings_sitepolicy_handler_select |
Selection of plugins that can work as site policy handlers. More... | |
class | advanced_testcase |
Advanced PHPUnit test case customised for Moodle. More... | |
class | alignment_form |
Form to edit alignment. More... | |
class | async_helper |
Helper functions for asynchronous backups and restores. More... | |
class | auth_plugin_base |
Abstract authentication plugin. More... | |
class | award_criteria |
Award criteria abstract definition. More... | |
class | award_criteria_activity |
Badge award criteria – award on activity completion. More... | |
class | award_criteria_badge |
Badge award criteria – award on badge completion. More... | |
class | award_criteria_cohort |
Badge award criteria – award on cohort membership. More... | |
class | award_criteria_competency |
Badge award criteria – award on competency completion. More... | |
class | award_criteria_course |
Badge award criteria – award on course completion. More... | |
class | award_criteria_courseset |
Badge award criteria – award on courseset completion. More... | |
class | award_criteria_manual |
Manual badge award criteria. More... | |
class | award_criteria_overall |
Overall badge award criteria. More... | |
class | award_criteria_profile |
Profile completion badge award criteria. More... | |
class | backup_cron_automated_helper |
This class is an abstract class with methods that can be called to aid the running of automated backups over cron. More... | |
class | badge_award_selector_base |
class | badge_existing_users_selector |
A user selector control for existing users to award badge. More... | |
class | badge_potential_users_selector |
A user selector control for potential users to award badge. More... | |
class | badges_preferences_form |
class | base_converter |
Base converter class. More... | |
class | base_testcase |
Base class for PHPUnit test cases customised for Moodle. More... | |
class | basic_testcase |
The simplest PHPUnit test case customised for Moodle. More... | |
class | behat_accessibility |
Steps definitions to assist with accessibility testing. More... | |
class | behat_action_menu |
Steps definitions to open and close action menus. More... | |
class | behat_base |
Steps definitions base class. More... | |
class | behat_command |
Behat command related utils. More... | |
class | behat_component_named_replacement |
A class for recording the definition of Mink replacements for use in Mink selectors. More... | |
class | behat_component_named_selector |
Class representing a named selector that can be used in Behat tests. More... | |
class | behat_config_manager |
Behat configuration manager. More... | |
class | behat_config_util |
Behat configuration manager. More... | |
class | behat_context_helper |
Helper to get behat contexts. More... | |
class | behat_data_generators |
Class to set up quickly a Given environment. More... | |
class | behat_deprecated |
class | behat_deprecated_base |
class | behat_exact_named_selector |
Moodle selectors manager. More... | |
class | behat_field_manager |
Helper to interact with form fields. More... | |
class | behat_filters |
Steps definitions related to filters. More... | |
class | behat_general |
Cross component steps definitions. More... | |
class | behat_init_context |
Loads main subcontexts. More... | |
class | behat_login |
Contains functions used by behat to test functionality. More... | |
class | behat_moodlenet |
class | behat_navigation |
Steps definitions to navigate through the navigation tree nodes. More... | |
class | behat_partial_named_selector |
Moodle selectors manager. More... | |
class | behat_permissions |
Steps definitions to set up permissions to capabilities. More... | |
class | behat_selectors |
Moodle selectors manager. More... | |
interface | behat_session_interface |
The Interface for a behat root context. More... | |
class | behat_transformations |
Transformations to apply to steps arguments. More... | |
class | behat_util |
Init/reset utilities for Behat database and dataroot. More... | |
class | block_contents |
This class represents how a block appears on a page. More... | |
class | block_manager |
This class keeps track of the block that should appear on a moodle_page. More... | |
class | block_move_target |
This class represents a target for where a block can go when it is being moved. More... | |
class | block_not_on_page_exception |
Exception thrown when someone tried to do something with a block that does not exist on a page. More... | |
class | bootstrap_renderer |
This class solves the problem of how to initialise $OUTPUT. More... | |
class | breadcrumb_navigation_node |
Subclass of navigation_node allowing different rendering for the breadcrumbs in particular adding extra metadata for search engine robots to leverage. More... | |
class | cache |
The main cache class. More... | |
class | cache_application |
An application cache. More... | |
class | cache_config |
Cache configuration reader. More... | |
class | cache_config_disabled |
The cache config class used when the Cache has been disabled. More... | |
interface | cache_data_source |
Cache Data Source. More... | |
interface | cache_data_source_versionable |
Versionable cache data source. More... | |
class | cache_definition |
The cache definition class. More... | |
class | cache_definition_mappings_form |
Form to set definition mappings. More... | |
class | cache_definition_sharing_form |
Form to set definition sharing option. More... | |
class | cache_disabled |
Required as it is needed for cache_config_disabled which extends cache_config_writer. More... | |
class | cache_factory |
The cache factory class. More... | |
class | cache_factory_disabled |
The cache factory class used when the Cache has been disabled. More... | |
class | cache_helper |
The cache helper class. More... | |
interface | cache_is_configurable |
Cache store feature: configurable. More... | |
interface | cache_is_key_aware |
Cache store feature: key awareness. More... | |
interface | cache_is_lockable |
Cache store feature: locking. More... | |
interface | cache_is_searchable |
Cache store feature: keys are searchable. More... | |
interface | cache_loader |
Cache Loader. More... | |
interface | cache_loader_with_locking |
Cache Loader supporting locking. More... | |
class | cache_lock_form |
Form to add a cache lock instance. More... | |
interface | cache_lock_interface |
Cache lock interface. More... | |
class | cache_mode_mappings_form |
Form to set the mappings for a mode. More... | |
class | cache_request |
An request cache. More... | |
class | cache_session |
A session cache. More... | |
class | cache_store |
Abstract cache store class. More... | |
interface | cache_store_interface |
Cache store interface. More... | |
interface | cacheable_object |
Cacheable object. More... | |
class | cached_cm_info |
Class that is the return value for the _get_coursemodule_info module API function. More... | |
class | cachestore_addinstance_form |
Add store instance form. More... | |
class | cachestore_dummy |
The cache dummy store. More... | |
class | calc_formula |
This class abstracts evaluation of spreadsheet formulas. More... | |
class | cm_info |
class | coding_exception |
Exception indicating programming error, must be fixed by a programer. More... | |
class | combined_progress_trace |
Special type of trace that can be used for redirecting to multiple other traces. More... | |
class | comment |
Comment is helper class to add/delete comments anywhere in moodle. More... | |
class | comment_exception |
Comment exception class. More... | |
class | completion_info |
Class represents completion information for a course. More... | |
class | component_action |
Helper class used by other components that involve an action on the page (URL or JS). More... | |
class | component_generator_base |
Component generator base class. More... | |
class | component_installer |
This class is used to check, download and install items from download.moodle.org to the moodledata directory. More... | |
class | confirm_action |
Confirm action. More... | |
class | context_header |
Renderable for the main page header. More... | |
class | convert_exception |
General convert-related exception. More... | |
class | convert_factory |
Factory class to create new instances of backup converters. More... | |
class | convert_helper |
Provides various functionality via its static methods. More... | |
class | convert_helper_exception |
General convert_helper related exception. More... | |
class | core\access\get_user_capability_course_helper |
Helper functions to implement the complex get_user_capability_course function. More... | |
class | core\activity_dates |
Class for fetching the important dates of an activity module for a given module instance and a user. More... | |
class | core\analytics\analyser\courses |
Courses analyser working at course level (insights for the course teachers). More... | |
class | core\analytics\analyser\site_courses |
Site courses analyser working at system level (insights for the site admin). More... | |
class | core\analytics\analyser\student_enrolments |
Student enrolments analyser. More... | |
class | core\analytics\analyser\users |
Users analyser (insights for users). More... | |
class | core\analytics\indicator\any_access_after_end |
Any access after the official end of the course. More... | |
class | core\analytics\indicator\any_access_before_start |
Any access before the official start of the course. More... | |
class | core\analytics\indicator\any_course_access |
Any access indicator. More... | |
class | core\analytics\indicator\any_write_action |
Write actions indicator. More... | |
class | core\analytics\indicator\any_write_action_in_course |
Write actions in a course indicator. More... | |
class | core\analytics\indicator\read_actions |
Read actions indicator. More... | |
class | core\analytics\time_splitting\deciles |
10 parts time splitting method. More... | |
class | core\analytics\time_splitting\deciles_accum |
Range processor splitting the course in ten parts and accumulating data. More... | |
class | core\analytics\time_splitting\no_splitting |
No time splitting method. More... | |
class | core\analytics\time_splitting\quarters |
Quarters time splitting method. More... | |
class | core\analytics\time_splitting\quarters_accum |
Range processor splitting the course in quarters and accumulating data. More... | |
class | core\analytics\time_splitting\single_range |
Single time splitting method. More... | |
class | core\antivirus\scanner |
Base abstract antivirus scanner class. More... | |
class | core\antivirus\scanner_exception |
An antivirus scanner exception class. More... | |
class | core\chart_axis |
Chart axis class. More... | |
class | core\chart_bar |
Chart bar class. More... | |
class | core\chart_base |
Chart base class. More... | |
class | core\chart_line |
Chart line class. More... | |
class | core\chart_pie |
Chart pie class. More... | |
class | core\chart_series |
Chart series class. More... | |
class | core\check\access\defaultuserrole |
class | core\check\access\frontpagerole |
Verifies sanity of frontpage role. More... | |
class | core\check\access\guestrole |
Verifies sanity of guest role. More... | |
class | core\check\access\riskadmin |
Lists all admins. More... | |
class | core\check\access\riskbackup |
Lists all roles that have the ability to backup user data, as well as users. More... | |
class | core\check\access\riskbackup_result |
Lists all roles that have the ability to backup user data, as well as users. More... | |
class | core\check\access\riskxss |
Lists all users with XSS risk. More... | |
class | core\check\access\riskxss_result |
Lists all users with XSS risk. More... | |
class | core\check\check |
Base class for checks. More... | |
class | core\check\environment\antivirus |
class | core\check\environment\configrw |
Verifies config.php is not writable anymore after installation. More... | |
class | core\check\environment\displayerrors |
Verifies displaying of errors. More... | |
class | core\check\environment\environment |
Environment check. More... | |
class | core\check\environment\preventexecpath |
Verifies the status of preventexecpath. More... | |
class | core\check\environment\publicpaths |
Check the public access of various paths. More... | |
class | core\check\environment\unsecuredataroot |
Verifies fatal misconfiguration of dataroot. More... | |
class | core\check\environment\upgradecheck |
Upgrade check. More... | |
class | core\check\http\cookiesecure |
Verifies if https enabled only secure cookies allowed. More... | |
class | core\check\manager |
Check API manager. More... | |
class | core\check\performance\backups |
Backups check. More... | |
class | core\check\performance\cachejs |
CacheJS check. More... | |
class | core\check\performance\dbschema |
DB schema performance check. More... | |
class | core\check\performance\debugging |
Debugging check. More... | |
class | core\check\performance\designermode |
Designer mode. More... | |
class | core\check\performance\stats |
class | core\check\result |
A check object returns a result object. More... | |
class | core\check\security\crawlers |
Verifies web crawler (search engine) access. More... | |
class | core\check\security\emailchangeconfirmation |
Verifies email confirmation - spammers were changing mails very often. More... | |
class | core\check\security\embed |
Verifies sloppy embedding - this should have been removed long ago!! More... | |
class | core\check\security\openprofiles |
Verifies open profiles - originally open by default, not anymore because spammer abused it a lot. More... | |
class | core\check\security\passwordpolicy |
Verifies if password policy set. More... | |
class | core\check\security\webcron |
Verifies the status of web cron. More... | |
class | core\check\table |
A table of check results. More... | |
class | core\content\export\exportable_item |
An object used to represent content which can be served. More... | |
class | core\content\export\exportable_items\exportable_filearea |
The definition of a set of files in a filearea to be exported. More... | |
class | core\content\export\exportable_items\exportable_stored_file |
An object used to represent content which can be served. More... | |
class | core\content\export\exportable_items\exportable_textarea |
The definition of a text area which can be exported. More... | |
class | core\content\export\exported_item |
This class describes the files which were exported, and any text content that those files were contained in. More... | |
class | core\content\export\exporters\abstract_mod_exporter |
Activity module exporter for the content API. More... | |
class | core\content\export\exporters\component_exporter |
A class to help define, describe, and export content in a specific context. More... | |
class | core\content\export\exporters\course_exporter |
The course exporter. More... | |
class | core\content\export\zipwriter |
Zip writer wrapper. More... | |
class | core\cron |
class | core\dataformat |
Dataformat utility class. More... | |
class | core\dataformat\base |
Base class for dataformat. More... | |
class | core\dataformat\spout_base |
Common Spout class for dataformat. More... | |
class | core\dml\recordset_walk |
Iterator that walks through a moodle_recordset applying the provided function. More... | |
class | core\dml\sql_join |
An object that contains sql join fragments. More... | |
class | core\dml\table |
Helpers and methods relating to DML tables. More... | |
class | core\encryption |
Class used to encrypt or decrypt data. More... | |
class | core\event\antivirus_scan_data_error |
class | core\event\antivirus_scan_file_error |
class | core\event\assessable_submitted |
Abstract assessable submitted event class. More... | |
class | core\event\assessable_uploaded |
class | core\event\badge_awarded |
Event triggered after a badge is awarded to a user. More... | |
class | core\event\badge_criteria_created |
class | core\event\badge_criteria_deleted |
class | core\event\badge_criteria_updated |
class | core\event\badge_deleted |
Event triggered after a badge is deleted. More... | |
class | core\event\badge_listing_viewed |
class | core\event\badge_revoked |
Event triggered after a badge is revoked from a user. More... | |
class | core\event\base |
class | core\event\blog_association_deleted |
class | core\event\blog_comment_created |
The blog comment created event class. More... | |
class | core\event\blog_comment_deleted |
The blog comment deleted event class. More... | |
class | core\event\blog_entries_viewed |
class | core\event\blog_external_removed |
Class for event to be triggered when an external blog is removed from moodle. More... | |
class | core\event\blog_external_viewed |
class | core\event\calendar_subscription_created |
class | core\event\calendar_subscription_deleted |
class | core\event\calendar_subscription_updated |
class | core\event\capability_assigned |
Capability assigned event class. More... | |
class | core\event\capability_unassigned |
Capability unassigned event class. More... | |
class | core\event\cohort_created |
Cohort created event class. More... | |
class | core\event\cohort_deleted |
Cohort deleted event class. More... | |
class | core\event\cohort_updated |
Cohort updated event class. More... | |
class | core\event\comments_viewed |
Abstract comments viewed event class. More... | |
class | core\event\config_log_created |
class | core\event\contentbank_content_created |
class | core\event\contentbank_content_deleted |
class | core\event\contentbank_content_updated |
class | core\event\contentbank_content_uploaded |
class | core\event\contentbank_content_viewed |
class | core\event\course_backup_created |
class | core\event\course_category_created |
Course category created event class. More... | |
class | core\event\course_category_updated |
Course category updated event class. More... | |
class | core\event\course_category_viewed |
Course category viewed event class. More... | |
class | core\event\course_completed |
class | core\event\course_completion_updated |
Course module completion updated event class. More... | |
class | core\event\course_information_viewed |
Course information viewed event class. More... | |
class | core\event\course_module_deleted |
class | core\event\course_module_instance_list_viewed |
Course module instance list viewed event class. More... | |
class | core\event\course_module_instances_list_viewed |
This class has been deprecated, please use core\event\course_module_instance_list_viewed. More... | |
class | core\event\course_module_viewed |
Abstract Course module viewed event class. More... | |
class | core\event\course_resources_list_viewed |
Event for viewing the list of course resources. More... | |
class | core\event\course_section_deleted |
class | core\event\course_updated |
class | core\event\course_user_report_viewed |
class | core\event\course_viewed |
class | core\event\dashboard_reset |
class | core\event\dashboard_viewed |
Dashboard viewed event class. More... | |
class | core\event\dashboards_reset |
class | core\event\database_text_field_content_replaced |
class | core\event\grade_exported |
class | core\event\grade_item_deleted |
Grade item deleted event class. More... | |
class | core\event\grade_item_updated |
Grade item updated event class. More... | |
class | core\event\grade_letter_created |
Grade letter created event class. More... | |
class | core\event\grade_letter_deleted |
Grade letter deleted event class. More... | |
class | core\event\grade_letter_updated |
Grade letter updated event class. More... | |
class | core\event\grade_report_viewed |
Grade report viewed event class. More... | |
class | core\event\group_created |
Group created event class. More... | |
class | core\event\group_deleted |
Group deleted event class. More... | |
class | core\event\group_message_sent |
class | core\event\group_updated |
Group updated event class. More... | |
class | core\event\grouping_created |
Grouping created event class. More... | |
class | core\event\grouping_deleted |
Grouping deleted event class. More... | |
class | core\event\grouping_group_assigned |
Group assigned to grouping event class. More... | |
class | core\event\grouping_group_unassigned |
Group unassigned from grouping event class. More... | |
class | core\event\grouping_updated |
Grouping updated event class. More... | |
class | core\event\manager |
Class used for event dispatching. More... | |
class | core\event\message_deleted |
class | core\event\message_sent |
class | core\event\message_viewed |
class | core\event\moodlenet_resource_exported |
class | core\event\mycourses_viewed |
class | core\event\notes_viewed |
Class note_viewed. More... | |
class | core\event\notification_sent |
class | core\event\question_base |
Base class for question events. More... | |
class | core\event\question_category_base |
Base class for question category events. More... | |
class | core\event\question_category_created |
Question category created event class. More... | |
class | core\event\question_category_deleted |
Question category deleted event class. More... | |
class | core\event\question_category_moved |
Question category moved event class. More... | |
class | core\event\question_category_updated |
Question category updated event class. More... | |
class | core\event\question_category_viewed |
Question category viewed event class. More... | |
class | core\event\question_created |
class | core\event\question_deleted |
class | core\event\question_moved |
class | core\event\question_updated |
class | core\event\question_viewed |
class | core\event\questions_exported |
class | core\event\questions_imported |
class | core\event\recent_activity_viewed |
Event for recent activity page. More... | |
class | core\event\role_allow_assign_updated |
Role assignments updated event class. More... | |
class | core\event\role_allow_override_updated |
Role allow override updated event class. More... | |
class | core\event\role_allow_switch_updated |
Role allow switch updated event class. More... | |
class | core\event\role_allow_view_updated |
Role allow view updated event class. More... | |
class | core\event\role_capabilities_updated |
Role updated event class. More... | |
class | core\event\scale_created |
Scale created event class. More... | |
class | core\event\scale_deleted |
Scale deleted event class. More... | |
class | core\event\scale_updated |
Scale updated event class. More... | |
class | core\event\search_indexed |
Event when new data has been indexed. More... | |
class | core\event\search_results_viewed |
class | core\event\tag_collection_created |
Tag collection created event class. More... | |
class | core\event\tag_collection_deleted |
Tag collection deleted event class. More... | |
class | core\event\tag_collection_updated |
Tag collection updated event class. More... | |
class | core\event\tag_created |
class | core\event\tag_deleted |
class | core\event\tag_flagged |
class | core\event\tag_unflagged |
class | core\event\tag_updated |
class | core\event\unknown_logged |
Unknown event class. More... | |
class | core\event\user_deleted |
class | core\event\user_enrolment_created |
class | core\event\user_enrolment_updated |
class | core\event\user_graded |
class | core\event\user_list_viewed |
class | core\event\user_loggedout |
class | core\event\user_login_failed |
class | core\event\user_password_policy_failed |
Event when user's current password fails the password policy. More... | |
class | core\event\user_password_updated |
class | core\event\userfeedback_give |
Class userfeedback_give. More... | |
class | core\event\userfeedback_remind |
Class userfeedback_remind. More... | |
class | core\event\virus_infected_data_detected |
Data infected event. More... | |
class | core\event\virus_infected_file_detected |
Fle infected event. More... | |
class | core\event\webservice_service_created |
class | core\event\webservice_service_deleted |
Web service service deleted event class. More... | |
class | core\event\webservice_service_updated |
Web service service updated event class. More... | |
class | core\event\webservice_token_created |
class | core\event\webservice_token_sent |
Webservice token sent event class. More... | |
class | core\external\coursecat_summary_exporter |
Class for exporting a course summary from an stdClass. More... | |
class | core\external\dynamic_tabs_get_content |
class | core\external\editmode |
class | core\external\moodlenet_auth_check |
class | core\external\moodlenet_get_share_info_activity |
class | core\external\moodlenet_send_activity |
class | core\external\output\icon_system\load_fontawesome_map |
class | core\external\paged_content_exporter |
Paged Content exporter. More... | |
class | core\external\persistent_exporter |
Abstract exporter based on the persistent model. More... | |
class | core\external\record_userfeedback_action |
class | core\files\curl_security_helper |
Host and port checking for curl. More... | |
class | core\files\curl_security_helper_base |
Security helper for the curl class. More... | |
class | core\form\error_feedback |
Moodle 404 Error page feedback form. More... | |
class | core\http_client |
class | core\hub\api |
Provides methods to communicate with the hub (sites directory) web services. More... | |
class | core\hub\registration |
Methods to use when registering the site at the moodle sites directory. More... | |
class | core\hub\site_registration_form |
The site registration form. More... | |
class | core\invalid_persistent_exception |
Invalid persistent exception class. More... | |
class | core\ip_utils |
Static helper class providing some useful internet-protocol-related functions. More... | |
class | core\local\cli\shutdown |
CLI script shutdown helper class. More... | |
class | core\local\guzzle\cache_handler |
class | core\local\guzzle\cache_item |
class | core\local\guzzle\cache_storage |
class | core\local\guzzle\check_request |
class | core\local\guzzle\redirect_middleware |
class | core\lock\db_record_lock_factory |
This is a db record locking factory. More... | |
class | core\lock\file_lock_factory |
Flock based file locking factory. More... | |
class | core\lock\installation_lock_factory |
Lock factory for use during installation. More... | |
class | core\lock\lock |
Class representing a lock. More... | |
class | core\lock\lock_config |
Lock configuration class, used to get an instance of the currently configured lock factory. More... | |
interface | core\lock\lock_factory |
Defines abstract factory class for generating locks. More... | |
class | core\lock\lock_utils |
class | core\lock\mysql_lock_factory |
MySQL / MariaDB locking factory. More... | |
class | core\lock\postgres_lock_factory |
Postgres advisory locking factory. More... | |
class | core\lock\timing_wrapper_lock_factory |
class | core\log\dummy_manager |
interface | core\log\manager |
Interface describing log readers. More... | |
interface | core\log\reader |
interface | core\log\sql_internal_table_reader |
Sql internal table reader. More... | |
interface | core\log\sql_reader |
Log iterator reader interface. More... | |
class | core\message\inbound\private_files_handler |
A Handler to store attachments sent in e-mails as private files. More... | |
class | core\moodlenet\activity_packager |
class | core\moodlenet\activity_sender |
class | core\moodlenet\helpers |
class | core\moodlenet\moodlenet_client |
class | core\moodlenet\utilities |
class | core\navigation\output\more_menu |
class | core\navigation\output\primary |
class | core\navigation\views\primary |
class | core\navigation\views\secondary |
class | core\navigation\views\view |
class | core\notification |
class | core\oauth2\access_token |
Loads/stores oauth2 access tokens in DB for system accounts in order to use a single token across multiple sessions. More... | |
class | core\oauth2\api |
Static list of api methods for system oauth2 configuration. More... | |
class | core\oauth2\client |
Configurable oauth2 client class. More... | |
class | core\oauth2\client\clever |
class | core\oauth2\client\linkedin |
class | core\oauth2\discovery\auth_server_config_reader |
class | core\oauth2\discovery\base_definition |
class | core\oauth2\discovery\imsbadgeconnect |
class | core\oauth2\discovery\openidconnect |
class | core\oauth2\endpoint |
Class for loading/storing oauth2 endpoints from the DB. More... | |
class | core\oauth2\issuer |
Class for loading/storing issuer from the DB. More... | |
class | core\oauth2\refresh_system_tokens_task |
Task to refresh system tokens regularly. More... | |
class | core\oauth2\rest |
Rest API base class mapping rest api methods to endpoints with http methods, args and post body. More... | |
class | core\oauth2\rest_exception |
Rest Exception class containing error code and message. More... | |
class | core\oauth2\service\clever |
class | core\oauth2\service\custom |
class | core\oauth2\service\facebook |
class | core\oauth2\service\google |
class | core\oauth2\service\imsobv2p1 |
interface | core\oauth2\service\issuer_interface |
class | core\oauth2\service\linkedin |
class | core\oauth2\service\microsoft |
class | core\oauth2\service\moodlenet |
class | core\oauth2\service\nextcloud |
class | core\oauth2\system_account |
Class for loading/storing oauth2 refresh tokens from the DB. More... | |
class | core\oauth2\user_field_mapping |
Class for loading/storing oauth2 user field mappings from the DB. More... | |
class | core\output\activity_header |
class | core\output\checkbox_toggleall |
The checkbox-toggleall renderable class. More... | |
class | core\output\chooser |
The chooser renderable class. More... | |
class | core\output\chooser_item |
The chooser_item renderable class. More... | |
class | core\output\chooser_section |
The chooser_section renderable class. More... | |
class | core\output\datafilter |
class | core\output\dynamic_tabs |
class | core\output\dynamic_tabs\base |
class | core\output\external |
class | core\output\icon_system |
Class allowing different systems for mapping and rendering icons. More... | |
class | core\output\icon_system_font |
Class allowing different systems for mapping and rendering icons. More... | |
class | core\output\icon_system_fontawesome |
Class allowing different systems for mapping and rendering icons. More... | |
class | core\output\icon_system_standard |
Standard icon rendering. More... | |
class | core\output\inplace_editable |
Class allowing to quick edit a title inline. More... | |
class | core\output\language_menu |
Class for creating the language menu. More... | |
class | core\output\mustache_clean_string_helper |
This class will load language strings in a template. More... | |
class | core\output\mustache_filesystem_loader |
Perform some custom name mapping for template file names. More... | |
class | core\output\mustache_pix_helper |
This class will call pix_icon with the section content. More... | |
class | core\output\mustache_quote_helper |
Wrap content in quotes, and escape all special JSON characters used. More... | |
class | core\output\mustache_shorten_text_helper |
This class will call shorten_text with the section content. More... | |
class | core\output\mustache_string_helper |
This class will load language strings in a template. More... | |
class | core\output\mustache_template_finder |
Get information about valid locations for mustache templates. More... | |
class | core\output\mustache_template_source_loader |
Load template source strings. More... | |
class | core\output\mustache_uniqid_helper |
Lazy create a uniqid per instance of the class. More... | |
class | core\output\mustache_user_date_helper |
Mustache helper that will convert a timestamp to a date string. More... | |
interface | core\output\named_templatable |
class | core\output\notification |
Data structure representing a notification. More... | |
class | core\output\participants_action_bar |
class | core\output\select_menu |
class | core\output\sticky_footer |
interface | core\output\url_rewriter |
URL rewriter interface. More... | |
class | core\persistent |
class | core\plugininfo\auth |
Class for authentication plugins. More... | |
class | core\plugininfo\availability |
Class for availability plugins. More... | |
class | core\plugininfo\base |
class | core\plugininfo\block |
Class for page side blocks. More... | |
class | core\plugininfo\cachelock |
Class for admin tool plugins. More... | |
class | core\plugininfo\cachestore |
Class for cache store plugins. More... | |
class | core\plugininfo\calendartype |
Class for calendar type plugins. More... | |
class | core\plugininfo\coursereport |
Class for admin tool plugins. More... | |
class | core\plugininfo\customfield |
Class for admin tool plugins. More... | |
class | core\plugininfo\dataformat |
Class for dataformats. More... | |
class | core\plugininfo\editor |
Class for HTML editors. More... | |
class | core\plugininfo\enrol |
Class for enrolment plugins. More... | |
class | core\plugininfo\fileconverter |
Class for document converter plugins. More... | |
class | core\plugininfo\filter |
Class for text filters. More... | |
class | core\plugininfo\format |
Class for course formats. More... | |
class | core\plugininfo\general |
General class for all plugin types that do not have their own class. More... | |
class | core\plugininfo\gradeexport |
Class for admin tool plugins. More... | |
class | core\plugininfo\gradeimport |
Class for admin tool plugins. More... | |
class | core\plugininfo\gradereport |
Class for admin tool plugins. More... | |
class | core\plugininfo\gradingform |
Class for admin tool plugins. More... | |
class | core\plugininfo\h5plib |
Class for H5P libraries. More... | |
class | core\plugininfo\local |
Class for local plugins. More... | |
class | core\plugininfo\media |
Class for media plugins. More... | |
class | core\plugininfo\message |
Class for messaging processors. More... | |
class | core\plugininfo\mlbackend |
Class for analytics machine learning backend plugins. More... | |
class | core\plugininfo\mnetservice |
Class representing an MNet service. More... | |
class | core\plugininfo\mod |
Class for activity modules. More... | |
class | core\plugininfo\orphaned |
Orphaned subplugins class. More... | |
class | core\plugininfo\plagiarism |
Class for plagiarism plugins. More... | |
class | core\plugininfo\portfolio |
Class for portfolios. More... | |
class | core\plugininfo\profilefield |
Class for admin tool plugins. More... | |
class | core\plugininfo\qbank |
Base class for qbank plugins. More... | |
class | core\plugininfo\qbehaviour |
Class for question behaviours. More... | |
class | core\plugininfo\qformat |
Class for question types. More... | |
class | core\plugininfo\qtype |
Class for question types. More... | |
class | core\plugininfo\report |
Class for admin tool plugins. More... | |
class | core\plugininfo\repository |
Class for repositories. More... | |
class | core\plugininfo\search |
Class for search plugins. More... | |
class | core\plugininfo\theme |
Class for themes. More... | |
class | core\plugininfo\tool |
Class for admin tool plugins. More... | |
class | core\plugininfo\webservice |
Class for webservice protocols. More... | |
class | core\privacy\provider |
Privacy class for requesting user data. More... | |
class | core\progress\db_updater |
Progress handler that updates a database table with the progress. More... | |
class | core\progress\none |
Progress handler that ignores progress entirely. More... | |
class | core\report_helper |
A helper class with static methods to help report plugins. More... | |
class | core\session\database |
Database based session handler. More... | |
class | core\session\exception |
Session related exception class. More... | |
class | core\session\external |
This class contains a list of webservice functions related to session. More... | |
class | core\session\file |
File based session handler. More... | |
class | core\session\handler |
Session handler base. More... | |
class | core\session\manager |
Session manager, this is the public Moodle API for sessions. More... | |
class | core\session\memcached |
Memcached based session handler. More... | |
class | core\session\redis |
Redis based session handler. More... | |
class | core\session\utility\cookie_helper |
class | core\task\adhoc_task |
Abstract class defining an adhoc task. More... | |
class | core\task\analytics_cleanup_task |
Delete stale records from analytics tables. More... | |
class | core\task\asynchronous_backup_task |
Adhoc task that performs asynchronous backups. More... | |
class | core\task\asynchronous_copy_task |
Adhoc task that performs asynchronous course copies. More... | |
class | core\task\asynchronous_restore_task |
Adhoc task that performs asynchronous restores. More... | |
class | core\task\automated_backup_report_task |
class | core\task\automated_backup_task |
Simple task to run the backup cron. More... | |
class | core\task\badges_adhoc_task |
class | core\task\badges_cron_task |
Simple task to run the badges cron. More... | |
class | core\task\badges_message_task |
Simple task to run the badges cron. More... | |
class | core\task\blog_cron_task |
Simple task to run the blog cron. More... | |
class | core\task\build_installed_themes_task |
Class that builds and caches all of the site's installed themes. More... | |
class | core\task\cache_cleanup_task |
Simple task to delete old cache records. More... | |
class | core\task\cache_cron_task |
Simple task to run the cache cron. More... | |
class | core\task\calendar_cron_task |
Simple task to run the calendar cron. More... | |
class | core\task\calendar_fix_orphaned_events |
Class handling fixing of events that have had their userid lost. More... | |
class | core\task\check_for_updates_task |
Simple task to run the registration cron. More... | |
class | core\task\clean_up_deleted_search_area_task |
Class that cleans up data related to deleted search area. More... | |
class | core\task\completion_daily_task |
Simple task to run the daily completion cron. More... | |
class | core\task\completion_regular_task |
Simple task to run the regular completion cron. More... | |
class | core\task\context_cleanup_task |
Simple task to delete old context records. More... | |
class | core\task\course_backup_task |
Adhoc task that performs single automated course backup. More... | |
class | core\task\create_contexts_task |
Simple task to create missing contexts at all levels. More... | |
class | core\task\database_logger |
Database logger for task logging. More... | |
class | core\task\delete_incomplete_users_task |
Simple task to delete user accounts for users who have not completed their profile in time. More... | |
class | core\task\delete_unconfirmed_users_task |
Simple task to delete user accounts for users who have not confirmed in time. More... | |
class | core\task\file_temp_cleanup_task |
Simple task to delete temp files older than 1 week. More... | |
class | core\task\file_trash_cleanup_task |
Simple task to run the file trash cleanup cron. More... | |
class | core\task\fix_file_timestamps_task |
class | core\task\grade_cron_task |
Simple task to run the grade cron. More... | |
class | core\task\grade_history_cleanup_task |
Simple task to clean grade history tables. More... | |
class | core\task\h5p_get_content_types_task |
class | core\task\legacy_plugin_cron_task |
Simple task to run cron for all plugins. More... | |
class | core\task\logmanager |
Task log manager. More... | |
class | core\task\manager |
Collection of task related methods. More... | |
class | core\task\messaging_cleanup_task |
Simple task to delete old messaging records. More... | |
class | core\task\password_reset_cleanup_task |
Simple task to delete old password reset records. More... | |
class | core\task\plagiarism_cron_task |
Simple task to run the plagiarism cron. More... | |
class | core\task\portfolio_cron_task |
Simple task to run the portfolio cron. More... | |
class | core\task\question_preview_cleanup_task |
A task to cleanup old question previews. More... | |
class | core\task\question_stats_cleanup_task |
A task to cleanup old question statistics cache. More... | |
class | core\task\refresh_mod_calendar_events_task |
Class that updates all of the existing calendar events for modules that implement the *_refresh_events() hook. More... | |
class | core\task\registration_cron_task |
Simple task to run the registration cron. More... | |
class | core\task\scheduled_task |
Abstract class defining a scheduled task. More... | |
class | core\task\search_index_task |
Runs global search indexing. More... | |
class | core\task\search_optimize_task |
Runs search index optimization. More... | |
class | core\task\send_failed_login_notifications_task |
Simple task to send notifications about failed login attempts. More... | |
class | core\task\send_login_notifications |
class | core\task\send_new_user_passwords_task |
Simple task to create accounts and send password emails for new users. More... | |
class | core\task\session_cleanup_task |
Simple task to cleanup user sessions from a scheduled task. More... | |
class | core\task\stats_cron_task |
Simple task to run the stats cron. More... | |
class | core\task\tag_cron_task |
Simple task to run the tag cron. More... | |
class | core\task\task_base |
Abstract class for common properties of scheduled_task and adhoc_task. More... | |
class | core\task\task_lock_cleanup_task |
Adhoc task metadata cleanup task. More... | |
class | core\task\task_log_cleanup_task |
A task to cleanup log entries for tasks. More... | |
interface | core\task\task_logger |
Interface for task logging. More... | |
class | core\update\api |
General purpose client for https://download.moodle.org/api/. More... | |
class | core\update\checker |
Singleton class that handles checking for available updates. More... | |
class | core\update\checker_exception |
General exception thrown by the core::update::checker class. More... | |
class | core\update\info |
Defines the structure of objects returned by core::update::checker::get_update_info(). More... | |
class | core\upgrade\util |
Core upgrade utility class. More... | |
class | core\uuid |
V4 UUID generator class. More... | |
class | core_admin\form\purge_caches |
Form for selecting which caches to purge on admin/purgecaches.php. More... | |
class | core_admin\form\testoutgoingmailconf_form |
Test mail form. More... | |
class | core_admin\local\settings\setting_scheduled_task_status |
This admin setting tells whether a given scheduled task is enabled, providing a link to its configuration page. More... | |
class | core_admin_renderer |
class | core_badges\badge |
Class that represents badge. More... | |
class | core_badges\form\backpack |
Form to edit backpack initial details. More... | |
class | core_badges\form\badge |
Form to edit badge details. More... | |
class | core_badges\form\collections |
Form to select backpack collections. More... | |
class | core_badges\form\message |
Form to edit badge message. More... | |
class | core_badges\helper |
Badge helper library. More... | |
class | core_badges\output\badge_alignments |
Link to external resources this badge is aligned with. More... | |
class | core_badges\output\badge_collection |
Collection of all badges for view.php page. More... | |
class | core_badges\output\badge_management |
Collection of badges used at the index.php page. More... | |
class | core_badges\output\badge_recipients |
Badge recipients rendering class. More... | |
class | core_badges\output\badge_related |
Collection of all related badges. More... | |
class | core_badges\output\badge_user_collection |
Collection of user badges used at the mybadges.php page. More... | |
class | core_badges\output\external_badge |
An external badges for external.php page. More... | |
class | core_badges\output\issued_badge |
An issued badges for badge.php page. More... | |
class | core_badges_assertion |
Open Badges Assertions specification 1.0 More... | |
class | core_badges_renderer |
Standard HTML output renderer for badges. More... | |
class | core_cache\administration_helper |
Administration helper base class. More... | |
class | core_cache\local\administration_display_helper |
A cache helper for administration tasks. More... | |
class | core_collator |
A collator class with static methods that can be used for sorting. More... | |
class | core_component |
Collection of components related methods. More... | |
class | core_course\analytics\indicator\activities_due |
Activities due indicator. More... | |
class | core_course\cache\course_image |
class | core_course\local\entity\activity_chooser_footer |
A class to represent the Activity Chooser footer data. More... | |
class | core_course\local\entity\content_item |
The content_item class. More... | |
class | core_course\local\entity\lang_string_title |
The lang_string_title class of value object, providing access to the value of a lang string. More... | |
class | core_course\local\entity\string_title |
The string_title class of value object, which provides access to a simple string. More... | |
interface | core_course\local\entity\title |
class | core_course\local\exporters\course_content_item_exporter |
The course_content_item_exporter class. More... | |
class | core_course\local\exporters\course_content_items_exporter |
The course_content_items_exporter class. More... | |
class | core_course\local\repository\caching_content_item_readonly_repository |
The class caching_content_item_repository, for fetching content_items, with additional caching. More... | |
class | core_course\local\repository\content_item_readonly_repository |
The class content_item_repository, for reading content_items. More... | |
interface | core_course\local\repository\content_item_readonly_repository_interface |
class | core_course\output\category_action_bar |
class | core_course\output\manage_categories_action_bar |
class | core_course_category |
class | core_course_list_element |
class | core_cssparser |
Moodle CSS parser. More... | |
class | core_date |
Core date and time related code. More... | |
class | core_event_course_module_instance_list_viewed_testcase |
Class core_event_course_module_instance_list_viewed_testcase. More... | |
class | core_event_course_module_viewed_testcase |
Class core_event_course_module_viewed_testcase. More... | |
class | core_external |
class | core_files_renderer |
File browser render. More... | |
class | core_filetypes |
Class to manage the custom filetypes list that is stored in a config variable. More... | |
class | core_geopattern |
class | core_html2text |
Wrapper for Html2Text. More... | |
class | core_minify |
Collection of JS and CSS compression methods. More... | |
class | core_php_time_limit |
Utility class to manage PHP time limit. More... | |
class | core_plugin_manager |
class | core_qrcode |
Class for generating QR codes. More... | |
class | core_question\statistics\questions\calculated |
This class is used to return the stats as calculated by core_question::statistics::questions::calculator. More... | |
class | core_question\statistics\questions\calculator |
This class has methods to compute the question statistics from the raw data. More... | |
class | core_renderer |
The standard implementation of the core_renderer interface. More... | |
class | core_renderer_ajax |
A renderer that generates output for ajax scripts. More... | |
class | core_renderer_cli |
A renderer that generates output for command-line scripts. More... | |
class | core_renderer_maintenance |
The maintenance renderer. More... | |
class | core_requirejs |
Collection of requirejs related methods. More... | |
class | core_rtlcss |
Moodle RTLCSS class. More... | |
class | core_scss |
Moodle SCSS compiler class. More... | |
class | core_shutdown_manager |
Shutdown management class. More... | |
interface | core_string_manager |
Interface for string manager. More... | |
class | core_string_manager_install |
Fetches minimum strings for installation. More... | |
class | core_string_manager_standard |
Standard string_manager implementation. More... | |
class | core_table\local\filter\filter |
Class representing a generic filter of any type. More... | |
class | core_table\local\filter\filterset |
Class representing a set of filters. More... | |
class | core_table\local\filter\integer_filter |
Class representing an integer filter. More... | |
class | core_table\local\filter\numeric_comparison_filter |
Class representing an integer filter. More... | |
class | core_table\local\filter\string_filter |
Class representing a string filter. More... | |
class | core_text |
defines string api's for manipulating strings More... | |
class | core_upgrade_time |
Static class monitors performance of upgrade steps. More... | |
class | core_user |
User class to access user details. More... | |
class | core_user\analytics\target\upcoming_activities_due |
Upcoming activities due target. More... | |
class | core_user\devicekey |
class | core_user\external\update_user_device_public_key |
class | core_user\table\participants_filterset |
Participants table filterset. More... | |
class | core_useragent |
The user agent class. More... | |
class | core_userfeedback |
This Class contains helper functions for user feedback functionality. More... | |
class | core_xml_parser |
Class for parsing xml files. More... | |
class | course_enrolment_table |
Main course enrolment table. More... | |
class | course_modinfo |
class | course_reset_form |
Defines the course reset settings form. More... | |
class | coursecat_helper |
Class storing display options and functions to help display course category and/or courses lists. More... | |
class | csv_export_writer |
Utitily class for exporting of CSV files. More... | |
class | csv_import_reader |
Utitily class for importing of CSV files. More... | |
class | custom_menu |
Custom menu class. More... | |
class | custom_menu_item |
Custom menu item. More... | |
class | database_driver_testcase |
Special test case for testing of DML drivers and DDL layer. More... | |
class | dbtransfer_exception |
Exception class for db transfer. More... | |
class | ddl_change_structure_exception |
Error during changing db structure. More... | |
class | ddl_dependency_exception |
Error changing db structure, caused by some dependency found like trying to modify one field having related indexes. More... | |
class | ddl_exception |
DDL exception class, use instead of throw new moodle_exception() and "return false;" in ddl code. More... | |
class | ddl_field_missing_exception |
Table does not exist problem exception. More... | |
class | ddl_table_missing_exception |
Table does not exist problem exception. More... | |
class | default_block_generator |
Default block generator class to be used when a specific one is not supported. More... | |
class | dml_connection_exception |
DML db connection exception - triggered if database not accessible. More... | |
class | dml_exception |
DML exception class, use instead of throw new moodle_exception() in dml code. More... | |
class | dml_missing_record_exception |
Caused by missing record that is required for normal operation. More... | |
class | dml_multiple_records_exception |
Caused by multiple records found in get_record() call. More... | |
class | dml_read_exception |
DML read exception - triggered by some SQL syntax errors, etc. More... | |
class | dml_sessionwait_exception |
DML db session wait exception - triggered when session lock request times out. More... | |
class | dml_transaction_exception |
DML transaction exception - triggered by problems related to DB transactions. More... | |
class | dml_write_exception |
DML write exception - triggered by some SQL syntax errors, etc. More... | |
class | dndupload_ajax_processor |
Processes the upload, creating the course module and returning the result. More... | |
class | dndupload_handler |
Stores all the information about the available dndupload handlers. More... | |
class | downgrade_exception |
Exception indicating downgrade error during upgrade. More... | |
class | edit_criteria_form |
Form to edit badge criteria. More... | |
class | edit_relatedbadge_form |
Form to edit badge details. More... | |
class | emoticon_manager |
Provides core support for plugins that have to deal with emoticons (like HTML editor or emoticon filter). More... | |
class | endorsement_form |
Form to edit endorsement. More... | |
class | enrol_plugin |
Enrolment plugins abstract class. More... | |
class | environment_results |
Helper Class to return results to caller. More... | |
class | error_log_progress_trace |
This subclass of progress_trace outputs to error log. More... | |
class | file_picker |
Data structure representing a file picker. More... | |
class | file_serving_exception |
An exception that indicates that file can not be served. More... | |
class | files_tree_viewer |
Data structure representing a general moodle file tree viewer. More... | |
class | filter_local_settings_form |
class | filter_manager |
Class to manage the filtering of strings. More... | |
class | filterobject |
This is just a little object to define a phrase and some instructions for how to process it. More... | |
class | flat_navigation |
Class used to generate a collection of navigation nodes most closely related to the current page. More... | |
class | flat_navigation_node |
Subclass of navigation_node allowing different rendering for the flat navigation in particular allowing dividers and indents. More... | |
class | flexible_table |
class | flickr_client |
Simple Flickr API client implementing the features needed by Moodle. More... | |
class | fragment_requirements_manager |
This requirements manager captures the appropriate html for creating a fragment to be inserted elsewhere. More... | |
class | global_navigation |
The global navigation class used for... the global navigation. More... | |
class | global_navigation_for_ajax |
The global navigation class used especially for AJAX requests. More... | |
class | google_docs |
Class for manipulating google documents through the google data api. More... | |
class | google_oauth |
OAuth 2.0 client for Google Services. More... | |
class | graph |
class | help_icon |
Data structure representing a help icon. More... | |
class | html_list_progress_trace |
HTML List Progress Tree. More... | |
class | html_progress_trace |
This subclass of progress_trace outputs as HTML. More... | |
class | html_table |
Holds all the information required to render a. More... | |
class | html_table_cell |
Component representing a table cell. More... | |
class | html_table_row |
Component representing a table row. More... | |
class | html_writer |
Simple html output class. More... | |
class | HTMLPurifier_URIScheme_gopher |
Validates Gopher defined by RFC 4266. More... | |
class | HTMLPurifier_URIScheme_irc |
Validates IRC defined by IETF Draft. More... | |
class | HTMLPurifier_URIScheme_mms |
Validates MMS defined by Microsoft. More... | |
class | HTMLPurifier_URIScheme_rtmp |
Validates RTMP defined by Adobe. More... | |
class | HTMLPurifier_URIScheme_rtsp |
Validates RTSP defined by RFC 2326. More... | |
class | HTMLPurifier_URIScheme_teamspeak |
Validates TeamSpeak defined by TeamSpeak. More... | |
class | image_icon |
Data structure representing an activity icon. More... | |
class | imscc11_backup_convert |
class | imscc11_convert_exception |
Exception thrown by this converter. More... | |
class | imscc11_converter |
class | imscc11_export_converter |
class | imscc11_store_backup_file |
class | imscc11_zip_contents |
class | imscc1_convert_exception |
Exception thrown by this converter. More... | |
class | imscc1_converter |
class | initials_bar |
Component representing initials bar. More... | |
class | invalid_dataroot_permissions |
An exception that indicates incorrect permissions in $CFG->dataroot. More... | |
class | invalid_parameter_exception |
Exception indicating malformed parameter problem. More... | |
class | invalid_response_exception |
Exception indicating malformed response problem. More... | |
class | invalid_state_exception |
An exception that indicates something really weird happened. More... | |
class | js_writer |
Simple javascript output class. More... | |
class | lang_installer |
End of component_installer class. More... | |
class | lang_installer_exception |
Exception thrown by lang_installer. More... | |
class | lang_string |
The lang_string class. More... | |
class | license_manager |
class | list_item |
class | login_change_password_form |
class | login_forgot_password_form |
Reset forgotten password form definition. More... | |
class | login_set_password_form |
Set forgotten password form definition. More... | |
class | login_signup_form |
class | mnet_profile_form |
small form to allow the administrator to configure (override) which profile fields are sent/imported over mnet More... | |
class | mnet_review_host_form |
The second step of the form - reviewing the host details This is also the same form that is used for editing an existing host. More... | |
class | mnet_services_form |
class | mnet_simple_host_form |
The very basic first step add new host form - just wwwroot & application The second form is loaded up with the information from this one. More... | |
class | mod_chat_generator |
mod_chat data generator class. More... | |
class | Moodle\BehatExtension\Context\ContextClass\ClassResolver |
class | Moodle\BehatExtension\Context\Initializer\MoodleAwareInitializer |
class | Moodle\BehatExtension\Context\MoodleContext |
class | Moodle\BehatExtension\Context\Step\ChainedStep |
class | Moodle\BehatExtension\Context\Step\Given |
class | Moodle\BehatExtension\Context\Step\Then |
class | Moodle\BehatExtension\Context\Step\When |
class | Moodle\BehatExtension\Definition\Cli\AvailableDefinitionsController |
class | Moodle\BehatExtension\Definition\Printer\ConsoleDefinitionInformationPrinter |
class | Moodle\BehatExtension\Driver\WebDriver |
class | Moodle\BehatExtension\Driver\WebDriverFactory |
class | Moodle\BehatExtension\EventDispatcher\Tester\ChainedStepTester |
class | Moodle\BehatExtension\EventDispatcher\Tester\MoodleEventDispatchingStepTester |
class | Moodle\BehatExtension\Exception\SkippedException |
class | Moodle\BehatExtension\Locator\FilesystemSkipPassedListLocator |
class | Moodle\BehatExtension\Output\Formatter\MoodleListFormatter |
class | Moodle\BehatExtension\Output\Formatter\MoodleProgressFormatterFactory |
class | Moodle\BehatExtension\Output\Formatter\MoodleScreenshotFormatter |
class | Moodle\BehatExtension\Output\Formatter\MoodleStepcountFormatter |
class | Moodle\BehatExtension\Output\Printer\MoodleProgressPrinter |
class | Moodle\BehatExtension\Tester\Cli\SkipPassedController |
class | moodle_exception |
Base Moodle Exception class. More... | |
class | moodle_list |
Clues to reading this code: More... | |
class | moodle_page |
class | moodle_phpmailer |
Moodle Customised version of the PHPMailer class. More... | |
class | moodle_phpmailer_oauth |
class | moodle_text_filter |
Base class for text filters. More... | |
class | moodle_url |
Class for creating and manipulating urls. More... | |
class | moodle_xhprofrun |
Custom implementation of iXHProfRuns. More... | |
class | MoodleExcelFormat |
Define and operate over one Format. More... | |
class | MoodleExcelWorkbook |
Define and operate over one Moodle Workbook. More... | |
class | MoodleExcelWorksheet |
Define and operate over one Worksheet. More... | |
class | MoodleODSCell |
ODS Cell abstraction. More... | |
class | MoodleODSFormat |
ODS cell format abstraction. More... | |
class | MoodleODSWorkbook |
ODS workbook abstraction. More... | |
class | MoodleODSWorksheet |
ODS Worksheet abstraction. More... | |
class | MoodleODSWriter |
ODS file writer. More... | |
class | mysqli_native_moodle_recordset |
Mysqli specific moodle recordset class. More... | |
class | nasty_strings |
Nasty strings manager. More... | |
class | navbar |
Navbar class. More... | |
class | navigation_cache |
The cache class used by global navigation and settings navigation. More... | |
class | navigation_json |
Simple class used to output a navigation branch in XML. More... | |
class | navigation_node |
This class is used to represent a node in a navigation tree. More... | |
class | navigation_node_collection |
Navigation node collection. More... | |
class | null_filter_manager |
Filter manager subclass that does nothing. More... | |
class | null_progress_trace |
This subclass of progress_trace does not ouput anything. More... | |
class | oauth2_client |
OAuth 2.0 Client for using web access tokens. More... | |
class | page_requirements_manager |
This class tracks all the things that are needed by the current page. More... | |
class | paging_bar |
Component representing a paging bar. More... | |
interface | parentable_part_of_admin_tree |
Interface implemented by any part_of_admin_tree that has children. More... | |
interface | part_of_admin_tree |
CLASS DEFINITIONS /////////////////////////////////////////////////////////. More... | |
class | performance_measuring_filter_manager |
Filter manager subclass that tracks how much work it does. More... | |
class | phpunit_constraint_object_is_equal_with_exceptions |
Constraint that checks a simple object with an isEqual constrain, allowing for exceptions to be made for some fields. More... | |
class | phpunit_coverage_info |
Coverage information for the core subsystem. More... | |
class | phpunit_dataset |
Lightweight dataset class for phpunit, supports XML, CSV and array datasets. More... | |
class | phpunit_event_mock |
Event mock class. More... | |
class | phpunit_event_sink |
Event redirection sink. More... | |
class | phpunit_message_sink |
Message sink. More... | |
class | phpunit_phpmailer_sink |
phpmailer message sink. More... | |
class | phpunit_util |
Collection of utility methods. More... | |
class | pix_emoticon |
Data structure representing an emoticon image. More... | |
class | pix_icon |
Data structure representing an icon. More... | |
class | pix_icon_font |
Data structure representing an icon font. More... | |
class | pix_icon_fontawesome |
Data structure representing an icon subtype. More... | |
class | plugin_defective_exception |
@subpackage upgrade More... | |
class | plugin_incompatible_exception |
Exception thrown when attempting to install a plugin that declares incompatibility with moodle version. More... | |
class | plugin_misplaced_exception |
Misplaced plugin exception. More... | |
class | plugin_renderer_base |
Basis for all plugin renderers. More... | |
class | PNG_MetaDataHandler |
Information on PNG file chunks can be found at http://www.w3.org/TR/PNG/#11Chunks Some other info on PNG that I used http://garethrees.org/2007/11/14/pngcrush/. More... | |
class | popup_action |
Component action for a popup window. More... | |
class | preferences_group |
Represents a group of preferences page link. More... | |
class | preferences_groups |
Represents a set of preferences groups. More... | |
class | progress_bar |
Progress bar class. More... | |
class | progress_trace |
Progress trace class. More... | |
class | progress_trace_buffer |
Special type of trace that can be used for catching of output of other traces. More... | |
class | question_behaviour_type |
This class represents the type of behaviour, rather than the instance of the behaviour which control a particular question attempt. More... | |
class | question_behaviour_type_fallback |
This class exists to allow behaviours that worked in Moodle 2.3 to continue to work. More... | |
interface | renderable |
Interface marking other classes as suitable for renderer_base\render() More... | |
class | renderer_base |
Simple base class for Moodle renderers. More... | |
interface | renderer_factory |
A renderer factory is just responsible for creating an appropriate renderer for any given part of Moodle. More... | |
class | renderer_factory_base |
This is a base class to help you implement the renderer_factory interface. More... | |
class | require_login_exception |
Course/activity access exception. More... | |
class | require_login_session_timeout_exception |
Session timeout exception. More... | |
class | required_capability_exception |
Exceptions indicating user does not have permissions to do something and the execution can not continue. More... | |
class | restore_date_testcase |
Advanced PHPUnit test case customised for testing restore dates in Moodle. More... | |
class | search_lexer |
This class does the heavy lifting of lexing the search string into tokens. More... | |
class | search_parser |
This class takes care of sticking the proper token type/value pairs into the parsed token array. More... | |
class | search_token |
Class to hold token/value pairs after they're parsed. More... | |
class | section_info |
class | settings_navigation |
Class used to manage the settings option for the current page. More... | |
class | settings_navigation_ajax |
Class used to populate site admin navigation for ajax. More... | |
class | single_button |
Data structure representing a simple form with only one button. More... | |
class | single_select |
Simple form with just one select field that gets submitted automatically. More... | |
class | standard_renderer_factory |
This is the default renderer factory for Moodle. More... | |
class | table_dataformat_export_format |
Dataformat exporter. More... | |
class | table_default_export_format_parent |
class | table_sql |
class | tabobject |
Stores one tab. More... | |
class | tabtree |
Stores tabs list. More... | |
interface | templatable |
Interface marking other classes having the ability to export their data for use by templates. More... | |
class | test_lock |
Tests lock to prevent concurrent executions of the same test suite. More... | |
class | testing_block_generator |
Block generator base class. More... | |
class | testing_module_generator |
Module generator base class. More... | |
class | testing_repository_generator |
Repository data generator class. More... | |
class | testing_util |
Utils for test sites creation. More... | |
class | tests_finder |
Finds components and plugins with tests. More... | |
class | text_progress_trace |
This subclass of progress_trace outputs to plain text. More... | |
class | texteditor |
Base abstract text editor class. More... | |
class | theme_config |
This class represents the configuration variables of a Moodle theme. More... | |
class | theme_overridden_renderer_factory |
This is renderer factory allows themes to override the standard renderers using php code. More... | |
class | upgrade_exception |
Exception indicating unknown error during upgrade. More... | |
class | upgrade_requires_exception |
@subpackage upgrade More... | |
class | upload_manager |
This class handles all aspects of fileuploading. More... | |
class | url_select |
Simple URL selection widget description. More... | |
class | user_bulk_action_form |
Bulk user action form. More... | |
class | user_bulk_cohortadd_form |
class | user_bulk_form |
Bulk user form. More... | |
class | user_picture |
Data structure representing a user picture. More... | |
class | uu_progress_tracker |
Tracking of processed users. More... | |
class | webservice_parameter_exception |
Web service parameter exception class. More... | |
class | WikiToMarkdown |
#- More... | |
class | xhprof_table_sql |
Simple subclass of table_sql that provides some custom formatters for various columns, in order to make the main profiles list nicer. More... | |
class | xhtml_container_stack |
This class keeps track of which HTML tags are currently open. More... | |
class | xml_format_exception |
class | YUI_config |
This class represents the YUI configuration. More... | |
Functions | |
filter_manager::__construct () | |
Constructor. | |
filterobject::__construct ($phrase, $hreftagbegin='< span class="highlight">', $hreftagend='</span >', $casesensitive=false, $fullmatch=false, $replacementphrase=null, $replacementcallback=null, array $replacementcallbackdata=null) | |
Constructor. | |
moodle_text_filter::__construct ($context, array $localconfig) | |
Set any context-specific configuration for this filter. | |
object | _fix_course_cats ($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) |
Internal recursive category verification function, do not use directly! | |
_tidy_question ($question, $category, array $tagobjects=null, array $filtercourses=null) | |
Private function to factor common code out of get_question_options(). | |
abort_all_db_transactions () | |
Unconditionally abort all database transactions, this function should be called from exception handlers only. | |
add_event () | |
CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////. | |
add_indented_names ($categories, $nochildrenof=-1) | |
Format categories into an indented list reflecting the tree structure. | |
add_mod_to_section () | |
moodle_database | add_to_config_log ($name, $oldvalue, $value, $plugin) |
Add an entry to the config log table. | |
add_to_log () | |
address_in_subnet ($addr, $subnetstr, $checkallzeros=false) | |
Function to check the passed address is within the passed subnet. | |
addslashes_js ($var) | |
Does proper javascript quoting. | |
admin_apply_default_settings ($node=null, $unconditional=true, $admindefaultsettings=array(), $settingsoutput=array()) | |
settings utility functions | |
admin_critical_warnings_present () | |
Test if and critical warnings are present. | |
moodle_page | admin_externalpage_setup ($section, $extrabutton='', array $extraurlparams=null, $actualurl='', array $options=array()) |
Initialise admin page - this function does require login and permission checks specified in page definition. | |
admin_find_write_settings ($node, $data) | |
Internal recursive function - finds all settings from submitted form. | |
admin_get_root ($reload=false, $requirefulltree=true) | |
Returns the reference to admin tree root. | |
admin_mnet_method_get_docblock (ReflectionFunctionAbstract $function) | |
Given some sort of reflection function/method object, return an array of docblock lines, where each line is an array of keywords/descriptions. | |
admin_mnet_method_get_help (ReflectionFunctionAbstract $function) | |
Given some sort of reflection function/method object, return just the help text. | |
admin_mnet_method_profile (ReflectionFunctionAbstract $function) | |
Given some sort of reflection function/method object, return a profile array, ready to be serialized and stored. | |
admin_output_new_settings_by_page ($node) | |
Internal function - returns arrays of html pages with uninitialised settings. | |
admin_search_settings_html ($query) | |
Internal function - prints the search results. | |
admin_write_settings ($formdata) | |
Store changed settings, this function updates the errors variable in $ADMIN. | |
ajax_capture_output () | |
Starts capturing output whilst processing an AJAX request. | |
ajax_check_captured_output () | |
Check captured output for content. | |
ajaxenabled () | |
allow_assign () | |
allow_override () | |
allow_switch () | |
any_new_admin_settings ($node) | |
Based on find_new_settings() in upgradesettings.php Looks to find any admin settings that have not been initialized. | |
filter_manager::apply_filter_chain ($text, $filterchain, array $options=array(), array $skipfilters=null) | |
Apply a list of filters to some content. | |
array_is_nested ($array) | |
Check if there is a nested array within the passed array. | |
authenticate_user_login ($username, $password, $ignorelockout=false, &$failurereason=null, $logintoken=false) | |
Authenticates a user against the chosen authentication mechanism. | |
badge_assemble_notification (stdClass $badge) | |
Creates single message for all notification and sends it out. | |
badge_award_criteria_competency_has_records_for_competencies ($competencyids) | |
Check if any badge has records for competencies. | |
badge_message_from_template ($message, $params) | |
Replaces variables in a message template and returns text ready to be emailed to a user. | |
badges_add_course_navigation (navigation_node $coursenode, stdClass $course) | |
Extends the course administration navigation with the Badges page. | |
badges_award_handle_manual_criteria_review (stdClass $data) | |
Triggered when badge is manually awarded. | |
badges_bake ($hash, $badgeid, $userid=0, $pathhash=false) | |
Bake issued badge. | |
badges_calculate_message_schedule ($schedule) | |
Caclulates date for the next message digest to badge creators. | |
badges_change_sortorder_backpacks (int $backpackid, int $direction) | |
Moves the backpack in the list one position up or down. | |
badges_check_backpack_accessibility () | |
Checks if badges can be pushed to external backpack. | |
badges_create_site_backpack ($data) | |
Create the site backpack with this data. | |
badges_delete_site_backpack ($id) | |
Delete the backpack with this id. | |
badges_disconnect_user_backpack ($userid) | |
Disconnect from the user backpack by deleting the user preferences. | |
badges_download ($userid) | |
Download all user badges in zip archive. | |
badges_external_create_mapping ($sitebackpackid, $type, $internalid, $externalid) | |
Save the info about which objects we connected with a backpack before. | |
badges_external_delete_mapping ($sitebackpackid, $type, $internalid) | |
Delete a specific external mapping information for a backpack. | |
badges_external_delete_mappings ($sitebackpackid) | |
Delete all external mapping information for a backpack. | |
badges_external_get_mapping ($sitebackpackid, $type, $internalid, $param='externalid') | |
Used to remember which objects we connected with a backpack before. | |
badges_generate_badgr_open_url ($backpack, $type, $externalid) | |
Generate a public badgr URL that conforms to OBv2. | |
badges_get_badge_api_versions () | |
List the supported badges api versions. | |
badges_get_badges ($type, $courseid=0, $sort='', $dir='', $page=0, $perpage=BADGE_PERPAGE, $user=0) | |
Get all badges. | |
badges_get_default_issuer () | |
Get the default issuer for a badge from this site. | |
badges_get_issued_badge_info () | |
badges_get_oauth2_service_options () | |
Get OAuth2 services for the external backpack. | |
badges_get_site_backpack ($id, int $userid=0) | |
Get a site backpacks by id for a particular user or site (if userid is 0) | |
badges_get_site_backpacks () | |
List the backpacks at site level. | |
badges_get_site_primary_backpack () | |
Get the primary backpack for the site. | |
badges_get_user_backpack (?int $userid=0) | |
Get the user backpack for the currently logged in user OR the provided user. | |
badges_get_user_badges ($userid, $courseid=0, $page=0, $perpage=0, $search='', $onlypublic=false) | |
Get badges for a specific user. | |
badges_handle_course_deletion ($courseid) | |
Handles what happens to the course badges when a course is deleted. | |
badges_list_criteria ($enabled=true) | |
Return all the enabled criteria types for this site. | |
badges_local_backpack_js ($checksite=false) | |
No js files are required for backpack support. | |
badges_notify_badge_award (badge $badge, $userid, $issued, $filepathhash) | |
Sends notifications to users about awarded badges. | |
badges_open_badges_backpack_api (?int $backpackid=null) | |
Is any backpack enabled that supports open badges V1? | |
badges_process_badge_image (badge $badge, $iconfile) | |
Process badge image from form data. | |
badges_save_backpack_credentials (stdClass $data) | |
Create a backpack with the provided details. | |
badges_save_external_backpack (stdClass $data) | |
Perform the actual create/update of external bakpacks. | |
badges_send_verification_email ($email, $backpackid, $backpackpassword) | |
Create and send a verification email to the email address supplied. | |
badges_setup_backpack_js () | |
Loads JS files required for backpack support. | |
badges_update_site_backpack ($id, $data) | |
Update the backpack with this id. | |
badges_user_has_backpack ($userid) | |
Checks if user has external backpack connected. | |
badges_verify_backpack (int $backpackid) | |
Attempt to authenticate with a backpack credentials and return an error if the authentication fails. | |
badges_verify_site_backpack () | |
Attempt to authenticate with the site backpack credentials and return an error if the authentication fails. | |
behat_check_config_vars () | |
Checks that the behat config vars are properly set. | |
behat_clean_init_config () | |
Restrict the config.php settings allowed. | |
behat_error ($errorcode, $text='') | |
Exits with an error code. | |
behat_error_handler ($errno, $errstr, $errfile, $errline) | |
PHP errors handler to use when running behat tests. | |
behat_get_command_flags (string $option, $value) | |
Get command flags for an option/value combination. | |
behat_get_error_string ($errtype) | |
Return logical error string. | |
behat_get_run_process () | |
Get behat run process from either $_SERVER or command config. | |
behat_get_shutdown_process_errors () | |
Return php errors save which were save during shutdown. | |
behat_is_requested_url ($url) | |
Checks if the URL requested by the user matches the provided argument. | |
behat_is_test_site () | |
Should we switch to the test site data? | |
behat_shutdown_function () | |
Before shutdown save last error entries, so we can fail the test. | |
behat_update_vars_for_process () | |
Fix variables for parallel behat testing. | |
block_add_block_ui ($page, $output) | |
Functions update the blocks if required by the request parameters ==========. | |
block_instance ($blockname, $instance=NULL, $page=NULL) | |
Creates a new instance of the specified block class. | |
block_instance_by_id ($blockinstanceid) | |
Returns a new instance of the specified block instance id. | |
block_load_class ($blockname) | |
Load the block class for a particular type of block. | |
block_method_result ($blockname, $method, $param=NULL) | |
Helper functions for working with block classes ============================. | |
blocks_add_default_course_blocks ($course) | |
Add the default blocks to a course. | |
blocks_add_default_system_blocks () | |
Add the default system-context blocks. | |
blocks_delete_all_for_context ($contextid) | |
Delete all the blocks that belong to a particular context. | |
blocks_delete_instance ($instance, $nolongerused=false, $skipblockstables=false) | |
Delete a block, and associated data. | |
blocks_delete_instances ($instanceids) | |
Delete multiple blocks at once. | |
blocks_find_block ($blockid, $blocksarray) | |
Find a given block by its blockid within a provide array. | |
blocks_get_default_site_course_blocks () | |
blocks_get_record ($blockid=NULL, $notusedanymore=false) | |
Get the block record for a particular blockid - that is, a particular type os block. | |
blocks_name_allowed_in_format ($name, $pageformat) | |
Check that a given name is in a permittable format. | |
blocks_parse_default_blocks_list ($blocksstr) | |
Parse a list of default blocks. | |
blocks_remove_inappropriate ($course) | |
Actually delete from the database any blocks that are currently on this page, but which should not be there according to blocks_name_allowed_in_format. | |
blocks_set_visibility ($instance, $page, $newvisibility) | |
Set a block to be visible or hidden on a particular page. | |
blog_get_context_url () | |
bounded_number ($min, $value, $max) | |
Used to make sure that $min <= $value <= $max. | |
break_up_long_words ($string, $maxsize=20, $cutchar=' ') | |
Given some normal text this function will break up any long words to a given size by inserting the given character. | |
build_context_path () | |
build_logs_array () | |
build_navigation () | |
calculate_user_dst_table () | |
calendar_cron () | |
calendar_get_all_allowed_types () | |
calendar_get_block_upcoming () | |
calendar_get_mini () | |
calendar_get_upcoming () | |
calendar_import_icalendar_events ($ical, $unused=null, $subscriptionid=null) | |
Import events from an iCalendar object into a course calendar. | |
calendar_normalize_tz () | |
calendar_preferences_button () | |
calendar_print_month_selector () | |
calendar_process_subscription_row ($subscriptionid, $pollinterval, $action) | |
Update a subscription from the form data in one of the rows in the existing subscriptions table. | |
calendar_wday_name () | |
can_send_from_real_email_address ($from, $user, $unused=null) | |
Check to see if a user's real email address should be used for the "From" field. | |
can_use_html_editor () | |
can_use_readonly (int $type, string $sql) | |
Check if The query qualifies for readonly connection execution Logging queries are exempt, those are write operations that circumvent standard query_start/query_end paths. | |
can_use_rotated_text () | |
category_delete_full () | |
category_delete_move () | |
check_admin_dir_usage (environment_results $result) | |
Check whether the admin directory has been configured and warn if so. | |
check_browser_operating_system () | |
check_browser_version () | |
check_consecutive_identical_characters ($password, $maxchars) | |
Check whether the given password has no more than the specified number of consecutive identical characters. | |
check_database_storage_engine (environment_results $result) | |
This function verifies that the database is not using an unsupported storage engine. | |
check_database_tables_row_format (environment_results $result) | |
This function verifies if the database has tables using innoDB Antelope row format. | |
check_db_prefix_length (environment_results $result) | |
This function checks that the database prefix ($CFG->prefix) is <= 10. | |
check_dir_exists ($dir, $create=true, $recursive=true) | |
Function to check if a directory exists and by default create it if not exists. | |
check_gd_version () | |
check_igbinary322_version (environment_results $result) | |
Check if the igbinary extension installed is buggy one. | |
check_is_https (environment_results $result) | |
Check if the site is being served using an ssl url. | |
check_libcurl_version (environment_results $result) | |
Check if recommended version of libcurl is installed or not. | |
check_max_input_vars (environment_results $result) | |
Environment check for the php setting max_input_vars. | |
check_mod_assignment (environment_results $result) | |
Check whether the mod_assignment is currently being used. | |
check_moodle_environment ($version, $env_select=ENV_SELECT_NEWER) | |
This function checks all the requirements defined in environment.xml. | |
check_mysql_file_format (environment_results $result) | |
This function verfies that the database has tables using InnoDB Antelope row format. | |
check_mysql_file_per_table (environment_results $result) | |
This function verfies that the database has a setting of one file per table. | |
check_mysql_incomplete_unicode_support (environment_results $result) | |
This function checks the database to see if it is using incomplete unicode support. | |
check_mysql_large_prefix (environment_results $result) | |
This function verfies that the database has the setting of large prefix enabled. | |
check_oracle_usage (environment_results $result) | |
Check whether the Oracle database is currently being used and warn if so. | |
check_password_policy ($password, &$errmsg, $user=null) | |
Validate a password against the configured password policy. | |
check_php_version ($version='5.2.4') | |
Returns true if the current version of PHP is greater that the specified one. | |
check_sixtyfour_bits (environment_results $result) | |
Check if the site is using 64 bits PHP. | |
check_slasharguments (environment_results $result) | |
Method used to check the usage of slasharguments config and display a warning message. | |
check_tls_libraries (environment_results $result) | |
Checks for up-to-date TLS libraries. | |
check_unoconv_version (environment_results $result) | |
Method used to check the installed unoconv version. | |
check_upgrade_key ($upgradekeyhash) | |
Assert the upgrade key is provided, if it is defined. | |
check_user_preferences_loaded (stdClass $user, $cachelifetime=120) | |
Refresh user preference cache. | |
check_xmlrpc_usage (environment_results $result) | |
Check whether the XML-RPC protocol is enabled and warn if so. | |
choose_from_menu () | |
clam_change_log () | |
clam_handle_infected_file () | |
clam_log_infected () | |
clam_log_upload () | |
clam_message_admins () | |
clam_replace_infected_file () | |
clam_scan_moodle_file () | |
clean_filename ($string) | |
Cleans a given filename by removing suspicious or troublesome characters. | |
clean_param ($param, $type) | |
Used by optional_param() and required_param() to clean the variables and/or cast to specific types, based on an options field. | |
clean_param_array (?array $param, $type, $recursive=false) | |
Makes sure array contains only the allowed types, this function does not validate array key names! | |
clean_text ($text, $format=FORMAT_HTML, $options=array()) | |
Cleans raw text removing nasties. | |
cleanremoteaddr ($addr, $compress=false) | |
Cleans an ip address. | |
cleanup_contexts () | |
cleardoubleslashes ($path) | |
Replace 1 or more slashes or backslashes to 1 slash. | |
cli_error ($text, $errorcode=1) | |
Write to standard error output and exit with the given code. | |
cli_execute_parallel ($cmds, $cwd=null, $delay=0) | |
Execute commands in parallel. | |
cli_get_params (array $longoptions, array $shortmapping=null) | |
Returns cli script parameters. | |
cli_heading ($string, $return=false) | |
Print or return section heading string. | |
cli_input ($prompt, $default='', array $options=null, $casesensitiveoptions=false) | |
Get input from user. | |
cli_logo ($padding=2, $return=false) | |
Print an ASCII version of the Moodle logo. | |
cli_problem ($text) | |
Write error notification. | |
cli_separator ($return=false) | |
Print or return section separator string. | |
cli_set_process_title_suffix (string $suffix) | |
This sets the cli process title suffix. | |
cli_write ($text, $stream=STDOUT) | |
Write a text to the given stream. | |
cli_writeln ($text, $stream=STDOUT) | |
Write a text followed by an end of line symbol to the given stream. | |
close_window ($delay=0, $reloadopener=false) | |
Try and close the current window using JavaScript, either immediately, or after a delay. | |
cohort_get_visible_list () | |
commit_delegated_transaction (moodle_transaction $transaction) | |
Indicates delegated transaction finished successfully. | |
complete_user_login ($user, array $extrauserinfo=[]) | |
Call to complete the user login process after authenticate_user_login() has succeeded. | |
completion_cron () | |
complex_random_string ($length=null) | |
Generate a complex random string (useful for md5 salts) | |
component_callback ($component, $function, array $params=array(), $default=null) | |
Invoke component's callback functions. | |
component_callback_exists ($component, $function) | |
Determine if a component callback exists and return the function name to call. | |
component_class_callback ($classname, $methodname, array $params, $default=null) | |
Call the specified callback method on the provided class. | |
confirm_sesskey ($sesskey=NULL) | |
Check the sesskey and return true of false for whether it is valid. | |
connect ($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) | |
Connect to db The connection parameters processor that sets up stage for master write and slave readonly handles. | |
content_to_text ($content, $contentformat) | |
Converts texts or strings to plain text. | |
context_instance_preload () | |
context_instance_preload_sql () | |
context_moved () | |
convert_tabrows_to_tree () | |
convert_to_array ($var) | |
Converts an object into an associative array. | |
convert_tree_to_html () | |
core_login_extend_change_password_form ($mform, $user) | |
Plugins can extend forms. | |
core_login_extend_forgot_password_form ($mform) | |
Inject form elements into forgot_password_form. | |
core_login_extend_set_password_form ($mform, $user) | |
Inject form elements into set_password_form. | |
core_login_extend_signup_form ($mform) | |
Inject form elements into signup_form. | |
core_login_generate_password_reset ($user) | |
Create a new record in the database to track a new password set request for user. | |
core_login_get_return_url () | |
Determine where a user should be redirected after they have been logged in. | |
core_login_post_change_password_requests ($data) | |
Plugins can perform post submission actions. | |
core_login_post_forgot_password_requests ($data) | |
Post forgot_password_form submission actions. | |
core_login_post_set_password_requests ($data, $user) | |
Post set_password_form submission actions. | |
core_login_post_signup_requests ($data) | |
Post signup_form submission actions. | |
core_login_pre_signup_requests () | |
Plugins can create pre sign up requests. | |
core_login_process_password_reset ($username, $email) | |
Process the password reset for the given user (via username or email). | |
core_login_process_password_reset_request () | |
Processes a user's request to set a new password in the event they forgot the old one. | |
core_login_process_password_set ($token) | |
This function processes a user's submitted token to validate the request to set a new password. | |
core_login_validate_extend_change_password_form ($data, $user) | |
Plugins can add additional validation to forms. | |
core_login_validate_extend_forgot_password_form ($data) | |
Inject validation into forgot_password_form. | |
core_login_validate_extend_set_password_form ($data, $user) | |
Inject validation into set_password_form. | |
core_login_validate_extend_signup_form ($data) | |
Inject validation into signup_form. | |
core_login_validate_forgot_password_data ($data) | |
Validates the forgot password form data. | |
core_myprofile_navigation (core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) | |
Defines core nodes for my profile navigation tree. | |
core_question_find_next_unused_idnumber (?string $oldidnumber, int $categoryid) | |
If $oldidnumber ends in some digits then return the next available idnumber of the same form. | |
core_question_question_preview_pluginfile ($previewcontext, $questionid, $filecontext, $filecomponent, $filearea, $args, $forcedownload, $options=[]) | |
Serve questiontext files in the question text when they are displayed in this report. | |
core_tables_exist () | |
Checks if the main tables have been installed yet or not. | |
count_enrolled_users (context $context, $withcapability='', $groupids=0, $onlyactive=false) | |
Counts list of users enrolled into course (as per above function) | |
count_letters ($string, $format=null) | |
Count letters in a string. | |
count_login_failures () | |
count_words ($string, $format=null) | |
Count words in a string. | |
course_category_hide () | |
course_category_show () | |
course_get_cm_rename_action () | |
course_scale_used () | |
coursemodule_visible_for_user () | |
coursetag_delete_course_tags () | |
coursetag_delete_keyword () | |
coursetag_get_all_tags () | |
coursetag_get_jscript () | |
coursetag_get_jscript_links () | |
coursetag_get_records () | |
coursetag_get_tagged_courses () | |
coursetag_get_tags () | |
coursetag_store_keywords () | |
create_contexts () | |
create_course_category () | |
create_user_key ($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) | |
Creates a new private user access key. | |
create_user_record ($username, $password, $auth='manual') | |
Creates a bare-bones user record. | |
cron_bc_hack_plugin_functions ($plugintype, $plugins) | |
Used to add in old-style cron functions within plugins that have not been converted to the new standard API. | |
cron_execute_plugin_type ($plugintype, $description=null) | |
Executes cron functions for a specific type of plugin. | |
cron_prepare_core_renderer ($restore=false) | |
Prepare the output renderer for the cron run. | |
cron_run (?int $keepalive=null) | |
Execute cron tasks. | |
cron_run_adhoc_tasks (int $timenow, $keepalive=0, $checklimits=true) | |
Execute all queued adhoc tasks, applying necessary concurrency limits and time limits. | |
cron_run_inner_adhoc_task (\core\task\adhoc_task $task) | |
Shared code that handles running of a single adhoc task within the cron. | |
cron_run_inner_scheduled_task (\core\task\task_base $task) | |
Shared code that handles running of a single scheduled task within the cron. | |
cron_run_scheduled_tasks (int $timenow) | |
Execute all queued scheduled tasks, applying necessary concurrency limits and time limits. | |
cron_run_single_task () | |
cron_set_process_title (string $title) | |
Sets the process title. | |
cron_setup_user ($user=null, $course=null, $leavepagealone=false) | |
Sets up current user and course environment (lang, etc.) in cron. | |
cron_trace_time_and_memory () | |
Output some standard information during cron runs. | |
css_is_colour () | |
css_is_width () | |
css_minify_css () | |
css_send_cached_css ($csspath, $etag) | |
Sends a cached CSS file. | |
css_send_cached_css_content ($csscontent, $etag) | |
Sends a cached CSS content. | |
css_send_css_not_found () | |
Sends a 404 message about CSS not being found. | |
css_send_temporary_css ($css) | |
Sends CSS directly and disables all caching. | |
css_send_uncached_css ($css) | |
Sends CSS directly without caching it. | |
css_send_unmodified ($lastmodified, $etag) | |
Send file not modified headers. | |
css_sort_by_count () | |
if(!defined( 'THEME_DESIGNER_CACHE_LIFETIME')) | css_store_css (theme_config $theme, $csspath, $csscontent) |
Stores CSS in a file at the given path. | |
css_write_file ($filename, $content) | |
Writes a CSS file. | |
current_language () | |
Returns the code for the current language. | |
current_theme () | |
custom_script_path () | |
Detect a custom script replacement in the data directory that will replace an existing moodle script. | |
data_submitted () | |
Determine if there is data waiting to be processed from a form. | |
date_format_string ($date, $format, $tz=99) | |
Returns a formatted date ensuring it is UTF-8. | |
dayofweek ($day, $month, $year) | |
Calculate the position in the week of a specific calendar day. | |
days_in_month ($month, $year) | |
Calculate the number of days in a given month. | |
db_replace ($search, $replace, $additionalskiptables='') | |
Moved from admin/replace.php so that we can use this in cron. | |
db_should_replace ($table, $column='', $additionalskiptables='') | |
Given a table and optionally a column name should replaces be done? | |
debugging ($message='', $level=DEBUG_NORMAL, $backtrace=null) | |
Standard Debugging Function. | |
decompose_update_into_safe_changes (array $newvalues, $unusedvalue) | |
Helper used by update_field_with_unique_index(). | |
dedupe_user_access () | |
default_error_handler ($errno, $errstr, $errfile, $errline) | |
Default error handler, prevents some white screens. | |
default_exception_handler ($ex) | |
Default exception handler. | |
default_page_type_list ($pagetype, $parentcontext=null, $currentcontext=null) | |
Generates a default page type list when a more appropriate callback cannot be decided upon. | |
delete_context () | |
delete_course ($courseorid, $showfeedback=true) | |
Delete a course, including all related data from the database, and any associated files. | |
delete_course_module () | |
delete_event () | |
delete_question_bank_entry ($entryid) | |
Check if there is more versions left for the entry. | |
delete_user (stdClass $user) | |
Marks user deleted in internal user database and notifies the auth plugin. | |
delete_user_key ($script, $userid) | |
Delete the user's new private user access keys for a particular script. | |
detect_munged_arguments () | |
display_auth_lock_options ($settings, $auth, $userfields, $helptext, $mapremotefields, $updateremotefields, $customfields=array()) | |
Helper function used to print locking for auth plugins on admin pages. | |
display_size ($size, int $decimalplaces=1, string $fixedunits='') | |
Converts bytes into display form. | |
dndupload_add_to_course ($course, $modnames) | |
Add the Javascript to enable drag and drop upload to a course page. | |
download_as_dataformat ($filename, $dataformat, $columns, $iterator, $callback=null) | |
Sends a formated data file to the browser. | |
draw_rand_array ($array, $draws) | |
Given an arbitrary array, and a number of draws, this function returns an array with that amount of items. | |
drop_plugin_tables ($name, $file, $feedback=true) | |
Delete all plugin tables. | |
dst_changes_for_year () | |
dst_offset_on ($time, $strtimezone=null) | |
Calculates the Daylight Saving Offset for a given date/time (timestamp) | |
during_initial_install () | |
Indicates whether we are in the middle of the initial Moodle install. | |
editors_get_available () | |
Get the list of available editors. | |
editors_get_enabled () | |
Returns list of enabled text editors. | |
editors_get_preferred_editor ($format=NULL) | |
Returns users preferred editor for given format. | |
editors_get_preferred_format () | |
Returns users preferred text format. | |
editors_head_setup () | |
Setup all JS and CSS needed for editors. | |
email_is_not_allowed ($email) | |
Check that an email is allowed. | |
email_should_be_diverted ($email) | |
A helper function to test for email diversion. | |
email_to_user ($user, $from, $subject, $messagetext, $messagehtml='', $attachment='', $attachname='', $usetrueaddress=true, $replyto='', $replytoname='', $wordwrapwidth=79) | |
Send an email to a specified user. | |
enable_cli_maintenance_mode () | |
Enables CLI maintenance mode by creating new dataroot/climaintenance.html file. | |
endecrypt ($pwd, $data, $case) | |
Based on a class by Mukul Sabharwal [mukulsabharwal @ yahoo.com]. | |
enrol_accessing_via_instance (stdClass $instance) | |
Is current user accessing course via this enrolment method? | |
enrol_add_course_navigation (navigation_node $coursenode, $course) | |
Add navigation nodes. | |
enrol_calculate_duration ($timestart, $timeend) | |
Calculate duration base on start time and end time. | |
enrol_check_plugins ($user, bool $ignoreintervalcheck=true) | |
Check all the login enrolment information for the given user object by querying the enrolment plugins This function may be very slow, use only once after log-in or login-as. | |
enrol_cohort_can_view_cohort () | |
enrol_cohort_enrol_all_users () | |
enrol_cohort_get_cohorts () | |
enrol_cohort_search_cohorts () | |
enrol_course_delete ($course, $userid=null) | |
Called when course is about to be deleted. | |
enrol_course_edit_form (MoodleQuickForm $mform, $data, $context) | |
This function adds necessary enrol plugins UI into the course edit form. | |
enrol_course_edit_validation (array $data, $context) | |
Validate course edit form data. | |
enrol_course_updated ($inserted, $course, $data) | |
Update enrol instances after course edit form submission. | |
enrol_get_all_users_courses ($userid, $onlyactive=false, $fields=null, $sort=null) | |
Returns list of courses user is enrolled into without performing any capability checks. | |
enrol_get_course_by_user_enrolment_id ($ueid) | |
Returns the course where a user enrolment belong to. | |
enrol_get_course_description_texts ($course) | |
Returns course enrolment detailed information. | |
enrol_get_course_info_icons ($course, array $instances=NULL) | |
Returns course enrolment information icons. | |
enrol_get_course_users ($courseid=false, $onlyactive=false, $usersfilter=[], $uefilter=[], $usergroups=[]) | |
Return all users enrolled in a course. | |
enrol_get_course_users_roles (int $courseid) | |
Returns list of roles per users into course. | |
enrol_get_courses_sortingsql ($sort=null) | |
Returns SQL ORDER arguments which reflect the admin settings to sort my courses. | |
enrol_get_enrolment_end ($courseid, $userid) | |
This function returns the end of current active user enrolment. | |
enrol_get_instances ($courseid, $enabled) | |
Returns enrolment instances in given course. | |
enrol_get_my_courses ($fields=null, $sort=null, $limit=0, $courseids=[], $allaccessible=false, $offset=0, $excludecourses=[]) | |
Returns list of courses current $USER is enrolled in and can access. | |
enrol_get_period_list () | |
Get the list of options for the enrolment period dropdown. | |
enrol_get_plugin ($name) | |
Returns instance of enrol plugin. | |
enrol_get_plugins ($enabled) | |
Returns instances of enrol plugins. | |
moodle_database | enrol_get_shared_courses ($user1, $user2, $preloadcontexts=false, $checkexistsonly=false) |
Returns any courses shared by the two users. | |
enrol_get_users_courses ($userid, $onlyactive=false, $fields=null, $sort=null) | |
Returns list of courses user is enrolled into. | |
enrol_is_enabled ($enrol) | |
Checks if a given plugin is in the list of enabled enrolment plugins. | |
enrol_output_fragment_user_enrolment_form ($args) | |
Serve the user enrolment form as a fragment. | |
enrol_selfenrol_available ($courseid) | |
Is there a chance users might self enrol. | |
enrol_send_welcome_email_options () | |
Send welcome email "from" options. | |
enrol_sharing_course ($user1, $user2) | |
Do these two students share any course? | |
enrol_try_internal_enrol ($courseid, $userid, $roleid=null, $timestart=0, $timeend=0) | |
Try to enrol user via default internal auth plugin. | |
enrol_user_delete ($user) | |
Called when user is about to be deleted. | |
enrol_user_sees_own_courses ($user=null) | |
Can user access at least one enrolled course? | |
object | environment_check ($version, $env_select) |
This function will check for everything (DB, PHP and PHP extensions for now) returning an array of environment_result objects. | |
environment_check_database ($version, $env_select) | |
This function will check if database requirements are satisfied. | |
environment_check_moodle ($version, $env_select) | |
This function will check if Moodle requirements are satisfied. | |
environment_check_pcre_unicode ($version, $env_select) | |
Looks for buggy PCRE implementation, we need unicode support in Moodle... | |
environment_check_php ($version, $env_select) | |
This function will check if php requirements are satisfied. | |
environment_check_php_extensions ($version, $env_select) | |
This function will check if php extensions requirements are satisfied. | |
environment_check_php_settings ($version, $env_select) | |
This function will check if php extensions requirements are satisfied. | |
environment_check_unicode ($version, $env_select) | |
This function will check if unicode database requirements are satisfied. | |
environment_custom_checks ($version, $env_select) | |
This function will do the custom checks. | |
environment_get_errors ($environment_results) | |
Returns array of critical errors in plain text format. | |
environment_verify_plugin ($plugin, $pluginxml) | |
Checks if a plugin tag has a name attribute and it matches the plugin being tested. | |
error () | |
events_cleanup () | |
events_cron () | |
events_dequeue () | |
events_dispatch () | |
events_get_cached () | |
events_get_handlers () | |
events_is_registered () | |
events_load_def () | |
events_pending_count () | |
events_process_queued_handler () | |
events_queue_handler () | |
events_trigger () | |
events_trigger_legacy () | |
events_uninstall () | |
events_update_definition () | |
exists_auth_plugin ($auth) | |
Returns whether a given authentication plugin exists. | |
external_function_info () | |
external_update_descriptions ($component) | |
Web service discovery function used during install and upgrade. | |
external_update_services () | |
Allow plugins and subsystems to add external functions to other plugins or built-in services. | |
extract_draft_file_urls_from_text ($text, $forcehttps=false, $contextid=null, $component=null, $filearea=null, $itemid=null, $filename=null) | |
Factory method for extracting draft file links from arbitrary text using regular expressions. | |
fetch_context_capabilities () | |
static | fill_classmap_renames_cache () |
Records all class renames that have been made to facilitate autoloading. | |
moodle_text_filter::filter ($text, array $options=array()) | |
Override this function to actually implement the filtering. | |
moodle_text_filter::filter_stage_post_clean (string $text, array $options) | |
Filter HTML text at the very end after text is sanitised. | |
moodle_text_filter::filter_stage_pre_clean (string $text, array $options) | |
Filter HTML text before sanitising text. | |
moodle_text_filter::filter_stage_pre_format (string $text, array $options) | |
Filter text before changing format to HTML. | |
moodle_text_filter::filter_stage_string (string $text, array $options) | |
Filter simple text coming from format_string(). | |
filter_manager::filter_string ($string, $context) | |
Filter a piece of string. | |
null_filter_manager::filter_string ($string, $context) | |
As for the equivalent filter_manager method. | |
performance_measuring_filter_manager::filter_string ($string, $context) | |
Filter a piece of string. | |
filter_manager::filter_text ($text, $context, array $options=array(), array $skipfilters=null) | |
Filter some text. | |
filter_text () | |
null_filter_manager::filter_text ($text, $context, array $options=array(), array $skipfilters=null) | |
As for the equivalent filter_manager method. | |
performance_measuring_filter_manager::filter_text ($text, $context, array $options=array(), array $skipfilters=null) | |
Filter some text. | |
find_day_in_month ($startday, $weekday, $month, $year) | |
Calculates when the day appears in specific month. | |
fix_align_rtl ($align) | |
Returns swapped left<=> right if in RTL environment. | |
object | fix_course_sortorder () |
Fixes course category and course sortorder, also verifies category and course parents and paths. | |
fix_current_language (string $lang) | |
Fix the current language to the given language code. | |
fix_utf8 ($value) | |
Makes sure the data is using valid utf8, invalid characters are discarded. | |
flatten_category_tree (&$categories, $id, $depth=0, $nochildrenof=-1) | |
Private method, only for the use of add_indented_names(). | |
force_current_language ($language) | |
Force the current language to get strings and dates localised in the given language. | |
format_admin_setting ($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') | |
Format admin settings. | |
format_backtrace ($callers, $plaintext=false) | |
Formats a backtrace ready for output. | |
format_float ($float, $decimalpoints=1, $localized=true, $stripzeros=false) | |
Given a float, prints it nicely. | |
format_module_intro ($module, $activity, $cmid, $filter=true) | |
Formats activity intro text. | |
format_string ($string, $striplinks=true, $options=null) | |
Given a simple string, this function returns the string processed by enabled string filters if $CFG->filterall is enabled. | |
format_text ($text, $format=FORMAT_MOODLE, $options=null, $courseiddonotuse=null) | |
Given text in a variety of format codings, this function returns the text as safe HTML. | |
format_text_email ($text, $format) | |
Given text in a variety of format codings, this function returns the text as plain text suitable for plain email. | |
format_text_menu () | |
Just returns an array of text formats suitable for a popup menu. | |
format_time ($totalsecs, $str=null) | |
Format a date/time (seconds) as weeks, days, hours etc as needed. | |
format_weeks_get_section_dates () | |
formerr () | |
fullclone ($thing) | |
This function will make a complete copy of anything it's given, regardless of whether it's an object or not. | |
fullname ($user, $override=false) | |
Returns a persons full name. | |
gc_cache_flags () | |
Garbage-collect volatile flags. | |
generate_email_messageid ($localpart=null) | |
Generate a unique email Message-ID using the moodle domain and install path. | |
generate_email_processing_address ($modid, $modargs) | |
Generate an email processing address. | |
generate_email_signoff () | |
Generate a signoff for emails based on support settings. | |
generate_email_supportuser () | |
generate_image_thumbnail ($filepath, $width, $height) | |
Generates a thumbnail for the given image. | |
generate_image_thumbnail_from_image ($original, $imageinfo, $width, $height) | |
Generates a thumbnail for the given image string. | |
generate_image_thumbnail_from_string ($filedata, $width, $height) | |
Generates a thumbnail for the given image string. | |
generate_page_type_patterns ($pagetype, $parentcontext=null, $currentcontext=null) | |
Given a specific page type, parent context and currect context, return all the page type patterns that might be used by this block. | |
generate_password ($maxlen=10) | |
Returns a randomly generated password of length $maxlen. | |
generate_uuid () | |
get_accesshide ($text, $elem='span', $class='', $attrs='') | |
Return a HTML element with the class "accesshide", for accessibility. | |
if(!defined( 'LASTACCESS_UPDATE_SECS')) | get_admin () |
Number of seconds to wait before updating lastaccess information in DB. | |
get_admins () | |
Returns list of all admins, using 1 DB query. | |
static | get_all_component_hash (?array $components=null) |
Returns hash of all core + plugin /db/ directories. | |
static | get_all_directory_hashes (?array $directories=null) |
Get the hashes of all core + plugin /db/ directories. | |
get_all_instances_in_course ($modulename, $course, $userid=NULL, $includeinvisible=false) | |
Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined. | |
object | get_all_instances_in_courses ($modulename, $courses, $userid=NULL, $includeinvisible=false) |
Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined. | |
get_all_mods () | |
get_all_sections () | |
get_all_subcategories () | |
get_all_user_name_fields ($returnsql=false, $tableprefix=null, $prefix=null, $fieldprefix=null, $order=false) | |
A centralised location for the all name fields. | |
static | get_all_versions () |
Returns hash of all versions including core and all plugins. | |
static | get_all_versions_hash () |
Returns hash of all versions including core and all plugins. | |
get_array_of_activities (int $courseid, bool $usecache=false) | |
For a given course, returns an array of course activity objects Each item in the array contains he following properties: | |
get_auth_plugin ($auth) | |
Returns an authentication plugin instance. | |
get_backpack_settings ($userid, $refresh=false) | |
Returns external backpack settings and badges from this backpack. | |
get_backup_temp_directory ($directory) | |
Get the full path of a directory under $CFG->backuptempdir. | |
get_browser_version_classes () | |
get_cache_flag ($type, $name, $changedsince=null) | |
Get volatile flags. | |
get_cache_flags ($type, $changedsince=null) | |
Get volatile flags. | |
get_callable_name ($callable) | |
Get human readable name describing the given callable. | |
get_categories () | |
get_categories_for_contexts ($contexts, $sortorder='parent, sortorder, name ASC', $top=false) | |
Get all the category objects, including a count of the number of questions in that category, for all the categories in the lists $contexts. | |
get_category_courses_array () | |
get_category_courses_array_recursively () | |
get_child_categories () | |
get_child_contexts () | |
get_clam_error_code () | |
get_complete_user_data ($field, $value, $mnethostid=null, $throwexception=false) | |
Get a complete user record, which includes all the info in the user record. | |
static | get_component_classes_in_namespace ($component=null, $namespace='') |
Returns all classes in a component matching the provided namespace. | |
static | get_component_directory ($component) |
Return exact absolute path to a plugin directory. | |
static | get_component_list () |
Returns a list of frankenstyle component names and their paths, for all components (plugins and subsystems). | |
static | get_component_names () |
Returns a list of frankenstyle component names. | |
get_component_version ($component, $source='installed') | |
Returns the version of installed component. | |
get_config ($plugin, $name=null) | |
Get configuration values from the global config table or the config_plugins table. | |
get_context_instance ($contextlevel, $instance=0, $strictness=IGNORE_MISSING) | |
Get the context instance as an object. | |
get_context_instance_by_id () | |
get_context_url () | |
get_contextlevel_name () | |
static | get_core_api_names () |
Returns the list of available API names. | |
static | get_core_apis () |
List all core APIs and their attributes. | |
get_core_subsystems ($fullpaths=false) | |
List all core subsystems and their location. | |
static | get_core_subsystems () |
List all core subsystems and their location. | |
get_course ($courseid, $clone=true) | |
Gets a course object from database. | |
get_course_and_cm_from_cmid ($cmorid, $modulename='', $courseorid=0, $userid=0) | |
Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given a cmid. | |
get_course_and_cm_from_instance ($instanceorid, $modulename, $courseorid=0, $userid=0) | |
Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given an instance id or record and module name. | |
get_course_category () | |
get_course_category_tree () | |
get_course_context () | |
get_course_display_name_for_list ($course) | |
Gets the name of a course to be displayed when showing a list of courses. | |
object | get_course_mods ($courseid) |
MODULE FUNCTIONS /////////////////////////////////////////////////. | |
get_course_participants () | |
get_course_section () | |
get_courseid_from_context () | |
object | get_coursemodule_from_id ($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) |
Given an id of a course module, finds the coursemodule description. | |
object | get_coursemodule_from_instance ($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) |
Given an instance number of a module, finds the coursemodule description. | |
get_coursemodules_in_course ($modulename, $courseid, $extrafields='') | |
Returns all course modules of given activity in course. | |
core_course_category::get_courses ($options=array()) | |
Retrieves the list of courses accessible by user. | |
object | get_courses ($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") |
Returns list of courses, for whole site, or category. | |
get_courses_page () | |
object | get_courses_search ($searchterms, $sort, $page, $recordsperpage, &$totalcount, $requiredcapabilities=array(), $searchcond=[], $params=[]) |
A list of courses that match a search. | |
get_courses_wmanagers () | |
get_current_group () | |
get_db_directories () | |
Returns list of all directories where we expect install.xml files. | |
get_db_handle () | |
Gets db handle currently used with queries. | |
get_default_home_page () | |
Returns the default home page to display if current one is not defined or can't be applied. | |
get_device_cfg_var_name () | |
get_device_type () | |
get_device_type_list () | |
get_directory_list ($rootdir, $excludefiles='', $descend=true, $getdirs=false, $getfiles=true) | |
Returns an array with all the filenames in all subdirectories, relative to the given rootdir. | |
get_directory_size ($rootdir, $excludefile='') | |
Adds up all the files in a directory and works out the size. | |
get_docs_url ($path=null) | |
Returns the Moodle Docs URL in the users language for a given 'More help' link. | |
get_emoticon_manager () | |
Factory function for emoticon_manager. | |
get_enabled_auth_plugins ($fix=false) | |
Returns array of active auth plugins. | |
get_enrolled_join (context $context, $useridcolumn, $onlyactive=false, $onlysuspended=false, $enrolid=0) | |
Returns array with sql joins and parameters returning all ids of users enrolled into course. | |
get_enrolled_sql (context $context, $withcapability='', $groupids=0, $onlyactive=false, $onlysuspended=false, $enrolid=0) | |
Returns array with sql code and parameters returning all ids of users enrolled into course. | |
get_enrolled_users (context $context, $withcapability='', $groupids=0, $userfields='u.*', $orderby=null, $limitfrom=0, $limitnum=0, $onlyactive=false) | |
Returns list of users enrolled into course. | |
get_enrolled_with_capabilities_join (context $context, $prefix='', $capability='', $groupids=0, $onlyactive=false, $onlysuspended=false, $enrolid=0) | |
Returns an array of joins, wheres and params that will limit the group of users to only those enrolled and with given capability (if specified). | |
get_environment_for_version ($version, $env_select) | |
This function will return the xmlized data belonging to one Moodle version. | |
get_exception_info ($ex) | |
Returns detailed information about specified exception. | |
get_extra_user_fields ($context, $already=array()) | |
Checks if current user is shown any extra fields when listing users. | |
get_extra_user_fields_sql ($context, $alias='', $prefix='', $already=array()) | |
If the current user is to be shown extra user fields when listing or selecting users, returns a string suitable for including in an SQL select clause to retrieve those fields. | |
get_fast_modinfo ($courseorid, $userid=0, $resetonly=false) | |
Returns reference to full info about modules in course (including visibility). | |
get_file_argument () | |
Extracts file argument either from file parameter or PATH_INFO. | |
get_file_browser () | |
Returns local file storage instance. | |
get_file_packer ($mimetype='application/zip') | |
Returns file packer. | |
get_file_storage ($reset=false) | |
Returns local file storage instance. | |
get_file_url () | |
get_formatted_help_string ($identifier, $component, $ajax=false, $a=null) | |
Get the value of a help string fully prepared for display in the current language. | |
get_generic_section_name () | |
get_google_client () | |
Wrapper to get a Google Client object. | |
get_group_picture_url ($group, $courseid, $large=false, $includetoken=false) | |
Return the url to the group picture. | |
get_home_page () | |
Gets the homepage to use for the current user. | |
get_host_from_url ($url) | |
Returns host part from url. | |
get_html_lang ($dir=false) | |
Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes. | |
get_html_lang_attribute_value (string $langcode) | |
Converts a language code to hyphen-separated format in accordance to the BCP47 syntax . | |
get_import_export_formats ($type) | |
Get list of available import or export formats. | |
get_last_soap_messages ($connection) | |
get_latest_version_available ($version, $env_select) | |
This function will return the most recent version in the environment.xml file previous or equal to the version requested. | |
get_level ($element) | |
Here all the restrict functions are coded to be used by the environment checker. | |
get_list_of_charsets () | |
Returns a list of charset codes. | |
get_list_of_environment_versions ($contents) | |
This function will return the list of Moodle versions available. | |
get_list_of_plugins ($directory='mod', $exclude='', $basedir='') | |
Lists plugin-like directories within specified directory. | |
get_list_of_themes () | |
Returns a list of valid and compatible themes. | |
get_list_of_timezones () | |
get_local_referer ($stripquery=true) | |
Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required. | |
get_log_manager ($forcereload=false) | |
LOG FUNCTIONS /////////////////////////////////////////////////////. | |
get_login_url () | |
Returns full login url. | |
get_logs () | |
get_logs_usercourse () | |
get_logs_userday () | |
get_mailer ($action='get') | |
Get mailer instance, enable buffering, flush buffer or disable buffering. | |
get_max_courses_in_category () | |
Return maximum number of courses in a category. | |
get_max_upload_file_size ($sitebytes=0, $coursebytes=0, $modulebytes=0, $unused=false) | |
Returns the maximum size for uploading files. | |
get_max_upload_sizes ($sitebytes=0, $coursebytes=0, $modulebytes=0, $custombytes=null) | |
Returns an array of possible sizes in local language. | |
get_mnet_environment () | |
helper function to load up and initialise the mnet environment this must be called before you use mnet functions. | |
get_mnet_remote_client () | |
during xmlrpc server code execution, any code wishing to access information about the remote peer must use this to get it. | |
get_module_metadata () | |
get_moodle_cookie () | |
Gets a moodle cookie with a weakly encrypted username. | |
object | get_my_remotecourses ($userid=0) |
List of remote courses that a user has access to via MNET. | |
object | get_my_remotehosts () |
List of remote hosts that a user has access to via MNET. | |
get_newuser_language () | |
Returns the string of the language for the new user. | |
get_next_version (int $questionbankentryid) | |
Get the next version number to create base on a Question bank entry id. | |
static | core\event::get_other_mapping () |
Used for maping events on restore. | |
get_parent_contextid () | |
get_parent_contexts () | |
get_parent_language ($lang=null) | |
Returns parent language of current active language if defined. | |
get_performance_info () | |
get_performance_info() pairs up with init_performance_info() loaded in setup.php. | |
performance_measuring_filter_manager::get_performance_summary () | |
Return performance information, in the form required by get_performance_info(). | |
static | get_plugin_directory ($plugintype, $pluginname) |
Returns the exact absolute path to plugin directory. | |
static | get_plugin_list ($plugintype) |
Get list of plugins of given type. | |
static | get_plugin_list_with_class ($plugintype, $class, $file=null) |
Get a list of all the plugins of a given type that define a certain class in a certain file. | |
static | get_plugin_list_with_file ($plugintype, $file, $include=false) |
Get a list of all the plugins of a given type that contain a particular file. | |
get_plugin_list_with_file () | |
get_plugin_list_with_function ($plugintype, $function, $file='lib.php') | |
Get a list of all the plugins of a given type that define a certain API function in a certain file. | |
get_plugin_types ($fullpaths=true) | |
Lists all plugin types. | |
static | get_plugin_types () |
Get list of available plugin types together with their location. | |
static | get_plugin_types_with_subplugins () |
Returns list of plugin types that allow subplugins. | |
get_plugins_with_function ($function, $file='lib.php', $include=true) | |
Get a list of all the plugins that define a certain API function in a certain file. | |
get_print_section_cm_text () | |
get_question_bank_entry (int $questionid) | |
Get the question_bank_entry object given a question id. | |
get_question_options (&$questions, $loadtags=false, $filtercourses=null) | |
Updates the question objects with question type specific information by calling {. | |
get_question_version ($questionid) | |
Get the question versions given a question id in a descending sort . | |
get_real_size ($size=0) | |
Converts numbers like 10M into bytes. | |
get_recent_enrolments () | |
get_records_csv () | |
get_referer () | |
get_related_contexts_string () | |
get_request_storage_directory ($exceptiononerror=true, bool $forcecreate=false) | |
Get a per-request storage directory in the tempdir. | |
get_role_context_caps () | |
get_roles_on_exact_context () | |
get_roles_with_assignment_on_context () | |
get_safe_orderby (array $orderbymap, string $orderbykey, string $direction='', bool $useprefix=true) | |
Prepare a safe ORDER BY statement from user interactable requests. | |
get_safe_orderby_multiple (array $orderbymap, array $orderbykeys, array $directions=[]) | |
Prepare a safe ORDER BY statement from user interactable requests using multiple values. | |
object | get_scales_menu ($courseid=0) |
Returns a menu of all available scales from the site as well as the given course. | |
get_selected_theme_for_device_type () | |
get_separator () | |
Return the breadcrumb trail navigation separator. | |
get_site () | |
OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////. | |
get_site_identifier () | |
Returns the site identifier. | |
get_string ($identifier, $component='', $a=null, $lazyload=false) | |
Returns a localized string. | |
filter_manager::get_string_filters ($context) | |
Get all the filters that apply to a given context for calls to format_string. | |
get_string_manager ($forcereload=false) | |
Returns current string_manager instance. | |
get_strings ($array, $component='') | |
Converts an array of strings to their localized value. | |
static | get_subplugins ($component) |
Return all subplugins of this component. | |
static | get_subsystem_directory ($subsystem) |
Returns the exact absolute path to plugin directory. | |
static | get_subtype_parent ($type) |
Returns parent of this subplugin type. | |
get_system_context ($cache=true) | |
Returns system context or null if can not be created yet. | |
filter_manager::get_text_filters ($context) | |
Get all the filters that apply to a given context for calls to format_text. | |
get_texteditor ($editorname) | |
Returns instance of text editor. | |
get_time_interval_string (int $time1, int $time2, string $format='') | |
Get a formatted string representation of an interval between two unix timestamps. | |
get_timezone_offset () | |
get_timezone_record () | |
core\task::get_trace () | |
Get the progress_trace. | |
get_used_table_names () | |
Returns names of all known tables == tables that moodle knows about. | |
get_user_access_sitewide () | |
get_user_courses_bycap () | |
get_user_device_type () | |
get_user_field_name ($field) | |
Returns the display name of a field in the user table. | |
get_user_fieldnames () | |
Returns an array of user fields. | |
get_user_key ($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) | |
Gets a private user access key (and creates one if one doesn't exist). | |
get_user_max_upload_file_size ($context, $sitebytes=0, $coursebytes=0, $modulebytes=0, $user=null, $unused=false) | |
Returns the maximum size for uploading files for the current user. | |
get_user_preferences ($name=null, $default=null, $user=null) | |
Used to fetch user preference(s) | |
get_user_timezone ($tz=99) | |
Returns a float or a string which denotes the user's timezone A float value means that a simple offset from GMT is used, while a string (it will be the name of a timezone in the database) means that for this timezone there are also DST rules to be taken into account Checks various settings and picks the most dominant of those which have a value. | |
get_user_timezone_offset () | |
object | get_users ($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC', $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields=' *', $extraselect='', array $extraparams=null) |
Returns a subset of users. | |
object | get_users_confirmed () |
Full list of users that have confirmed their accounts. | |
get_users_from_config ($value, $capability, $includeadmins=true) | |
Use this function to get a list of users from a config setting of type admin_setting_users_with_capability. | |
get_users_listing ($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0, $search='', $firstinitial='', $lastinitial='', $extraselect='', array $extraparams=null, $extracontext=null) | |
Return filtered (if provided) list of users in site, except guest and deleted users. | |
getremoteaddr ($default='0.0.0.0') | |
Returns most reliable client address. | |
getweek ($startdate, $thedate) | |
Given dates in seconds, how many weeks is the date from startdate The first week is 1, the second 2 etc ... | |
grade_print_tabs ($active_type, $active_plugin, $plugin_info, $return=false) | |
Print grading plugin selection tab-based navigation. | |
groupmode () | |
This means that cm_info\$groupmode should be ignored and cm_info\$coursegroupmode be used instead. | |
groups_course_module_visible () | |
groups_filter_users_by_course_module_visible () | |
groups_get_all_groups_for_courses () | |
guest_user () | |
Retrieve the guest user object. | |
handle_soap_wsdl_request ($wsdlfile, $address=false) | |
static | has_monologo_icon (string $plugintype, string $pluginname) |
Checks for the presence of monologo icons within a plugin. | |
moodle_text_filter::hash () | |
hash_internal_user_password ($password, $fasthash=false) | |
Calculate hash for a plain text password. | |
hash_local_config_cache () | |
Calculate a proper hash to be able to invalidate stale cached configs. | |
hide_event () | |
highlight ($needle, $haystack, $matchcase=false, $prefix='< span class="highlight">', $suffix='</span >') | |
This function will highlight search words in a given string. | |
highlightfast ($needle, $haystack) | |
This function will highlight instances of $needle in $haystack. | |
html_is_blank ($string) | |
Tests whether anything was returned by text editor. | |
html_to_text ($html, $width=75, $dolinks=true) | |
Given HTML text, make it into plain text using external function. | |
httpsrequired () | |
idnumber_exist_in_question_category ($questionidnumber, $categoryid, $limitfrom=0, $limitnum=1) | |
Check if an idnumber exist in the category. | |
imagecopybicubic ($dst_img, $src_img, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) | |
Copies a rectangular portion of the source image to another rectangle in the destination image. | |
in_object_vars ($var, $object) | |
Checks whether the given variable name is defined as a variable within the given object. | |
increment_revision_number ($table, $field, $select, array $params=null) | |
Increment standard revision field. | |
ini_get_bool ($ini_get_arg) | |
This function makes the return value of ini_get consistent if you are setting server directives through the .htaccess file in apache. | |
init_performance_info () | |
Initializes our performance info early. | |
initialise_fullme () | |
Initialises $FULLME and friends. | |
initialise_fullme_cli () | |
Initialises $FULLME and friends for command line scripts. | |
initialise_local_config_cache () | |
Cache any immutable config locally to avoid constant DB lookups. | |
install_cli_database (array $options, $interactive) | |
Install Moodle DB, config.php must exist, there must not be any tables in db yet. | |
install_core ($version, $verbose) | |
Install core moodle tables and initialize. | |
install_db_validate ($database, $dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions) | |
This is in function because we want the /install.php to parse in PHP4. | |
install_generate_configphp ($database, $cfg) | |
Returns content of config.php file. | |
install_guess_wwwroot () | |
Tries to detect the right www root setting. | |
install_helpbutton ($url, $title='') | |
Print help button. | |
install_ini_get_bool ($ini_get_arg) | |
Copy of. | |
install_init_dataroot ($dataroot, $dirpermissions) | |
Creates dataroot if not exists yet, makes sure it is writable, add lang directory and add .htaccess just in case it works. | |
object | install_print_footer ($config, $reload=false) |
Prints installation page header, we can not use weblib yet in installer. | |
object | install_print_header ($config, $stagename, $heading, $stagetext, $stageclass="alert-info") |
Prints installation page header, we can not use weblib yet in installer. | |
object | install_print_help_page ($help) |
Prints complete help page used during installation. | |
static | filter_manager::instance () |
Factory method. | |
object | instance_is_visible ($moduletype, $module) |
Determine whether a module instance is visible within a course. | |
static | invalidate_opcode_php_cache ($file) |
Invalidate opcode cache for given file, this is intended for php files that are stored in dataroot. | |
ip_is_public ($ip) | |
Is IP address a public address? | |
iplookup_find_location ($ip) | |
Returns location information. | |
static | is_core_api ($apiname) |
Return true if apiname is a core API. | |
static | is_core_subsystem ($subsystemname) |
Return true if subsystemname is core subsystem. | |
is_course_participant () | |
is_dataroot_insecure ($fetchtest=false) | |
Try to verify that dataroot is not accessible from web. | |
is_early_init ($backtrace) | |
This function encapsulates the tests for whether an exception was thrown in early init – either during setup.php or during init of $OUTPUT. | |
is_enabled_auth ($auth) | |
Checks if a given plugin is in the list of enabled authentication plugins. | |
is_enrolled (context $context, $user=null, $withcapability='', $onlyactive=false) | |
Returns true if user is enrolled (is participating) in course this is intended for students and teachers. | |
is_float_problem () | |
Detects if float supports at least 10 decimal digits. | |
is_https () | |
Determines whether or not the Moodle site is being served over HTTPS. | |
is_in_popup () | |
Returns true if the page is displayed in a popup window. | |
is_internal_auth ($auth) | |
Returns true if an internal authentication method is being used. | |
is_latest (string $version, string $questionbankentryid) | |
Checks if question is the latest version. | |
is_major_upgrade_required () | |
Check whether a major upgrade is needed. | |
is_mnet_remote_user ($user) | |
Returns whether or not the user object is a remote MNET user. | |
is_moodle_cookie_secure () | |
Determine wether the secure flag should be set on cookies. | |
is_newnav ($navigation) | |
Check if the passed navigation is of the new style. | |
is_number ($value) | |
Return true if given value is integer or string with integer value. | |
is_primary_admin ($userid) | |
Is a userid the primary administrator? | |
is_proxybypass ( $url) | |
Check if $url matches anything in proxybypass list. | |
is_restored_user ($username) | |
Returns true if the user is a 'restored' one. | |
is_rtl_compatible ($paramtype) | |
Whether the PARAM_* type is compatible in RTL. | |
is_valid_plugin_name ($name) | |
This method validates a plug name. | |
static | is_valid_plugin_name ($plugintype, $pluginname) |
This method validates a plug name. | |
is_web_crawler () | |
ismoving ($courseid) | |
Determines if the logged in user is currently moving an activity. | |
js_minify () | |
js_reset_all_caches () | |
Invalidate all server and client side JS caches. | |
ldap_addslashes ($text) | |
Quote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253. | |
ldap_connect_moodle ($host_url, $ldap_version, $user_type, $bind_dn, $bind_pw, $opt_deref, &$debuginfo, $start_tls=false) | |
Tries connect to specified ldap servers. | |
ldap_filter_addslashes ($text) | |
Quote control characters in texts used in LDAP filters - see RFC 4515/2254. | |
ldap_find_userdn ($ldapconnection, $username, $contexts, $objectclass, $search_attrib, $search_sub) | |
Search specified contexts for username and return the user dn like: cn=username,ou=suborg,o=org. | |
if(!defined('LDAP_DN_SPECIAL_CHARS')) if(!defined( 'LDAP_DN_SPECIAL_CHARS_QUOTED_NUM')) if(!defined('LDAP_DN_SPECIAL_CHARS_QUOTED_ALPHA')) if(!defined( 'LDAP_DN_SPECIAL_CHARS_QUOTED_ALPHA_REGEX')) | ldap_get_dn_special_chars () |
The order of the special characters in these arrays IS IMPORTANT. | |
ldap_get_entries_moodle ($ldapconnection, $searchresult) | |
Returns values like ldap_get_entries but is binary compatible and returns all attributes as array. | |
ldap_getdefaults () | |
Initializes needed variables for ldap-module. | |
ldap_isgroupmember ($ldapconnection, $userid, $group_dns, $member_attrib) | |
Checks if user belongs to specific group(s) or is in a subtree. | |
ldap_normalise_objectclass ($objectclass, $default=' *') | |
Normalise the supplied objectclass filter. | |
ldap_paged_results_supported ($ldapversion, $ldapconnection=null) | |
Check if we can use paged results (see RFC 2696). | |
ldap_stripslashes ($text) | |
Unquote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253. | |
if(!defined( 'ROOTDSE')) if(!defined('LDAP_PAGED_RESULTS_CONTROL')) if(!defined( 'LDAP_DEFAULT_PAGESIZE')) | ldap_supported_usertypes () |
Returns predefined user types. | |
link_arrow_left ($text, $url='', $accesshide=false, $addclass='', $addparams=[]) | |
Return the left arrow with text ('previous'), and optionally embedded in a link. | |
link_arrow_right ($text, $url='', $accesshide=false, $addclass='', $addparams=[]) | |
Return the right arrow with text ('next'), and optionally embedded in a link. | |
load_course_context () | |
load_environment_xml ($env_select=ENV_SELECT_NEWER) | |
This function will load the environment.xml file and xmlize it. | |
filter_manager::load_filters ($context) | |
Load all the filters required by this context. | |
static | load_renamed_classes (?string $fulldir) |
Loads the db/renamedclasses.php file from the given directory. | |
load_role_access_by_context () | |
core\task::log ($message, $depth=1) | |
Log a message to the progress tracer. | |
core\task::log_finish ($message, $depth=0) | |
Log an end message to the progress tracer. | |
core\task::log_start ($message, $depth=0) | |
Log a start message to the progress tracer. | |
log_update_descriptions ($component) | |
Log_display description function used during install and upgrade. | |
login_attempt_failed ($user) | |
To be called after failed user login. | |
login_attempt_valid ($user) | |
To be called after valid user login. | |
login_is_lockedout ($user) | |
Verify if user is locked out. | |
login_lock_account ($user) | |
Lockout user and send notification email. | |
login_unlock_account ($user) | |
Unlock user account and reset timers. | |
make_backup_temp_directory ($directory, $exceptiononerror=true) | |
Create a directory under $CFG->backuptempdir and make sure it is writable. | |
make_cache_directory ($directory, $exceptiononerror=true) | |
Create a directory under cachedir and make sure it is writable. | |
make_categories_list () | |
make_categories_options () | |
make_editing_buttons () | |
filter_manager::make_filter_object ($filtername, $context, $localconfig) | |
Factory method for creating a filter. | |
performance_measuring_filter_manager::make_filter_object ($filtername, $context, $localconfig) | |
Factory method for creating a filter. | |
make_grades_menu ($gradingtype) | |
Creates an array that represents all the current grades that can be chosen using the given grading type. | |
make_localcache_directory ($directory, $exceptiononerror=true) | |
Create a directory under localcachedir and make sure it is writable. | |
make_menu_from_list ($list, $separator=',') | |
Given a list (eg a,b,c,d,e) this function returns an array of 1->a, 2->b, 3->c etc. | |
make_request_directory (bool $exceptiononerror=true, bool $forcecreate=false) | |
Create a per-request directory and make sure it is writable. | |
make_soap_fault ($faultcode, $faultstring, $faultactor='', $detail='', $faultname='', $headerfault='') | |
make_temp_directory ($directory, $exceptiononerror=true) | |
Create a directory under tempdir and make sure it is writable. | |
make_timestamp ($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) | |
Given Gregorian date parts in user time produce a GMT timestamp. | |
make_unique_id_code ($extra='') | |
make_unique_id_code | |
make_unique_writable_directory ($basedir, $exceptiononerror=true) | |
Create a new unique directory within the specified directory. | |
make_upload_directory ($directory, $exceptiononerror=true) | |
Create a directory under dataroot and make sure it is writable. | |
mark_context_dirty () | |
markdown_to_html ($text) | |
Given Markdown formatted text, make it into XHTML using external function. | |
match_grade_options ($gradeoptionsfull, $grade, $matchgrades='error') | |
Check whether a given grade is one of a list of allowed options. | |
matching_page_type_patterns ($pagetype) | |
Given a specific page type, return all the page type patterns that might match it. | |
matching_page_type_patterns_from_pattern ($pattern) | |
Give an specific pattern, return all the page type patterns that would also match it. | |
Html2Text::mb_internal_encoding ($encoding=null) | |
Set the encoding to be used by our monkey patched mb_ functions. | |
Html2Text::mb_strlen ($str, $encoding=null) | |
Gets the length of a string. | |
Html2Text::mb_strtolower ($str, $encoding=null) | |
Returns $str with all alphabetic chatacters converted to lowercase. | |
Html2Text::mb_strtoupper ($str, $encoding=null) | |
Html2Text::mb_substr ($str, $start, $length=null, $encoding=null) | |
Performs a multi-byte safe substr() operation based on number of characters. | |
mdie ($msg='', $errorcode=1) | |
Print an error to STDOUT and exit with a non-zero code. | |
me () | |
Returns the name of the current script, WITH the querystring portion. | |
merge_query_params (array &$target, array $values) | |
Merge parsed POST chunks. | |
message_add_contact () | |
message_block_contact () | |
message_can_delete_message () | |
message_can_post_message () | |
message_contact_link () | |
message_count_blocked_users () | |
message_count_messages () | |
message_count_unread_messages () | |
message_current_user_is_involved () | |
message_delete_message () | |
message_get_blocked_users () | |
message_get_contact () | |
message_get_contact_add_remove_link () | |
message_get_contact_block_link () | |
message_get_contacts () | |
message_get_course_contexts () | |
message_get_fragment () | |
message_get_history () | |
message_get_recent_conversations ($userorid, $limitfrom=0, $limitto=100) | |
message_get_recent_notifications () | |
message_history_link () | |
message_is_user_blocked () | |
message_is_user_non_contact_blocked () | |
message_mark_message_read () | |
message_mark_messages_read () | |
message_move_userfrom_unread2read () | |
message_remove_contact () | |
message_remove_url_params () | |
message_search () | |
message_shorten_message () | |
message_unblock_contact () | |
microtime_diff ($a, $b) | |
Calculate the difference between two microtimes. | |
min_clean_param ($value, $type) | |
Minimalistic parameter cleaning function. | |
min_enable_zlib_compression () | |
This method tries to enable output compression if possible. | |
min_fix_utf8 ($value) | |
Minimalistic UTF-8 sanitisation. | |
min_get_maximum_revision () | |
Get the highest possible currently valid revision number. | |
min_get_minimum_revision () | |
Get the lowest possible currently valid revision number. | |
min_get_slash_argument ($clean=true) | |
Returns the slashargument part of the URL. | |
min_is_revision_valid_and_current (int $revision) | |
Helper function to determine if the given revision number is valid. | |
min_optional_param ($name, $default, $type) | |
Minimalistic parameter validation function. | |
mnet_get_idp_jump_url ($user) | |
return the jump url for a given remote user this is used for rewriting forum post links in emails, etc | |
mod_page_type_list ($pagetype, $parentcontext=null, $currentcontext=null) | |
Generates the page type list for a module by either locating and using the modules callback or by generating a default list. | |
moodle_getlocale () | |
Gets the system locale. | |
moodle_major_version ($fromdisk=false) | |
Returns the major version of this site. | |
moodle_minimum_php_version_is_met ($haltexecution=false) | |
Tests the current PHP version against Moodle's minimum requirement. | |
moodle_needs_upgrading ($checkupgradeflag=true) | |
Determine if moodle installation requires update. | |
moodle_process_email ($modargs, $body) | |
? | |
moodle_require_minimum_php_version () | |
Require our minimum php version or halt execution if requirement not met. | |
moodle_setlocale ($locale='') | |
Sets the system locale. | |
move_category () | |
move_question_set_references (int $oldcategoryid, int $newcatgoryid, int $oldcontextid, int $newcontextid, bool $delete=false) | |
Update the questioncontextid field for all question_set_references records given a new context id. | |
mtrace ($string, $eol="\n", $sleep=0) | |
For outputting debugging info. | |
mtrace_exception (Throwable $e) | |
Helper to {. | |
my_page_type_list ($pagetype, $parentcontext=null, $currentcontext=null) | |
Generates the page type list for the my moodle page. | |
mygroupid () | |
navmenu () | |
navmenulist ($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) | |
Returns a popup menu with course activity modules. | |
static | normalize_component ($component) |
Normalize the component name using the "frankenstyle" rules. | |
static | normalize_componentname ($componentname) |
Normalize the component name. | |
normalize_version ($version) | |
This function will normalize any version to just a serie of numbers separated by dots. | |
notice ($message, $link='', $course=null) | |
Print a message and exit. | |
notify () | |
obfuscate_email ($email) | |
Given an email address, this function will return an obfuscated version of it. | |
obfuscate_mailto ($email, $label='', $dimmed=false, $subject='', $body='') | |
This function uses the obfuscate_email() and obfuscate_text() to generate a fully obfuscated email link, ready to use. | |
obfuscate_text ($plaintext) | |
This function takes some text and replaces about half of the characters with HTML entity equivalents. | |
object_array_unique ($array, $keepkeyassoc=true) | |
Returns an array without repeated objects. | |
object_property_exists ( $obj, $property) | |
Detect if an object or a class contains a given property will take an actual object or the name of a class. | |
optional_param ($parname, $default, $type) | |
Returns a particular value for the named variable, taken from POST or GET, otherwise returning a given default. | |
optional_param_array ($parname, $default, $type) | |
Returns a particular array value for the named variable, taken from POST or GET, otherwise returning a given default. | |
order_in_string ($values, $stringformat) | |
Returns an array of values in order of occurance in a provided string. | |
over_bounce_threshold ($user) | |
Check whether the user has exceeded the bounce threshold. | |
p ($var) | |
Add quotes to HTML characters. | |
page_doc_link ($text='') | |
Returns a string containing a link to the user documentation for the current page. | |
page_get_doc_link_path (moodle_page $page) | |
Returns the path to use when constructing a link to the docs. | |
partial () | |
Helper function to do partial function binding. | |
password_compat_not_supported () | |
password_is_legacy_hash ($password) | |
Check a password hash to see if it was hashed using the legacy hash algorithm (md5). | |
perf_get_reads_slave () | |
Returns the number of reads done by the read only database. | |
phpunit_bootstrap_error ($errorcode, $text='') | |
Print error and stop execution. | |
plagiarism_get_file_results ($cmid, $userid, $file) | |
returns array of plagiarism details about specified file | |
plagiarism_get_form_elements_module () | |
if(!defined( 'MOODLE_INTERNAL')) | plagiarism_get_links ($linkarray) |
displays the similarity score and provides a link to the full report if allowed. | |
plagiarism_load_available_plugins () | |
Helper function - also loads lib file of plagiarism plugin. | |
plagiarism_print_disclosure ($cmid) | |
Function that prints the student disclosure notifying that the files will be checked for plagiarism. | |
plagiarism_save_form_elements () | |
plagiarism_update_status ($course, $cm) | |
Allows a plagiarism plugin to print a button/link at the top of activity overview report pages. | |
plugin_callback ($type, $name, $feature, $action, $params=null, $default=null) | |
Invoke plugin's callback functions. | |
plugin_supports ($type, $name, $feature, $default=null) | |
Checks whether a plugin supports a specified feature. | |
preload_course_contexts () | |
prevent_form_autofill_password () | |
object | print_arrow ($direction='up', $strsort=null, $return=false) |
Returns an image of an up or down arrow, used for column sorting. | |
print_badge_image (badge $badge, stdClass $context, $size='small') | |
Print badge image. | |
print_category_info () | |
print_checkbox () | |
print_collapsible_region ($contents, $classes, $id, $caption, $userpref='', $default=false, $return=false) | |
Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region. | |
print_collapsible_region_end ($return=false) | |
Close a region started with print_collapsible_region_start. | |
print_collapsible_region_start ($classes, $id, $caption, $userpref='', $default=false, $return=false, $extracontent=null) | |
Print (or return) the start of a collapsible region. | |
print_container () | |
print_container_end () | |
print_container_start () | |
print_context_name () | |
print_continue () | |
print_course () | |
print_course_search () | |
print_courses () | |
print_error ($errorcode, $module='error', $link='', $a=null, $debuginfo=null) | |
Abort execution by throwing of a general exception, default exception handler displays the error message in most cases. | |
print_grade_menu ($courseid, $name, $current, $includenograde=true, $return=false) | |
Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales. | |
print_grade_plugin_selector ($plugin_info, $active_type, $active_plugin, $return=false) | |
Print grading plugin selection popup form. | |
print_group_picture ($group, $courseid, $large=false, $return=false, $link=true, $includetoken=false) | |
Print a specified group's avatar. | |
print_header () | |
print_header_simple () | |
print_location_comment ($file, $line, $return=false) | |
Outputs a HTML comment to the browser. | |
print_log () | |
print_log_csv () | |
print_log_ods () | |
print_log_xls () | |
print_maintenance_message () | |
Prints a maintenance message from $CFG->maintenance_message or default if empty. | |
print_mnet_log () | |
print_my_moodle () | |
print_navigation () | |
print_object ($object) | |
GENERAL HELPFUL THINGS ///////////////////////////////////. | |
print_overview () | |
print_password_policy () | |
Returns a localized sentence in the current language summarizing the current password policy. | |
print_question_icon ($question) | |
Print the icon for the question type. | |
print_recent_activity () | |
print_recent_activity_note ($time, $user, $text, $link, $return=false, $viewfullnames=null) | |
Display a recent activity note. | |
print_remote_course () | |
print_remote_host () | |
print_scale_menu_helpbutton () | |
print_section () | |
print_section_add_menus () | |
print_side_block () | |
print_string ($identifier, $component='', $a=null) | |
Prints out a translated string. | |
print_tabs ($tabrows, $selected=null, $inactive=null, $activated=null, $return=false) | |
Returns a string containing a nested list, suitable for formatting into tabs with CSS. | |
print_textarea () | |
print_upgrade_part_end ($plugin, $installation, $verbose) | |
Default end upgrade callback. | |
print_upgrade_part_start ($plugin, $installation, $verbose) | |
Default start upgrade callback. | |
print_upgrade_separator () | |
print_whole_category_list () | |
process_environment_bypass ($xml, &$result) | |
This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer. | |
process_environment_messages ($xml, &$result) | |
This function will detect if there is some message available to be added to the result in order to clarify enviromental details. | |
process_environment_restrict ($xml, &$result) | |
This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer. | |
process_environment_result ($element, &$result) | |
Once the result has been determined, look in the XML for any messages, or other things that should be done depending on the outcome. | |
process_manual_award ($recipientid, $issuerid, $issuerrole, $badgeid) | |
process_manual_revoke ($recipientid, $issuerid, $issuerrole, $badgeid) | |
Manually revoke awarded badges. | |
process_new_icon ($context, $component, $filearea, $itemid, $originalfile, $preferpng=false) | |
Stores optimised icon images in icon file area. | |
profile_display_badges () | |
profiling_available () | |
Whether PHP profiling is available. | |
profiling_export_generate (array $runids, $tmpdir) | |
Generate the mpr contents (xml files) in the temporal directory. | |
profiling_export_package ($file, $tmpdir) | |
Package (zip) the mpr contents (xml files) in the final location. | |
profiling_export_runs (array $runids, $file) | |
Export profiling runs to a .mpr (moodle profile runs) file. | |
profiling_get_difference ($number1, $number2, $units='', $factor=1, $numdec=2) | |
Helper function that, given to floats, returns their numerical and percentual differences, propertly formated and cssstyled. | |
profiling_get_flag ($flag) | |
Check for profiling flags in all possible places. | |
profiling_get_import_main_schema () | |
Return the xml schema for the main import file. | |
profiling_get_import_run_schema () | |
Return the xml schema for each individual run import file. | |
profiling_get_script () | |
Returns the path to the php script being requested. | |
profiling_import_runs ($file, $commentprefix='') | |
Import a .mpr (moodle profile runs) file into moodle. | |
profiling_is_running ($value=null) | |
Returns if profiling is running, optionally setting it. | |
profiling_is_saved ($value=null) | |
Returns if profiling has been saved, optionally setting it. | |
profiling_list_controls ($listurl) | |
Helper function that returns the HTML fragment to be displayed on listing mode, it includes actions like deletion/export/import... | |
profiling_print_run ($run, $prevreferences=null) | |
Generate the output to print a profiling run including further actions you can then take. | |
profiling_print_rundiff ($run1, $run2) | |
profiling_prune_old_runs ($exception=0) | |
profiling_start () | |
Start profiling observing all the configuration. | |
profiling_stop () | |
Stop profiling, gathering results and storing them. | |
profiling_string_matches ($string, $patterns) | |
Helper function that looks for matchings of one string against an array of * wildchar patterns. | |
profiling_urls ($report, $runid, $runid2=null) | |
proxy_log_callback ($code) | |
Add http stream instrumentation. | |
purge_all_caches () | |
Invalidates browser caches and cached data in temp. | |
purge_caches ($options=[]) | |
Selectively invalidate different types of cache. | |
purge_other_caches () | |
Purge all non-MUC caches not otherwise purged in purge_caches. | |
purify_html ($text, $options=array()) | |
KSES replacement cleaning function - uses HTML Purifier. | |
put_records_csv () | |
qualified_me () | |
Guesses the full URL of the current script. | |
query_end ($result) | |
This should be called immediately after each db query. | |
query_start ($sql, ?array $params, $type, $extrainfo=null) | |
Called before each db query. | |
question_add_context_in_key ($categories) | |
Add context in categories key. | |
question_add_tops () | |
question_category_delete_safe ($category) | |
Category is about to be deleted, 1/ All questions are deleted for this question category. | |
question_category_in_use ($categoryid, $recursive=false) | |
Tests whether any question in a category is used by any part of Moodle. | |
question_category_options ($contexts, $top=false, $currentcat=0, $popupform=false, $nochildrenof=-1, $escapecontextnames=true) | |
Output an array of question categories. | |
question_category_select_menu ($contexts, $top=false, $currentcat=0, $selected="", $nochildrenof=-1) | |
Output a select menu of question categories. | |
question_categorylist ($categoryid) | |
Get the list of categories. | |
question_categorylist_parents (int $categoryid) | |
Get all parent categories of a given question category in descending order. | |
question_context_has_any_questions ($context) | |
Determine whether there are any questions belonging to this context, that is whether any of its question categories contain any questions. | |
question_default_export_filename ($course, $category) | |
Create a reasonable default file name for exporting questions from a particular category. | |
question_delete_activity ($cm, $notused=false) | |
All question categories and their questions are deleted for this activity. | |
question_delete_context ($contextid) | |
All question categories and their questions are deleted for this context id. | |
question_delete_course ($course, $notused=false) | |
All question categories and their questions are deleted for this course. | |
question_delete_course_category ($category, $newcategory, $notused=false) | |
Category is about to be deleted, 1/ All question categories and their questions are deleted for this course category. | |
question_delete_question ($questionid) | |
Deletes question and all associated data from the database. | |
question_edit_url ($context) | |
Gets the question edit url. | |
question_extend_settings_navigation (navigation_node $navigationnode, $context, $baseurl='/question/edit.php') | |
Adds question bank setting links to the given navigation node if caps are met and loads the navigation from the plugins. | |
question_fix_top_names ($categories, $escape=true) | |
Finds top categories in the given categories hierarchy and replace their name with a proper localised string. | |
question_get_all_capabilities () | |
Get the question bank caps. | |
question_get_default_category ($contextid) | |
Get the default category for the context. | |
question_get_export_single_question_url ($question) | |
Get the URL to export a single question (exportone.php). | |
question_get_question_capabilities () | |
Get the array of capabilities for question. | |
question_get_top_categories_for_contexts ($contextids) | |
Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format. | |
question_get_top_category ($contextid, $create=false) | |
Gets the top category in the given context. | |
question_has_capability_on ($questionorid, $cap, $notused=-1) | |
Check capability on category. | |
question_hash ($question) | |
Creates a stamp that uniquely identifies this version of the question. | |
question_is_only_toplevel_category_in_context () | |
question_load_questions ($questionids, $extrafields='', $join='') | |
Load a set of questions, given a list of ids. | |
question_make_default_categories ($contexts) | |
Gets the default category in the most specific context. | |
question_make_export_url ($contextid, $categoryid, $format, $withcategories, $withcontexts, $filename) | |
Create url for question export. | |
question_module_uses_questions ($modname) | |
Does an activity module use the question bank? | |
question_move_category_to_context ($categoryid, $oldcontextid, $newcontextid) | |
This function helps move a question cateogry to a new context by moving all the files belonging to all the questions to the new context. | |
question_move_question_tags_to_new_context (array $questions, context $newcontext) | |
This function will handle moving all tag instances to a new context for a given list of questions. | |
question_move_questions_to_category ($questionids, $newcategoryid) | |
This function should be considered private to the question bank, it is called from question/editlib.php question/contextmoveq.php and a few similar places to to the work of actually moving questions and associated data. | |
question_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
Return a list of page types. | |
question_pluginfile ($course, $context, $component, $filearea, $args, $forcedownload, $options=[]) | |
Called by pluginfile.php to serve files related to the 'question' core component and for files belonging to qtypes. | |
question_preload_questions ($questionids=null, $extrafields='', $join='', $extraparams=[], $orderby='') | |
Given a list of ids, load the basic information about a set of questions from the questions table. | |
question_preview_popup_params () | |
Popup params for the question preview. | |
question_preview_url ($questionid, $preferredbehaviour=null, $maxmark=null, $displayoptions=null, $variant=null, $context=null) | |
Generate the URL for starting a new preview of a given question with the given options. | |
question_remove_stale_questions_from_category ($categoryid) | |
Remove stale questions from a category. | |
question_reorder_qtypes ($sortedqtypes, $tomove, $direction) | |
Move one question type in a list of question types. | |
question_require_capability_on ($question, $cap) | |
Require capability on question. | |
question_rewrite_question_preview_urls ($text, $questionid, $filecontextid, $filecomponent, $filearea, $itemid, $previewcontextid, $previewcomponent, $options=null) | |
Rewrite the PLUGINFILE urls in part of the content of a question, for use when viewing the question outside an attempt (for example, in the question bank listing or in the quiz statistics report). | |
question_save_from_deletion ($questionids, $newcontextid, $oldplace, $newcategory=null) | |
Creates a new category to save the questions in use. | |
question_save_qtype_order ($neworder, $config=null) | |
Save a new question type order to the config_plugins table. | |
question_sort_tags ($tagobjects, $categorycontext, $filtercourses=null) | |
Sort question tags by course or normal tags. | |
questions_in_use ($questionids) | |
Check if the question is used. | |
raise_memory_limit ($newlimit) | |
Function to raise the memory limit to a new value. | |
random_bytes_emulate ($length) | |
Try to generates cryptographically secure pseudo-random bytes. | |
random_string ($length=15) | |
Generate and return a random string of the specified length. | |
raw_connect (string $dbhost, string $dbuser, string $dbpass, string $dbname, $prefix, array $dboptions=null) | |
Connect to db The real connection establisment, called from connect() and set_dbhwrite() | |
rc4decrypt ($data) | |
rc4decrypt | |
rc4encrypt ($data) | |
rc4encrypt | |
rebuild_contexts () | |
moodle_database | rebuild_course_cache (int $courseid=0, bool $clearonly=false, bool $partialrebuild=false) |
Rebuilds or resets the cached list of course activities stored in MUC. | |
rebuildnolinktag ($text) | |
This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI) will transform it to html entities. | |
recaptcha_check_response ($verifyurl, $privkey, $remoteip, $response) | |
Calls an HTTP POST function to verify if the user's response was correct. | |
recaptcha_get_challenge_html ($apiurl, $pubkey, $lang=null) | |
Gets the challenge HTML This is called from the browser, and the resulting reCAPTCHA HTML widget is embedded within the HTML form it was called from. | |
recaptcha_lang ($lang=null) | |
Returns the language code the reCAPTCHA element should use. | |
redirect ($url, $message='', $delay=null, $messagetype=core\output\notification::NOTIFY_INFO) | |
Redirects the user to another page, after printing a notice. | |
redirect_if_major_upgrade_required () | |
Redirect to the Notifications page if a major upgrade is required, and terminate the current user session. | |
reduce_memory_limit ($newlimit) | |
Function to reduce the memory limit to a new value. | |
remoteip_in_list ($list) | |
Is the current ip in a given list? | |
remove_course_contents ($courseid, $showfeedback=true, array $options=null) | |
Clear a course out completely, deleting all content but don't delete the course itself. | |
remove_dir ($dir, $contentonly=false) | |
Delete directory or only its content. | |
rename_to_unused_name (string $filepath, string $prefix='_temp_') | |
Renames a file or directory to a unique name within the same directory. | |
replace_ampersands_not_followed_by_entity ($string) | |
Given a string, performs a negative lookahead looking for any ampersand character that is not followed by a proper HTML entity. | |
report_insights_context_insights (\context $context) | |
require_admin () | |
A convenience function for where we must be logged in as admin. | |
require_phpunit_isolation () | |
A helper function for deprecated files to use to ensure that, when they are included for unit tests, they are run in an isolated process. | |
require_sesskey () | |
Check the session key using confirm_sesskey(), and cause a fatal error if it does not match. | |
require_user_key_login ($script, $instance=null, $keyvalue=null) | |
Require key login. | |
required_param ($parname, $type) | |
Returns a particular value for the named variable, taken from POST or GET. | |
required_param_array ($parname, $type) | |
Returns a particular array value for the named variable, taken from POST or GET. | |
static | filter_manager::reset_caches () |
Resets the caches, usually to be called between unit tests. | |
reset_course_userdata ($data) | |
This function will empty a course of user data. | |
reset_login_count () | |
reset_password_and_mail ($user) | |
Resets specified user's password and send the new password to the user via email. | |
reset_text_filters_cache ($phpunitreset=false) | |
Resets some data related to filters, called during upgrade or when general filter settings change. | |
resize_image ($filepath, $width, $height, $forcecanvas=false) | |
Resize an image from an image path. | |
resize_image_from_image ($original, $imageinfo, $width, $height, $forcecanvas=false) | |
Resize an image from an image object. | |
resourcelib_embed_general ($fullurl, $title, $clicktoopen, $mimetype) | |
Returns general link or file embedding html. | |
resourcelib_embed_image ($fullurl, $title) | |
Returns image embedding html. | |
resourcelib_embed_pdf ($fullurl, $title, $clicktoopen) | |
Returns general link or pdf embedding html. | |
resourcelib_get_displayoptions (array $enabled, $current=null) | |
Returns list of available display options. | |
resourcelib_get_extension ($fullurl) | |
Looks for the extension. | |
resourcelib_guess_url_mimetype ($fullurl) | |
Tries to guess correct mimetype for arbitrary URL. | |
resourcelib_try_file_migration ($filepath, $cmid, $courseid, $component, $filearea, $itemid) | |
Try on demand migration of file from old course files. | |
restrict_php_version (&$result, $version) | |
Check if the current PHP version is greater than or equal to an unsupported version. | |
restrict_php_version_7 (&$result) | |
Check if the current PHP version is greater than or equal to PHP version 7. | |
restrict_php_version_71 (&$result) | |
Check if the current PHP version is greater than or equal to PHP version 7.1. | |
restrict_php_version_72 (&$result) | |
Check if the current PHP version is greater than or equal to PHP version 7.2. | |
restrict_php_version_73 (&$result) | |
Check if the current PHP version is greater than or equal to PHP version 7.3. | |
restrict_php_version_74 (&$result) | |
Check if the current PHP version is greater than or equal to PHP version 7.4. | |
restrict_php_version_80 ($result) | |
Check if the current PHP version is greater than or equal to PHP version 8.0. | |
restrict_php_version_81 ($result) | |
Check if the current PHP version is greater than or equal to PHP version 8.1. | |
restrict_php_version_82 ($result) | |
Check if the current PHP version is greater than or equal to PHP version 8.2. | |
restrict_php_version_83 ($result) | |
Check if the current PHP version is greater than or equal to PHP version 8.3. | |
right_to_left () | |
Returns true if the user is using a right-to-left language. | |
s ($var) | |
Add quotes to HTML characters. | |
object | search_generate_SQL ($parsetree, $datafield, $metafield, $mainidfield, $useridfield, $userfirstnamefield, $userlastnamefield, $timefield, $instancefield, $tagfields=[]) |
Primitive function to generate a SQL string from a parse tree. | |
search_generate_text_SQL ($parsetree, $datafield, $metafield, $mainidfield, $useridfield, $userfirstnamefield, $userlastnamefield, $timefield, $instancefield) | |
Primitive function to generate a SQL string from a parse tree using TEXT indexes. | |
object | search_users ($courseid, $groupid, $searchtext, $sort='', array $exceptions=null) |
Search through course users. | |
select_db_handle (int $type, string $sql) | |
Select appropriate db handle - readwrite or readonly. | |
send_confirmation_email ($user, $confirmationurl=null) | |
Send email to specified user with confirmation text and activation link. | |
send_headers ($contenttype, $cacheable=true) | |
Send the HTTP headers that Moodle requires. | |
send_password_change_confirmation_email ($user, $resetrecord) | |
Sends a password change confirmation email. | |
send_password_change_info ($user) | |
Sends an email containing information on how to change your password. | |
serialise_tool_proxy () | |
session_get_instance () | |
session_get_realuser () | |
session_is_legacy () | |
session_is_loggedinas () | |
session_kill () | |
session_kill_all () | |
session_kill_user () | |
session_loginas () | |
session_set_user () | |
session_touch () | |
sesskey () | |
Makes sure that $USER->sesskey exists, if $USER itself exists. | |
set_access_log_user () | |
Webserver access user logging. | |
set_bounce_count ($user, $reset=false) | |
Increment or reset user's email bounce count. | |
set_cache_flag ($type, $name, $value, $expiry=null) | |
Set a volatile flag. | |
set_config ($name, $value, $plugin=null) | |
Set a key in global configuration. | |
set_cron_lock ($name, $until, $ignorecurrent=false) | |
Try to obtain or release the cron lock. | |
set_current_group () | |
set_db_handle ($dbh) | |
Sets db handle to be used with subsequent queries. | |
set_debugging ($level, $debugdisplay=null) | |
Alter debugging level for the current request, the change is not saved in database. | |
set_login_session_preferences () | |
When logging in, this function is run to set certain preferences for the current SESSION. | |
set_mnet_remote_client ($client) | |
during the xmlrpc server code execution, this will be called to setup the object returned by get_mnet_remote_client | |
set_moodle_cookie ($username) | |
Sets a moodle cookie with a weakly encrypted username. | |
set_send_count ($user, $reset=false) | |
Used to increment or reset email sent count. | |
set_user_device_type () | |
set_user_preference ($name, $value, $user=null) | |
Sets a preference for the specified user. | |
set_user_preferences (array $prefarray, $user=null) | |
Sets a whole array of preferences for the current user. | |
setnew_password_and_mail ($user, $fasthash=false) | |
Sets specified user's password and send the new password to the user via email. | |
moodle_text_filter::setup ($page, $context) | |
Setup page with filter requirements and other prepare stuff. | |
stdClass | setup_DB () |
Sets up global $DB moodle_database instance. | |
setup_get_remote_url () | |
Get the URL that PHP/the web server thinks it is serving. | |
setup_lang_from_browser () | |
This function will search for browser prefereed languages, setting Moodle to use the best one available if $SESSION->lang is undefined. | |
filter_manager::setup_page_for_filters ($page, $context) | |
Setup page with filters requirements and other prepare stuff. | |
filter_manager::setup_page_for_globally_available_filters ($page) | |
Setup the page for globally available filters. | |
setup_validate_php_configuration () | |
This function verifies the sanity of PHP configuration and stops execution if anything critical found. | |
shift_course_mod_dates ($modname, $fields, $timeshift, $courseid, $modid=0) | |
Change dates in module - used from course reset. | |
shorten_filename ($filename, $length=MAX_FILENAME_SIZE, $includehash=false) | |
Shortens a given filename by removing characters positioned after the ideal string length. | |
shorten_filenames (array $path, $length=MAX_FILENAME_SIZE, $includehash=false) | |
Shortens a given array of filenames by removing characters positioned after the ideal string length. | |
shorten_text ($text, $ideal=30, $exact=false, $ending='...') | |
Given some text (which may contain HTML) and an ideal length, this function truncates the text neatly on a word boundary if possible. | |
show_event () | |
signup_captcha_enabled () | |
Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements. | |
signup_get_user_confirmation_authplugin () | |
Check if user confirmation is enabled on this site and return the auth plugin handling registration if enabled. | |
signup_is_enabled () | |
Check if sign-up is enabled in the site. | |
signup_setup_new_user ($user) | |
Add the missing fields to a user that is going to be created. | |
signup_validate_data ($data, $files) | |
Validates the standard sign-up data (except recaptcha that is validated by the form element). | |
site_is_public () | |
Tries to guess if $CFG->wwwroot is publicly accessible or not. | |
site_scale_used () | |
skip_main_destination () | |
soap_call ($connection, $call, $params) | |
Make a call to a SoapClient. | |
soap_connect ($wsdl, $trace=false) | |
Create a new SoapClient object. | |
soap_encode ($value, $name, $type, $namespace, $encode=XSD_STRING) | |
soap_encode_array ($value, $name, $type, $namespace) | |
soap_encode_object ($value, $name, $type, $namespace) | |
soap_serve ($wsdl, $functions) | |
sort_categories_by_tree (&$categories, $id=0, $level=1) | |
Returns the categories with their names ordered following parent-child relationships. | |
start_delegated_transaction () | |
On DBs that support it, switch to transaction mode and begin a transaction. | |
stats_check_uptodate ($courseid=0) | |
stats_clean_old () | |
Remove old stats data. | |
stats_compare_times ($a, $b) | |
stats_cron_daily ($maxdays=1) | |
Execute daily statistics gathering. | |
stats_cron_monthly () | |
Execute monthly statistics gathering. | |
stats_cron_weekly () | |
Execute weekly statistics gathering. | |
stats_fix_zeros ($stats, $timeafter, $timestr, $line2=true, $line3=false) | |
Fix missing entries in the statistics. | |
stats_get_action_names ($str) | |
stats_get_base_daily ($time=0) | |
Start of day. | |
stats_get_base_monthly ($time=0) | |
Start of month. | |
stats_get_base_weekly ($time=0) | |
Start of week. | |
stats_get_next_day_start ($time) | |
Start of next day. | |
stats_get_next_month_start ($time) | |
Start of next month. | |
stats_get_next_week_start ($time) | |
Start of next week. | |
stats_get_parameters ($time, $report, $courseid, $mode, $roleid=0) | |
stats_get_post_actions () | |
stats_get_report_options ($courseid, $mode) | |
stats_get_start_from ($str) | |
Return starting date of stats processing. | |
stats_get_time_options ($now, $lastweekend, $lastmonthend, $earliestday, $earliestweek, $earliestmonth) | |
stats_get_view_actions () | |
stats_progress ($ident) | |
Print daily cron progress. | |
stats_run_query ($sql, $parameters=array()) | |
Execute individual daily statistics queries. | |
stats_temp_table_clean () | |
Deletes summary logs table for stats calculation. | |
stats_temp_table_create () | |
Create temporary tables to speed up log generation. | |
stats_temp_table_drop () | |
Deletes summary logs table for stats calculation. | |
stats_temp_table_fill ($timestart, $timeend) | |
Fills the temporary stats tables with new data. | |
stats_temp_table_setup () | |
Fills the temporary stats tables with new data. | |
strip_links ($string) | |
Given a string, replaces all . | |
strip_pluginfile_content ($source) | |
Removes the usage of Moodle files from a text. | |
strip_querystring ($url) | |
Remove query string from url. | |
swapshuffle ($array) | |
Given a simple array, this shuffles it up just like shuffle() Unlike PHP's shuffle() this function works on any machine. | |
swapshuffle_assoc ($array) | |
Like swapshuffle(), but works on associative arrays. | |
table_names (string $sql) | |
Parse table names from query. | |
tag_add () | |
tag_assign () | |
tag_autocomplete () | |
tag_bulk_delete_instances () | |
tag_cleanup () | |
tag_cloud_sort () | |
tag_compute_correlations () | |
tag_cron () | |
tag_delete () | |
tag_delete_instance () | |
tag_delete_instances () | |
tag_description_set () | |
tag_display_name () | |
tag_find_records () | |
tag_find_tags () | |
tag_get () | |
tag_get_correlated () | |
tag_get_id () | |
tag_get_name () | |
tag_get_related_tags () | |
tag_get_related_tags_csv () | |
tag_get_tags () | |
tag_get_tags_array () | |
tag_get_tags_csv () | |
tag_get_tags_ids () | |
tag_normalize () | |
tag_print_cloud () | |
tag_print_description_box () | |
tag_print_management_box () | |
tag_print_search_box () | |
tag_print_search_results () | |
tag_print_tagged_users_table () | |
tag_print_user_box () | |
tag_print_user_list () | |
tag_process_computed_correlation () | |
tag_record_count () | |
tag_record_tagged_with () | |
tag_rename () | |
tag_set () | |
tag_set_add () | |
tag_set_delete () | |
tag_set_flag () | |
tag_type_set () | |
tag_unset_flag () | |
template_reset_all_caches () | |
Invalidate all server and client side template caches. | |
testing_cli_argument_path ($moodlepath) | |
Returns relative path against current working directory, to be used for shell execution hints. | |
testing_cli_fix_directory_separator ($path) | |
Fix DIRECTORY_SEPARATOR for windows. | |
testing_error ($errorcode, $text='') | |
Prints an error and stops execution. | |
testing_fix_file_permissions ($file) | |
Try to change permissions to $CFG->dirroot or $CFG->dataroot if possible. | |
testing_initdataroot ($dataroot, $framework) | |
Mark empty dataroot to be used for testing. | |
testing_is_cygwin () | |
Find out if running under Cygwin on Windows. | |
testing_is_mingw () | |
Returns whether a mingw CLI is running. | |
testing_update_composer_dependencies (bool $selfupdate=true, bool $updatedependencies=true) | |
Perform necessary steps to install and/or upgrade composer and its dependencies. | |
filter_manager::text_filtering_hash () | |
null_filter_manager::text_filtering_hash () | |
As for the equivalent filter_manager method. | |
text_to_html ($text, $smileyignored=null, $para=true, $newlines=true) | |
Given plain text, makes it into HTML as nicely as possible. | |
textlib_get_instance () | |
theme_build_css_for_themes ($themeconfigs=[], $directions=['rtl', 'ltr'], $cache=true, $mtraceprogress=false) | |
Generates and saves the CSS files for the given theme configs. | |
theme_get_config_file_path ($themename) | |
Get the path to a theme config.php file. | |
theme_get_css_filename ($themename, $globalrevision, $themerevision, $direction) | |
Get the path to the local cached CSS file. | |
theme_get_locked_theme_for_device ($device) | |
Returns the theme named defined in config.php for the given device. | |
theme_get_next_revision () | |
Calculates and returns the next theme revision number. | |
theme_get_next_sub_revision_for_theme ($themename) | |
Calculates and returns the next theme revision number. | |
theme_get_revision () | |
Returns current theme revision number. | |
theme_get_sub_revision_for_theme ($themename) | |
Returns current theme sub revision number. | |
theme_is_device_locked ($device) | |
Checks if the given device has a theme defined in config.php. | |
theme_reset_all_caches () | |
Invalidate all server and client side caches. | |
theme_reset_static_caches () | |
Reset static caches. | |
theme_set_designer_mod ($state) | |
Enable or disable theme designer mode. | |
theme_set_revision ($revision) | |
Sets the current theme revision number. | |
theme_set_sub_revision_for_theme ($themename, $revision) | |
Sets the current theme revision number for a specific theme. | |
truncate_userinfo (array $info) | |
Will truncate userinfo as it comes from auth_get_userinfo (from external auth) which may have large fields. | |
trusttext_active () | |
Is trusttext feature active? | |
trusttext_pre_edit ($object, $field, $context) | |
Must be called before editing of all texts with trust flag. | |
trusttext_trusted ($context) | |
Is current user trusted to enter no dangerous XSS in this context? | |
unformat_float ($localefloat, $strict=false) | |
Converts locale specific floating point/comma number back to standard PHP float value Do NOT try to do any math operations before this conversion on any user submitted floats! | |
uninstall_plugin ($type, $name) | |
Automatically clean-up all plugin data and remove the plugin DB tables. | |
filter_manager::unload_all_filters () | |
Unloads all filters and other cached information. | |
performance_measuring_filter_manager::unload_all_filters () | |
Unloads all filters and other cached information. | |
unserialize_array ($expression) | |
Safe analogue of unserialize() that can only parse arrays. | |
unserialize_object (string $input) | |
Safe method for unserializing given input that is expected to contain only a serialized instance of an stdClass object. | |
unset_all_config_for_plugin ($plugin) | |
Remove all the config variables for a given plugin. | |
unset_cache_flag ($type, $name) | |
Removes a single volatile flag. | |
unset_config ($name, $plugin=null) | |
Removes a key from global configuration. | |
unset_user_preference ($name, $user=null) | |
Unsets a preference completely by deleting it from the database. | |
object | unzip_file ($zipfile, $destination='', $showstatus_ignored=true) |
Unzip one zip file to a destination dir Both parameters must be FULL paths If destination isn't specified, it will be the SAME directory where the zip file resides. | |
update_category_button () | |
update_event () | |
update_field_with_unique_index ($table, $field, array $newvalues, array $otherconditions, $unusedvalue=-1) | |
This method can update the values in mulitple database rows for a colum with a unique index, without violating that constraint. | |
update_internal_user_password ($user, $password, $fasthash=false) | |
Update password hash in user object (if necessary). | |
update_log_display_entry () | |
update_login_count () | |
update_module_button () | |
update_timezone_records () | |
update_user_login_times () | |
Modify the user table by setting the currently logged in user's last login to now. | |
update_user_record ($username) | |
Will update a local user record from an external source (MNET users can not be updated using this method!). | |
update_user_record_by_id ($id) | |
Will update a local user record from an external source (MNET users can not be updated using this method!). | |
upgrade_block_savepoint ($result, $version, $blockname, $allowabort=true) | |
Blocks upgrade savepoint, marks end of blocks upgrade blocks It stores block version, resets upgrade timeout and abort upgrade if user cancels page loading. | |
upgrade_component_updated (string $component, string $messageplug='', bool $coreinstall=false) | |
After upgrading a module, block, or generic plugin, various parts of the system need to be informed. | |
upgrade_core ($version, $verbose) | |
Upgrade moodle core. | |
upgrade_ensure_not_running ($warningonly=false) | |
Makes sure that upgrade process is not running. | |
object | upgrade_finished ($continueurl=null) |
Indicates upgrade is finished. | |
upgrade_finished_handler () | |
Internal function - executed if upgrade interrupted. | |
upgrade_handle_exception ($ex, $plugin=null) | |
upgrade logging functions | |
object | upgrade_init_javascript () |
Sets up JS code required for all upgrade scripts. | |
upgrade_install_plugins (array $installable, $confirmed, $heading='', $continue=null, $return=null) | |
Helper procedure/macro for installing remote plugins at admin/index.php. | |
upgrade_language_pack ($lang=null) | |
Try to upgrade the given language pack (or current language) | |
upgrade_log ($type, $plugin, $info, $details=null, $backtrace=null) | |
Adds log entry into upgrade_log table. | |
upgrade_main_savepoint ($result, $version, $allowabort=true) | |
Upgrade savepoint, marks end of each upgrade block. | |
upgrade_mod_savepoint ($result, $version, $modname, $allowabort=true) | |
Module upgrade savepoint, marks end of module upgrade blocks It stores module version, resets upgrade timeout and abort upgrade if user cancels page loading. | |
upgrade_noncore ($verbose) | |
Upgrade/install other parts of moodle. | |
upgrade_plugin_mnet_functions ($component) | |
upgrades the mnet rpc definitions for the given component. | |
upgrade_plugin_savepoint ($result, $version, $type, $plugin, $allowabort=true) | |
Plugins upgrade savepoint, marks end of blocks upgrade blocks It stores plugin version, resets upgrade timeout and abort upgrade if user cancels page loading. | |
upgrade_plugins ($type, $startcallback, $endcallback, $verbose) | |
Upgrade plugins. | |
object | upgrade_plugins_blocks ($startcallback, $endcallback, $verbose) |
This function finds all available blocks and install them into blocks table or do all the upgrade process if newer. | |
object | upgrade_plugins_modules ($startcallback, $endcallback, $verbose) |
Find and check all modules and load them up or upgrade them if necessary. | |
upgrade_set_timeout ($max_execution_time=300) | |
Sets maximum expected time needed for upgrade task. | |
object | upgrade_setup_debug ($starting) |
@global object | |
upgrade_stale_php_files_present () | |
Detect if there are leftovers in PHP source files. | |
object | upgrade_started ($preinstall=false) |
Marks start of upgrade, blocks any other access to site. | |
upgrade_themes () | |
Build the current theme so that the user doesn't have to wait for it to build on the first page load after the install / upgrade. | |
stdClass | user_accesstime_log ($courseid=0) |
Store user last access times - called when use enters a course or site. | |
object | user_can_create_courses () |
@uses CONTEXT_COURSECAT | |
user_get_participants ($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search, $additionalwhere='', $additionalparams=array(), $sort='', $limitfrom=0, $limitnum=0) | |
Returns the participants for a given course. | |
user_get_participants_sql ($courseid, $groupid=0, $accesssince=0, $roleid=0, $enrolid=0, $statusid=-1, $search='', $additionalwhere='', $additionalparams=array()) | |
Returns the SQL used by the participants table. | |
user_get_total_participants ($courseid, $groupid=0, $accesssince=0, $roleid=0, $enrolid=0, $statusid=-1, $search='', $additionalwhere='', $additionalparams=array()) | |
Returns the total number of participants for a given course. | |
user_not_fully_set_up ($user, $strict=true) | |
Determines if a user has completed setting up their account. | |
user_preference_allow_ajax_update ($name, $paramtype) | |
You need to call this function if you wish to use the set_user_preference method in javascript_static.php, to white-list the preference you want to update from JavaScript, and to specify the type of cleaning you expect to be done on values. | |
userdate ($date, $format='', $timezone=99, $fixday=true, $fixhour=true) | |
Returns a formatted string that represents a date in user time. | |
userdate_htmltime ($date, $format='', $timezone=99, $fixday=true, $fixhour=true) | |
Returns a html "time" tag with both the exact user date with timezone information as a datetime attribute in the W3C format, and the user readable date and time as text. | |
useredit_shared_definition_preferences () | |
usergetdate ($time, $timezone=99) | |
Given a $time timestamp in GMT (seconds since epoch), returns an array that represents the Gregorian date in user time. | |
usergetmidnight ($date, $timezone=99) | |
Given a time, return the GMT timestamp of the most recent midnight for the current user. | |
username_load_fields_from_object ($addtoobject, $secondobject, $prefix=null, $additionalfields=null) | |
Reduces lines of duplicated code for getting user name fields. | |
users_order_by_sql (string $usertablealias='', string $search=null, context $context=null, array $customfieldmappings=[]) | |
This function generates the standard ORDER BY clause for use when generating lists of users. | |
users_search_sql (string $search, string $u='u', bool $searchanywhere=true, array $extrafields=[], array $exclude=null, array $includeonly=null) | |
Returns SQL used to search through user table to find users (in a query which may also join and apply other conditions). | |
usertime ($date, $timezone=99) | |
Given a GMT timestamp (seconds since epoch), offsets it by the timezone. | |
usertimezone ($timezone=99) | |
Returns a string that prints the user's timezone. | |
valid_uploaded_file ($newfile) | |
Returns current name of file on disk if it exists. | |
validate_email ($address) | |
Validates an email to make sure it makes sense. | |
validate_internal_user_password ($user, $password) | |
Compare password against hash stored in user object to determine if it is valid. | |
validate_param ($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') | |
Strict validation of parameter values, the values are only converted to requested PHP type. | |
validate_user_key ($keyvalue, $script, $instance) | |
Validates a user key, checking if the key exists, is not expired and the remote ip is correct. | |
want_read_slave () | |
Returns whether we want to connect to slave database for read queries. | |
wikify_links ($string) | |
This expression turns links into something nice in a text format. | |
workaround_max_input_vars () | |
Try to work around the 'max_input_vars' restriction if necessary. | |
xmldb_debug ($message, $object) | |
This function is the official hook inside XMLDB stuff to delegate its debug to one external function. | |
xmlize ($data, $whitespace=1, $encoding='UTF-8', $reporterrors=false) | |
XML parsing function calles into class. | |
object | zip_files ($originalfiles, $destination) |
Zip an array of files/dirs to a destination zip file Both parameters must be FULL paths to the files/dirs. | |
Variables | |
$branch = '402' | |
$capabilities | |
bool | filterobject::$casesensitive |
whether the match needs to be case sensitive. | |
global | $CFG |
$CFG = new stdClass() | |
global object | $CFG |
$CFG | |
global | core\hub::$CFG |
global | core\task::$CFG |
global | core_admin\local\settings::$CFG |
if(file_exists('install/distrolib.php')) | $config = new stdClass() |
$configfile = './config.php' | |
$content = '' | |
context | moodle_text_filter::$context |
The context we are in. | |
global | $COURSE |
$COURSE = new stdClass() | |
global | $DB |
resource | $dbhreadonly |
slave read only database handle | |
$definitions | |
$distro = null | |
if(file_exists(__DIR__.'/../config.php')) | $files = array('boost/style/moodle.css') |
int | performance_measuring_filter_manager::$filterscreated = 0 |
number of filter objects created. | |
bool | filterobject::$fullmatch |
whether to match complete words. | |
$handlers | |
$hint_admindir = '' | |
$hint_database = '' | |
$hint_dataroot = '' | |
string | filterobject::$hreftagbegin |
HTML to insert before any match. | |
string | filterobject::$hreftagend |
HTML to insert after any match. | |
$languages = get_string_manager()->get_list_of_translations() | |
array | moodle_text_filter::$localconfig |
Any local configuration for this filter in this context. | |
$logs | |
$maturity = MATURITY_STABLE | |
$memlimit = @ini_get('memory_limit') | |
$messageproviders | |
$models | |
$name ='Courier' | |
$observers | |
if($hassiteconfig) | $pages = array() |
string | filterobject::$phrase |
this is the phrase that should be matched. | |
foreach($pages as $page) if( $hassiteconfig) if($hassiteconfig) | $plugins = core_plugin_manager::instance()->get_plugins_of_type('tool') |
Add all admin tools. | |
$plugins | |
$release = '4.2.8 (Build: 20240610)' | |
$renamedclasses | |
null callable | filterobject::$replacementcallback |
hold a replacement function to be called. | |
null array | filterobject::$replacementcallbackdata |
data to be passed to $replacementcallback. | |
null string | filterobject::$replacementphrase |
replacement text to go inside begin and end. | |
global | $SESSION |
static filter_manager | filter_manager::$singletoninstance |
Holds the singleton instance. | |
global | $SITE |
global | $SITE |
$SITE = $COURSE | |
array | filter_manager::$stringfilternames = array() |
Exploded version of $CFG->stringfilters. | |
moodle_text_filter[][] | filter_manager::$stringfilters = array() |
This list of active filters, by context, for filtering strings. | |
int | performance_measuring_filter_manager::$stringsfiltered = 0 |
number of calls to filter_string. | |
$strmnetedithost = get_string('reviewhostdetails', 'mnet') | |
if(!defined('MOODLE_INTERNAL')) | $strmnetservices = get_string('mnetservices', 'mnet') |
$tabs = array() | |
$tagareas | |
$tasks | |
$tasks | |
moodle_text_filter[][] | filter_manager::$textfilters = array() |
This list of active filters, by context, for filtering content. | |
int | performance_measuring_filter_manager::$textsfiltered = 0 |
number of calls to filter_text. | |
stdClass | core\task::$tracestats = null |
global | $USER |
$version = 2023042408.00 | |
null string | filterobject::$workregexp = null |
once initialised, holds the regexp for matching this phrase. | |
null string | filterobject::$workreplacementphrase = null |
once initialised, holds the mangled HTML to replace the regexp with. | |
color | __pad0__ |
background | __pad1__ |
margin | __pad2__ |
padding | __pad3__ |
margin | __pad4__ |
border | __pad5__ |
margin | __pad6__ |
padding | __pad7__ |
$config | admin = 'admin' |
$CFG | admin = $config->admin |
const | AJAX_SCRIPT false |
text | align |
const | ALLOW_GET_PARAMETERS true |
const | ANY_VERSION 'any' |
Any version - special value that can be used in $plugin->dependencies in version.php files. | |
font | Arial |
if write to the Free Software Temple MA USA **Copy of GNU Lesser General Public License | at |
const | AUTH_CONFIRM_ALREADY 2 |
const | AUTH_CONFIRM_ERROR 3 |
const | AUTH_CONFIRM_FAIL 0 |
Authentication - error codes for user confirm. | |
const | AUTH_CONFIRM_OK 1 |
const | AUTH_DENIED 2 |
Returned when the login was denied (a reason for AUTH_FAIL). | |
const | AUTH_ERROR 4 |
Returned when some error occurred (a reason for AUTH_FAIL). | |
const | AUTH_FAIL 1 |
Returned when the login was unsuccessful. | |
const | AUTH_LOGIN_FAILED 3 |
Can not login, most probably password did not match. | |
const | AUTH_LOGIN_LOCKOUT 4 |
Can not login because user is locked out. | |
const | AUTH_LOGIN_NOUSER 1 |
Can not login because user does not exist. | |
const | AUTH_LOGIN_OK 0 |
Login attempt successful. | |
const | AUTH_LOGIN_SUSPENDED 2 |
Can not login because user is suspended. | |
const | AUTH_LOGIN_UNAUTHORISED 5 |
Can not login becauser user is not authorised. | |
const | AUTH_OK 0 |
Returned when the login was successful. | |
const | AUTH_PASSWORD_NOT_CACHED 'not cached' |
Authentication constant: String used in password field when password is not stored. | |
const | AUTH_REMOVEUSER_FULLDELETE 2 |
const | AUTH_REMOVEUSER_KEEP 0 |
const | AUTH_REMOVEUSER_SUSPEND 1 |
const | BACKPACK_MOVE_DOWN 1 |
const | BACKPACK_MOVE_UP -1 |
$CFG | backuptempdir = $CFG->tempdir.'/backup' |
const | BADGE_BACKPACKAPIURL 'https://backpack.openbadges.org' |
const | BADGE_BACKPACKWEBURL 'https://backpack.openbadges.org' |
const | BADGE_CRITERIA_AGGREGATION_ALL 1 |
const | BADGE_CRITERIA_AGGREGATION_ANY 2 |
const | BADGE_CRITERIA_TYPE_ACTIVITY 1 |
const | BADGE_CRITERIA_TYPE_BADGE 7 |
const | BADGE_CRITERIA_TYPE_COHORT 8 |
const | BADGE_CRITERIA_TYPE_COMPETENCY 9 |
const | BADGE_CRITERIA_TYPE_COURSE 4 |
const | BADGE_CRITERIA_TYPE_COURSESET 5 |
const | BADGE_CRITERIA_TYPE_MANUAL 2 |
const | BADGE_CRITERIA_TYPE_OVERALL 0 |
const | BADGE_CRITERIA_TYPE_PROFILE 6 |
const | BADGE_CRITERIA_TYPE_SOCIAL 3 |
const | BADGE_MESSAGE_ALWAYS 1 |
const | BADGE_MESSAGE_DAILY 2 |
const | BADGE_MESSAGE_MONTHLY 4 |
const | BADGE_MESSAGE_NEVER 0 |
const | BADGE_MESSAGE_WEEKLY 3 |
const | BADGE_PERPAGE 50 |
const | BADGE_STATUS_ACTIVE 1 |
const | BADGE_STATUS_ACTIVE_LOCKED 3 |
const | BADGE_STATUS_ARCHIVED 4 |
const | BADGE_STATUS_INACTIVE 0 |
const | BADGE_STATUS_INACTIVE_LOCKED 2 |
const | BADGE_TYPE_COURSE 2 |
const | BADGE_TYPE_SITE 1 |
const | BADGRIO_BACKPACKAPIURL 'https://api.badgr.io/v2' |
const | BADGRIO_BACKPACKWEBURL 'https://badgr.io' |
const | BEHAT_EXITCODE_CONFIG 250 |
const | BEHAT_EXITCODE_INSTALL 254 |
const | BEHAT_EXITCODE_INSTALLED 256 |
const | BEHAT_EXITCODE_PERMISSIONS 252 |
const | BEHAT_EXITCODE_REINSTALL 253 |
const | BEHAT_EXITCODE_REQUIREMENT 251 |
const | BEHAT_PARALLEL_SITE_NAME "behatrun" |
The behat test site fullname and shortname. | |
font | BlinkMacSystemFont |
const | BLOCK_ADDBLOCK_POSITION_CUSTOM -1 |
const | BLOCK_ADDBLOCK_POSITION_DEFAULT 0 |
const | BLOCK_ADDBLOCK_POSITION_FLATNAV 1 |
const | BLOCK_POS_LEFT 'side-pre' |
#+ Default names for the block regions in the standard theme. | |
const | BLOCK_POS_RIGHT 'side-post' |
const | BLOG_COURSE_LEVEL 3 |
const | BLOG_GLOBAL_LEVEL 5 |
const | BLOG_GROUP_LEVEL 2 |
const | BLOG_SITE_LEVEL 4 |
const | BLOG_USER_LEVEL 1 |
if write to the Free Software Temple | Boston |
const | BUI_CONTEXTS_CURRENT 0 |
const | BUI_CONTEXTS_CURRENT_SUBS 1 |
const | BUI_CONTEXTS_ENTIRE_SITE 2 |
const | BUI_CONTEXTS_FRONTPAGE_ONLY 0 |
#- | |
const | BUI_CONTEXTS_FRONTPAGE_SUBS 1 |
const | CACHE_DISABLE_ALL true |
$CFG | cachedir = $CFG->dataroot.'/cache' |
const | CLI_SCRIPT (file_exists($configfile)) false |
background | color |
const | COMPONENT_ERROR 0 |
const | COMPONENT_INSTALLED 3 |
const | COMPONENT_NEEDUPDATE 2 |
const | COMPONENT_UPTODATE 1 |
const | CONTACT_SUPPORT_ANYONE 2 |
Contact site support form/link available to anyone visiting the site. | |
const | CONTACT_SUPPORT_AUTHENTICATED 1 |
Contact site support form/link only available to authenticated users. | |
const | CONTACT_SUPPORT_DISABLED 0 |
Contact site support form/link disabled. | |
const | core\task::CORE_TASK_TASKS_FILENAME 'db/tasks.php' |
const | COURSE_DISPLAY_MULTIPAGE 1 |
Course display settings: split pages into a page per section. | |
const | COURSE_DISPLAY_SINGLEPAGE 0 |
Course display settings: display all sections on one page. | |
const | CUSTOM_CHECK_FILE_MISSING 13 |
XML Processing Error. | |
const | CUSTOM_CHECK_FUNCTION_MISSING 14 |
XML Processing Error. | |
alert | danger |
$config | dataroot = empty($distro->dataroot) ? null : $distro->dataroot |
$CFG | dataroot = $config->dataroot |
const | DAYMINS 1440 |
Time constant - the number of minutes in a day. | |
const | DAYSECS 86400 |
Time constant - the number of seconds in a day. | |
$config | dbhost = empty($distro->dbhost) ? 'localhost' : $distro->dbhost |
$config | dbname = 'moodle' |
$config | dbpass = '' |
$config | dbport = empty($distro->dbport) ? '' : $distro->dbport |
$config | dbsocket = empty($distro->dbsocket) ? '' : $distro->dbsocket |
$config | dbtype = empty($distro->dbtype) ? '' : $distro->dbtype |
$config | dbuser = empty($distro->dbuser) ? '' : $distro->dbuser |
$CFG | debug = (E_ALL | E_STRICT) |
const | DEBUG_ALL E_ALL & ~E_STRICT |
All problems except strict PHP warnings. | |
const | DEBUG_DEVELOPER E_ALL | E_STRICT |
DEBUG_ALL with all debug messages and strict warnings. | |
const | DEBUG_MINIMAL E_ERROR | E_PARSE |
Fatal errors only. | |
const | DEBUG_NONE 0 |
No warnings and errors at all. | |
const | DEBUG_NORMAL E_ERROR | E_PARSE | E_WARNING | E_NOTICE |
Errors, warnings and notices. | |
$CFG | debugdeveloper = true |
$CFG | debugdisplay = true |
defined ( 'HUB_MOODLEORGHUBURL')||define( 'HUB_MOODLEORGHUBURL' | |
URL of the Moodle sites registration portal. | |
die | |
$CFG | directorypermissions = isset($distro->directorypermissions) ? $distro->directorypermissions : 00777 |
$CFG | dirroot = __DIR__ |
$CFG | docroot = 'https://docs.moodle.org' |
$CFG | early_install_lang = true |
if(isset($mnet_peer->id) && $mnet_peer->id > 0) | else |
if(isset($_REQUEST['lang'])) | else |
if(isset($_REQUEST['admin'])) | else |
if(!function_exists( 'iconv')) if(PHP_INT_SIZE > 4) | else |
if(!empty($_POST)) | else |
if(defined('COMPONENT_CLASSLOADER')) | else |
if($distro) | else |
const | EMAIL_VIA_ALWAYS 1 |
Email from header to always include via information. | |
const | EMAIL_VIA_NEVER 0 |
Email from header to never include via information. | |
const | EMAIL_VIA_NO_REPLY_ONLY 2 |
Email from header to only include via information if the address is no-reply. | |
const | ENROL_ACTION_EDIT 'editenrolment' |
Edit enrolment action. | |
const | ENROL_ACTION_UNENROL 'unenrol' |
Unenrol action. | |
const | ENROL_DO_NOT_SEND_EMAIL 0 |
Do not send email. | |
const | ENROL_EXT_REMOVED_KEEP 1 |
When user disappears from external source, the enrolment is kept as is - one way sync. | |
const | ENROL_EXT_REMOVED_SUSPEND 2 |
When user disappears from external source, user enrolment is suspended, roles are kept as is. | |
const | ENROL_EXT_REMOVED_SUSPENDNOROLES 3 |
When user disappears from external source, the enrolment is suspended and roles assigned by enrol instance are removed. | |
const | ENROL_EXT_REMOVED_UNENROL 0 |
When user disappears from external source, the enrolment is completely removed. | |
const | ENROL_INSTANCE_DISABLED 1 |
Course enrol instance disabled, user may enter course if other enrol instance enabled. | |
const | ENROL_INSTANCE_ENABLED 0 |
Course enrol instance enabled. | |
const | ENROL_MAX_TIMESTAMP 2147483647 |
The timestamp indicating forever. | |
const | ENROL_REQUIRE_LOGIN_CACHE_PERIOD 1800 |
const | ENROL_RESTORE_TYPE 'enrolrestore' |
const | ENROL_SEND_EMAIL_FROM_COURSE_CONTACT 1 |
Send email from course contact. | |
const | ENROL_SEND_EMAIL_FROM_KEY_HOLDER 2 |
Send email from enrolment key holder. | |
const | ENROL_SEND_EMAIL_FROM_NOREPLY 3 |
Send email from no reply address. | |
const | ENROL_USER_ACTIVE 0 |
User is active participant (used in user_enrolments->status) | |
const | ENROL_USER_SUSPENDED 1 |
User participation in course is suspended (used in user_enrolments->status) | |
const | ENV_SELECT_DATAROOT 1 |
To enforce the use of the file under dataroot. | |
const | ENV_SELECT_NEWER 0 |
Define algorithm used to select the xml file. | |
const | ENV_SELECT_RELEASE 2 |
To enforce the use of the file under admin (release) | |
const | EXTERNAL_TOKEN_EMBEDDED 1 |
Security token used for allowing access of embedded applications, the code is executed in the active user session. | |
const | EXTERNAL_TOKEN_PERMANENT 0 |
Security token used for allowing access from external application such as web services. | |
font | family |
const | FEATURE_ADVANCED_GRADING 'grade_advanced_grading' |
True if module supports advanced grading methods. | |
const | FEATURE_BACKUP_MOODLE2 'backup_moodle2' |
True if module supports backup/restore of moodle2 format. | |
const | FEATURE_COMMENT 'comment' |
const | FEATURE_COMPLETION_HAS_RULES 'completion_has_rules' |
True if module has custom completion rules. | |
const | FEATURE_COMPLETION_TRACKS_VIEWS 'completion_tracks_views' |
True if module has code to track whether somebody viewed it. | |
const | FEATURE_CONTROLS_GRADE_VISIBILITY 'controlsgradevisbility' |
True if module controls the grade visibility over the gradebook. | |
const | FEATURE_GRADE_HAS_GRADE 'grade_has_grade' |
True if module can provide a grade. | |
const | FEATURE_GRADE_OUTCOMES 'outcomes' |
True if module supports outcomes. | |
const | FEATURE_GROUPINGS 'groupings' |
True if module supports groupings. | |
const | FEATURE_GROUPMEMBERSONLY 'groupmembersonly' |
True if module supports groupmembersonly (which no longer exists) | |
const | FEATURE_GROUPS 'groups' |
True if module supports groups. | |
const | FEATURE_IDNUMBER 'idnumber' |
True (which is default) if the module wants support for setting the ID number for grade calculation purposes. | |
const | FEATURE_MOD_ARCHETYPE 'mod_archetype' |
Type of module. | |
const | FEATURE_MOD_INTRO 'mod_intro' |
True if module supports intro editor. | |
const | FEATURE_MOD_PURPOSE 'mod_purpose' |
Type of module. | |
const | FEATURE_MODEDIT_DEFAULT_COMPLETION 'modedit_default_completion' |
True if module has default completion. | |
const | FEATURE_NO_VIEW_LINK 'viewlink' |
True if module has no 'view' page (like label) | |
const | FEATURE_PLAGIARISM 'plagiarism' |
True if module supports plagiarism plugins. | |
const | FEATURE_RATE 'rate' |
const | FEATURE_SHOW_DESCRIPTION 'showdescription' |
True if module can show description on course main page. | |
const | FEATURE_USES_QUESTIONS 'usesquestions' |
True if module uses the question bank. | |
$CFG | filepermissions = ($CFG->directorypermissions & 0666) |
foreach ( $languages as $name=> $value) = core_plugin_manager::instance()->get_plugins_of_type('local') | |
Add all local plugins - must be always last! | |
const | FORMAT_HTML '1' |
Plain HTML (with some tags stripped). | |
const | FORMAT_MARKDOWN '4' |
Markdown-formatted text http://daringfireball.net/projects/markdown/. | |
const | FORMAT_MOODLE '0' |
Does all sorts of transformations and filtering. | |
const | FORMAT_PLAIN '2' |
Plain text (even tags are printed in full). | |
const | FORMAT_WIKI '3' |
Wiki-formatted text. | |
you can redistribute it and or *modify it under the terms of the GNU Lesser General Public *License as published by the Free Software | Foundation |
const | GETREMOTEADDR_SKIP_DEFAULT GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR|GETREMOTEADDR_SKIP_HTTP_CLIENT_IP |
GETREMOTEADDR_SKIP_DEFAULT defines the default behavior remote IP address validation. | |
const | GETREMOTEADDR_SKIP_HTTP_CLIENT_IP '1' |
Get remote addr constant. | |
const | GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR '2' |
Get remote addr constant. | |
h1 | |
line | height |
const | HOMEPAGE_MY 1 |
The home page should be the users my page. | |
const | HOMEPAGE_MYCOURSES 3 |
The home page should be the users my courses page. | |
const | HOMEPAGE_SITE 0 |
The home page should be the site home. | |
const | HOMEPAGE_USER 2 |
The home page can be chosen by the user. | |
const | HOURMINS 60 |
Time constant - the number of minutes in an hour. | |
const | HOURSECS 3600 |
Time constant - the number of seconds in an hour. | |
**ingroup core *subpackage backup convert *copyright Darko Miletic< dmiletic @moodlerooms.com > *license | http |
**ingroup core *subpackage backup convert *copyright Darko Miletic< dmiletic @moodlerooms.com > *license | http |
$CFG | httpswwwroot = $CFG->wwwroot |
$COURSE | id = 1 |
if (!defined( 'MOODLE_INTERNAL')) | |
if (!defined( 'MOODLE_INTERNAL')) | |
if (!defined( 'MOODLE_INTERNAL')) | |
if (!empty( $memlimit) and $memlimit !=-1) | |
const | IGNORE_COMPONENT_CACHE true |
const | IGNORE_MISSING 0 |
Return false if record not found, show debug warning if multiple records found. | |
const | IGNORE_MULTIPLE 1 |
Similar to IGNORE_MISSING but does not show debug warning if multiple records found, not recommended to be used. | |
if write to the Free Software | Inc |
const | INCORRECT_FEEDBACK_FOR_OPTIONAL 17 |
XML Processing Error. | |
const | INCORRECT_FEEDBACK_FOR_REQUIRED 16 |
XML Processing Error. | |
const | INSECURE_DATAROOT_ERROR 2 |
const | INSECURE_DATAROOT_WARNING 1 |
Add libraries. | |
const | INSTALL_DATABASE 5 |
INSTALL_DATABASE = 5. | |
const | INSTALL_DATABASETYPE 4 |
INSTALL_DATABASETYPE = 4. | |
const | INSTALL_DOWNLOADLANG 3 |
INSTALL_DOWNLOADLANG = 3. | |
const | INSTALL_ENVIRONMENT 1 |
INSTALL_ENVIRONMENT = 1. | |
const | INSTALL_PATHS 2 |
INSTALL_PATHS = 2. | |
const | INSTALL_SAVE 6 |
INSTALL_SAVE = 6. | |
const | INSTALL_WELCOME 0 |
INSTALL_WELCOME = 0. | |
$config | lang = $lang |
$CFG | lang = $config->lang |
$CFG | langlocalroot = $CFG->dataroot.'/lang' |
$CFG | langotherroot = $CFG->dataroot.'/lang' |
$CFG | libdir = "$CFG->dirroot/lib" |
without even the implied warranty of *MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU *Lesser General Public License for more details **You should have received a copy of the GNU Lesser General Public *License along with this | library |
either *version of the | License |
const | LIST_DEFINITION 4 |
const | LIST_NONE 1 |
#- | |
const | LIST_ORDERED 3 |
const | LIST_UNORDERED 2 |
$CFG | localcachedir = $CFG->dataroot.'/localcache' |
trait | core\task::logging_trait |
This trait includes functions to assist with logging in tasks. | |
const | MATURITY_ALPHA 50 |
Software maturity level - internals can be tested using white box techniques. | |
const | MATURITY_BETA 100 |
Software maturity level - feature complete, ready for preview and testing. | |
const | MATURITY_RC 150 |
Software maturity level - tested, will be released unless there are fatal bugs. | |
const | MATURITY_STABLE 200 |
Software maturity level - ready for production deployment. | |
const | MAX_COURSE_CATEGORIES 10000 |
The maximum number of course categories MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer! | |
const | MAX_COURSES_IN_CATEGORY 10000 |
The maximum courses in a category MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer! | |
const | MAX_FILENAME_SIZE 100 |
Maximum filename char size. | |
const | MDL_PERF_TEST false |
const | MEMORY_EXTRA -3 |
Large memory limit for given platform - used in cron, upgrade, and other places that need a lot of memory. | |
const | MEMORY_HUGE -4 |
Extremely large memory limit - not recommended for standard scripts. | |
const | MEMORY_STANDARD -2 |
Standard memory limit for given platform. | |
const | MEMORY_UNLIMITED -1 |
Remove any memory limits. | |
const | MINSECS 60 |
Time constant - the number of seconds in a minute. | |
const | MOD_ARCHETYPE_ASSIGNMENT 2 |
Assignment module archetype. | |
const | MOD_ARCHETYPE_OTHER 0 |
Unspecified module archetype. | |
const | MOD_ARCHETYPE_RESOURCE 1 |
Resource-like type module. | |
const | MOD_ARCHETYPE_SYSTEM 3 |
System (not user-addable) module archetype. | |
const | MOD_PURPOSE_ADMINISTRATION 'administration' |
Module purpose administration. | |
const | MOD_PURPOSE_ASSESSMENT 'assessment' |
Module purpose assessment. | |
const | MOD_PURPOSE_COLLABORATION 'collaboration' |
Module purpose communication. | |
const | MOD_PURPOSE_COMMUNICATION 'communication' |
Module purpose communication. | |
const | MOD_PURPOSE_CONTENT 'content' |
Module purpose content. | |
const | MOD_PURPOSE_INTERFACE 'interface' |
Module purpose interface. | |
const | MOD_PURPOSE_OTHER 'other' |
Module purpose other. | |
const | MOODLE_INTERNAL true |
Used by library scripts to check they are being called by Moodle. | |
const | MOODLE_OFFICIAL_MOBILE_SERVICE 'moodle_mobile_app' |
Moodle mobile app service name. | |
trait | moodle_read_slave_trait |
Trait to wrap connect() method of database driver classes that gives ability to use read only slave instances for SELECT queries. | |
const | MUST_EXIST 2 |
Indicates exactly one record must exist. | |
const | NAVIGATION_CACHE_NAME 'navigation' |
The name that will be used to separate the navigation cache within SESSION. | |
const | NAVIGATION_SITE_ADMIN_CACHE_NAME 'navigationsiteadmin' |
const | NO_CUSTOM_CHECK_FOUND 12 |
XML Processing Error. | |
const | NO_DATABASE_SECTION_FOUND 2 |
XML Processing Error. | |
const | NO_DATABASE_VENDOR_MYSQL_FOUND 4 |
XML Processing Error. | |
const | NO_DATABASE_VENDOR_POSTGRES_FOUND 5 |
XML Processing Error. | |
const | NO_DATABASE_VENDOR_VERSION_FOUND 10 |
XML Processing Error. | |
const | NO_DATABASE_VENDORS_FOUND 3 |
XML Processing Error. | |
const | NO_ERROR 0 |
Add required files. | |
const | NO_MOODLE_COOKIES true |
const | NO_PHP_EXTENSIONS_NAME_FOUND 9 |
XML Processing Error. | |
const | NO_PHP_EXTENSIONS_SECTION_FOUND 8 |
XML Processing Error. | |
const | NO_PHP_SECTION_FOUND 6 |
XML Processing Error. | |
const | NO_PHP_SETTINGS_NAME_FOUND 15 |
XML Processing Error. | |
const | NO_PHP_VERSION_FOUND 7 |
XML Processing Error. | |
const | NO_UNICODE_SECTION_FOUND 11 |
XML Processing Error. | |
const | NO_VERSION_DATA_FOUND 1 |
XML Processing Error. | |
if | not |
const | NULL_ALLOWED true |
NULL_ALLOWED - the parameter can be set to null in the database. | |
const | NULL_NOT_ALLOWED false |
NULL_NOT_ALLOWED - the parameter can not be set to null in the database. | |
const | OPEN_BADGES_V1 1 |
const | OPEN_BADGES_V2 2 |
const | OPEN_BADGES_V2_CONTEXT 'https://w3id.org/openbadges/v2' |
const | OPEN_BADGES_V2_TYPE_ASSERTION 'Assertion' |
const | OPEN_BADGES_V2_TYPE_AUTHOR 'Author' |
const | OPEN_BADGES_V2_TYPE_BADGE 'BadgeClass' |
const | OPEN_BADGES_V2_TYPE_ENDORSEMENT 'Endorsement' |
const | OPEN_BADGES_V2_TYPE_ISSUER 'Issuer' |
const | OPEN_BADGES_V2P1 2.1 |
$CFG | ostype = (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) ? 'WINDOWS' : 'UNIX' |
border | padding |
const | PAGE_COURSE_VIEW 'course-view' |
PAGE_COURSE_VIEW is a definition of a page type. | |
const | PARAM_ACTION 'alphanumext' |
PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls NOTE: originally alias for PARAM_APLHA. | |
const | PARAM_ALPHA 'alpha' |
PARAM_ALPHA - contains only English ascii letters [a-zA-Z]. | |
const | PARAM_ALPHAEXT 'alphaext' |
PARAM_ALPHAEXT the same contents as PARAM_ALPHA (English ascii letters [a-zA-Z]) plus the chars in quotes: "_-" allowed NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed. | |
const | PARAM_ALPHANUM 'alphanum' |
PARAM_ALPHANUM - expected numbers 0-9 and English ascii letters [a-zA-Z] only. | |
const | PARAM_ALPHANUMEXT 'alphanumext' |
PARAM_ALPHANUMEXT - expected numbers 0-9, letters (English ascii letters [a-zA-Z]) and _- only. | |
const | PARAM_AREA 'area' |
PARAM_AREA is a name of area used when addressing files, comments, ratings, etc. | |
const | PARAM_AUTH 'auth' |
PARAM_AUTH - actually checks to make sure the string is a valid auth plugin. | |
const | PARAM_BASE64 'base64' |
PARAM_BASE64 - Base 64 encoded format. | |
const | PARAM_BOOL 'bool' |
PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls. | |
const | PARAM_CAPABILITY 'capability' |
PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. | |
const | PARAM_CLEAN 'clean' |
PARAM_CLEAN - obsoleted, please use a more specific type of parameter. | |
const | PARAM_CLEANFILE 'file' |
PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too. | |
const | PARAM_CLEANHTML 'cleanhtml' |
PARAM_CLEANHTML - cleans submitted HTML code. | |
const | PARAM_COMPONENT 'component' |
PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'. | |
const | PARAM_EMAIL 'email' |
PARAM_EMAIL - an email address following the RFC. | |
const | PARAM_FILE 'file' |
PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals. | |
const | PARAM_FLOAT 'float' |
PARAM_FLOAT - a real/floating point number. | |
const | PARAM_FORMAT 'alphanumext' |
PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc. | |
const | PARAM_HOST 'host' |
PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address) | |
const | PARAM_INT 'int' |
PARAM_INT - integers only, use when expecting only numbers. | |
const | PARAM_INTEGER 'int' |
PARAM_INTEGER - deprecated alias for PARAM_INT. | |
const | PARAM_LANG 'lang' |
PARAM_LANG - checks to see if the string is a valid installed language in the current site. | |
const | PARAM_LOCALISEDFLOAT 'localisedfloat' |
PARAM_LOCALISEDFLOAT - a localised real/floating point number. | |
const | PARAM_LOCALURL 'localurl' |
PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. | |
const | PARAM_MULTILANG 'text' |
PARAM_MULTILANG - deprecated alias of PARAM_TEXT. | |
const | PARAM_NOTAGS 'notags' |
PARAM_NOTAGS - all html tags are stripped from the text. | |
const | PARAM_NUMBER 'float' |
PARAM_NUMBER - deprecated alias of PARAM_FLOAT. | |
const | PARAM_PATH 'path' |
PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals note: the leading slash is not removed, window drive letter is not allowed. | |
const | PARAM_PEM 'pem' |
PARAM_PEM - Privacy Enhanced Mail format. | |
const | PARAM_PERMISSION 'permission' |
PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. | |
const | PARAM_PLUGIN 'plugin' |
PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'paypal', 'completionstatus'. | |
const | PARAM_RAW 'raw' |
PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters. | |
const | PARAM_RAW_TRIMMED 'raw_trimmed' |
PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped. | |
const | PARAM_SAFEDIR 'safedir' |
PARAM_SAFEDIR - safe directory name, suitable for include() and require() | |
const | PARAM_SAFEPATH 'safepath' |
PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths and other references to Moodle code files. | |
const | PARAM_SEQUENCE 'sequence' |
PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9. | |
const | PARAM_STRINGID 'stringid' |
PARAM_STRINGID - used to check if the given string is valid string identifier for get_string() | |
const | PARAM_TAG 'tag' |
PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported. | |
const | PARAM_TAGLIST 'taglist' |
PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.) | |
const | PARAM_TEXT 'text' |
PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. | |
const | PARAM_THEME 'theme' |
PARAM_THEME - Checks to see if the string is a valid theme name in the current site. | |
const | PARAM_TIMEZONE 'timezone' |
PARAM_TIMEZONE - expected timezone. | |
const | PARAM_URL 'url' |
PARAM_URL - expected properly formatted URL. | |
const | PARAM_USERNAME 'username' |
PARAM_USERNAME - Clean username to only contains allowed characters. | |
const | PASSWORD_DIGITS '0123456789' |
const | PASSWORD_LOWER 'abcdefghijklmnopqrstuvwxyz' |
const | PASSWORD_NONALPHANUM '.,;:!?_-+/*@#&$' |
const | PASSWORD_UPPER 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' |
const | PHPUNIT_EXITCODE_CONFIGERROR 135 |
const | PHPUNIT_EXITCODE_CONFIGWARNING 136 |
const | PHPUNIT_EXITCODE_INSTALL 140 |
const | PHPUNIT_EXITCODE_PHPUNITEXTMISSING 131 |
const | PHPUNIT_EXITCODE_PHPUNITMISSING 129 |
const | PHPUNIT_EXITCODE_PHPUNITWRONG 130 |
const | PHPUNIT_EXITCODE_REINSTALL 141 |
const | PHPUNIT_TEST false |
if write to the Free Software Temple | Place |
$config | prefix = 'mdl_' |
const | PWRESET_STATUS_ALREADYSENT 4 |
const | PWRESET_STATUS_NOEMAILSENT 1 |
const | PWRESET_STATUS_OTHEREMAILSENT 3 |
const | PWRESET_STATUS_TOKENSENT 2 |
const | QUESTION_NUMANS 10 |
Constant determines the number of answer boxes supplied in the editing form for multiple choice and similar question types. | |
const | QUESTION_NUMANS_ADD 3 |
Constant determines the number of answer boxes to add in the editing form for multiple choice and similar question types when the user presses 'add form fields button'. | |
const | QUESTION_NUMANS_START 3 |
Constant determines the number of answer boxes supplied in the editing form for multiple choice and similar question types to start with, with the option of adding QUESTION_NUMANS_ADD more answers. | |
const | RECAPTCHA_API_URL 'https://www.recaptcha.net/recaptcha/api.js' |
The reCAPTCHA URL's. | |
const | RECAPTCHA_VERIFY_URL 'https://www.recaptcha.net/recaptcha/api/siteverify' |
const | RENDERER_TARGET_AJAX 'ajax' |
Plain text rendering for Ajax scripts. | |
const | RENDERER_TARGET_CLI 'cli' |
Plain text rendering for CLI scripts and cron. | |
const | RENDERER_TARGET_GENERAL 'general' |
General rendering target, usually normal browser page. | |
const | RENDERER_TARGET_HTMLEMAIL 'htmlemail' |
Rich text html rendering intended for sending via email. | |
const | RENDERER_TARGET_MAINTENANCE 'maintenance' |
General rendering target, usually normal browser page, but with limited capacity to avoid API use. | |
const | RENDERER_TARGET_TEXTEMAIL 'textemail' |
Plain text rendering intended for sending via email. | |
const | RESOURCELIB_DISPLAY_AUTO 0 |
Try the best way. | |
const | RESOURCELIB_DISPLAY_DOWNLOAD 4 |
Force download of file instead of display. | |
const | RESOURCELIB_DISPLAY_EMBED 1 |
Display using object tag. | |
const | RESOURCELIB_DISPLAY_FRAME 2 |
Display inside frame. | |
const | RESOURCELIB_DISPLAY_NEW 3 |
Display normal link in new window. | |
const | RESOURCELIB_DISPLAY_OPEN 5 |
Open directly. | |
const | RESOURCELIB_DISPLAY_POPUP 6 |
Open in "emulated" pop-up without navigation. | |
const | RESOURCELIB_LEGACYFILES_ACTIVE 2 |
Legacy files conversion in progress. | |
const | RESOURCELIB_LEGACYFILES_DONE 1 |
Legacy files conversion marked as completed. | |
const | RESOURCELIB_LEGACYFILES_NO 0 |
Legacy files not needed or new resource. | |
font | Roboto |
$CFG | running_installer = true |
font sans | serif |
const | SITEID 1 |
font sans font | size |
if(isset($_GET['help'])) if(is_null( $CFG->dataroot)) if($config->stage< INSTALL_WELCOME) if( $config->stage > INSTALL_SAVE) if($config->stage==INSTALL_SAVE) if( $config->stage==INSTALL_DOWNLOADLANG) if($config->stage==INSTALL_DOWNLOADLANG) if( $config->stage==INSTALL_DATABASETYPE) if($config->stage==INSTALL_DOWNLOADLANG) if( $config->stage==INSTALL_DATABASE) if($config->stage==INSTALL_DATABASETYPE) if( $config->stage==INSTALL_ENVIRONMENT or $config->stage==INSTALL_PATHS) if($config->stage==INSTALL_PATHS) $config | stage = INSTALL_WELCOME |
const | STATE_BLOCKQUOTE 3 |
const | STATE_NONE 1 |
#+ state defines | |
const | STATE_NOTIKI 5 |
const | STATE_PARAGRAPH 2 |
const | STATE_PREFORM 4 |
const | STATS_MODE_DETAILED 2 |
const | STATS_MODE_GENERAL 1 |
const | STATS_MODE_RANKED 3 |
const | STATS_PLACEHOLDER_OUTPUT '.' |
const | STATS_REPORT_ACTIVE_COURSES 11 |
const | STATS_REPORT_ACTIVE_COURSES_WEIGHTED 12 |
const | STATS_REPORT_ACTIVITY 4 |
const | STATS_REPORT_ACTIVITYBYROLE 5 |
const | STATS_REPORT_LOGINS 1 |
THESE CONSTANTS ARE USED FOR THE REPORTING PAGE. | |
const | STATS_REPORT_PARTICIPATORY_COURSES 13 |
const | STATS_REPORT_PARTICIPATORY_COURSES_RW 14 |
const | STATS_REPORT_READS 2 |
const | STATS_REPORT_USER_ACTIVITY 7 |
const | STATS_REPORT_USER_ALLACTIVITY 8 |
const | STATS_REPORT_USER_LOGINS 9 |
const | STATS_REPORT_USER_VIEW 10 |
const | STATS_REPORT_WRITES 3 |
const | STATS_TIME_LAST10MONTHS 30 |
const | STATS_TIME_LAST11MONTHS 31 |
const | STATS_TIME_LAST2MONTHS 12 |
const | STATS_TIME_LAST2WEEKS 2 |
const | STATS_TIME_LAST3MONTHS 13 |
const | STATS_TIME_LAST3WEEKS 3 |
const | STATS_TIME_LAST4MONTHS 14 |
const | STATS_TIME_LAST4WEEKS 4 |
const | STATS_TIME_LAST5MONTHS 15 |
const | STATS_TIME_LAST6MONTHS 16 |
const | STATS_TIME_LAST7MONTHS 27 |
const | STATS_TIME_LAST8MONTHS 28 |
const | STATS_TIME_LAST9MONTHS 29 |
const | STATS_TIME_LASTWEEK 1 |
const | STATS_TIME_LASTYEAR 32 |
**Library file of miscellaneous general purpose LDAP functions and *data | structures |
if write to the Free Software Temple | Suite |
const | TABLE_P_BOTTOM 2 |
const | TABLE_P_TOP 1 |
#- | |
const | TABLE_SHOW_ALL_PAGE_SIZE 5000 |
#- | |
const | TABLE_VAR_DIR 8 |
const | TABLE_VAR_HIDE 2 |
const | TABLE_VAR_IFIRST 4 |
const | TABLE_VAR_ILAST 5 |
const | TABLE_VAR_PAGE 6 |
const | TABLE_VAR_RESET 7 |
const | TABLE_VAR_SHOW 3 |
const | TABLE_VAR_SORT 1 |
#+ These constants relate to the table's handling of URL parameters. | |
const | TAG_MAX_LENGTH 50 |
To prevent problems with multibytes strings,Flag updating in nav not working on the review page. | |
$CFG | target_release = $release |
$CFG | tempdir = $CFG->dataroot.'/temp' |
const | TESTING_EXITCODE_COMPOSER 255 |
Composer error exit status. | |
const | TEXTFILTER_DISABLED -9999 |
The states a filter can be in, stored in the filter_active table. | |
const | TEXTFILTER_EXCL_SEPARATOR chr(0x1F) . '%' . chr(0x1F) |
Define one exclusive separator that we'll use in the temp saved tags keys. | |
const | TEXTFILTER_INHERIT 0 |
The states a filter can be in, stored in the filter_active table. | |
const | TEXTFILTER_OFF -1 |
The states a filter can be in, stored in the filter_active table. | |
const | TEXTFILTER_ON 1 |
The states a filter can be in, stored in the filter_active table. | |
const | TOKEN_DATEFROM "6" |
const | TOKEN_DATETO "7" |
const | TOKEN_EXACT "2" |
const | TOKEN_INSTANCE "8" |
const | TOKEN_META "1" |
const | TOKEN_NEGATE "3" |
const | TOKEN_STRING "4" |
const | TOKEN_TAGS "9" |
const | TOKEN_USER "0" |
Constants for the various types of tokens. | |
const | TOKEN_USERID "5" |
margin | top |
$CFG | umaskpermissions = (($CFG->directorypermissions & 0777) ^ 0777) |
const | UPGRADE_LOG_ERROR 2 |
UPGRADE_LOG_ERROR = 2. | |
const | UPGRADE_LOG_NORMAL 0 |
UPGRADE_LOG_NORMAL = 0. | |
const | UPGRADE_LOG_NOTICE 1 |
UPGRADE_LOG_NOTICE = 1. | |
const | URL_MATCH_BASE 0 |
A moodle_url comparison using this flag will return true if the base URLs match, params are ignored. | |
const | URL_MATCH_EXACT 2 |
A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params. | |
const | URL_MATCH_PARAMS 1 |
A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2. | |
const | USER_CAN_IGNORE_FILE_SIZE_LIMITS -1 |
Indicates the user has the capabilities required to ignore activity and course file size restrictions. | |
const | VALUE_DEFAULT 0 |
VALUE_DEFAULT - if the parameter is not supplied, then the default value is used. | |
const | VALUE_OPTIONAL 2 |
VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value. | |
const | VALUE_REQUIRED 1 |
VALUE_REQUIRED - if the parameter is not supplied, there is an error. | |
either *version of the or *(at your option) any later version. **This library is distributed in the hope that it will be useful but WITHOUT ANY | WARRANTY |
const | WEEKSECS 604800 |
Time constant - the number of seconds in a week. | |
font | weight |
max | width |
$CFG | wwwroot = install_guess_wwwroot() |
const | YEARSECS 31536000 |
Time constant - the number of seconds in a year. | |
filter_get_name ($filter) | |
Look up the name of this filter. | |
filter_get_all_installed () | |
Get the names of all the filters installed in this Moodle. | |
filter_set_global_state ($filtername, $state, $move=0) | |
Set the global activated state for a text filter. | |
filter_get_active_state (string $filtername, $contextid=null) | |
Returns the active state for a filter in the given context. | |
filter_is_enabled ($filtername) | |
filter_get_globally_enabled () | |
Return a list of all the filters that may be in use somewhere. | |
filter_get_globally_enabled_filters_with_config () | |
Get the globally enabled filters. | |
filter_get_string_filters () | |
Return the names of the filters that should also be applied to strings (when they are enabled). | |
filter_set_applies_to_strings ($filter, $applytostrings) | |
Sets whether a particular active filter should be applied to all strings by format_string, or just used by format_text. | |
filter_set_local_state ($filter, $contextid, $state) | |
Set the local activated state for a text filter. | |
filter_set_local_config ($filter, $contextid, $name, $value) | |
Set a particular local config variable for a filter in a context. | |
filter_unset_local_config ($filter, $contextid, $name) | |
Remove a particular local config variable for a filter in a context. | |
filter_get_local_config ($filter, $contextid) | |
Get local config variables for a filter in a context. | |
filter_get_all_local_settings ($contextid) | |
This function is for use by backup. | |
filter_get_active_in_context ($context) | |
Get the list of active filters, in the order that they should be used for a particular context, along with any local configuration variables. | |
filter_preload_activities (course_modinfo $modinfo) | |
Preloads the list of active filters for all activities (modules) on the course using two database queries. | |
filter_get_available_in_context ($context) | |
List all of the filters that are available in this context, and what the local and inherited states of that filter are. | |
filter_get_global_states () | |
This function is for use by the filter administration page. | |
filter_delete_all_for_filter ($filter) | |
Delete all the data in the database relating to a filter, prior to deleting it. | |
filter_delete_all_for_context ($contextid) | |
Delete all the data in the database relating to a context, used when contexts are deleted. | |
filter_has_global_settings ($filter) | |
Does this filter have a global settings page in the admin tree? (The settings page for a filter must be called, for example, filtersettingfiltertex.) | |
filter_has_local_settings ($filter) | |
Does this filter have local (per-context) settings? | |
filter_context_may_have_filter_settings ($context) | |
Certain types of context (block and user) may not have local filter settings. | |
filter_phrases ($text, $linkarray, $ignoretagsopen=null, $ignoretagsclose=null, $overridedefaultignore=false, $linkarrayalreadyprepared=false) | |
Process phrases intelligently found within a HTML text (such as adding links). | |
filter_prepare_phrases_for_filtering (array $linkarray) | |
Prepare a list of link for processing with filter_phrases(). | |
filter_prepare_phrase_for_replacement (filterobject $linkobject) | |
Fill in the remaining ->work... fields, that would be needed to replace the phrase. | |
filter_remove_duplicates ($linkarray) | |
Remove duplicate from a list of filterobject. | |
filter_save_ignore_tags (&$text, $filterignoretagsopen, $filterignoretagsclose, &$ignoretags) | |
Extract open/lose tags and their contents to avoid being processed by filters. | |
filter_save_tags (&$text, &$tags) | |
Extract tags (any text enclosed by < and > to avoid being processed by filters. | |
filter_add_javascript ($text) | |
Add missing openpopup javascript to HTML files. | |
|
protected |
Constructor.
Protected. Use instance() instead.
filterobject::__construct | ( | $phrase, | |
$hreftagbegin = '<span class="highlight">', | |||
$hreftagend = '</span>', | |||
$casesensitive = false, | |||
$fullmatch = false, | |||
$replacementphrase = null, | |||
$replacementcallback = null, | |||
array | $replacementcallbackdata = null ) |
Constructor.
string | $phrase | this is the phrase that should be matched. |
string | $hreftagbegin | HTML to insert before any match. Default ''. |
string | $hreftagend | HTML to insert after any match. Default ''. |
bool | $casesensitive | whether the match needs to be case sensitive |
bool | $fullmatch | whether to match complete words. If true, 'T' won't be matched in 'Tim'. |
mixed | $replacementphrase | replacement text to go inside begin and end. If not set, the body of the replacement will be the original phrase. |
callback | $replacementcallback | if set, then this will be called just before $hreftagbegin, $hreftagend and $replacementphrase are needed, so they can be computed only if required. The call made is list($linkobject->hreftagbegin, $linkobject->hreftagend, $linkobject->replacementphrase) = call_user_func_array($linkobject->replacementcallback, $linkobject->replacementcallbackdata); so the return should be an array [$hreftagbegin, $hreftagend, $replacementphrase], the last of which may be null. |
array | $replacementcallbackdata | data to be passed to $replacementcallback (optional). |
moodle_text_filter::__construct | ( | $context, | |
array | $localconfig ) |
Set any context-specific configuration for this filter.
context | $context | The current context. |
array | $localconfig | Any context-specific configuration for this filter. |
object _fix_course_cats | ( | $children, | |
& | $sortorder, | ||
$parent, | |||
$depth, | |||
$path, | |||
& | $fixcontexts ) |
Internal recursive category verification function, do not use directly!
@uses CONTEXT_COURSECAT
array | $children | |
int | $sortorder | |
string | $parent | |
int | $depth | |
string | $path | |
array | $fixcontexts |
bool | if changes were made |
_tidy_question | ( | $question, | |
$category, | |||
array | $tagobjects = null, | ||
array | $filtercourses = null ) |
Private function to factor common code out of get_question_options().
object | $question | the question to tidy. |
stdClass | $category | The question_categories record for the given $question. |
core_tag_tag[] | null | $tagobjects | The tags for the given $question. |
stdClass[] | null | $filtercourses | The courses to filter the course tags by. |
abort_all_db_transactions | ( | ) |
Unconditionally abort all database transactions, this function should be called from exception handlers only.
void |
add_event | ( | ) |
CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////.
add_indented_names | ( | $categories, | |
$nochildrenof = -1 ) |
Format categories into an indented list reflecting the tree structure.
array | $categories | An array of category objects, for example from the. |
int | $nochildrenof |
array | The formatted list of categories. |
add_mod_to_section | ( | ) |
moodle_database add_to_config_log | ( | $name, | |
$oldvalue, | |||
$value, | |||
$plugin ) |
Add an entry to the config log table.
These are "action" focussed rather than web server hits, and provide a way to easily reconstruct changes to Moodle configuration.
$DB @global stdClass $USER
string | $name | The name of the configuration change action For example 'filter_active' when activating or deactivating a filter |
string | $oldvalue | The config setting's previous value |
string | $value | The config setting's new value |
string | $plugin | Plugin name, for example a filter name when changing filter configuration |
void |
add_to_log | ( | ) |
address_in_subnet | ( | $addr, | |
$subnetstr, | |||
$checkallzeros = false ) |
Function to check the passed address is within the passed subnet.
The parameter is a comma separated string of subnet definitions. Subnet strings can be in one of three formats: 1: xxx.xxx.xxx.xxx/nn or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/nnn (number of bits in net mask) 2: xxx.xxx.xxx.xxx-yyy or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx::xxxx-yyyy (a range of IP addresses in the last group) 3: xxx.xxx or xxx.xxx. or xxx:xxx:xxxx or xxx:xxx:xxxx. (incomplete address, a bit non-technical ;-) Code for type 1 modified from user posted comments by mediator at
string | $addr | The address you are checking |
string | $subnetstr | The string of subnet addresses |
bool | $checkallzeros | The state to whether check for 0.0.0.0 |
bool |
addslashes_js | ( | $var | ) |
Does proper javascript quoting.
Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
mixed | $var | String, Array, or Object to add slashes to |
mixed | quoted result |
admin_apply_default_settings | ( | $node = null, | |
$unconditional = true, | |||
$admindefaultsettings = array(), | |||
$settingsoutput = array() ) |
settings utility functions
This function applies default settings. Because setting the defaults of some settings can enable other settings, this function is called recursively until no more new settings are found.
object | $node,NULL | means complete tree, null by default |
bool | $unconditional | if true overrides all values with defaults, true by default |
array | $admindefaultsettings | default admin settings to apply. Used recursively |
array | $settingsoutput | The names and values of the changed settings. Used recursively |
array\$settingsoutput | The names and values of the changed settings |
admin_critical_warnings_present | ( | ) |
Test if and critical warnings are present.
bool |
moodle_page admin_externalpage_setup | ( | $section, | |
$extrabutton = '', | |||
array | $extraurlparams = null, | ||
$actualurl = '', | |||
array | $options = array() ) |
Initialise admin page - this function does require login and permission checks specified in page definition.
This function must be called on each admin page before other code.
$PAGE
string | $section | name of page |
string | $extrabutton | extra HTML that is added after the blocks editing on/off button. |
array | $extraurlparams | an array paramname => paramvalue, or parameters that need to be added to the turn blocks editing on/off form, so this page reloads correctly. |
string | $actualurl | if the actual page being viewed is not the normal one for this page (e.g. admin/roles/allow.php, instead of admin/roles/manage.php, you can pass the alternate URL here. |
array | $options | Additional options that can be specified for page setup. pagelayout - This option can be used to set a specific pagelyaout, admin is default. nosearch - Do not display search bar |
admin_find_write_settings | ( | $node, | |
$data ) |
Internal recursive function - finds all settings from submitted form.
object | $node | Instance of admin_category, or admin_settingpage |
array | $data |
array |
admin_get_root | ( | $reload = false, | |
$requirefulltree = true ) |
Returns the reference to admin tree root.
object | admin_root object |
admin_mnet_method_get_docblock | ( | ReflectionFunctionAbstract | $function | ) |
Given some sort of reflection function/method object, return an array of docblock lines, where each line is an array of keywords/descriptions.
ReflectionFunctionAbstract | $function | reflection function/method object from which to extract information |
array | docblock converted in to an array |
admin_mnet_method_get_help | ( | ReflectionFunctionAbstract | $function | ) |
Given some sort of reflection function/method object, return just the help text.
ReflectionFunctionAbstract | $function | reflection function/method object from which to extract information |
string | docblock help text |
admin_mnet_method_profile | ( | ReflectionFunctionAbstract | $function | ) |
Given some sort of reflection function/method object, return a profile array, ready to be serialized and stored.
ReflectionFunctionAbstract | $function | reflection function/method object from which to extract information |
array | associative array with function/method information |
admin_output_new_settings_by_page | ( | $node | ) |
Internal function - returns arrays of html pages with uninitialised settings.
object | $node | Instance of admin_category or admin_settingpage |
array |
admin_search_settings_html | ( | $query | ) |
Internal function - prints the search results.
string | $query | String to search for |
string | empty or XHTML |
admin_write_settings | ( | $formdata | ) |
Store changed settings, this function updates the errors variable in $ADMIN.
object | $formdata | from form |
int | number of changed settings |
ajax_capture_output | ( | ) |
Starts capturing output whilst processing an AJAX request.
This should be used in combination with ajax_check_captured_output to report any captured output to the user.
Boolean | Returns true on success or false on failure. |
ajax_check_captured_output | ( | ) |
Check captured output for content.
If the site has a debug level of debugdeveloper set, and the content is non-empty, then throw a coding exception which can be captured by the Y.IO request and displayed to the user.
Any | output that was captured. |
ajaxenabled | ( | ) |
allow_assign | ( | ) |
allow_override | ( | ) |
allow_switch | ( | ) |
any_new_admin_settings | ( | $node | ) |
Based on find_new_settings() in upgradesettings.php Looks to find any admin settings that have not been initialized.
Returns 1 if it finds any.
object | $node | Instance of admin_category, or admin_settingpage |
boolean | true if any settings haven't been initialised, false if they all have |
|
protected |
Apply a list of filters to some content.
string | $text | |
moodle_text_filter[] | $filterchain | array filter name => filter object. |
array | $options | options passed to the filters. |
array | $skipfilters | of filter names. Any filters that should not be applied to this text. |
string\$text |
array_is_nested | ( | $array | ) |
Check if there is a nested array within the passed array.
array | $array |
bool | true if there is a nested array false otherwise |
authenticate_user_login | ( | $username, | |
$password, | |||
$ignorelockout = false, | |||
& | $failurereason = null, | ||
$logintoken = false ) |
Authenticates a user against the chosen authentication mechanism.
Given a username and password, this function looks them up using the currently selected authentication mechanism, and if the authentication is successful, it returns a valid $user object from the 'user' table.
Uses auth_ functions from the currently active auth module
After authenticate_user_login() returns success, you will need to log that the user has logged in, and call complete_user_login() to set the session up.
Note: this function works only with non-mnet accounts!
string | $username | User's username (or also email if $CFG->authloginviaemail enabled) |
string | $password | User's password |
bool | $ignorelockout | useful when guessing is prevented by other mechanism such as captcha or SSO |
int | $failurereason | login failure reason, can be used in renderers (it may disclose if account exists) |
mixed | logintoken If this is set to a string it is validated against the login token for the session. |
stdClass|false | A $USER object or false if error |
badge_assemble_notification | ( | stdClass | $badge | ) |
Creates single message for all notification and sends it out.
object | $badge | A badge which is notified about. |
badge_award_criteria_competency_has_records_for_competencies | ( | $competencyids | ) |
Check if any badge has records for competencies.
array | $competencyids | Array of competencies ids. |
boolean | Return true if competencies were found in any badge. |
badge_message_from_template | ( | $message, | |
$params ) |
Replaces variables in a message template and returns text ready to be emailed to a user.
string | $message | Message body. |
string | Message with replaced values |
badges_add_course_navigation | ( | navigation_node | $coursenode, |
stdClass | $course ) |
Extends the course administration navigation with the Badges page.
navigation_node | $coursenode | |
object | $course |
badges_award_handle_manual_criteria_review | ( | stdClass | $data | ) |
Triggered when badge is manually awarded.
object | $data |
boolean |
badges_bake | ( | $hash, | |
$badgeid, | |||
$userid = 0, | |||
$pathhash = false ) |
Bake issued badge.
string | $hash | Unique hash of an issued badge. |
int | $badgeid | ID of the original badge. |
int | $userid | ID of badge recipient (optional). |
boolean | $pathhash | Return file pathhash instead of image url (optional). |
string|url | Returns either new file path hash or new file URL |
badges_calculate_message_schedule | ( | $schedule | ) |
Caclulates date for the next message digest to badge creators.
in | $schedule | Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY. |
int | Timestamp for next cron |
badges_change_sortorder_backpacks | ( | int | $backpackid, |
int | $direction ) |
Moves the backpack in the list one position up or down.
int | $backpackid | The backpack identifier to be moved. |
int | $direction | The direction (BACKPACK_MOVE_UP/BACKPACK_MOVE_DOWN) where to move the backpack. |
moodle_exception | if attempting to use invalid direction value. |
badges_check_backpack_accessibility | ( | ) |
Checks if badges can be pushed to external backpack.
string | Code of backpack accessibility status. |
badges_create_site_backpack | ( | $data | ) |
Create the site backpack with this data.
stdClass | $data | The new backpack data. |
boolean |
badges_delete_site_backpack | ( | $id | ) |
Delete the backpack with this id.
integer | $id | The backpack to delete. |
boolean |
badges_disconnect_user_backpack | ( | $userid | ) |
Disconnect from the user backpack by deleting the user preferences.
integer | $userid | The user to diconnect. |
boolean |
badges_download | ( | $userid | ) |
Download all user badges in zip archive.
int | $userid | ID of badge owner. |
badges_external_create_mapping | ( | $sitebackpackid, | |
$type, | |||
$internalid, | |||
$externalid ) |
Save the info about which objects we connected with a backpack before.
integer | $sitebackpackid | The site backpack to connect to. |
string | $type | The type of this remote object. |
string | $internalid | The id for this object on the Moodle site. |
string | $externalid | The id of this object on the remote site. |
boolean |
badges_external_delete_mapping | ( | $sitebackpackid, | |
$type, | |||
$internalid ) |
Delete a specific external mapping information for a backpack.
integer | $sitebackpackid | The site backpack to connect to. |
string | $type | The type of this remote object. |
string | $internalid | The id for this object on the Moodle site. |
boolean |
badges_external_delete_mappings | ( | $sitebackpackid | ) |
Delete all external mapping information for a backpack.
integer | $sitebackpackid | The site backpack to connect to. |
boolean |
badges_external_get_mapping | ( | $sitebackpackid, | |
$type, | |||
$internalid, | |||
$param = 'externalid' ) |
Used to remember which objects we connected with a backpack before.
integer | $sitebackpackid | The site backpack to connect to. |
string | $type | The type of this remote object. |
string | $internalid | The id for this object on the Moodle site. |
string | $param | The param we need to return. Defaults to the externalid. |
mixed | The id or false if it doesn't exist. |
badges_generate_badgr_open_url | ( | $backpack, | |
$type, | |||
$externalid ) |
Generate a public badgr URL that conforms to OBv2.
This is done because badgr responses do not currently conform to the spec.
WARNING: This is an extremely hacky way of implementing this and should be removed once the standards are conformed to.
stdClass | $backpack | The Badgr backpack we are pushing to |
string | $type | The type of object we are dealing with either Issuer, Assertion OR Badge. |
string | $externalid | The externalid as provided by the backpack |
string | The public URL to access Badgr objects |
badges_get_badge_api_versions | ( | ) |
List the supported badges api versions.
array(version) |
badges_get_badges | ( | $type, | |
$courseid = 0, | |||
$sort = '', | |||
$dir = '', | |||
$page = 0, | |||
$perpage = BADGE_PERPAGE, | |||
$user = 0 ) |
Get all badges.
int | Type of badges to return | |
int | Course ID for course badges | |
string | $sort | An SQL field to sort by |
string | $dir | The sort direction ASC|DESC |
int | $page | The page or records to return |
int | $perpage | The number of records to return per page |
int | $user | User specific search |
array\$badge | Array of records matching criteria |
badges_get_default_issuer | ( | ) |
Get the default issuer for a badge from this site.
array |
badges_get_issued_badge_info | ( | ) |
badges_get_oauth2_service_options | ( | ) |
badges_get_site_backpack | ( | $id, | |
int | $userid = 0 ) |
Get a site backpacks by id for a particular user or site (if userid is 0)
int | $id | The backpack id. |
int | $userid | The owner of the backpack, 0 if it's a sitewide backpack else a user's site backpack |
stdClass |
badges_get_site_backpacks | ( | ) |
List the backpacks at site level.
array(stdClass) |
badges_get_site_primary_backpack | ( | ) |
Get the primary backpack for the site.
stdClass |
badges_get_user_backpack | ( | ?int | $userid = 0 | ) |
Get the user backpack for the currently logged in user OR the provided user.
int | null | $userid | The user whose backpack you're requesting for. If null, get the logged in user's backpack |
mixed | The user's backpack or none. |
dml_exception |
badges_get_user_badges | ( | $userid, | |
$courseid = 0, | |||
$page = 0, | |||
$perpage = 0, | |||
$search = '', | |||
$onlypublic = false ) |
Get badges for a specific user.
int | $userid | User ID |
int | $courseid | Badges earned by a user in a specific course |
int | $page | The page or records to return |
int | $perpage | The number of records to return per page |
string | $search | A simple string to search for |
bool | $onlypublic | Return only public badges |
array | of badges ordered by decreasing date of issue |
badges_handle_course_deletion | ( | $courseid | ) |
Handles what happens to the course badges when a course is deleted.
int | $courseid | course ID. |
void. |
badges_list_criteria | ( | $enabled = true | ) |
Return all the enabled criteria types for this site.
boolean | $enabled |
array |
badges_local_backpack_js | ( | $checksite = false | ) |
No js files are required for backpack support.
This only exists to directly support the custom V1 backpack api.
boolean | $checksite | Call check site function. |
void |
badges_notify_badge_award | ( | badge | $badge, |
$userid, | |||
$issued, | |||
$filepathhash ) |
Sends notifications to users about awarded badges.
core_badges\badge | $badge | Badge that was issued |
int | $userid | Recipient ID |
string | $issued | Unique hash of an issued badge |
string | $filepathhash | File path hash of an issued badge for attachments |
badges_open_badges_backpack_api | ( | ?int | $backpackid = null | ) |
Is any backpack enabled that supports open badges V1?
int | null | $backpackid | Check the version of the given id OR if null the sitewide backpack |
boolean |
badges_process_badge_image | ( | badge | $badge, |
$iconfile ) |
Process badge image from form data.
badge | $badge | Badge object |
string | $iconfile | Original file |
badges_save_backpack_credentials | ( | stdClass | $data | ) |
Create a backpack with the provided details.
Stores the auth details of the backpack
stdClass | $data | Backpack specific data. |
int | The id of the external backpack that the credentials correspond to |
badges_save_external_backpack | ( | stdClass | $data | ) |
Perform the actual create/update of external bakpacks.
Any checks on the validity of the id will need to be performed before it reaches this function.
stdClass | $data | The backpack data we are updating/inserting |
int | Returns the id of the new/updated record |
badges_send_verification_email | ( | $email, | |
$backpackid, | |||
$backpackpassword ) |
Create and send a verification email to the email address supplied.
Since we're not sending this email to a user, email_to_user can't be used but this function borrows largely the code from that process.
string | the email address to send the verification email to. | |
int | $backpackid | the id of the backpack to connect to |
string | $backpackpassword | the user entered password to connect to this backpack |
true | if the email was sent successfully, false otherwise. |
badges_setup_backpack_js | ( | ) |
badges_update_site_backpack | ( | $id, | |
$data ) |
Update the backpack with this id.
integer | $id | The backpack to edit |
stdClass | $data | The new backpack data. |
boolean |
badges_user_has_backpack | ( | $userid | ) |
Checks if user has external backpack connected.
int | $userid | ID of a user. |
bool | True|False whether backpack connection exists. |
badges_verify_backpack | ( | int | $backpackid | ) |
Attempt to authenticate with a backpack credentials and return an error if the authentication fails.
If external backpacks are not enabled or the backpack version is different from OBv2, this will not perform any test.
int | $backpackid | Backpack identifier to verify. |
string | The result of the verification process. |
badges_verify_site_backpack | ( | ) |
Attempt to authenticate with the site backpack credentials and return an error if the authentication fails.
If external backpacks are not enabled, this will not perform any test.
string |
behat_check_config_vars | ( | ) |
Checks that the behat config vars are properly set.
void | Stops execution with error code if something goes wrong. |
behat_clean_init_config | ( | ) |
Restrict the config.php settings allowed.
When running the behat features the config.php settings should not affect the results.
void |
behat_error | ( | $errorcode, | |
$text = '' ) |
Exits with an error code.
mixed | $errorcode | |
string | $text |
void | Stops execution with error code |
behat_error_handler | ( | $errno, | |
$errstr, | |||
$errfile, | |||
$errline ) |
PHP errors handler to use when running behat tests.
Adds specific CSS classes to identify the messages.
int | $errno | |
string | $errstr | |
string | $errfile | |
int | $errline |
bool |
behat_get_command_flags | ( | string | $option, |
$value ) |
Get command flags for an option/value combination.
string | $option | |
string | bool | null | $value |
string |
behat_get_error_string | ( | $errtype | ) |
Return logical error string.
int | $errtype | php error type. |
string | string which will be returned. |
behat_get_run_process | ( | ) |
Get behat run process from either $_SERVER or command config.
bool|int | false if single run, else run process number. |
behat_get_shutdown_process_errors | ( | ) |
Return php errors save which were save during shutdown.
array |
behat_is_requested_url | ( | $url | ) |
Checks if the URL requested by the user matches the provided argument.
string | $url |
bool | Returns true if it matches. |
behat_is_test_site | ( | ) |
Should we switch to the test site data?
bool |
behat_update_vars_for_process | ( | ) |
Fix variables for parallel behat testing.
block_add_block_ui | ( | $page, | |
$output ) |
Functions update the blocks if required by the request parameters ==========.
Return a block_contents representing the add a new block UI, if this user is allowed to see it.
block_contents | an appropriate block_contents, or null if the user cannot add any blocks here. |
block_instance | ( | $blockname, | |
$instance = NULL, | |||
$page = NULL ) |
Creates a new instance of the specified block class.
string | $blockname | the name of the block. |
stdClass | $instance | block_instances DB table row (optional). |
moodle_page | $page | the page this block is appearing on. |
block_base | the requested block instance. |
block_instance_by_id | ( | $blockinstanceid | ) |
Returns a new instance of the specified block instance id.
int | $blockinstanceid |
block_base | the requested block instance. |
block_load_class | ( | $blockname | ) |
Load the block class for a particular type of block.
string | $blockname | the name of the block. |
boolean | success or failure. |
block_method_result | ( | $blockname, | |
$method, | |||
$param = NULL ) |
Helper functions for working with block classes ============================.
Call a class method (one that does not require a block instance) on a block class.
string | $blockname | the name of the block. |
string | $method | the method name. |
array | $param | parameters to pass to the method. |
mixed | whatever the method returns. |
blocks_add_default_course_blocks | ( | $course | ) |
Add the default blocks to a course.
object | $course | a course object. |
blocks_add_default_system_blocks | ( | ) |
Add the default system-context blocks.
E.g. the admin tree.
blocks_delete_all_for_context | ( | $contextid | ) |
Delete all the blocks that belong to a particular context.
int | $contextid | the context id. |
blocks_delete_instance | ( | $instance, | |
$nolongerused = false, | |||
$skipblockstables = false ) |
Delete a block, and associated data.
object | $instance | a row from the block_instances table |
bool | $nolongerused | legacy parameter. Not used, but kept for backwards compatibility. |
bool | $skipblockstables | for internal use only. Makes |
blocks_delete_instances | ( | $instanceids | ) |
Delete multiple blocks at once.
array | $instanceids | A list of block instance ID. |
blocks_find_block | ( | $blockid, | |
$blocksarray ) |
Find a given block by its blockid within a provide array.
int | $blockid | |
array | $blocksarray |
bool|object | Instance if found else false |
blocks_get_default_site_course_blocks | ( | ) |
array | the blocks that should be added to the site course by default. |
blocks_get_record | ( | $blockid = NULL, | |
$notusedanymore = false ) |
Get the block record for a particular blockid - that is, a particular type os block.
$int | blockid block type id. If null, an array of all block types is returned. | |
bool | $notusedanymore | No longer used. |
array|object | row from block table, or all rows. |
blocks_name_allowed_in_format | ( | $name, | |
$pageformat ) |
Check that a given name is in a permittable format.
string | $name | |
string | $pageformat |
bool |
blocks_parse_default_blocks_list | ( | $blocksstr | ) |
Parse a list of default blocks.
See config-dist for a description of the format.
string | $blocksstr | Determines the starting point that the blocks are added in the region. |
array | the parsed list of default blocks |
blocks_remove_inappropriate | ( | $course | ) |
Actually delete from the database any blocks that are currently on this page, but which should not be there according to blocks_name_allowed_in_format.
$course |
blocks_set_visibility | ( | $instance, | |
$page, | |||
$newvisibility ) |
Set a block to be visible or hidden on a particular page.
object | $instance | a row from the block_instances, preferably LEFT JOINed with the block_positions table as return by block_manager. |
moodle_page | $page | the back to set the visibility with respect to. |
integer | $newvisibility | 1 for visible, 0 for hidden. |
blog_get_context_url | ( | ) |
bounded_number | ( | $min, | |
$value, | |||
$max ) |
Used to make sure that $min <= $value <= $max.
Make sure that value is between min, and max
int | $min | The minimum value |
int | $value | The value to check |
int | $max | The maximum value |
int |
break_up_long_words | ( | $string, | |
$maxsize = 20, | |||
$cutchar = ' ' ) |
Given some normal text this function will break up any long words to a given size by inserting the given character.
It's multibyte savvy and doesn't change anything inside html tags.
string | $string | the string to be modified |
int | $maxsize | maximum length of the string to be returned |
string | $cutchar | the string used to represent word breaks |
string |
build_context_path | ( | ) |
build_logs_array | ( | ) |
build_navigation | ( | ) |
calculate_user_dst_table | ( | ) |
calendar_cron | ( | ) |
calendar_get_all_allowed_types | ( | ) |
calendar_get_block_upcoming | ( | ) |
calendar_get_mini | ( | ) |
calendar_get_upcoming | ( | ) |
calendar_import_icalendar_events | ( | $ical, | |
$unused = null, | |||
$subscriptionid = null ) |
calendar_normalize_tz | ( | ) |
calendar_preferences_button | ( | ) |
calendar_print_month_selector | ( | ) |
calendar_process_subscription_row | ( | $subscriptionid, | |
$pollinterval, | |||
$action ) |
Update a subscription from the form data in one of the rows in the existing subscriptions table.
int | $subscriptionid | The ID of the subscription we are acting upon. |
int | $pollinterval | The poll interval to use. |
int | $action | The action to be performed. One of update or remove. |
dml_exception | if invalid subscriptionid is provided |
string | A log of the import progress, including errors |
calendar_wday_name | ( | ) |
can_send_from_real_email_address | ( | $from, | |
$user, | |||
$unused = null ) |
Check to see if a user's real email address should be used for the "From" field.
object | $from | The user object for the user we are sending the email from. |
object | $user | The user object that we are sending the email to. |
array | $unused | No longer used. |
bool | Returns true if we can use the from user's email adress in the "From" field. |
can_use_html_editor | ( | ) |
|
protected |
Check if The query qualifies for readonly connection execution Logging queries are exempt, those are write operations that circumvent standard query_start/query_end paths.
int | $type | type of query |
string | $sql |
bool |
can_use_rotated_text | ( | ) |
category_delete_full | ( | ) |
category_delete_move | ( | ) |
check_admin_dir_usage | ( | environment_results | $result | ) |
Check whether the admin directory has been configured and warn if so.
The admin directory has been deprecated since Moodle 4.0.
environment_results | $result |
null|environment_results |
check_browser_operating_system | ( | ) |
check_browser_version | ( | ) |
check_consecutive_identical_characters | ( | $password, | |
$maxchars ) |
Check whether the given password has no more than the specified number of consecutive identical characters.
string | $password | password to be checked against the password policy |
integer | $maxchars | maximum number of consecutive identical characters |
bool |
check_database_storage_engine | ( | environment_results | $result | ) |
This function verifies that the database is not using an unsupported storage engine.
environment_results | $result | object to update, if relevant |
environment_results|null | updated results object, or null if the storage engine is supported |
check_database_tables_row_format | ( | environment_results | $result | ) |
This function verifies if the database has tables using innoDB Antelope row format.
environment_results | $result |
environment_results|null | updated results object, or null if no Antelope table has been found. |
check_db_prefix_length | ( | environment_results | $result | ) |
This function checks that the database prefix ($CFG->prefix) is <= 10.
environment_results | $result |
environment_results|null | updated results object, or null if the prefix check is passing ok. |
check_dir_exists | ( | $dir, | |
$create = true, | |||
$recursive = true ) |
Function to check if a directory exists and by default create it if not exists.
Previously this was accepting paths only from dataroot, but we now allow files outside of dataroot if you supply custom paths for some settings in config.php. This function does not verify that the directory is writable.
NOTE: this function uses current file stat cache, please use clearstatcache() before this if you expect that the directories may have been removed recently from a different request.
string | $dir | absolute directory path |
boolean | $create | directory if does not exist |
boolean | $recursive | create directory recursively |
boolean | true if directory exists or created, false otherwise |
check_gd_version | ( | ) |
check_igbinary322_version | ( | environment_results | $result | ) |
Check if the igbinary extension installed is buggy one.
There are a few php-igbinary versions that are buggy and return any unserialised array with wrong index. This defeats key() and next() operations on them.
This library is used by MUC and also by memcached and redis when available.
Let's inform if there is some problem when:
environment_results | $result | object to update, if relevant. |
environment_results|null | updated results or null. |
check_is_https | ( | environment_results | $result | ) |
Check if the site is being served using an ssl url.
Note this does not really perform any request neither looks for proxies or other situations. Just looks to wwwroot and warn if it's not using https.
environment_results | $result | $result |
environment_results|null | updated results object, or null if the site is https. |
check_libcurl_version | ( | environment_results | $result | ) |
Check if recommended version of libcurl is installed or not.
environment_results | $result | object to update, if relevant. |
environment_results|null | updated results or null. |
check_max_input_vars | ( | environment_results | $result | ) |
Environment check for the php setting max_input_vars.
environment_results | $result |
environment_results|null |
check_mod_assignment | ( | environment_results | $result | ) |
Check whether the mod_assignment is currently being used.
environment_results | $result |
environment_results|null |
check_moodle_environment | ( | $version, | |
$env_select = ENV_SELECT_NEWER ) |
This function checks all the requirements defined in environment.xml.
string | $version | version to check. |
int | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. Default ENV_SELECT_NEWER (BC) |
array | with two elements. The first element true/false, depending on on whether the check passed. The second element is an array of environment_results objects that has detailed information about the checks and which ones passed. |
check_mysql_file_format | ( | environment_results | $result | ) |
This function verfies that the database has tables using InnoDB Antelope row format.
environment_results | $result |
environment_results|null | updated results object, or null if no Antelope table has been found. |
check_mysql_file_per_table | ( | environment_results | $result | ) |
This function verfies that the database has a setting of one file per table.
This is required for 'utf8mb4'.
environment_results | $result |
environment_results|null | updated results object, or null if innodb_file_per_table = 1. |
check_mysql_incomplete_unicode_support | ( | environment_results | $result | ) |
This function checks the database to see if it is using incomplete unicode support.
environment_results | $result | $result |
environment_results|null | updated results object, or null if unicode is fully supported. |
check_mysql_large_prefix | ( | environment_results | $result | ) |
This function verfies that the database has the setting of large prefix enabled.
This is required for 'utf8mb4'.
environment_results | $result |
environment_results|null | updated results object, or null if innodb_large_prefix = 1. |
check_oracle_usage | ( | environment_results | $result | ) |
Check whether the Oracle database is currently being used and warn if so.
The Oracle database support will be removed in a future version (4.5) as it is no longer supported by PHP.
environment_results | $result | object to update, if relevant |
environment_results|null | updated results or null if the current database is not Oracle. |
check_password_policy | ( | $password, | |
& | $errmsg, | ||
$user = null ) |
Validate a password against the configured password policy.
string | $password | the password to be checked against the password policy |
string | $errmsg | the error message to display when the password doesn't comply with the policy. |
stdClass | $user | the user object to perform password validation against. Defaults to null if not provided. |
bool | true if the password is valid according to the policy. false otherwise. |
check_php_version | ( | $version = '5.2.4' | ) |
Returns true if the current version of PHP is greater that the specified one.
string | $version | The version of php being tested. |
bool |
check_sixtyfour_bits | ( | environment_results | $result | ) |
Check if the site is using 64 bits PHP.
environment_results | $result |
environment_results|null | updated results object, or null if the site is using 64 bits PHP. |
check_slasharguments | ( | environment_results | $result | ) |
Method used to check the usage of slasharguments config and display a warning message.
environment_results | $result | object to update, if relevant. |
environment_results|null | updated results or null if slasharguments is disabled. |
check_tls_libraries | ( | environment_results | $result | ) |
Checks for up-to-date TLS libraries.
NOTE: this is not currently used, see MDL-57262.
environment_results | $result | object to update, if relevant. |
environment_results|null | updated results or null if unoconv path is not executable. |
check_unoconv_version | ( | environment_results | $result | ) |
Method used to check the installed unoconv version.
environment_results | $result | object to update, if relevant. |
environment_results|null | updated results or null if unoconv path is not executable. |
check_upgrade_key | ( | $upgradekeyhash | ) |
Assert the upgrade key is provided, if it is defined.
The upgrade key can be defined in the main config.php as $CFG->upgradekey. If it is defined there, then its value must be provided every time the site is being upgraded, regardless the administrator is logged in or not.
This is supposed to be used at certain places in /admin/index.php only.
string | null | $upgradekeyhash | the SHA-1 of the value provided by the user |
check_user_preferences_loaded | ( | stdClass | $user, |
$cachelifetime = 120 ) |
Refresh user preference cache.
This is used most often for $USER object that is stored in session, but it also helps with performance in cron script.
Preferences for each user are loaded on first use on every page, then again after the timeout expires.
stdClass | $user | User object. Preferences are preloaded into 'preference' property |
int | $cachelifetime | Cache life time on the current page (in seconds) |
coding_exception |
null |
check_xmlrpc_usage | ( | environment_results | $result | ) |
Check whether the XML-RPC protocol is enabled and warn if so.
The XML-RPC protocol will be removed in a future version (4.1) as it is no longer supported by PHP.
See MDL-70889 for further information.
environment_results | $result |
null|environment_results |
choose_from_menu | ( | ) |
clam_change_log | ( | ) |
clam_handle_infected_file | ( | ) |
clam_log_infected | ( | ) |
clam_log_upload | ( | ) |
clam_message_admins | ( | ) |
clam_replace_infected_file | ( | ) |
clam_scan_moodle_file | ( | ) |
clean_filename | ( | $string | ) |
Cleans a given filename by removing suspicious or troublesome characters.
string | $string | file name |
string | cleaned file name |
clean_param | ( | $param, | |
$type ) |
Used by optional_param() and required_param() to clean the variables and/or cast to specific types, based on an options field.
$course->format = clean_param($course->format, PARAM_ALPHA); $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
mixed | $param | the variable we are cleaning |
string | $type | expected format of param after cleaning. |
mixed |
coding_exception |
clean_param_array | ( | ?array | $param, |
$type, | |||
$recursive = false ) |
Makes sure array contains only the allowed types, this function does not validate array key names!
$options = clean_param($options, PARAM_INT);
array | null | $param | the variable array we are cleaning |
string | $type | expected format of param after cleaning. |
bool | $recursive | clean recursive arrays |
array |
coding_exception |
clean_text | ( | $text, | |
$format = FORMAT_HTML, | |||
$options = array() ) |
Cleans raw text removing nasties.
Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up Moodle pages through XSS attacks.
The result must be used as a HTML text fragment, this function can not cleanup random parts of html tags such as url or src attributes.
NOTE: the format parameter was deprecated because we can safely clean only HTML.
string | $text | The text to be cleaned |
int | string | $format | deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE |
array | $options | Array of options; currently only option supported is 'allowid' (if true, does not remove id attributes when cleaning) |
string | The cleaned up text |
cleanremoteaddr | ( | $addr, | |
$compress = false ) |
cleanup_contexts | ( | ) |
cleardoubleslashes | ( | $path | ) |
Replace 1 or more slashes or backslashes to 1 slash.
string | $path | The path to strip |
string | the path with double slashes removed |
cli_error | ( | $text, | |
$errorcode = 1 ) |
Write to standard error output and exit with the given code.
string | $text | |
int | $errorcode |
void | (does not return) |
cli_execute_parallel | ( | $cmds, | |
$cwd = null, | |||
$delay = 0 ) |
Execute commands in parallel.
array | $cmds | list of commands to be executed. |
string | $cwd | absolute path of working directory. |
int | $delay | time in seconds to add delay between each parallel process. |
array | list of processes. |
cli_get_params | ( | array | $longoptions, |
array | $shortmapping = null ) |
Returns cli script parameters.
array | $longoptions | array of –style options ex:('verbose'=>false) |
array | $shortmapping | array describing mapping of short to long style options ex:('h'=>'help', 'v'=>'verbose') |
array | array of arrays, options, unrecognised as optionlongname=>value |
cli_heading | ( | $string, | |
$return = false ) |
Print or return section heading string.
string | $string | text |
bool | $return | false means print, true return as string |
mixed | void or string |
cli_input | ( | $prompt, | |
$default = '', | |||
array | $options = null, | ||
$casesensitiveoptions = false ) |
Get input from user.
string | $prompt | text prompt, should include possible options |
string | $default | default value when enter pressed |
array | $options | list of allowed options, empty means any text |
bool | $casesensitive | true if options are case sensitive |
string | entered text |
cli_logo | ( | $padding = 2, | |
$return = false ) |
Print an ASCII version of the Moodle logo.
int | $padding | left padding of the logo |
bool | $return | should we print directly (false) or return the string (true) |
mixed | void or string |
cli_problem | ( | $text | ) |
Write error notification.
$text |
void |
cli_separator | ( | $return = false | ) |
Print or return section separator string.
bool | $return | false means print, true return as string |
mixed | void or string |
cli_set_process_title_suffix | ( | string | $suffix | ) |
This sets the cli process title suffix.
An example is appending current Task API info so a sysadmin can immediately see what task a cron process is running at any given moment.
string | $suffix | process suffix |
cli_write | ( | $text, | |
$stream = STDOUT ) |
Write a text to the given stream.
string | $text | text to be written |
resource | $stream | output stream to be written to, defaults to STDOUT |
cli_writeln | ( | $text, | |
$stream = STDOUT ) |
Write a text followed by an end of line symbol to the given stream.
string | $text | text to be written |
resource | $stream | output stream to be written to, defaults to STDOUT |
close_window | ( | $delay = 0, | |
$reloadopener = false ) |
Try and close the current window using JavaScript, either immediately, or after a delay.
Echo's out the resulting XHTML & javascript
integer | $delay | a delay in seconds before closing the window. Default 0. |
boolean | $reloadopener | if true, we will see if this window was a pop-up, and try to reload the parent window before this one closes. |
cohort_get_visible_list | ( | ) |
commit_delegated_transaction | ( | moodle_transaction | $transaction | ) |
Indicates delegated transaction finished successfully.
Set written times after outermost transaction finished
moodle_transaction | $transaction | The transaction to commit |
void |
dml_transaction_exception | Creates and throws transaction related exceptions. |
complete_user_login | ( | $user, | |
array | $extrauserinfo = [] ) |
Call to complete the user login process after authenticate_user_login() has succeeded.
It will setup the $USER variable and other required bits and pieces.
NOTE:
stdClass | $user | |
array | $extrauserinfo |
stdClass | A $USER object - BC only, do not use |
completion_cron | ( | ) |
complex_random_string | ( | $length = null | ) |
Generate a complex random string (useful for md5 salts)
This function is based on the above random_string() however it uses a larger pool of characters and generates a string between 24 and 32 characters
int | $length | Optional if set generates a string to exactly this length |
string |
component_callback | ( | $component, | |
$function, | |||
array | $params = array(), | ||
$default = null ) |
Invoke component's callback functions.
string | $component | frankenstyle component name, e.g. 'mod_quiz' |
string | $function | the rest of the function name, e.g. 'cron' will end up calling 'mod_quiz_cron' |
array | $params | parameters of callback function |
mixed | $default | default value if callback function hasn't been defined, or if it retursn null. |
mixed |
component_callback_exists | ( | $component, | |
$function ) |
Determine if a component callback exists and return the function name to call.
Note that this function will include the required library files so that the functioname returned can be called directly.
string | $component | frankenstyle component name, e.g. 'mod_quiz' |
string | $function | the rest of the function name, e.g. 'cron' will end up calling 'mod_quiz_cron' |
mixed | Complete function name to call if the callback exists or false if it doesn't. |
coding_exception | if invalid component specfied |
component_class_callback | ( | $classname, | |
$methodname, | |||
array | $params, | ||
$default = null ) |
Call the specified callback method on the provided class.
If the callback returns null, then the default value is returned instead. If the class does not exist, then the default value is returned.
string | $classname | The name of the class to call upon. |
string | $methodname | The name of the staticically defined method on the class. |
array | $params | The arguments to pass into the method. |
mixed | $default | The default value. |
mixed | The return value. |
confirm_sesskey | ( | $sesskey = NULL | ) |
Check the sesskey and return true of false for whether it is valid.
(You might like to imagine this function is called sesskey_is_valid().)
Every script that lets the user perform a significant action (that is, changes data in the database) should check the sesskey before doing the action. Depending on your code flow, you may want to use the require_sesskey() helper function.
string | $sesskey | The sesskey value to check (optional). Normally leave this blank and this function will do required_param('sesskey', ...). |
bool | whether the sesskey sent in the request matches the one stored in the session. |
connect | ( | $dbhost, | |
$dbuser, | |||
$dbpass, | |||
$dbname, | |||
$prefix, | |||
array | $dboptions = null ) |
Connect to db The connection parameters processor that sets up stage for master write and slave readonly handles.
Must be called before other methods.
string | $dbhost | The database host. |
string | $dbuser | The database username. |
string | $dbpass | The database username's password. |
string | $dbname | The name of the database being connected to. |
mixed | $prefix | string means moodle db prefix, false used for external databases where prefix not used |
array | $dboptions | driver specific options |
bool | true |
dml_connection_exception | if error |
content_to_text | ( | $content, | |
$contentformat ) |
Converts texts or strings to plain text.
string | $content | The text as entered by the user |
int | false | $contentformat | False for strings or the text format: FORMAT_MOODLE/FORMAT_HTML/FORMAT_PLAIN/FORMAT_MARKDOWN |
string | Plain text. |
context_instance_preload | ( | ) |
context_instance_preload_sql | ( | ) |
context_moved | ( | ) |
convert_tabrows_to_tree | ( | ) |
convert_to_array | ( | $var | ) |
Converts an object into an associative array.
This function converts an object into an associative array by iterating over its public properties. Because this function uses the foreach construct, Iterators are respected. It works recursively on arrays of objects. Arrays and simple values are returned as is.
If class has magic properties, it can implement IteratorAggregate and return all available properties in getIterator()
mixed | $var |
array |
convert_tree_to_html | ( | ) |
core_login_extend_change_password_form | ( | $mform, | |
$user ) |
Plugins can extend forms.
Inject form elements into change_password_form.
mform | $mform | the form to inject elements into. |
stdClass | $user | the user object to use for context. |
core_login_extend_forgot_password_form | ( | $mform | ) |
Inject form elements into forgot_password_form.
mform | $mform | the form to inject elements into. |
core_login_extend_set_password_form | ( | $mform, | |
$user ) |
Inject form elements into set_password_form.
mform | $mform | the form to inject elements into. |
stdClass | $user | the user object to use for context. |
core_login_extend_signup_form | ( | $mform | ) |
Inject form elements into signup_form.
mform | $mform | the form to inject elements into. |
core_login_generate_password_reset | ( | $user | ) |
Create a new record in the database to track a new password set request for user.
object | $user | the user record, the requester would like a new password set for. |
record | created. |
core_login_get_return_url | ( | ) |
Determine where a user should be redirected after they have been logged in.
string | url the user should be redirected to. |
core_login_post_change_password_requests | ( | $data | ) |
Plugins can perform post submission actions.
Post change_password_form submission actions.
stdClass | $data | the data object from the submitted form. |
core_login_post_forgot_password_requests | ( | $data | ) |
Post forgot_password_form submission actions.
stdClass | $data | the data object from the submitted form. |
core_login_post_set_password_requests | ( | $data, | |
$user ) |
Post set_password_form submission actions.
stdClass | $data | the data object from the submitted form. |
stdClass | $user | the user object for set_password context. |
core_login_post_signup_requests | ( | $data | ) |
Post signup_form submission actions.
stdClass | $data | the data object from the submitted form. |
core_login_process_password_reset | ( | $username, | |
$email ) |
Process the password reset for the given user (via username or email).
string | $username | the user name |
string | the user email |
array | an array containing fields indicating the reset status, a info notice and redirect URL. |
core_login_process_password_reset_request | ( | ) |
Processes a user's request to set a new password in the event they forgot the old one.
If no user identifier has been supplied, it displays a form where they can submit their identifier. Where they have supplied identifier, the function will check their status, and send email as appropriate.
core_login_process_password_set | ( | $token | ) |
This function processes a user's submitted token to validate the request to set a new password.
If the user's token is validated, they are prompted to set a new password.
string | $token | the one-use identifier which should verify the password reset request as being valid. |
void |
core_login_validate_extend_change_password_form | ( | $data, | |
$user ) |
Plugins can add additional validation to forms.
Inject validation into change_password_form.
array | $data | the data array from submitted form values. |
stdClass | $user | the user object to use for context. |
array\$errors | the updated array of errors from validation. |
core_login_validate_extend_forgot_password_form | ( | $data | ) |
Inject validation into forgot_password_form.
array | $data | the data array from submitted form values. |
array\$errors | the updated array of errors from validation. |
core_login_validate_extend_set_password_form | ( | $data, | |
$user ) |
Inject validation into set_password_form.
array | $data | the data array from submitted form values. |
stdClass | $user | the user object to use for context. |
array\$errors | the updated array of errors from validation. |
core_login_validate_extend_signup_form | ( | $data | ) |
Inject validation into signup_form.
array | $data | the data array from submitted form values. |
array\$errors | the updated array of errors from validation. |
core_login_validate_forgot_password_data | ( | $data | ) |
Validates the forgot password form data.
This is used by the forgot_password_form and by the core_auth_request_password_rest WS.
array | $data | array containing the data to be validated (email and username) |
array | array of errors compatible with mform |
core_myprofile_navigation | ( | core_user\output\myprofile\tree | $tree, |
$user, | |||
$iscurrentuser, | |||
$course ) |
Defines core nodes for my profile navigation tree.
core_user\output\myprofile\tree | $tree | Tree object |
stdClass | $user | user object |
bool | $iscurrentuser | is the user viewing profile, current user ? |
stdClass | $course | course object |
bool |
core_question_find_next_unused_idnumber | ( | ?string | $oldidnumber, |
int | $categoryid ) |
If $oldidnumber ends in some digits then return the next available idnumber of the same form.
So idnum -> null (no digits at the end) idnum0099 -> idnum0100 (if that is unused, else whichever of idnum0101, idnume0102, ... is unused. idnum9 -> idnum10.
string | null | $oldidnumber | a question idnumber, or can be null. |
int | $categoryid | a question category id. |
string|null | suggested new idnumber for a question in that category, or null if one cannot be found. |
core_question_question_preview_pluginfile | ( | $previewcontext, | |
$questionid, | |||
$filecontext, | |||
$filecomponent, | |||
$filearea, | |||
$args, | |||
$forcedownload, | |||
$options = [] ) |
Serve questiontext files in the question text when they are displayed in this report.
context | $previewcontext | the context in which the preview is happening. |
int | $questionid | the question id. |
context | $filecontext | the file (question) context. |
string | $filecomponent | the component the file belongs to. |
string | $filearea | the file area. |
array | $args | remaining file args. |
bool | $forcedownload | |
array | $options | additional options affecting the file serving. |
core_tables_exist | ( | ) |
Checks if the main tables have been installed yet or not.
Note: we can not use caches here because they might be stale, use with care!
bool |
count_enrolled_users | ( | context | $context, |
$withcapability = '', | |||
$groupids = 0, | |||
$onlyactive = false ) |
Counts list of users enrolled into course (as per above function)
context | $context | |
string | $withcapability | |
int | array | $groupids | The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
int | number of users enrolled into course |
count_letters | ( | $string, | |
$format = null ) |
Count letters in a string.
Letters are defined as chars not in tags and different from whitespace.
string | $string | The text to be searched for letters. May be HTML. |
int | null | $format |
int | The count of letters in the specified text. |
count_login_failures | ( | ) |
count_words | ( | $string, | |
$format = null ) |
Count words in a string.
Words are defined as things between whitespace.
string | $string | The text to be searched for words. May be HTML. |
int | null | $format |
int | The count of words in the specified string |
course_category_hide | ( | ) |
course_category_show | ( | ) |
course_get_cm_rename_action | ( | ) |
course_scale_used | ( | ) |
coursemodule_visible_for_user | ( | ) |
coursetag_delete_course_tags | ( | ) |
coursetag_delete_keyword | ( | ) |
coursetag_get_all_tags | ( | ) |
coursetag_get_jscript | ( | ) |
coursetag_get_jscript_links | ( | ) |
coursetag_get_records | ( | ) |
coursetag_get_tagged_courses | ( | ) |
coursetag_get_tags | ( | ) |
coursetag_store_keywords | ( | ) |
create_contexts | ( | ) |
create_course_category | ( | ) |
create_user_key | ( | $script, | |
$userid, | |||
$instance = null, | |||
$iprestriction = null, | |||
$validuntil = null ) |
Creates a new private user access key.
string | $script | unique target identifier |
int | $userid | |
int | $instance | optional instance id |
string | $iprestriction | optional ip restricted access |
int | $validuntil | key valid only until given data |
string | access key value |
create_user_record | ( | $username, | |
$password, | |||
$auth = 'manual' ) |
Creates a bare-bones user record.
string | $username | New user's username to add to record |
string | $password | New user's password to add to record |
string | $auth | Form of authentication required |
stdClass | A complete user object |
cron_bc_hack_plugin_functions | ( | $plugintype, | |
$plugins ) |
Used to add in old-style cron functions within plugins that have not been converted to the new standard API.
(The standard API is frankenstyle_name_cron() in lib.php; some types used cron.php and some used a different name.)
string | $plugintype | Plugin type e.g. 'report' |
array | $plugins | Array from plugin name (e.g. 'report_frog') to function name (e.g. 'report_frog_cron') for plugin cron functions that were already found using the new API |
array | Revised version of $plugins that adds in any extra plugin functions found by looking in the older location |
cron_execute_plugin_type | ( | $plugintype, | |
$description = null ) |
Executes cron functions for a specific type of plugin.
string | $plugintype | Plugin type (e.g. 'report') |
string | $description | If specified, will display 'Starting (whatever)' and 'Finished (whatever)' lines, otherwise does not display |
cron_prepare_core_renderer | ( | $restore = false | ) |
Prepare the output renderer for the cron run.
This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing any other.
bool | $restore | Whether to restore the original PAGE and OUTPUT |
cron_run | ( | ?int | $keepalive = null | ) |
Execute cron tasks.
int | null | $keepalive | The keepalive time for this cron run. |
cron_run_adhoc_tasks | ( | int | $timenow, |
$keepalive = 0, | |||
$checklimits = true ) |
Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.
int | $timenow | The time this process started. |
int | $keepalive | Keep this function alive for N seconds and poll for new adhoc tasks. |
bool | $checklimits | Should we check limits? |
cron_run_inner_adhoc_task | ( | \core\task\adhoc_task | $task | ) |
Shared code that handles running of a single adhoc task within the cron.
core\task\adhoc_task | $task |
cron_run_inner_scheduled_task | ( | \core\task\task_base | $task | ) |
Shared code that handles running of a single scheduled task within the cron.
Not intended for calling directly outside of this library!
core\task\task_base | $task |
cron_run_scheduled_tasks | ( | int | $timenow | ) |
Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.
int | $timenow | The time this process started. |
cron_run_single_task | ( | ) |
cron_set_process_title | ( | string | $title | ) |
Sets the process title.
This makes it very easy for a sysadmin to immediately see what task a cron process is running at any given moment.
string | $title | process status title |
cron_setup_user | ( | $user = null, | |
$course = null, | |||
$leavepagealone = false ) |
Sets up current user and course environment (lang, etc.) in cron.
Do not use outside of cron script!
stdClass | $user | full user object, null means default cron user (admin), value 'reset' means reset internal static caches. |
stdClass | $course | full course record, null means $SITE |
bool | $leavepagealone | If specified, stops it messing with global page object |
void |
cron_trace_time_and_memory | ( | ) |
Output some standard information during cron runs.
Specifically current time and memory usage. This method also does gc_collect_cycles() (before displaying memory usage) to try to help PHP manage memory better.
css_is_colour | ( | ) |
css_is_width | ( | ) |
css_minify_css | ( | ) |
css_send_cached_css | ( | $csspath, | |
$etag ) |
Sends a cached CSS file.
This function sends the cached CSS file. Remember it is generated on the first request, then optimised/minified, and finally cached for serving.
string | $csspath | The path to the CSS file we want to serve. |
string | $etag | The revision to make sure we utilise any caches. |
css_send_cached_css_content | ( | $csscontent, | |
$etag ) |
Sends a cached CSS content.
string | $csscontent | The actual CSS markup. |
string | $etag | The revision to make sure we utilise any caches. |
css_send_temporary_css | ( | $css | ) |
Sends CSS directly and disables all caching.
The Content-Length of the body is also included, but the script is not ended.
string | $css | The CSS content to send |
css_send_uncached_css | ( | $css | ) |
Sends CSS directly without caching it.
This function takes a raw CSS string, optimises it if required, and then serves it. Turning both themedesignermode and CSS optimiser on at the same time is awful for performance because of the optimiser running here. However it was done so that theme designers could utilise the optimised output during development to help them optimise their CSS... not that they should write lazy CSS.
string | $css |
css_send_unmodified | ( | $lastmodified, | |
$etag ) |
Send file not modified headers.
int | $lastmodified | |
string | $etag |
css_sort_by_count | ( | ) |
if(!defined('THEME_DESIGNER_CACHE_LIFETIME')) css_store_css | ( | theme_config | $theme, |
$csspath, | |||
$csscontent ) |
Stores CSS in a file at the given path.
This function either succeeds or throws an exception.
theme_config | $theme | The theme that the CSS belongs to. |
string | $csspath | The path to store the CSS at. |
string | $csscontent | the complete CSS in one string. |
css_write_file | ( | $filename, | |
$content ) |
Writes a CSS file.
string | $filename | |
string | $content |
current_language | ( | ) |
Returns the code for the current language.
string |
current_theme | ( | ) |
custom_script_path | ( | ) |
Detect a custom script replacement in the data directory that will replace an existing moodle script.
string|bool | full path name if a custom script exists, false if no custom script exists |
data_submitted | ( | ) |
Determine if there is data waiting to be processed from a form.
Used on most forms in Moodle to check for data Returns the data as an object, if it's found. This object can be used in foreach loops without casting because it's cast to (array) automatically
Checks that submitted POST data exists and returns it as object.
mixed | false or object |
date_format_string | ( | $date, | |
$format, | |||
$tz = 99 ) |
Returns a formatted date ensuring it is UTF-8.
If we are running under Windows convert to Windows encoding and then back to UTF-8 (because it's impossible to specify UTF-8 to fetch locale info in Win32).
int | $date | the timestamp - since Moodle 2.9 this is a real UTC timestamp |
string | $format | strftime format. |
int | float | string | $tz | the user timezone |
string | the formatted date/time. |
dayofweek | ( | $day, | |
$month, | |||
$year ) |
Calculate the position in the week of a specific calendar day.
int | $day | The day of the date whose position in the week is sought |
int | $month | The month of the date whose position in the week is sought |
int | $year | The year of the date whose position in the week is sought |
int |
days_in_month | ( | $month, | |
$year ) |
Calculate the number of days in a given month.
int | $month | The month whose day count is sought |
int | $year | The year of the month whose day count is sought |
int |
db_replace | ( | $search, | |
$replace, | |||
$additionalskiptables = '' ) |
Moved from admin/replace.php so that we can use this in cron.
string | $search | string to look for |
string | $replace | string to replace |
bool | success or fail |
db_should_replace | ( | $table, | |
$column = '', | |||
$additionalskiptables = '' ) |
Given a table and optionally a column name should replaces be done?
string | $table | name |
string | $column | name |
bool | success or fail |
debugging | ( | $message = '', | |
$level = DEBUG_NORMAL, | |||
$backtrace = null ) |
Standard Debugging Function.
Returns true if the current site debugging settings are equal or above specified level. If passed a parameter it will emit a debugging notice similar to trigger_error(). The routing of notices is controlled by $CFG->debugdisplay eg use like this:
1) debugging('a normal debug notice'); 2) debugging('something really picky', DEBUG_ALL); 3) debugging('annoying debug message only for developers', DEBUG_DEVELOPER); 4) if (debugging()) { perform extra debugging operations (do not use print or echo) }
In code blocks controlled by debugging() (such as example 4) any output should be routed via debugging() itself, or the lower-level trigger_error() or error_log(). Using echo or print will break XHTML JS and HTTP headers.
It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
string | $message | a message to print |
int | $level | the level at which this debugging statement should show |
array | $backtrace | use different backtrace |
bool |
decompose_update_into_safe_changes | ( | array | $newvalues, |
$unusedvalue ) |
Helper used by update_field_with_unique_index().
Given a desired set of changes, break them down into single udpates that can be done one at a time without breaking any unique index constraints.
Suppose the input is array(1 => 2, 2 => 1) and -1. Then the output will be array (array(1, -1), array(2, 1), array(-1, 2)). This function solves this problem in the general case, not just for simple swaps. The unit tests give more examples.
Note that, it is the responsibility of the caller to make sure that the requested rename is legal. For example, if you ask for something impossible like array(1 => 2, 2 => 2) then the results are undefined. (You will probably get a unique key violation error from the database later.)
array | $newvalues | The desired re-ordering. E.g. array(1 => 4, 2 => 1, 3 => 3, 4 => 2). |
int | $unusedvalue | A value that is not currently used. |
array | A safe way to perform the re-order. An array of two-element arrays array($from, $to). E.g. array(array(1, -1), array(2, 1), array(4, 2), array(-1, 4)). |
dedupe_user_access | ( | ) |
default_error_handler | ( | $errno, | |
$errstr, | |||
$errfile, | |||
$errline ) |
Default error handler, prevents some white screens.
int | $errno | |
string | $errstr | |
string | $errfile | |
int | $errline |
bool | false means use default error handler |
default_exception_handler | ( | $ex | ) |
Default exception handler.
Exception | $ex |
void | -does not return. Terminates execution! |
default_page_type_list | ( | $pagetype, | |
$parentcontext = null, | |||
$currentcontext = null ) |
Generates a default page type list when a more appropriate callback cannot be decided upon.
string | $pagetype | |
stdClass | $parentcontext | |
stdClass | $currentcontext |
array |
delete_context | ( | ) |
delete_course | ( | $courseorid, | |
$showfeedback = true ) |
Delete a course, including all related data from the database, and any associated files.
mixed | $courseorid | The id of the course or course object to delete. |
bool | $showfeedback | Whether to display notifications of each action the function performs. |
bool | true if all the removals succeeded. false if there were any failures. If this method returns false, some of the removals will probably have succeeded, and others failed, but you have no way of knowing which. |
delete_course_module | ( | ) |
delete_event | ( | ) |
delete_question_bank_entry | ( | $entryid | ) |
Check if there is more versions left for the entry.
If not delete the entry.
int | $entryid |
delete_user | ( | stdClass | $user | ) |
Marks user deleted in internal user database and notifies the auth plugin.
Also unenrols user from all roles and does other cleanup.
Any plugin that needs to purge user data should register the 'user_deleted' event.
stdClass | $user | full user object before delete |
boolean | success |
coding_exception | if invalid $user parameter detected |
delete_user_key | ( | $script, | |
$userid ) |
Delete the user's new private user access keys for a particular script.
string | $script | unique target identifier |
int | $userid |
void |
detect_munged_arguments | ( | ) |
display_auth_lock_options | ( | $settings, | |
$auth, | |||
$userfields, | |||
$helptext, | |||
$mapremotefields, | |||
$updateremotefields, | |||
$customfields = array() ) |
Helper function used to print locking for auth plugins on admin pages.
admin_settingpage | $settings | Moodle admin settings instance |
string | $auth | authentication plugin shortname |
array | $userfields | user profile fields |
string | $helptext | help text to be displayed at top of form |
boolean | $mapremotefields | Map fields or lock only. |
boolean | $updateremotefields | Allow remote updates |
array | $customfields | list of custom profile fields |
display_size | ( | $size, | |
int | $decimalplaces = 1, | ||
string | $fixedunits = '' ) |
Converts bytes into display form.
int | $size | The size to convert to human readable form |
int | $decimalplaces | If specified, uses fixed number of decimal places |
string | $fixedunits | If specified, uses fixed units (e.g. 'KB') |
string | Display version of size |
dndupload_add_to_course | ( | $course, | |
$modnames ) |
Add the Javascript to enable drag and drop upload to a course page.
object | $course | The currently displayed course |
array | $modnames | The list of enabled (visible) modules on this site |
void |
download_as_dataformat | ( | $filename, | |
$dataformat, | |||
$columns, | |||
$iterator, | |||
$callback = null ) |
Sends a formated data file to the browser.
@subpackage dataformat
string | $filename | The base filename without an extension |
string | $dataformat | A dataformat name |
array | $columns | An ordered map of column keys and labels |
Iterator | $iterator | An iterator over the records, usually a RecordSet |
callable | $callback | An option function applied to each record before writing |
coding_exception |
draw_rand_array | ( | $array, | |
$draws ) |
Given an arbitrary array, and a number of draws, this function returns an array with that amount of items.
The indexes are retained.
array | $array | |
int | $draws |
array |
drop_plugin_tables | ( | $name, | |
$file, | |||
$feedback = true ) |
Delete all plugin tables.
string | $name | Name of plugin, used as table prefix |
string | $file | Path to install.xml file |
bool | $feedback | defaults to true |
bool | Always returns true |
dst_changes_for_year | ( | ) |
dst_offset_on | ( | $time, | |
$strtimezone = null ) |
Calculates the Daylight Saving Offset for a given date/time (timestamp)
int | $time | must NOT be compensated at all, it has to be a pure timestamp |
int | float | string | $strtimezone | user timezone |
int |
during_initial_install | ( | ) |
Indicates whether we are in the middle of the initial Moodle install.
Very occasionally it is necessary avoid running certain bits of code before the Moodle installation has completed. The installed flag is set in admin/index.php after Moodle core and all the plugins have been installed, but just before the person doing the initial install is asked to choose the admin password.
boolean | true if the initial install is not complete. |
editors_get_available | ( | ) |
Get the list of available editors.
array | Array ('editorname'=>'localised editor name') |
editors_get_enabled | ( | ) |
Returns list of enabled text editors.
array | of name=>texteditor |
editors_get_preferred_editor | ( | $format = NULL | ) |
Returns users preferred editor for given format.
int | $format | text format or null of none |
texteditor | object |
editors_get_preferred_format | ( | ) |
Returns users preferred text format.
int | standard text format |
editors_head_setup | ( | ) |
Setup all JS and CSS needed for editors.
void |
email_is_not_allowed | ( | ) |
Check that an email is allowed.
It returns an error message if there was a problem.
string | Content of email |
string|false |
email_should_be_diverted | ( | ) |
A helper function to test for email diversion.
string |
bool | Returns true if the email should be diverted |
email_to_user | ( | $user, | |
$from, | |||
$subject, | |||
$messagetext, | |||
$messagehtml = '', | |||
$attachment = '', | |||
$attachname = '', | |||
$usetrueaddress = true, | |||
$replyto = '', | |||
$replytoname = '', | |||
$wordwrapwidth = 79 ) |
Send an email to a specified user.
stdClass | $user | A $USER object |
stdClass | $from | A $USER object |
string | $subject | plain text subject line of the email |
string | $messagetext | plain text version of the message |
string | $messagehtml | complete html version of the message (optional) |
string | $attachment | a file on the filesystem, either relative to $CFG->dataroot or a full path to a file in one of the following directories: $CFG->cachedir, $CFG->dataroot, $CFG->dirroot, $CFG->localcachedir, $CFG->tempdir |
string | $attachname | the name of the file (extension indicates MIME) |
bool | $usetrueaddress | determines whether $from email address should be sent out. Will be overruled by user profile setting for maildisplay |
string | $replyto | Email address to reply to |
string | $replytoname | Name of reply to recipient |
int | $wordwrapwidth | custom word wrap width, default 79 |
bool | Returns true if mail was sent OK and false if there was an error. |
endecrypt | ( | $pwd, | |
$data, | |||
$case ) |
Based on a class by Mukul Sabharwal [mukulsabharwal @ yahoo.com].
string | $pwd | The password to use when encrypting or decrypting |
string | $data | The data to be decrypted/encrypted |
string | $case | Either 'de' for decrypt or '' for encrypt |
string |
enrol_accessing_via_instance | ( | stdClass | $instance | ) |
Is current user accessing course via this enrolment method?
This is intended for operations that are going to affect enrol instances.
stdClass | $instance | enrol instance |
bool |
enrol_add_course_navigation | ( | navigation_node | $coursenode, |
$course ) |
enrol_calculate_duration | ( | $timestart, | |
$timeend ) |
Calculate duration base on start time and end time.
int | $timestart | Time start |
int | $timeend | Time end |
float|int | Calculated duration |
enrol_check_plugins | ( | $user, | |
bool | $ignoreintervalcheck = true ) |
Check all the login enrolment information for the given user object by querying the enrolment plugins This function may be very slow, use only once after log-in or login-as.
stdClass | $user | User object. |
bool | $ignoreintervalcheck | Force to ignore checking configured sync intervals. |
void |
enrol_cohort_can_view_cohort | ( | ) |
enrol_cohort_enrol_all_users | ( | ) |
enrol_cohort_get_cohorts | ( | ) |
enrol_cohort_search_cohorts | ( | ) |
enrol_course_delete | ( | $course, | |
$userid = null ) |
Called when course is about to be deleted.
If a user id is passed, only enrolments that the user has permission to un-enrol will be removed, otherwise all enrolments in the course will be removed.
stdClass | $course | |
int | null | $userid |
void |
enrol_course_edit_form | ( | MoodleQuickForm | $mform, |
$data, | |||
$context ) |
This function adds necessary enrol plugins UI into the course edit form.
MoodleQuickForm | $mform | |
object | $data | course edit form data |
object | $context | context of existing course or parent category if course does not exist |
void |
enrol_course_edit_validation | ( | array | $data, |
$context ) |
Validate course edit form data.
array | $data | raw form data |
object | $context | context of existing course or parent category if course does not exist |
array | errors array |
enrol_course_updated | ( | $inserted, | |
$course, | |||
$data ) |
Update enrol instances after course edit form submission.
bool | $inserted | true means new course added, false course already existed |
object | $course | |
object | $data | form data |
void |
enrol_get_all_users_courses | ( | $userid, | |
$onlyactive = false, | |||
$fields = null, | |||
$sort = null ) |
Returns list of courses user is enrolled into without performing any capability checks.
The $fields param is a list of field names to ADD so name just the fields you really need, which will be added and uniq'd.
int | $userid | User whose courses are returned, defaults to the current user. |
bool | $onlyactive | Return only active enrolments in courses user may see. |
string | array | $fields | Extra fields to be returned (array or comma-separated list). |
string | null | $sort | Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort. |
array |
enrol_get_course_by_user_enrolment_id | ( | $ueid | ) |
Returns the course where a user enrolment belong to.
int | $ueid | user_enrolments id |
stdClass |
enrol_get_course_description_texts | ( | $course | ) |
Returns course enrolment detailed information.
object | $course |
array | of html fragments - can be used to construct lists |
enrol_get_course_info_icons | ( | $course, | |
array | $instances = NULL ) |
Returns course enrolment information icons.
object | $course | |
array | $instances | enrol instances of this course, improves performance |
array | of pix_icon |
enrol_get_course_users | ( | $courseid = false, | |
$onlyactive = false, | |||
$usersfilter = [], | |||
$uefilter = [], | |||
$usergroups = [] ) |
Return all users enrolled in a course.
int | $courseid | Course id or false if using $uefilter (user enrolment ids may belong to different courses) |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
array | $usersfilter | Limit the results obtained to this list of user ids. $uefilter compatibility not guaranteed. |
array | $uefilter | Limit the results obtained to this list of user enrolment ids. $usersfilter compatibility not guaranteed. |
array | $usergroups | Limit the results of users to the ones that belong to one of the submitted group ids. |
stdClass[] |
enrol_get_course_users_roles | ( | int | $courseid | ) |
Returns list of roles per users into course.
int | $courseid | Course id. |
array | Array[$userid][$roleid] = role_assignment. |
enrol_get_courses_sortingsql | ( | $sort = null | ) |
Returns SQL ORDER arguments which reflect the admin settings to sort my courses.
string | null | $sort | SQL ORDER arguments which were originally requested (optionally). |
string | SQL ORDER arguments. |
enrol_get_enrolment_end | ( | $courseid, | |
$userid ) |
This function returns the end of current active user enrolment.
It deals correctly with multiple overlapping user enrolments.
int | $courseid | |
int | $userid |
int|bool | timestamp when active enrolment ends, false means no active enrolment now, 0 means never |
enrol_get_instances | ( | $courseid, | |
$enabled ) |
Returns enrolment instances in given course.
int | $courseid | |
bool | $enabled |
array | of enrol instances |
enrol_get_my_courses | ( | $fields = null, | |
$sort = null, | |||
$limit = 0, | |||
$courseids = [], | |||
$allaccessible = false, | |||
$offset = 0, | |||
$excludecourses = [] ) |
Returns list of courses current $USER is enrolled in and can access.
The $fields param is a list of field names to ADD so name just the fields you really need, which will be added and uniq'd.
If $allaccessible is true, this will additionally return courses that the current user is not enrolled in, but can access because they are open to the user for other reasons (course view permission, currently viewing course as a guest, or course allows guest access without password).
string | array | $fields | Extra fields to be returned (array or comma-separated list). |
string | null | $sort | Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort. Allowed prefixes for sort fields are: "ul" for the user_lastaccess table, "c" for the courses table, "ue" for the user_enrolments table. |
int | $limit | max number of courses |
array | $courseids | the list of course ids to filter by |
bool | $allaccessible | Include courses user is not enrolled in, but can access |
int | $offset | Offset the result set by this number |
array | $excludecourses | IDs of hidden courses to exclude from search |
array |
enrol_get_period_list | ( | ) |
Get the list of options for the enrolment period dropdown.
array | List of options for the enrolment period dropdown |
enrol_get_plugin | ( | $name | ) |
Returns instance of enrol plugin.
string | $name | name of enrol plugin ('manual', 'guest', ...) |
enrol_plugin |
enrol_get_plugins | ( | $enabled | ) |
Returns instances of enrol plugins.
bool | $enabled | return enabled only |
array | of enrol plugins name=>instance |
moodle_database enrol_get_shared_courses | ( | $user1, | |
$user2, | |||
$preloadcontexts = false, | |||
$checkexistsonly = false ) |
Returns any courses shared by the two users.
The courses has to be visible and enrolments has to be active, timestart and timeend restrictions are ignored.
$DB
stdClass | int | $user1 | |
stdClass | int | $user2 | |
bool | $preloadcontexts | If set to true contexts for the returned courses will be preloaded. |
bool | $checkexistsonly | If set to true then this function will return true if the users share any courses and false if not. |
array|bool | An array of courses that both users are enrolled in OR if $checkexistsonly set returns true if the users share any courses and false if not. |
enrol_get_users_courses | ( | $userid, | |
$onlyactive = false, | |||
$fields = null, | |||
$sort = null ) |
Returns list of courses user is enrolled into.
Note: Use enrol_get_all_users_courses() if you need the list without any capability checks.
The $fields param is a list of field names to ADD so name just the fields you really need, which will be added and uniq'd.
int | $userid | User whose courses are returned, defaults to the current user. |
bool | $onlyactive | Return only active enrolments in courses user may see. |
string | array | $fields | Extra fields to be returned (array or comma-separated list). |
string | null | $sort | Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort. |
array |
enrol_is_enabled | ( | $enrol | ) |
Checks if a given plugin is in the list of enabled enrolment plugins.
string | $enrol | Enrolment plugin name |
boolean | Whether the plugin is enabled |
enrol_output_fragment_user_enrolment_form | ( | $args | ) |
Serve the user enrolment form as a fragment.
array | $args | List of named arguments for the fragment loader. |
string |
enrol_selfenrol_available | ( | $courseid | ) |
Is there a chance users might self enrol.
int | $courseid |
bool |
enrol_send_welcome_email_options | ( | ) |
Send welcome email "from" options.
array | list of from options |
enrol_sharing_course | ( | $user1, | |
$user2 ) |
Do these two students share any course?
The courses has to be visible and enrolments has to be active, timestart and timeend restrictions are ignored.
This function calls {
stdClass | int | $user1 | |
stdClass | int | $user2 |
bool |
enrol_try_internal_enrol | ( | $courseid, | |
$userid, | |||
$roleid = null, | |||
$timestart = 0, | |||
$timeend = 0 ) |
Try to enrol user via default internal auth plugin.
For now this is always using the manual enrol plugin...
$courseid | |
$userid | |
$roleid | |
$timestart | |
$timeend |
bool | success |
enrol_user_delete | ( | $user | ) |
Called when user is about to be deleted.
object | $user |
void |
enrol_user_sees_own_courses | ( | $user = null | ) |
Can user access at least one enrolled course?
Cheat if necessary, but find out as fast as possible!
int | stdClass | $user | null means use current user |
bool |
object environment_check | ( | $version, | |
$env_select ) |
This function will check for everything (DB, PHP and PHP extensions for now) returning an array of environment_result objects.
string | $version | xml version we are going to use to test this server |
int | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. |
environment_results[] | array of results encapsulated in one environment_result object |
environment_check_database | ( | $version, | |
$env_select ) |
This function will check if database requirements are satisfied.
@uses NO_VERSION_DATA_FOUND @uses NO_DATABASE_SECTION_FOUND @uses NO_DATABASE_VENDORS_FOUND @uses NO_DATABASE_VENDOR_MYSQL_FOUND @uses NO_DATABASE_VENDOR_POSTGRES_FOUND @uses NO_DATABASE_VENDOR_VERSION_FOUND
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
object | results encapsulated in one environment_result object |
environment_check_moodle | ( | $version, | |
$env_select ) |
This function will check if Moodle requirements are satisfied.
@uses NO_VERSION_DATA_FOUND
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
object | results encapsulated in one environment_result object |
environment_check_pcre_unicode | ( | $version, | |
$env_select ) |
Looks for buggy PCRE implementation, we need unicode support in Moodle...
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
stdClass | results encapsulated in one environment_result object, null if irrelevant |
environment_check_php | ( | $version, | |
$env_select ) |
This function will check if php requirements are satisfied.
@uses NO_VERSION_DATA_FOUND @uses NO_PHP_SECTION_FOUND @uses NO_PHP_VERSION_FOUND
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
object | results encapsulated in one environment_result object |
environment_check_php_extensions | ( | $version, | |
$env_select ) |
This function will check if php extensions requirements are satisfied.
@uses NO_VERSION_DATA_FOUND @uses NO_PHP_EXTENSIONS_SECTION_FOUND @uses NO_PHP_EXTENSIONS_NAME_FOUND
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
array | array of results encapsulated in one environment_result object |
environment_check_php_settings | ( | $version, | |
$env_select ) |
This function will check if php extensions requirements are satisfied.
@uses NO_VERSION_DATA_FOUND @uses NO_PHP_SETTINGS_NAME_FOUND
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
array | array of results encapsulated in one environment_result object |
environment_check_unicode | ( | $version, | |
$env_select ) |
This function will check if unicode database requirements are satisfied.
@uses NO_VERSION_DATA_FOUND @uses NO_UNICODE_SECTION_FOUND
string | $version | xml version we are going to use to test this server |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
object | results encapsulated in one environment_result object |
environment_custom_checks | ( | $version, | |
$env_select ) |
This function will do the custom checks.
@uses CUSTOM_CHECK_FUNCTION_MISSING @uses CUSTOM_CHECK_FILE_MISSING @uses NO_CUSTOM_CHECK_FOUND
string | $version | xml version we are going to use to test this server. |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
array | array of results encapsulated in environment_result objects. |
environment_get_errors | ( | $environment_results | ) |
Returns array of critical errors in plain text format.
array | $environment_results | array of results gathered |
array | errors |
environment_verify_plugin | ( | $plugin, | |
$pluginxml ) |
Checks if a plugin tag has a name attribute and it matches the plugin being tested.
string | $plugin | the name of the plugin. |
array | $pluginxml | the xmlised structure for the plugin tag being tested. |
boolean | true if the name attribute exists and matches the plugin being tested. |
error | ( | ) |
events_cleanup | ( | ) |
events_cron | ( | ) |
events_dequeue | ( | ) |
events_dispatch | ( | ) |
events_get_cached | ( | ) |
events_get_handlers | ( | ) |
events_is_registered | ( | ) |
events_load_def | ( | ) |
events_pending_count | ( | ) |
events_process_queued_handler | ( | ) |
events_queue_handler | ( | ) |
events_trigger | ( | ) |
events_trigger_legacy | ( | ) |
events_uninstall | ( | ) |
events_update_definition | ( | ) |
exists_auth_plugin | ( | $auth | ) |
Returns whether a given authentication plugin exists.
string | $auth | Form of authentication to check for. Defaults to the global setting in $CFG. |
boolean | Whether the plugin is available. |
external_function_info | ( | ) |
external_update_descriptions | ( | $component | ) |
Web service discovery function used during install and upgrade.
string | $component | name of component (moodle, etc.) |
void |
external_update_services | ( | ) |
Allow plugins and subsystems to add external functions to other plugins or built-in services.
This function is executed just after all the plugins have been updated.
extract_draft_file_urls_from_text | ( | $text, | |
$forcehttps = false, | |||
$contextid = null, | |||
$component = null, | |||
$filearea = null, | |||
$itemid = null, | |||
$filename = null ) |
Factory method for extracting draft file links from arbitrary text using regular expressions.
Only text is required; other file fields may be passed to filter.
string | $text | Some html content. |
bool | $forcehttps | force https urls. |
int | $contextid | This parameter and the next three identify the file area to save to. |
string | $component | The component name. |
string | $filearea | The filearea. |
int | $itemid | The item id for the filearea. |
string | $filename | The specific filename of the file. |
array |
fetch_context_capabilities | ( | ) |
|
abstract |
Override this function to actually implement the filtering.
Filter developers must make sure that filtering done after text cleaning does not introduce security vulnerabilities.
string | $text | some HTML content to process. |
array | $options | options passed to the filters |
string | the HTML content after the filtering has been applied. |
Reimplemented in filter_activitynames, filter_algebra, filter_displayh5p, filter_emoticon, filter_glossary, filter_mathjaxloader, filter_mediaplugin, filter_multilang, filter_tidy, and filter_urltolink.
filter_add_javascript | ( | $text | ) |
Add missing openpopup javascript to HTML files.
string | $text |
string |
filter_context_may_have_filter_settings | ( | $context | ) |
Certain types of context (block and user) may not have local filter settings.
the function checks a context to see whether it may have local config.
object | $context | a context. |
boolean | whether this context may have local filter settings. |
filter_delete_all_for_context | ( | $contextid | ) |
Delete all the data in the database relating to a context, used when contexts are deleted.
integer | $contextid | The id of the context being deleted. |
filter_delete_all_for_filter | ( | $filter | ) |
Delete all the data in the database relating to a filter, prior to deleting it.
string | $filter | The filter name, for example 'tex'. |
filter_get_active_in_context | ( | $context | ) |
Get the list of active filters, in the order that they should be used for a particular context, along with any local configuration variables.
context | $context | a context |
array | an array where the keys are the filter names, for example 'tex' and the values are any local configuration for that filter, as an array of name => value pairs from the filter_config table. In a lot of cases, this will be an empty array. So, an example return value for this function might be array(tex' => array()) |
filter_get_active_state | ( | string | $filtername, |
$contextid = null ) |
Returns the active state for a filter in the given context.
string | $filtername | The filter name, for example 'tex'. |
integer | $contextid | The id of the context to get the data for. |
int | value of active field for the given filter. |
filter_get_all_installed | ( | ) |
Get the names of all the filters installed in this Moodle.
array | path => filter name from the appropriate lang file. e.g. array('tex' => 'TeX Notation'); sorted in alphabetical order of name. |
filter_get_all_local_settings | ( | $contextid | ) |
This function is for use by backup.
Gets all the filter information specific to one context.
int | $contextid |
array | Array with two elements. The first element is an array of objects with fields filter and active. These come from the filter_active table. The second element is an array of objects with fields filter, name and value from the filter_config table. |
filter_get_available_in_context | ( | $context | ) |
List all of the filters that are available in this context, and what the local and inherited states of that filter are.
context | $context | a context that is not the system context. |
array | an array with filter names, for example 'tex' as keys. and and the values are objects with fields: ->filter filter name, same as the key. ->localstate TEXTFILTER_ON/OFF/INHERIT ->inheritedstate TEXTFILTER_ON/OFF - the state that will be used if localstate is set to TEXTFILTER_INHERIT. |
filter_get_global_states | ( | ) |
This function is for use by the filter administration page.
array | 'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder' |
filter_get_globally_enabled | ( | ) |
Return a list of all the filters that may be in use somewhere.
array | where the keys and values are both the filter name, like 'tex'. |
filter_get_globally_enabled_filters_with_config | ( | ) |
Get the globally enabled filters.
This returns the filters which could be used in any context. Essentially the filters which are not disabled for the entire site.
array | Keys are filter names, and values the config. |
filter_get_local_config | ( | $filter, | |
$contextid ) |
Get local config variables for a filter in a context.
Normally (when your filter is running) you don't need to call this, becuase the config is fetched for you automatically. You only need this, for example, when you are getting the config so you can show the user an editing from.
string | $filter | The filter name, for example 'tex'. |
integer | $contextid | The ID of the context to get the local config for. |
array | of name => value pairs. |
filter_get_name | ( | $filter | ) |
Look up the name of this filter.
string | $filter | the filter name |
string | the human-readable name for this filter. |
filter_get_string_filters | ( | ) |
Return the names of the filters that should also be applied to strings (when they are enabled).
array | where the keys and values are both the filter name, like 'tex'. |
filter_has_global_settings | ( | $filter | ) |
Does this filter have a global settings page in the admin tree? (The settings page for a filter must be called, for example, filtersettingfiltertex.)
string | $filter | The filter name, for example 'tex'. |
boolean | Whether there should be a 'Settings' link on the config page. |
filter_has_local_settings | ( | $filter | ) |
Does this filter have local (per-context) settings?
string | $filter | The filter name, for example 'tex'. |
boolean | Whether there should be a 'Settings' link on the manage filters in context page. |
filter_is_enabled | ( | $filtername | ) |
string | $filtername | The filter name, for example 'tex'. |
boolean | is this filter allowed to be used on this site. That is, the admin has set the global 'active' setting to On, or Off, but available. |
filter_phrases | ( | $text, | |
$linkarray, | |||
$ignoretagsopen = null, | |||
$ignoretagsclose = null, | |||
$overridedefaultignore = false, | |||
$linkarrayalreadyprepared = false ) |
Process phrases intelligently found within a HTML text (such as adding links).
string | $text | the text that we are filtering |
filterobject[] | $linkarray | an array of filterobjects |
array | $ignoretagsopen | an array of opening tags that we should ignore while filtering |
array | $ignoretagsclose | an array of corresponding closing tags |
bool | $overridedefaultignore | True to only use tags provided by arguments |
bool | $linkarrayalreadyprepared | True to say that filter_prepare_phrases_for_filtering has already been called for $linkarray. Default false. |
string |
filter_preload_activities | ( | course_modinfo | $modinfo | ) |
Preloads the list of active filters for all activities (modules) on the course using two database queries.
course_modinfo | $modinfo | Course object from get_fast_modinfo |
filter_prepare_phrase_for_replacement | ( | filterobject | $linkobject | ) |
Fill in the remaining ->work... fields, that would be needed to replace the phrase.
filterobject | $linkobject | the link object on which to set additional fields. |
filter_prepare_phrases_for_filtering | ( | array | $linkarray | ) |
Prepare a list of link for processing with filter_phrases().
filterobject[] | $linkarray | the links that will be passed to filter_phrases(). |
filterobject[] | the updated list of links with necessary pre-processing done. |
filter_remove_duplicates | ( | $linkarray | ) |
Remove duplicate from a list of filterobject.
filterobject[] | $linkarray | a list of filterobject. |
filterobject[] | the same list, but with dupicates removed. |
filter_save_ignore_tags | ( | & | $text, |
$filterignoretagsopen, | |||
$filterignoretagsclose, | |||
& | $ignoretags ) |
Extract open/lose tags and their contents to avoid being processed by filters.
Useful to extract pieces of code like ... tags. It returns the text converted with some <#xTEXTFILTER_EXCL_SEPARATORx#> codes replacing the extracted text. Such extracted texts are returned in the ignoretags array (as values), with codes as keys.
string | $text | the text that we are filtering (in/out) |
array | $filterignoretagsopen | an array of open tags to start searching |
array | $filterignoretagsclose | an array of close tags to end searching |
array | $ignoretags | an array of saved strings useful to rebuild the original text (in/out) |
filter_save_tags | ( | & | $text, |
& | $tags ) |
Extract tags (any text enclosed by < and > to avoid being processed by filters.
It returns the text converted with some <xTEXTFILTER_EXCL_SEPARATORx%> codes replacing the extracted text. Such extracted texts are returned in the tags array (as values), with codes as keys.
string | $text | the text that we are filtering (in/out) |
array | $tags | an array of saved strings useful to rebuild the original text (in/out) |
filter_set_applies_to_strings | ( | $filter, | |
$applytostrings ) |
Sets whether a particular active filter should be applied to all strings by format_string, or just used by format_text.
string | $filter | The filter name, for example 'tex'. |
boolean | $applytostrings | if true, this filter will apply to format_string and format_text, when it is enabled. |
filter_set_global_state | ( | $filtername, | |
$state, | |||
$move = 0 ) |
Set the global activated state for a text filter.
string | $filtername | The filter name, for example 'tex'. |
int | $state | One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED. |
int | $move | -1 means up, 0 means the same, 1 means down |
filter_set_local_config | ( | $filter, | |
$contextid, | |||
$name, | |||
$value ) |
Set a particular local config variable for a filter in a context.
string | $filter | The filter name, for example 'tex'. |
integer | $contextid | The id of the context to get the local config for. |
string | $name | the setting name. |
string | $value | the corresponding value. |
filter_set_local_state | ( | $filter, | |
$contextid, | |||
$state ) |
Set the local activated state for a text filter.
string | $filter | The filter name, for example 'tex'. |
integer | $contextid | The id of the context to get the local config for. |
integer | $state | One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT. |
void |
moodle_text_filter::filter_stage_post_clean | ( | string | $text, |
array | $options ) |
Filter HTML text at the very end after text is sanitised.
NOTE: this is called even if $options['noclean'] is true and text is not cleaned.
string | $text | |
array | $options |
string |
moodle_text_filter::filter_stage_pre_clean | ( | string | $text, |
array | $options ) |
Filter HTML text before sanitising text.
NOTE: this is called even if $options['noclean'] is true and text is not cleaned.
string | $text | |
array | $options |
string |
moodle_text_filter::filter_stage_pre_format | ( | string | $text, |
array | $options ) |
Filter text before changing format to HTML.
string | $text | |
array | $options |
string |
moodle_text_filter::filter_stage_string | ( | string | $text, |
array | $options ) |
Filter simple text coming from format_string().
Note that unless $CFG->formatstringstriptags is disabled HTML tags are not expected in returned value.
string | $text | |
array | $options |
string |
filter_manager::filter_string | ( | $string, | |
$context ) |
Filter a piece of string.
string | $string | The text to filter |
context | $context | the context. |
string | resulting string |
Reimplemented in performance_measuring_filter_manager.
null_filter_manager::filter_string | ( | $string, | |
$context ) |
As for the equivalent filter_manager method.
string | $string | The text to filter |
context | $context | not used. |
string | resulting string |
performance_measuring_filter_manager::filter_string | ( | $string, | |
$context ) |
Filter a piece of string.
string | $string | The text to filter |
context | $context | the context. |
string | resulting string |
Reimplemented from filter_manager.
filter_manager::filter_text | ( | $text, | |
$context, | |||
array | $options = array(), | ||
array | $skipfilters = null ) |
Filter some text.
string | $text | The text to filter |
context | $context | the context. |
array | $options | options passed to the filters |
array | $skipfilters | of filter names. Any filters that should not be applied to this text. |
string | resulting text |
Reimplemented in performance_measuring_filter_manager.
filter_text | ( | ) |
null_filter_manager::filter_text | ( | $text, | |
$context, | |||
array | $options = array(), | ||
array | $skipfilters = null ) |
As for the equivalent filter_manager method.
string | $text | The text to filter |
context | $context | not used. |
array | $options | not used |
array | $skipfilters | not used |
string | resulting text. |
performance_measuring_filter_manager::filter_text | ( | $text, | |
$context, | |||
array | $options = array(), | ||
array | $skipfilters = null ) |
Filter some text.
string | $text | The text to filter |
context | $context | the context. |
array | $options | options passed to the filters |
array | $skipfilters | of filter names. Any filters that should not be applied to this text. |
string | resulting text |
Reimplemented from filter_manager.
filter_unset_local_config | ( | $filter, | |
$contextid, | |||
$name ) |
Remove a particular local config variable for a filter in a context.
string | $filter | The filter name, for example 'tex'. |
integer | $contextid | The id of the context to get the local config for. |
string | $name | the setting name. |
find_day_in_month | ( | $startday, | |
$weekday, | |||
$month, | |||
$year ) |
Calculates when the day appears in specific month.
int | $startday | starting day of the month |
int | $weekday | The day when week starts (normally taken from user preferences) |
int | $month | The month whose day is sought |
int | $year | The year of the month whose day is sought |
int |
fix_align_rtl | ( | $align | ) |
Returns swapped left<=> right if in RTL environment.
Part of RTL Moodles support.
string | $align | align to check |
string |
object fix_course_sortorder | ( | ) |
Fixes course category and course sortorder, also verifies category and course parents and paths.
(circular references are not fixed)
@global object @uses MAX_COURSE_CATEGORIES @uses SITEID @uses CONTEXT_COURSE
void |
fix_current_language | ( | string | $lang | ) |
Fix the current language to the given language code.
string | $lang | The language code to use. |
void |
fix_utf8 | ( | $value | ) |
Makes sure the data is using valid utf8, invalid characters are discarded.
Note: this function is not intended for full objects with methods and private properties.
mixed | $value |
mixed | with proper utf-8 encoding |
flatten_category_tree | ( | & | $categories, |
$id, | |||
$depth = 0, | |||
$nochildrenof = -1 ) |
Private method, only for the use of add_indented_names().
Recursively adds an indentedname field to each category, starting with the category with id $id, and dealing with that category and all its children, and return a new array, with those categories in the right order.
array | $categories | an array of categories which has had childids fields added by flatten_category_tree(). Passed by reference for performance only. It is not modfied. |
int | $id | the category to start the indenting process from. |
int | $depth | the indent depth. Used in recursive calls. |
int | $nochildrenof |
array | a new array of categories, in the right order for the tree. |
force_current_language | ( | $language | ) |
Force the current language to get strings and dates localised in the given language.
After calling this function, all strings will be provided in the given language until this function is called again, or equivalent code is run.
string | $language |
string | previous $SESSION->forcelang value |
format_admin_setting | ( | $setting, | |
$title = '', | |||
$form = '', | |||
$description = '', | |||
$label = true, | |||
$warning = '', | |||
$defaultinfo = NULL, | |||
$query = '' ) |
Format admin settings.
object | $setting | |
string | $title | label element |
string | $form | form fragment, html code - not highlighted automatically |
string | $description | |
mixed | $label | link label to id, true by default or string being the label to connect it to |
string | $warning | warning text |
sting | $defaultinfo | defaults info, null means nothing, '' is converted to "Empty" string, defaults to null |
string | $query | search query to be highlighted |
string | XHTML |
format_backtrace | ( | $callers, | |
$plaintext = false ) |
Formats a backtrace ready for output.
This function does not include function arguments because they could contain sensitive information not suitable to be exposed in a response.
array | $callers | backtrace array, as returned by debug_backtrace(). |
boolean | $plaintext | if false, generates HTML, if true generates plain text. |
string | formatted backtrace, ready for output. |
format_float | ( | $float, | |
$decimalpoints = 1, | |||
$localized = true, | |||
$stripzeros = false ) |
Given a float, prints it nicely.
Localized floats must not be used in calculations!
The stripzeros feature is intended for making numbers look nicer in small areas where it is not necessary to indicate the degree of accuracy by showing ending zeros. If you turn it on with $decimalpoints set to 3, for example, then it will display '5.4' instead of '5.400' or '5' instead of '5.000'.
float | $float | The float to print |
int | $decimalpoints | The number of decimal places to print. -1 is a special value for auto detect (full precision). |
bool | $localized | use localized decimal separator |
bool | $stripzeros | If true, removes final zeros after decimal point. It will be ignored and the trailing zeros after the decimal point are always striped if $decimalpoints is -1. |
string | locale float |
format_module_intro | ( | $module, | |
$activity, | |||
$cmid, | |||
$filter = true ) |
Formats activity intro text.
string | $module | name of module |
object | $activity | instance of activity |
int | $cmid | course module id |
bool | $filter | filter resulting html text |
string |
format_string | ( | $string, | |
$striplinks = true, | |||
$options = null ) |
Given a simple string, this function returns the string processed by enabled string filters if $CFG->filterall is enabled.
This function should be used to print short strings (non html) that need filter processing e.g. activity titles, post subjects, glossary concepts.
@staticvar bool $strcache
string | $string | The string to be filtered. Should be plain text, expect possibly for multilang tags. |
boolean | $striplinks | To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713 |
array | $options | options array/object or courseid |
string |
format_text | ( | $text, | |
$format = FORMAT_MOODLE, | |||
$options = null, | |||
$courseiddonotuse = null ) |
Given text in a variety of format codings, this function returns the text as safe HTML.
This function should mainly be used for long strings like posts, answers, glossary items etc. For short strings format_string().
Options: trusted : If true the string won't be cleaned. Default false required noclean=true. noclean : If true the string won't be cleaned, unless $CFG->forceclean is set. Default false required trusted=true. nocache : If true the strign will not be cached and will be formatted every call. Default false. filter : If true the string will be run through applicable filters as well. Default true. para : If true then the returned string will be wrapped in div tags. Default true. newlines : If true then lines newline breaks will be converted to HTML newline breaks. Default true. context : The context that will be used for filtering. overflowdiv : If set to true the formatted text will be encased in a div with the class no-overflow before being returned. Default false. allowid : If true then id attributes will not be removed, even when using htmlpurifier. Default false. blanktarget : If true all tags will have target="_blank" added unless target is explicitly specified.
@staticvar array $croncache
string | $text | The text to be formatted. This is raw text originally from user input. |
int | $format | Identifier of the text format to be used [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN] |
stdClass | array | $options | text formatting options |
int | $courseiddonotuse | deprecated course id, use context option instead |
string |
format_text_email | ( | $text, | |
$format ) |
Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.
string | $text | The text to be formatted. This is raw text originally from user input. |
int | $format | Identifier of the text format to be used [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN] |
string |
format_text_menu | ( | ) |
Just returns an array of text formats suitable for a popup menu.
array |
format_time | ( | $totalsecs, | |
$str = null ) |
Format a date/time (seconds) as weeks, days, hours etc as needed.
Given an amount of time in seconds, returns string formatted nicely as years, days, hours etc as needed
@uses MINSECS @uses HOURSECS @uses DAYSECS @uses YEARSECS
int | $totalsecs | Time in seconds |
stdClass | $str | Should be a time object |
string | A nicely formatted date/time string |
format_weeks_get_section_dates | ( | ) |
formerr | ( | ) |
fullclone | ( | $thing | ) |
This function will make a complete copy of anything it's given, regardless of whether it's an object or not.
mixed | $thing | Something you want cloned |
mixed | What ever it is you passed it |
fullname | ( | $user, | |
$override = false ) |
Returns a persons full name.
Given an object containing all of the users name values, this function returns a string with the full name of the person. The result may depend on system settings or language. 'override' will force the alternativefullnameformat to be used. In English, fullname as well as alternativefullnameformat is set to 'firstname lastname' by default. But you could have fullname set to 'firstname lastname' and alternativefullnameformat set to 'firstname middlename alternatename lastname'.
stdClass | $user | A $USER object to get full name of. |
bool | $override | If true then the alternativefullnameformat format rather than fullnamedisplay format will be used. |
string |
gc_cache_flags | ( | ) |
Garbage-collect volatile flags.
bool | Always returns true |
generate_email_messageid | ( | $localpart = null | ) |
Generate a unique email Message-ID using the moodle domain and install path.
string | $localpart | An optional unique message id prefix. |
string | The formatted ID ready for appending to the email headers. |
generate_email_processing_address | ( | $modid, | |
$modargs ) |
Generate an email processing address.
int | $modid | |
string | $modargs |
string | Returns email processing address |
generate_email_signoff | ( | ) |
Generate a signoff for emails based on support settings.
string |
generate_email_supportuser | ( | ) |
generate_image_thumbnail | ( | $filepath, | |
$width, | |||
$height ) |
Generates a thumbnail for the given image.
If the GD library has at least version 2 and PNG support is available, the returned data is the content of a transparent PNG file containing the thumbnail. Otherwise, the function returns contents of a JPEG file with black background containing the thumbnail.
string | $filepath | the full path to the original image file |
int | $width | the width of the requested thumbnail |
int | $height | the height of the requested thumbnail |
string|bool | false if a problem occurs, the thumbnail image data otherwise |
generate_image_thumbnail_from_image | ( | $original, | |
$imageinfo, | |||
$width, | |||
$height ) |
Generates a thumbnail for the given image string.
If the GD library has at least version 2 and PNG support is available, the returned data is the content of a transparent PNG file containing the thumbnail. Otherwise, the function returns contents of a JPEG file with black background containing the thumbnail.
resource | $original | The image to work on. |
array | $imageinfo | Contains [0] => originalwidth, [1] => originalheight. |
int | $width | The width of the requested thumbnail. |
int | $height | The height of the requested thumbnail. |
string|bool | False if a problem occurs, the thumbnail image data otherwise. |
generate_image_thumbnail_from_string | ( | $filedata, | |
$width, | |||
$height ) |
Generates a thumbnail for the given image string.
If the GD library has at least version 2 and PNG support is available, the returned data is the content of a transparent PNG file containing the thumbnail. Otherwise, the function returns contents of a JPEG file with black background containing the thumbnail.
string | $filedata | The image content as a string |
int | $width | the width of the requested thumbnail |
int | $height | the height of the requested thumbnail |
string|bool | false if a problem occurs, the thumbnail image data otherwise |
generate_page_type_patterns | ( | $pagetype, | |
$parentcontext = null, | |||
$currentcontext = null ) |
Given a specific page type, parent context and currect context, return all the page type patterns that might be used by this block.
string | $pagetype | for example 'course-view-weeks' or 'mod-quiz-view'. |
stdClass | $parentcontext | Block's parent context |
stdClass | $currentcontext | Current context of block |
array | an array of all the page type patterns that might match this page type. |
generate_password | ( | $maxlen = 10 | ) |
generate_uuid | ( | ) |
get_accesshide | ( | $text, | |
$elem = 'span', | |||
$class = '', | |||
$attrs = '' ) |
Return a HTML element with the class "accesshide", for accessibility.
Please use cautiously - where possible, text should be visible!
string | $text | Plain text. |
string | $elem | Lowercase element name, default "span". |
string | $class | Additional classes for the element. |
string | $attrs | Additional attributes string in the form, "name='value' name2='value2'" |
string | HTML string. |
|
static |
Number of seconds to wait before updating lastaccess information in DB.
We allow overwrites from config.php, useful to ensure coherence in performance tests results.
Note: For web service requests in the external_tokens field, we use a different constant webservice\TOKEN_LASTACCESS_UPDATE_SECS. Returns $user object of the main admin user
stdClass $mainadmin
get_admins | ( | ) |
Returns list of all admins, using 1 DB query.
array |
|
static |
Returns hash of all core + plugin /db/ directories.
This is relatively slow and not fully cached, use with care!
array | null | $components | optional component directory => hash array to use. Only used in PHPUnit. |
string | sha1 hash. |
|
static |
Get the hashes of all core + plugin /db/ directories.
array | null | $directories | optional component directory array to hash. Only used in PHPUnit. |
array | of directory => hash. |
get_all_instances_in_course | ( | $modulename, | |
$course, | |||
$userid = NULL, | |||
$includeinvisible = false ) |
Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined.
Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined in the course. Returns an empty array on any errors.
The returned objects includle the columns cw.section, cm.visible, cm.groupmode, and cm.groupingid, and are indexed by cm.id.
Simply calls all_instances_in_courses() with a single provided course
string | $modulename | The name of the module to get instances for |
object | $course | The course obect. |
array | of module instance objects, including some extra fields from the course_modules and course_sections tables, or an empty array if an error occurred. |
int | $userid | |
int | $includeinvisible |
object get_all_instances_in_courses | ( | $modulename, | |
$courses, | |||
$userid = NULL, | |||
$includeinvisible = false ) |
Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined.
Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined in the course. Returns an empty array on any errors.
The returned objects includle the columns cw.section, cm.visible, cm.groupmode, cm.groupingid and cm.lang and are indexed by cm.id.
@global object
string | $modulename | The name of the module to get instances for |
array | $courses | an array of course objects. |
int | $userid | |
int | $includeinvisible |
array | of module instance objects, including some extra fields from the course_modules and course_sections tables, or an empty array if an error occurred. |
get_all_mods | ( | ) |
get_all_sections | ( | ) |
get_all_subcategories | ( | ) |
get_all_user_name_fields | ( | $returnsql = false, | |
$tableprefix = null, | |||
$prefix = null, | |||
$fieldprefix = null, | |||
$order = false ) |
A centralised location for the all name fields.
Returns an array / sql string snippet.
bool | $returnsql | True for an sql select field snippet. |
string | $tableprefix | table query prefix to use in front of each field. |
string | $prefix | prefix added to the name fields e.g. authorfirstname. |
string | $fieldprefix | sql field prefix e.g. id AS userid. |
bool | $order | moves firstname and lastname to the top of the array / start of the string. |
array|string | All name fields. |
|
static |
Returns hash of all versions including core and all plugins.
This is relatively slow and not fully cached, use with care!
array | as (string)plugintype_pluginname => (int)version |
|
static |
Returns hash of all versions including core and all plugins.
This is relatively slow and not fully cached, use with care!
string | sha1 hash |
get_array_of_activities | ( | int | $courseid, |
bool | $usecache = false ) |
For a given course, returns an array of course activity objects Each item in the array contains he following properties:
int | $courseid | course id |
bool | $usecache | get activities from cache if modinfo exists when $usecache is true |
array | list of activities |
get_auth_plugin | ( | $auth | ) |
Returns an authentication plugin instance.
string | $auth | name of authentication plugin |
auth_plugin_base | An instance of the required authentication plugin. |
get_backpack_settings | ( | $userid, | |
$refresh = false ) |
Returns external backpack settings and badges from this backpack.
This function first checks if badges for the user are cached and tries to retrieve them from the cache. Otherwise, badges are obtained through curl request to the backpack.
int | $userid | Backpack user ID. |
boolean | $refresh | Refresh badges collection in cache. |
null|object | Returns null is there is no backpack or object with backpack settings. |
get_backup_temp_directory | ( | $directory | ) |
Get the full path of a directory under $CFG->backuptempdir.
string | $directory | the relative path of the directory under $CFG->backuptempdir |
string|false | Returns full path to directory given a valid string; otherwise, false. |
get_browser_version_classes | ( | ) |
get_cache_flag | ( | $type, | |
$name, | |||
$changedsince = null ) |
Get volatile flags.
string | $type | |
string | $name | |
int | $changedsince | default null |
string|false | The cache flag value or false |
get_cache_flags | ( | $type, | |
$changedsince = null ) |
Get volatile flags.
string | $type | |
int | $changedsince | default null |
array | records array |
get_callable_name | ( | $callable | ) |
Get human readable name describing the given callable.
This performs syntax check only to see if the given param looks like a valid function, method or closure. It does not check if the callable actually exists.
callable | string | array | $callable |
string|bool | Human readable name of callable, or false if not a valid callable. |
get_categories | ( | ) |
get_categories_for_contexts | ( | $contexts, | |
$sortorder = 'parent, | |||
sortorder | , | ||
name ASC' | , | ||
$top = false ) |
Get all the category objects, including a count of the number of questions in that category, for all the categories in the lists $contexts.
mixed | $contexts | either a single contextid, or a comma-separated list of context ids. |
string | $sortorder | used as the ORDER BY clause in the select statement. |
bool | $top | Whether to return the top categories or not. |
array | of category objects. |
get_category_courses_array | ( | ) |
get_category_courses_array_recursively | ( | ) |
get_child_categories | ( | ) |
get_child_contexts | ( | ) |
get_clam_error_code | ( | ) |
get_complete_user_data | ( | $field, | |
$value, | |||
$mnethostid = null, | |||
$throwexception = false ) |
Get a complete user record, which includes all the info in the user record.
Intended for setting as $USER session variable
string | $field | The user field to be checked for a given value. |
string | $value | The value to match for $field. |
int | $mnethostid | |
bool | $throwexception | If true, it will throw an exception when there's no record found or when there are multiple records found. Otherwise, it will just return false. |
mixed | False, or A $USER object. |
|
static |
Returns all classes in a component matching the provided namespace.
It checks that the class exists.
e.g. get_component_classes_in_namespace('mod_forum', 'event')
string | null | $component | A valid moodle component (frankenstyle) or null if searching all components |
string | $namespace | Namespace from the component name or empty string if all $component classes. |
array | The full class name as key and the class path as value, empty array if $component is null and $namespace is empty. |
|
static |
Return exact absolute path to a plugin directory.
string | $component | name such as 'moodle', 'mod_forum' |
string | full path to component directory; NULL if not found |
string | $component | name such as 'moodle', 'mod_forum' |
string | full path to component directory; NULL if not found |
|
static |
Returns a list of frankenstyle component names and their paths, for all components (plugins and subsystems).
E.g. [ 'mod' => [ 'mod_forum' => FORUM_PLUGIN_PATH, ... ], ... 'core' => [ 'core_comment' => COMMENT_SUBSYSTEM_PATH, ... ] ]
array | an associative array of components and their corresponding paths. |
|
static |
Returns a list of frankenstyle component names.
E.g. [ 'core_course', 'core_message', 'mod_assign', ... ]
array | the list of frankenstyle component names. |
get_component_version | ( | $component, | |
$source = 'installed' ) |
Returns the version of installed component.
string | $component | component name |
string | $source | either 'disk' or 'installed' - where to get the version information from |
string|bool | version number or false if the component is not found |
get_config | ( | $plugin, | |
$name = null ) |
Get configuration values from the global config table or the config_plugins table.
If called with one parameter, it will load all the config variables for one plugin, and return them as an object.
If called with 2 parameters it will return a string single value or false if the value is not found.
NOTE: this function is called from lib/db/upgrade.php
string | $plugin | full component name |
string | $name | default null |
mixed | hash-like object or single value, return false no config found |
dml_exception |
get_context_instance | ( | $contextlevel, | |
$instance = 0, | |||
$strictness = IGNORE_MISSING ) |
Get the context instance as an object.
This function will create the context instance if it does not exist yet.
integer | $contextlevel | The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE. |
integer | $instance | The instance id. For $level = CONTEXT_COURSE, this would be $course->id, for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0 |
int | $strictness | IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found |
context | The context object. |
get_context_instance_by_id | ( | ) |
get_context_url | ( | ) |
get_contextlevel_name | ( | ) |
|
static |
Returns the list of available API names.
string[] | the list of available API names. |
|
static |
List all core APIs and their attributes.
This is a list of all the existing / allowed APIs in moodle, each one with the following attributes:
stdClass[] | array of APIs (as keys) with their attributes as object instances. |
get_core_subsystems | ( | $fullpaths = false | ) |
List all core subsystems and their location.
This is a list of components that are part of the core and their language strings are defined in /lang/en/<<subsystem>>.php. If a given plugin is not listed here and it does not have proper plugintype prefix, then it is considered as course activity module.
The location is optionally dirroot relative path. NULL means there is no special directory for this subsystem. If the location is set, the subsystem's renderer.php is expected to be there.
bool | $fullpaths | false means relative paths from dirroot, use true for performance reasons |
array | of (string)name => (string|null)location |
|
static |
List all core subsystems and their location.
This is a list of components that are part of the core and their language strings are defined in /lang/en/<<subsystem>>.php. If a given plugin is not listed here and it does not have proper plugintype prefix, then it is considered as course activity module.
The location is absolute file path to dir. NULL means there is no special directory for this subsystem. If the location is set, the subsystem's renderer.php is expected to be there.
array | of (string)name => (string|null)full dir location |
get_course | ( | $courseid, | |
$clone = true ) |
Gets a course object from database.
If the course id corresponds to an already-loaded $COURSE or $SITE object, then the loaded object will be used, saving a database query.
If it reuses an existing object, by default the object will be cloned. This means you can modify the object safely without affecting other code.
int | $courseid | Course id |
bool | $clone | If true (default), makes a clone of the record |
stdClass | A course object |
dml_exception | If not found in database |
get_course_and_cm_from_cmid | ( | $cmorid, | |
$modulename = '', | |||
$courseorid = 0, | |||
$userid = 0 ) |
Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given a cmid.
If module name is also provided, it will ensure the cm is of that type.
Usage: list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum');
Using this method has a performance advantage because it works by loading modinfo for the course - which will then be cached and it is needed later in most requests. It also guarantees that the $cm object is a cm_info and not a stdclass.
The $course object can be supplied if already known and will speed up this function - although it is more efficient to use this function to get the course if you are starting from a cmid.
To avoid security problems and obscure bugs, you should always specify $modulename if the cmid value came from user input.
By default this obtains information (for example, whether user can access the activity) for current user, but you can specify a userid if required.
stdClass | int | $cmorid | Id of course-module, or database object |
string | $modulename | Optional modulename (improves security) |
stdClass | int | $courseorid | Optional course object if already loaded |
int | $userid | Optional userid (default = current) |
array | Array with 2 elements $course and $cm |
moodle_exception | If the item doesn't exist or is of wrong module name |
get_course_and_cm_from_instance | ( | $instanceorid, | |
$modulename, | |||
$courseorid = 0, | |||
$userid = 0 ) |
Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given an instance id or record and module name.
Usage: list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
Using this method has a performance advantage because it works by loading modinfo for the course - which will then be cached and it is needed later in most requests. It also guarantees that the $cm object is a cm_info and not a stdclass.
The $course object can be supplied if already known and will speed up this function - although it is more efficient to use this function to get the course if you are starting from an instance id.
By default this obtains information (for example, whether user can access the activity) for current user, but you can specify a userid if required.
stdclass | int | $instanceorid | Id of module instance, or database object |
string | $modulename | Modulename (required) |
stdClass | int | $courseorid | Optional course object if already loaded |
int | $userid | Optional userid (default = current) |
array | Array with 2 elements $course and $cm |
moodle_exception | If the item doesn't exist or is of wrong module name |
get_course_category | ( | ) |
get_course_category_tree | ( | ) |
get_course_context | ( | ) |
get_course_display_name_for_list | ( | $course | ) |
Gets the name of a course to be displayed when showing a list of courses.
By default this is just $course->fullname but user can configure it. The result of this function should be passed through print_string.
stdClass | core_course_list_element | $course | Moodle course object |
string | Display name of course (either fullname or short + fullname) |
object get_course_mods | ( | $courseid | ) |
MODULE FUNCTIONS /////////////////////////////////////////////////.
Just gets a raw list of all modules in a course
int | $courseid | The id of the course as found in the 'course' table. |
array |
get_course_participants | ( | ) |
get_course_section | ( | ) |
get_courseid_from_context | ( | ) |
object get_coursemodule_from_id | ( | $modulename, | |
$cmid, | |||
$courseid = 0, | |||
$sectionnum = false, | |||
$strictness = IGNORE_MISSING ) |
Given an id of a course module, finds the coursemodule description.
Please note that this function performs 1-2 DB queries. When possible use cached course modinfo. For example get_fast_modinfo($courseorid)->get_cm($cmid) See also cm_info::get_course_module_record()
string | $modulename | name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified) |
int | $cmid | course module id (id in course_modules table) |
int | $courseid | optional course id for extra validation |
bool | $sectionnum | include relative section number (0,1,2 ...) |
int | $strictness | IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended); MUST_EXIST means throw exception if no record or multiple records found |
stdClass |
object get_coursemodule_from_instance | ( | $modulename, | |
$instance, | |||
$courseid = 0, | |||
$sectionnum = false, | |||
$strictness = IGNORE_MISSING ) |
Given an instance number of a module, finds the coursemodule description.
Please note that this function performs DB query. When possible use cached course modinfo. For example get_fast_modinfo($courseorid)->instances[$modulename][$instance] See also cm_info::get_course_module_record()
string | $modulename | name of module type, eg. resource, assignment,... |
int | $instance | module instance number (id in resource, assignment etc. table) |
int | $courseid | optional course id for extra validation |
bool | $sectionnum | include relative section number (0,1,2 ...) |
int | $strictness | IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended); MUST_EXIST means throw exception if no record or multiple records found |
stdClass |
get_coursemodules_in_course | ( | $modulename, | |
$courseid, | |||
$extrafields = '' ) |
Returns all course modules of given activity in course.
string | $modulename | The module name (forum, quiz, etc.) |
int | $courseid | The course id to get modules for |
string | $extrafields | extra fields starting with m. |
array | Array of results |
core_course_category::get_courses | ( | $options = array() | ) |
Retrieves the list of courses accessible by user.
was called with option 'summary'.
Not all information is cached, try to avoid calling this method twice in the same request.
The following fields are always retrieved:
If you plan to use properties/methods core_course_list_element\$summary and/or core_course_list_element\get_course_contacts() you can preload this information using appropriate 'options'. Otherwise they will be retrieved from DB on demand and it may end with bigger DB load.
Note that method core_course_list_element\has_summary() will not perform additional DB queries even if $options['summary'] is not specified
List of found course ids is cached for 10 minutes. Cache may be purged prior to this when somebody edits courses or categories, however it is very difficult to keep track of all possible changes that may affect list of courses.
array | $options | options for retrieving children
|
core_course_list_element[] |
Otherwise will be retrieved from DB on first request
object get_courses | ( | $categoryid = "all", | |
$sort = "c.sortorder ASC", | |||
$fields = "c.*" ) |
Returns list of courses, for whole site, or category.
Returns list of courses, for whole site, or category Important: Using c.* for fields is extremely expensive because we are using distinct. You almost NEVER need all the fields in such a large SELECT
Consider using core_course_category\get_courses() or core_course_category\search_courses() instead since they use caching.
@global object @global object @uses CONTEXT_COURSE
string | int | $categoryid | Either a category id or 'all' for everything |
string | $sort | A field and direction to sort by |
string | $fields | The additional fields to return (note that "id, category, visible" are always present) |
array | Array of courses |
get_courses_page | ( | ) |
object get_courses_search | ( | $searchterms, | |
$sort, | |||
$page, | |||
$recordsperpage, | |||
& | $totalcount, | ||
$requiredcapabilities = array(), | |||
$searchcond = [], | |||
$params = [] ) |
A list of courses that match a search.
@global object
array | $searchterms | An array of search criteria |
string | $sort | A field and direction to sort by |
int | $page | The page number to get |
int | $recordsperpage | The number of records per page |
int | $totalcount | Passed in by reference. |
array | $requiredcapabilities | Extra list of capabilities used to filter courses |
array | $searchcond | additional search conditions, for example ['c.enablecompletion = :p1'] |
array | $params | named parameters for additional search conditions, for example ['p1' => 1] |
stdClass[] | $COURSE records |
get_courses_wmanagers | ( | ) |
get_current_group | ( | ) |
get_db_directories | ( | ) |
Returns list of all directories where we expect install.xml files.
array | Array of paths |
|
abstractprotected |
Gets db handle currently used with queries.
resource |
get_default_home_page | ( | ) |
Returns the default home page to display if current one is not defined or can't be applied.
The default behaviour is to return Dashboard if it's enabled or My courses page if it isn't.
int | The default home page. |
get_device_cfg_var_name | ( | ) |
get_device_type | ( | ) |
get_device_type_list | ( | ) |
get_directory_list | ( | $rootdir, | |
$excludefiles = '', | |||
$descend = true, | |||
$getdirs = false, | |||
$getfiles = true ) |
Returns an array with all the filenames in all subdirectories, relative to the given rootdir.
If excludefiles is defined, then that file/directory is ignored If getdirs is true, then (sub)directories are included in the output If getfiles is true, then files are included in the output (at least one of these must be true!)
string | $rootdir | A given root directory to start from |
string | array | $excludefiles | If defined then the specified file/directory is ignored |
bool | $descend | If true then subdirectories are recursed as well |
bool | $getdirs | If true then (sub)directories are included in the output |
bool | $getfiles | If true then files are included in the output |
array | An array with all the filenames in all subdirectories, relative to the given rootdir |
get_directory_size | ( | $rootdir, | |
$excludefile = '' ) |
Adds up all the files in a directory and works out the size.
string | $rootdir | The directory to start from |
string | $excludefile | A file to exclude when summing directory size |
int | The summed size of all files and subfiles within the root directory |
get_docs_url | ( | $path = null | ) |
Returns the Moodle Docs URL in the users language for a given 'More help' link.
There are three cases:
This is the only option that should be used in standard Moodle code. The other two options have been implemented because they are useful for third-party plugins.
string | $path | the place to link to. See above for details. |
string | The MoodleDocs URL in the user's language. for example $path} |
get_emoticon_manager | ( | ) |
Factory function for emoticon_manager.
emoticon_manager | singleton |
get_enabled_auth_plugins | ( | $fix = false | ) |
Returns array of active auth plugins.
bool | $fix | fix $CFG->auth if needed. Only set if logged in as admin. |
array |
get_enrolled_join | ( | context | $context, |
$useridcolumn, | |||
$onlyactive = false, | |||
$onlysuspended = false, | |||
$enrolid = 0 ) |
Returns array with sql joins and parameters returning all ids of users enrolled into course.
This function is using 'ej[0-9]+_' prefix for table names and parameters.
coding_exception |
context | $context | |
string | $useridcolumn | User id column used the calling query, e.g. u.id |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
bool | $onlysuspended | inverse of onlyactive, consider only suspended enrolments |
int | $enrolid | The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned. |
core\dml\sql_join | Contains joins, wheres, params |
get_enrolled_sql | ( | context | $context, |
$withcapability = '', | |||
$groupids = 0, | |||
$onlyactive = false, | |||
$onlysuspended = false, | |||
$enrolid = 0 ) |
Returns array with sql code and parameters returning all ids of users enrolled into course.
This function is using 'eu[0-9]+_' prefix for table names and parameters.
context | $context | |
string | $withcapability | |
int | array | $groupids | The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
bool | $onlysuspended | inverse of onlyactive, consider only suspended enrolments |
int | $enrolid | The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned. |
array | list($sql, $params) |
get_enrolled_users | ( | context | $context, |
$withcapability = '', | |||
$groupids = 0, | |||
$userfields = 'u.*', | |||
$orderby = null, | |||
$limitfrom = 0, | |||
$limitnum = 0, | |||
$onlyactive = false ) |
Returns list of users enrolled into course.
context | $context | |
string | $withcapability | |
int | array | $groupids | The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group |
string | $userfields | requested user record fields |
string | $orderby | |
int | $limitfrom | return a subset of records, starting at this point (optional, required if $limitnum is set). |
int | $limitnum | return a subset comprising this many records (optional, required if $limitfrom is set). |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
array | of user records |
get_enrolled_with_capabilities_join | ( | context | $context, |
$prefix = '', | |||
$capability = '', | |||
$groupids = 0, | |||
$onlyactive = false, | |||
$onlysuspended = false, | |||
$enrolid = 0 ) |
Returns an array of joins, wheres and params that will limit the group of users to only those enrolled and with given capability (if specified).
Note this join will return duplicate rows for users who have been enrolled several times (e.g. as manual enrolment, and as self enrolment). You may need to use a SELECT DISTINCT in your query (see get_enrolled_sql for example).
In case is guaranteed some of the joins never match any rows, the resulting join_sql->cannotmatchanyrows will be true. This happens when the capability is prohibited.
context | $context | |
string | $prefix | optional, a prefix to the user id column |
string | array | $capability | optional, may include a capability name, or array of names. If an array is provided then this is the equivalent of a logical 'OR', i.e. the user needs to have one of these capabilities. |
int | array | $groupids | The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
bool | $onlysuspended | inverse of onlyactive, consider only suspended enrolments |
int | $enrolid | The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned. |
core\dml\sql_join | Contains joins, wheres, params and cannotmatchanyrows |
get_environment_for_version | ( | $version, | |
$env_select ) |
This function will return the xmlized data belonging to one Moodle version.
string | $version | top version from which we start to look backwards |
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
mixed | the xmlized structure or false on error |
get_exception_info | ( | $ex | ) |
Returns detailed information about specified exception.
Throwable | $ex | any sort of exception or throwable. |
stdClass | standardised info to display. Fields are clear if you look at the end of this function. |
get_extra_user_fields | ( | $context, | |
$already = array() ) |
Checks if current user is shown any extra fields when listing users.
Does not include any custom profile fields.
object | $context | Context |
array | $already | Array of fields that we're going to show anyway so don't bother listing them |
array | Array of field names from user table, not including anything listed in $already |
get_extra_user_fields_sql | ( | $context, | |
$alias = '', | |||
$prefix = '', | |||
$already = array() ) |
If the current user is to be shown extra user fields when listing or selecting users, returns a string suitable for including in an SQL select clause to retrieve those fields.
Does not include any custom profile fields.
context | $context | Context |
string | $alias | Alias of user table, e.g. 'u' (default none) |
string | $prefix | Prefix for field names using AS, e.g. 'u_' (default none) |
array | $already | Array of fields that we're going to include anyway so don't list them (default none) |
string | Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank |
get_fast_modinfo | ( | $courseorid, | |
$userid = 0, | |||
$resetonly = false ) |
Returns reference to full info about modules in course (including visibility).
Cached and as fast as possible (0 or 1 db query).
use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
use rebuild_course_cache($courseid, true) to reset the application AND static cache for particular course when it's contents has changed
int | stdClass | $courseorid | object from DB table 'course' (must have field 'id' and recommended to have field 'cacherev') or just a course id. Just course id is enough when calling get_fast_modinfo() for current course or site or when calling for any other course for the second time. |
int | $userid | User id to populate 'availble' and 'uservisible' attributes of modules and sections. Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data. |
bool | $resetonly | whether we want to get modinfo or just reset the cache |
course_modinfo|null | Module information for course, or null if resetting |
moodle_exception | when course is not found (nothing is thrown if resetting) |
get_file_argument | ( | ) |
Extracts file argument either from file parameter or PATH_INFO.
Note: $scriptname parameter is not needed anymore
string | file path (only safe characters) |
get_file_browser | ( | ) |
Returns local file storage instance.
file_browser |
get_file_packer | ( | $mimetype = 'application/zip' | ) |
get_file_storage | ( | $reset = false | ) |
Returns local file storage instance.
file_storage |
get_file_url | ( | ) |
get_formatted_help_string | ( | $identifier, | |
$component, | |||
$ajax = false, | |||
$a = null ) |
Get the value of a help string fully prepared for display in the current language.
string | $identifier | The identifier of the string to search for. |
string | $component | The module the string is associated with. |
boolean | $ajax | Whether this help is called from an AJAX script. This is used to influence text formatting and determines which format to output the doclink in. |
string | object | array | $a | An object, string or number that can be used within translation strings |
stdClass | An object containing:
|
get_generic_section_name | ( | ) |
get_google_client | ( | ) |
Wrapper to get a Google Client object.
This automatically sets the config to Moodle's defaults.
Google_Client |
get_group_picture_url | ( | $group, | |
$courseid, | |||
$large = false, | |||
$includetoken = false ) |
Return the url to the group picture.
stdClass | $group | A group object. |
int | $courseid | The course ID for the group. |
bool | $large | A large or small group picture? Default is small. |
boolean | $includetoken | Whether to use a user token when displaying this group image. True indicates to generate a token for current user, and integer value indicates to generate a token for the user whose id is the value indicated. If the group picture is included in an e-mail or some other location where the audience is a specific user who will not be logged in when viewing, then we use a token to authenticate the user. |
moodle_url | Returns the url for the group picture. |
get_home_page | ( | ) |
Gets the homepage to use for the current user.
int | One of HOMEPAGE_* |
get_host_from_url | ( | $url | ) |
Returns host part from url.
string | $url | full url |
string | host, null if not found |
get_html_lang | ( | $dir = false | ) |
Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
Internationalisation, for print_header and backup/restorelib.
bool | $dir | Default false |
string | Attributes |
get_html_lang_attribute_value | ( | string | $langcode | ) |
Converts a language code to hyphen-separated format in accordance to the BCP47 syntax
.
For additional information, check out MDN web docs - lang
.
string | $langcode | The language code to convert. |
string |
get_import_export_formats | ( | $type | ) |
Get list of available import or export formats.
string | $type | 'import' if import list, otherwise export list assumed |
array | sorted list of import/export formats available |
get_latest_version_available | ( | $version, | |
$env_select ) |
This function will return the most recent version in the environment.xml file previous or equal to the version requested.
string | $version | top version from which we start to look backwards |
int | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. |
string|bool | string more recent version or false if not found |
get_level | ( | $element | ) |
Here all the restrict functions are coded to be used by the environment checker.
All those functions will receive the result object and will return it modified as needed (status and bypass string)
array | $element | the element from the environment.xml file that should have either a level="required" or level="optional" attribute. |
string | "required" or "optional". |
get_list_of_charsets | ( | ) |
Returns a list of charset codes.
Returns a list of charset codes. It's hardcoded, so they should be added manually (checking that such charset is supported by the texlib library!)
array | And associative array with contents in the form of charset => charset |
get_list_of_environment_versions | ( | $contents | ) |
This function will return the list of Moodle versions available.
array | of versions |
get_list_of_plugins | ( | $directory = 'mod', | |
$exclude = '', | |||
$basedir = '' ) |
Lists plugin-like directories within specified directory.
This function was originally used for standard Moodle plugins, please use new core_component\get_plugin_list() now.
This function is used for general directory listing and backwards compatility.
string | $directory | relative directory from root |
string | $exclude | dir name to exclude from the list (defaults to none) |
string | $basedir | full path to the base dir where $plugin resides (defaults to $CFG->dirroot) |
array | Sorted array of directory names found under the requested parameters |
get_list_of_themes | ( | ) |
Returns a list of valid and compatible themes.
array |
get_list_of_timezones | ( | ) |
get_local_referer | ( | $stripquery = true | ) |
Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required.
bool | $stripquery | if true, also removes the query part of the url. |
string | The resulting referer or empty string. |
get_log_manager | ( | $forcereload = false | ) |
LOG FUNCTIONS /////////////////////////////////////////////////////.
Get instance of log manager.
bool | $forcereload |
core\log\manager |
get_login_url | ( | ) |
Returns full login url.
Any form submissions for authentication to this URL must include username, password as well as a logintoken generated by core\session\manager\get_login_token().
string | login url |
get_logs | ( | ) |
get_logs_usercourse | ( | ) |
get_logs_userday | ( | ) |
get_mailer | ( | $action = 'get' | ) |
Get mailer instance, enable buffering, flush buffer or disable buffering.
string | $action | 'get', 'buffer', 'close' or 'flush' |
moodle_phpmailer|null | mailer instance if 'get' used or nothing |
get_max_courses_in_category | ( | ) |
Return maximum number of courses in a category.
@uses MAX_COURSES_IN_CATEGORY
int | number of courses |
get_max_upload_file_size | ( | $sitebytes = 0, | |
$coursebytes = 0, | |||
$modulebytes = 0, | |||
$unused = false ) |
Returns the maximum size for uploading files.
There are seven possible upload limits:
These last two are passed to this function as arguments (in bytes). Anything defined as 0 is ignored. The smallest of all the non-zero numbers is returned.
int | $sitebytes | Set maximum size |
int | $coursebytes | Current course $course->maxbytes (in bytes) |
int | $modulebytes | Current module ->maxbytes (in bytes) |
bool | $unused | This parameter has been deprecated and is not used any more. |
int | The maximum size for uploading files. |
get_max_upload_sizes | ( | $sitebytes = 0, | |
$coursebytes = 0, | |||
$modulebytes = 0, | |||
$custombytes = null ) |
Returns an array of possible sizes in local language.
Related to get_max_upload_file_size() - this function returns an array of possible sizes in an array, translated to the local language.
The list of options will go up to the minimum of $sitebytes, $coursebytes or $modulebytes.
If $coursebytes or $sitebytes is not 0, an option will be included for "Course/Site upload limit (X)" with the value set to 0. This option will be the first in the list.
@uses SORT_NUMERIC
int | $sitebytes | Set maximum size |
int | $coursebytes | Current course $course->maxbytes (in bytes) |
int | $modulebytes | Current module ->maxbytes (in bytes) |
int | array | $custombytes | custom upload size/s which will be added to list, Only value/s smaller then maxsize will be added to list. |
array |
get_mnet_environment | ( | ) |
helper function to load up and initialise the mnet environment this must be called before you use mnet functions.
mnet_environment | the equivalent of old $MNET global |
get_mnet_remote_client | ( | ) |
during xmlrpc server code execution, any code wishing to access information about the remote peer must use this to get it.
mnet_remote_client | the equivalent of old $MNETREMOTE_CLIENT global |
get_module_metadata | ( | ) |
get_moodle_cookie | ( | ) |
Gets a moodle cookie with a weakly encrypted username.
string | username |
object get_my_remotecourses | ( | $userid = 0 | ) |
List of remote courses that a user has access to via MNET.
Works only on the IDP
@global object
int | @userid The user id to get remote courses for |
array | Array of $COURSE of course objects |
object get_my_remotehosts | ( | ) |
List of remote hosts that a user has access to via MNET.
Works on the SP
@global object
array|bool | Array of host objects or false |
get_newuser_language | ( | ) |
Returns the string of the language for the new user.
string | language for the new user |
get_next_version | ( | int | $questionbankentryid | ) |
Get the next version number to create base on a Question bank entry id.
int | $questionbankentryid | Question bank entry id. |
int | next version number. |
dml_exception |
|
static |
Used for maping events on restore.
bool |
get_parent_contextid | ( | ) |
get_parent_contexts | ( | ) |
get_parent_language | ( | $lang = null | ) |
Returns parent language of current active language if defined.
string | $lang | null means current language |
string |
get_performance_info | ( | ) |
get_performance_info() pairs up with init_performance_info() loaded in setup.php.
Returns an array with 'html' and 'txt' values ready for use, and each of the individual stats provided separately as well.
array |
performance_measuring_filter_manager::get_performance_summary | ( | ) |
Return performance information, in the form required by get_performance_info().
array | the performance info. |
|
static |
Returns the exact absolute path to plugin directory.
string | $plugintype | type of plugin |
string | $pluginname | name of the plugin |
string | full path to plugin directory; null if not found |
string | $plugintype | type of plugin |
string | $name | name of the plugin |
string | full path to plugin directory; NULL if not found |
|
static |
Get list of plugins of given type.
Use when listing real plugins of one type.
string | $plugintype |
array | as (string)pluginname => (string)fulldir |
string | $plugintype | type of plugin |
array | name=>fulllocation pairs of plugins of given type |
|
static |
Get a list of all the plugins of a given type that define a certain class in a certain file.
The plugin component names and class names are returned.
string | $plugintype | the type of plugin, e.g. 'mod' or 'report'. |
string | $class | the part of the name of the class after the frankenstyle prefix. e.g 'thing' if you are looking for classes with names like report_courselist_thing. If you are looking for classes with the same name as the plugin name (e.g. qtype_multichoice) then pass ''. Frankenstyle namespaces are also supported. |
string | $file | the name of file within the plugin that defines the class. |
array | with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum') and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice'). |
The plugin component names and class names are returned.
string | $plugintype | the type of plugin, e.g. 'mod' or 'report'. |
string | $class | the part of the name of the class after the frankenstyle prefix. e.g 'thing' if you are looking for classes with names like report_courselist_thing. If you are looking for classes with the same name as the plugin name (e.g. qtype_multichoice) then pass ''. |
string | $file | the name of file within the plugin that defines the class. |
array | with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum') and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice'). |
|
static |
Get a list of all the plugins of a given type that contain a particular file.
string | $plugintype | the type of plugin, e.g. 'mod' or 'report'. |
string | $file | the name of file that must be present in the plugin. (e.g. 'view.php', 'db/install.xml'). |
bool | $include | if true (default false), the file will be include_once-ed if found. |
array | with plugin name as keys (e.g. 'forum', 'courselist') and the path to the file relative to dirroot as value (e.g. "$CFG->dirroot/mod/forum/view.php"). |
get_plugin_list_with_file | ( | ) |
get_plugin_list_with_function | ( | $plugintype, | |
$function, | |||
$file = 'lib.php' ) |
Get a list of all the plugins of a given type that define a certain API function in a certain file.
The plugin component names and function names are returned.
string | $plugintype | the type of plugin, e.g. 'mod' or 'report'. |
string | $function | the part of the name of the function after the frankenstyle prefix. e.g 'hook' if you are looking for functions with names like report_courselist_hook. |
string | $file | the name of file within the plugin that defines the function. Defaults to lib.php. |
array | with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum') and the function names as values (e.g. 'report_courselist_hook', 'forum_hook'). |
get_plugin_types | ( | $fullpaths = true | ) |
Lists all plugin types.
bool | $fullpaths | false means relative paths from dirroot |
array | Array of strings - name=>location |
|
static |
Get list of available plugin types together with their location.
array | as (string)plugintype => (string)fulldir |
|
static |
Returns list of plugin types that allow subplugins.
array | as (string)plugintype => (string)fulldir |
get_plugins_with_function | ( | $function, | |
$file = 'lib.php', | |||
$include = true ) |
Get a list of all the plugins that define a certain API function in a certain file.
string | $function | the part of the name of the function after the frankenstyle prefix. e.g 'hook' if you are looking for functions with names like report_courselist_hook. |
string | $file | the name of file within the plugin that defines the function. Defaults to lib.php. |
bool | $include | Whether to include the files that contain the functions or not. |
array | with [plugintype][plugin] = functionname |
get_print_section_cm_text | ( | ) |
get_question_bank_entry | ( | int | $questionid | ) |
Get the question_bank_entry object given a question id.
int | $questionid | Question id. |
false|mixed |
dml_exception |
get_question_options | ( | & | $questions, |
$loadtags = false, | |||
$filtercourses = null ) |
Updates the question objects with question type specific information by calling {.
Can be called either with an array of question objects or with a single question object.
mixed | $questions | Either an array of question objects to be updated or just a single question object |
bool | $loadtags | load the question tags from the tags table. Optional, default false. |
stdClass[] | $filtercourses | The courses to filter the course tags by. |
bool | Indicates success or failure. |
get_question_version | ( | $questionid | ) |
Get the question versions given a question id in a descending sort .
int | $questionid | Question id. |
array |
dml_exception |
get_real_size | ( | $size = 0 | ) |
Converts numbers like 10M into bytes.
string | $size | The size to be converted |
int |
get_recent_enrolments | ( | ) |
get_records_csv | ( | ) |
get_referer | ( | ) |
get_related_contexts_string | ( | ) |
get_request_storage_directory | ( | $exceptiononerror = true, | |
bool | $forcecreate = false ) |
Get a per-request storage directory in the tempdir.
The directory is automatically cleaned up during the shutdown handler.
bool | $exceptiononerror | throw exception if error encountered |
bool | $forcecreate | Force creation of a new parent directory |
string | Returns full path to directory if successful, false if not; may throw exception |
get_role_context_caps | ( | ) |
get_roles_on_exact_context | ( | ) |
get_roles_with_assignment_on_context | ( | ) |
get_safe_orderby | ( | array | $orderbymap, |
string | $orderbykey, | ||
string | $direction = '', | ||
bool | $useprefix = true ) |
Prepare a safe ORDER BY statement from user interactable requests.
This allows safe user specified sorting (ORDER BY), by abstracting the SQL from the value being requested by the user. A standard string (and optional direction) can be specified, which will be mapped to a predefined allow list of SQL ordering. The mapping can optionally include a 'default', which will be used if the key provided is invalid.
Example usage: -If $orderbymap = [ 'courseid' => 'c.id', 'somecustomvalue'=> 'c.startdate, c.shortname', 'default' => 'c.fullname', ] -A value from the map array's keys can be passed in by a user interaction (eg web service) along with an optional direction. -get_safe_orderby($orderbymap, 'courseid', 'DESC') would return: ORDER BY c.id DESC -get_safe_orderby($orderbymap, 'somecustomvalue') would return: ORDER BY c.startdate, c.shortname -get_safe_orderby($orderbymap, 'invalidblah', 'DESC') would return: ORDER BY c.fullname DESC -If no default key was specified in $orderbymap, the invalidblah example above would return empty string.
array | $orderbymap | An array in the format [keystring => sqlstring]. A default fallback can be set with the key 'default'. |
string | $orderbykey | A string to be mapped to a key in $orderbymap. |
string | $direction | Optional ORDER BY direction (ASC/DESC, case insensitive). |
bool | $useprefix | Whether ORDER BY is prefixed to the output (true by default). This should not be modified in most cases. It is included to enable get_safe_orderby_multiple() to use this function multiple times. |
string | The ORDER BY statement, or empty string if $orderbykey is invalid and no default is mapped. |
get_safe_orderby_multiple | ( | array | $orderbymap, |
array | $orderbykeys, | ||
array | $directions = [] ) |
Prepare a safe ORDER BY statement from user interactable requests using multiple values.
This allows safe user specified sorting (ORDER BY) similar to get_safe_orderby(), but supports multiple keys and directions. This is useful in cases where combinations of columns are needed and/or each item requires a specified direction (ASC/DESC). The mapping can optionally include a 'default', which will be used if the key provided is invalid.
Example usage: -If $orderbymap = [ 'courseid' => 'c.id', 'fullname'=> 'c.fullname', 'default' => 'c.startdate', ] -An array of values from the map's keys can be passed in by a user interaction (eg web service), with optional directions. -get_safe_orderby($orderbymap, ['courseid', 'fullname'], ['DESC', 'ASC']) would return: ORDER BY c.id DESC, c.fullname ASC -get_safe_orderby($orderbymap, ['courseid', 'invalidblah'], ['aaa', 'DESC']) would return: ORDER BY c.id, c.startdate DESC -If no default key was specified in $orderbymap, the invalidblah example above would return: ORDER BY c.id
array | $orderbymap | An array in the format [keystring => sqlstring]. A default fallback can be set with the key 'default'. |
array | $orderbykeys | An array of strings to be mapped to keys in $orderbymap. |
array | $directions | Optional array of ORDER BY direction (ASC/DESC, case insensitive). The array keys should match array keys in $orderbykeys. |
string | The ORDER BY statement, or empty string if $orderbykeys contains no valid items and no default is mapped. |
object get_scales_menu | ( | $courseid = 0 | ) |
Returns a menu of all available scales from the site as well as the given course.
int | $courseid | The id of the course as found in the 'course' table. |
array |
get_selected_theme_for_device_type | ( | ) |
get_separator | ( | ) |
Return the breadcrumb trail navigation separator.
string | HTML string. |
get_site | ( | ) |
OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////.
Returns $course object of the top-level site.
object | A $COURSE object for the site, exception if not found |
get_site_identifier | ( | ) |
Returns the site identifier.
string\$CFG-,>siteidentifier,first | making sure it is properly initialised. |
get_string | ( | $identifier, | |
$component = '', | |||
$a = null, | |||
$lazyload = false ) |
Returns a localized string.
Returns the translated string specified by $identifier as for $module. Uses the same format files as STphp. $a is an object, string or number that can be used within translation strings
eg 'hello {$a->firstname} {$a->lastname}' or 'hello {$a}'
If you would like to directly echo the localized string use the function print_string()
Example usage of this function involves finding the string you would like a local equivalent of and using its identifier and module information to retrieve it.
If you open moodle/lang/en/moodle.php and look near line 278 you will find a string to prompt a user for their word for 'course' $string['course'] = 'Course';
So if you want to display the string 'Course' in any language that supports it on your site you just need to use the identifier 'course' $mystring = ''. get_string('course') .''; or
If the string you want is in another file you'd take a slightly different approach. Looking in moodle/lang/en/calendar.php you find around line 75: $string['typecourse'] = 'Course event';
If you want to display the string "Course event" in any language supported you would use the identifier 'typecourse' and the module 'calendar' (because it is in the file calendar.php): $mystring = '
';
As a last resort, should the identifier fail to map to a string the returned string will be [[ $identifier ]]
In Moodle 2.3 there is a new argument to this function $lazyload. Setting $lazyload to true causes get_string to return a lang_string object rather than the string itself. The fetching of the string is then put off until the string object is first used. The object can be used by calling it's out method or by casting the object to a string, either directly e.g. (string)$stringobject or indirectly by using the string within another string or echoing it out e.g. echo $stringobject return "<p>{$stringobject}</p>"; It is worth noting that using $lazyload and attempting to use the string as an array key will cause a fatal error as objects cannot be used as array keys. But you should never do that anyway! For more information lang_string
string | $identifier | The key identifier for the localized string |
string | $component | The module where the key identifier is stored, usually expressed as the filename in the language pack without the .php on the end but can also be written as mod/forum or grade/export/xls. If none is specified then moodle.php is used. |
string | object | array | int | $a | An object, string or number that can be used within translation strings |
bool | $lazyload | If set to true a string object is returned instead of the string itself. The string then isn't calculated until it is first used. |
string | The localized string. |
coding_exception |
|
protected |
Get all the filters that apply to a given context for calls to format_string.
context | $context | the context. |
moodle_text_filter[] | A text filter |
get_string_manager | ( | $forcereload = false | ) |
Returns current string_manager instance.
The param $forcereload is needed for CLI installer only where the string_manager instance must be replaced during the install.php script life time.
bool | $forcereload | shall the singleton be released and new instance created instead? |
core_string_manager |
get_strings | ( | $array, | |
$component = '' ) |
Converts an array of strings to their localized value.
array | $array | An array of strings |
string | $component | The language module that these strings can be found in. |
stdClass | translated strings. |
|
static |
Return all subplugins of this component.
string | $component,. |
array\$subtype,=>array($component,..),null | if no subtypes defined |
|
static |
Returns the exact absolute path to plugin directory.
string | $subsystem | type of core subsystem |
string | full path to subsystem directory; null if not found |
|
static |
Returns parent of this subplugin type.
string | $type |
string | parent component or null |
get_system_context | ( | $cache = true | ) |
Returns system context or null if can not be created yet.
bool | $cache | use caching |
context | system context (null if context table not created yet) |
|
protected |
Get all the filters that apply to a given context for calls to format_text.
context | $context |
moodle_text_filter[] | A text filter |
get_texteditor | ( | $editorname | ) |
Returns instance of text editor.
string | $editorname | name of editor (textarea, tiny, ...) |
object|bool | texeditor instance or false if does not exist |
get_time_interval_string | ( | int | $time1, |
int | $time2, | ||
string | $format = '' ) |
Get a formatted string representation of an interval between two unix timestamps.
E.g. $intervalstring = get_time_interval_string(12345600, 12345660); Will produce the string: '0d 0h 1m'
int | $time1 | unix timestamp |
int | $time2 | unix timestamp |
string | $format | string (can be lang string) containing format chars: https://www.php.net/manual/en/dateinterval.format.php. |
string | the formatted string describing the time difference, e.g. '10d 11h 45m'. |
get_timezone_offset | ( | ) |
get_timezone_record | ( | ) |
|
protected |
Get the progress_trace.
progress_trace |
get_used_table_names | ( | ) |
Returns names of all known tables == tables that moodle knows about.
array | Array of lowercase table names |
get_user_access_sitewide | ( | ) |
get_user_courses_bycap | ( | ) |
get_user_device_type | ( | ) |
get_user_field_name | ( | $field | ) |
Returns the display name of a field in the user table.
Works for most fields that are commonly displayed to users.
Also works for custom fields.
string | $field | Field name, e.g. 'phone1' |
string | Text description taken from language file, e.g. 'Phone number' |
get_user_fieldnames | ( | ) |
Returns an array of user fields.
array | User field/column names |
get_user_key | ( | $script, | |
$userid, | |||
$instance = null, | |||
$iprestriction = null, | |||
$validuntil = null ) |
Gets a private user access key (and creates one if one doesn't exist).
string | $script | unique target identifier |
int | $userid | |
int | $instance | optional instance id |
string | $iprestriction | optional ip restricted access |
int | $validuntil | key valid only until given date |
string | access key value |
get_user_max_upload_file_size | ( | $context, | |
$sitebytes = 0, | |||
$coursebytes = 0, | |||
$modulebytes = 0, | |||
$user = null, | |||
$unused = false ) |
Returns the maximum size for uploading files for the current user.
This function takes in account get_max_upload_file_size() the user's capabilities
context | $context | The context in which to check user capabilities |
int | $sitebytes | Set maximum size |
int | $coursebytes | Current course $course->maxbytes (in bytes) |
int | $modulebytes | Current module ->maxbytes (in bytes) |
stdClass | $user | The user |
bool | $unused | This parameter has been deprecated and is not used any more. |
int | The maximum size for uploading files. |
get_user_preferences | ( | $name = null, | |
$default = null, | |||
$user = null ) |
Used to fetch user preference(s)
If no arguments are supplied this function will return all of the current user preferences as an array.
If a name is specified then this function attempts to return that particular preference value. If none is found, then the optional value $default is returned, otherwise null.
If a $user object is submitted it's 'preference' property is used for the preferences cache.
string | $name | Name of the key to use in finding a preference value |
mixed | null | $default | Value to be returned if the $name key is not set in the user preferences |
stdClass | int | null | $user | A moodle user object or id, null means current user |
coding_exception |
string|mixed|null | A string containing the value of a single preference. An array with all of the preferences or null |
get_user_timezone | ( | $tz = 99 | ) |
Returns a float or a string which denotes the user's timezone A float value means that a simple offset from GMT is used, while a string (it will be the name of a timezone in the database) means that for this timezone there are also DST rules to be taken into account Checks various settings and picks the most dominant of those which have a value.
float | int | string | $tz | timezone to calculate GMT time offset before calculating user timezone, 99 is default user timezone |
float|string |
get_user_timezone_offset | ( | ) |
object get_users | ( | $get = true, | |
$search = '', | |||
$confirmed = false, | |||
array | $exceptions = null, | ||
$sort = 'firstname ASC', | |||
$firstinitial = '', | |||
$lastinitial = '', | |||
$page = '', | |||
$recordsperpage = '', | |||
$fields = '*', | |||
$extraselect = '', | |||
array | $extraparams = null ) |
Returns a subset of users.
@uses DEBUG_DEVELOPER @uses SQL_PARAMS_NAMED
bool | $get | If false then only a count of the records is returned |
string | $search | A simple string to search for |
bool | $confirmed | A switch to allow/disallow unconfirmed users |
array | $exceptions | A list of IDs to ignore, eg 2,4,5,8,9,10 |
string | $sort | A SQL snippet for the sorting criteria to use |
string | $firstinitial | Users whose first name starts with $firstinitial |
string | $lastinitial | Users whose last name starts with $lastinitial |
string | $page | The page or records to return |
string | $recordsperpage | The number of records to return per page |
string | $fields | A comma separated list of fields to be returned from the chosen table. |
array|int|bool | $USER records unless get is false in which case the integer count of the records found is returned. False is returned if an error is encountered. |
object get_users_confirmed | ( | ) |
Full list of users that have confirmed their accounts.
array | of unconfirmed users |
get_users_from_config | ( | $value, | |
$capability, | |||
$includeadmins = true ) |
Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
All users are verified if they still have the necessary capability.
string | $value | the value of the config setting. |
string | $capability | the capability - must match the one passed to the admin_setting_users_with_capability constructor. |
bool | $includeadmins | include administrators. |
array | of user objects. |
get_users_listing | ( | $sort = 'lastaccess', | |
$dir = 'ASC', | |||
$page = 0, | |||
$recordsperpage = 0, | |||
$search = '', | |||
$firstinitial = '', | |||
$lastinitial = '', | |||
$extraselect = '', | |||
array | $extraparams = null, | ||
$extracontext = null ) |
Return filtered (if provided) list of users in site, except guest and deleted users.
string | $sort | An SQL field to sort by |
string | $dir | The sort direction ASC|DESC |
int | $page | The page or records to return |
int | $recordsperpage | The number of records to return per page |
string | $search | A simple string to search for |
string | $firstinitial | Users whose first name starts with $firstinitial |
string | $lastinitial | Users whose last name starts with $lastinitial |
string | $extraselect | An additional SQL select statement to append to the query |
array | $extraparams | Additional parameters to use for the above $extraselect |
stdClass | $extracontext | If specified, will include user 'extra fields' as appropriate for current user and given context |
array | Array of $USER records |
getremoteaddr | ( | $default = '0.0.0.0' | ) |
Returns most reliable client address.
string | $default | If an address can't be determined, then return this |
string | The remote IP address |
getweek | ( | $startdate, | |
$thedate ) |
Given dates in seconds, how many weeks is the date from startdate The first week is 1, the second 2 etc ...
int | $startdate | Timestamp for the start date |
int | $thedate | Timestamp for the end date |
string |
grade_print_tabs | ( | $active_type, | |
$active_plugin, | |||
$plugin_info, | |||
$return = false ) |
Print grading plugin selection tab-based navigation.
string | $active_type | type of plugin on current page - import, export, report or edit |
string | $active_plugin | active plugin type - grader, user, cvs, ... |
array | $plugin_info | Array of plugins |
boolean | $return | return as string |
nothing | or string if $return true |
groupmode | ( | ) |
This means that cm_info\$groupmode should be ignored and cm_info\$coursegroupmode be used instead.
groups_course_module_visible | ( | ) |
groups_filter_users_by_course_module_visible | ( | ) |
groups_get_all_groups_for_courses | ( | ) |
guest_user | ( | ) |
Retrieve the guest user object.
stdClass | A $USER object |
|
static |
Checks for the presence of monologo icons within a plugin.
Only checks monologo icons in PNG and SVG formats as they are formats that can have transparent background.
string | $plugintype | The plugin type. |
string | $pluginname | The plugin name. |
bool | True if the plugin has a monologo icon |
moodle_text_filter::hash | ( | ) |
hash_internal_user_password | ( | $password, | |
$fasthash = false ) |
Calculate hash for a plain text password.
string | $password | Plain text password to be hashed. |
bool | $fasthash | If true, use a low cost factor when generating the hash This is much faster to generate but makes the hash less secure. It is used when lots of hashes need to be generated quickly. |
string | The hashed password. |
moodle_exception | If a problem occurs while generating the hash. |
hash_local_config_cache | ( | ) |
Calculate a proper hash to be able to invalidate stale cached configs.
Only to be used to verify bootstrap.php status.
string | md5 hash of all the sensible bits deciding if cached config is stale or no. |
hide_event | ( | ) |
highlight | ( | $needle, | |
$haystack, | |||
$matchcase = false, | |||
$prefix = '<span class="highlight">', | |||
$suffix = '</span>' ) |
This function will highlight search words in a given string.
It cares about HTML and will not ruin links. It's best to use this function after performing any conversions to HTML.
string | $needle | The search string. Syntax like "word1 +word2 -word3" is dealt with correctly. |
string | $haystack | The string (HTML) within which to highlight the search terms. |
boolean | $matchcase | whether to do case-sensitive. Default case-insensitive. |
string | $prefix | the string to put before each search term found. |
string | $suffix | the string to put after each search term found. |
string | The highlighted HTML. |
highlightfast | ( | $needle, | |
$haystack ) |
This function will highlight instances of $needle in $haystack.
It's faster that the above function highlight() and doesn't care about HTML or anything.
string | $needle | The string to search for |
string | $haystack | The string to search for $needle in |
string | The highlighted HTML |
html_is_blank | ( | $string | ) |
Tests whether anything was returned by text editor.
This function is useful for testing whether something you got back from the HTML editor actually contains anything. Sometimes the HTML editor appear to be empty, but actually you get back a
tag or something.
string | $string | a string containing HTML. |
boolean | does the string contain any actual content - that is text, images, objects, etc. |
html_to_text | ( | $html, | |
$width = 75, | |||
$dolinks = true ) |
Given HTML text, make it into plain text using external function.
string | $html | The text to be converted. |
integer | $width | Width to wrap the text at. (optional, default 75 which is a good value for email. 0 means do not limit line length.) |
boolean | $dolinks | By default, any links in the HTML are collected, and printed as a list at the end of the HTML. If you don't want that, set this argument to false. |
string | plain text equivalent of the HTML. |
httpsrequired | ( | ) |
idnumber_exist_in_question_category | ( | $questionidnumber, | |
$categoryid, | |||
$limitfrom = 0, | |||
$limitnum = 1 ) |
Check if an idnumber exist in the category.
int | $questionidnumber | |
int | $categoryid | |
int | $limitfrom | |
int | $limitnum |
array |
imagecopybicubic | ( | $dst_img, | |
$src_img, | |||
$dst_x, | |||
$dst_y, | |||
$src_x, | |||
$src_y, | |||
$dst_w, | |||
$dst_h, | |||
$src_w, | |||
$src_h ) |
Copies a rectangular portion of the source image to another rectangle in the destination image.
This function calls imagecopyresampled() if it is available and GD version is 2 at least. Otherwise it reimplements the same behaviour. See the PHP manual page for more info.
@externalurl http://php.net/manual/en/function.imagecopyresampled.php
resource | GdImage | $dst_img | the destination GD image resource |
resource | GdImage | $src_img | the source GD image resource |
int | $dst_x | vthe X coordinate of the upper left corner in the destination image |
int | $dst_y | the Y coordinate of the upper left corner in the destination image |
int | $src_x | the X coordinate of the upper left corner in the source image |
int | $src_y | the Y coordinate of the upper left corner in the source image |
int | $dst_w | the width of the destination rectangle |
int | $dst_h | the height of the destination rectangle |
int | $src_w | the width of the source rectangle |
int | $src_h | the height of the source rectangle |
bool | tru on success, false otherwise |
in_object_vars | ( | $var, | |
$object ) |
Checks whether the given variable name is defined as a variable within the given object.
This will NOT work with stdClass objects, which have no class variables.
string | $var | The variable name |
object | $object | The object to check |
boolean |
increment_revision_number | ( | $table, | |
$field, | |||
$select, | |||
array | $params = null ) |
Increment standard revision field.
The revision are based on current time and are incrementing. There is a protection for runaway revisions, it may not go further than one hour into future.
The field has to be XMLDB_TYPE_INTEGER with size 10.
string | $table | |
string | $field | name of the field containing revision |
string | $select | use empty string when updating all records |
array | $params | optional select parameters |
ini_get_bool | ( | $ini_get_arg | ) |
This function makes the return value of ini_get consistent if you are setting server directives through the .htaccess file in apache.
Current behavior for value set from php.ini On = 1, Off = [blank] Current behavior for value set from .htaccess On = On, Off = Off Contributed by jdell @ unr.edu
string | $ini_get_arg | The argument to get |
bool | True for on false for not |
init_performance_info | ( | ) |
Initializes our performance info early.
Pairs up with get_performance_info() which is actually in moodlelib.php. This function is here so that we can call it before all the libs are pulled in.
@uses $PERF
initialise_fullme | ( | ) |
Initialises $FULLME and friends.
Private function. Should only be called from setup.php.
initialise_fullme_cli | ( | ) |
Initialises $FULLME and friends for command line scripts.
This is a private method for use by initialise_fullme.
initialise_local_config_cache | ( | ) |
install_cli_database | ( | array | $options, |
$interactive ) |
install_core | ( | $version, | |
$verbose ) |
Install core moodle tables and initialize.
float | $version | target version |
bool | $verbose |
void,may | throw exception |
install_db_validate | ( | $database, | |
$dbhost, | |||
$dbuser, | |||
$dbpass, | |||
$dbname, | |||
$prefix, | |||
$dboptions ) |
This is in function because we want the /install.php to parse in PHP4.
object | $database | |
string | $dbhsot | |
string | $dbuser | |
string | $dbpass | |
string | $dbname | |
string | $prefix | |
mixed | $dboptions |
string |
install_generate_configphp | ( | $database, | |
$cfg ) |
Returns content of config.php file.
Uses PHP_EOL for generating proper end of lines for the given platform.
moodle_database | $database | database instance |
object | $cfg | copy of $CFG |
string |
install_guess_wwwroot | ( | ) |
Tries to detect the right www root setting.
string | detected www root |
install_helpbutton | ( | $url, | |
$title = '' ) |
Print help button.
string | $url | |
string | $titel |
void |
install_ini_get_bool | ( | $ini_get_arg | ) |
install_init_dataroot | ( | $dataroot, | |
$dirpermissions ) |
Creates dataroot if not exists yet, makes sure it is writable, add lang directory and add .htaccess just in case it works.
string | $dataroot | full path to dataroot |
int | $dirpermissions |
bool | success |
object install_print_footer | ( | $config, | |
$reload = false ) |
Prints installation page header, we can not use weblib yet in installer.
stdClass | $config | |
bool | $reload | print reload button instead of next |
void |
object install_print_header | ( | $config, | |
$stagename, | |||
$heading, | |||
$stagetext, | |||
$stageclass = "alert-info" ) |
Prints installation page header, we can not use weblib yet in installer.
stdClass | $config | |
string | $stagename | |
string | $heading | |
string | $stagetext | |
string | $stageclass |
void |
object install_print_help_page | ( | $help | ) |
Prints complete help page used during installation.
Does not return.
string | $help |
|
static |
Factory method.
Use this to get the filter manager.
filter_manager | the singleton instance. |
object instance_is_visible | ( | $moduletype, | |
$module ) |
Determine whether a module instance is visible within a course.
Given a valid module object with info about the id and course, and the module's type (eg "forum") returns whether the object is visible or not according to the 'eye' icon only.
NOTE: This does NOT take into account visibility to a particular user. To get visibility access for a specific user, use get_fast_modinfo, get a cm_info object from this, and check the ->uservisible property; or use the core_availability\info_module\is_user_visible() static function.
$moduletype | Name of the module eg 'forum' |
$module | Object which is the instance of the module |
bool | Success |
|
static |
Invalidate opcode cache for given file, this is intended for php files that are stored in dataroot.
Note: we need it here because this class must be self-contained.
string | $file |
ip_is_public | ( | $ip | ) |
Is IP address a public address?
string | $ip | The ip to check |
bool | true if the ip is public |
iplookup_find_location | ( | $ip | ) |
Returns location information.
string | $ip |
array |
|
static |
Return true if apiname is a core API.
string | $apiname | name of the API. |
bool | true if core API. |
|
static |
Return true if subsystemname is core subsystem.
string | $subsystemname | name of the subsystem. |
bool | true if core subsystem. |
is_course_participant | ( | ) |
is_dataroot_insecure | ( | $fetchtest = false | ) |
Try to verify that dataroot is not accessible from web.
Try to verify that dataroot is not accessible from web. It is not 100% correct but might help to reduce number of vulnerable sites. Protection from httpd.conf and .htaccess is not detected properly.
@uses INSECURE_DATAROOT_WARNING @uses INSECURE_DATAROOT_ERROR
bool | $fetchtest | try to test public access by fetching file, default false |
mixed | empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic |
is_early_init | ( | $backtrace | ) |
This function encapsulates the tests for whether an exception was thrown in early init – either during setup.php or during init of $OUTPUT.
If another exception is thrown then, and if we do not take special measures, we would just get a very cryptic message "Exception thrown without a stack frame in Unknown on line 0". That makes debugging very hard, so we do take special measures in default_exception_handler, with the help of this function.
array | $backtrace | the stack trace to analyse. |
boolean | whether the stack trace is somewhere in output initialisation. |
is_enabled_auth | ( | $auth | ) |
Checks if a given plugin is in the list of enabled authentication plugins.
string | $auth | Authentication plugin. |
boolean | Whether the plugin is enabled. |
is_enrolled | ( | context | $context, |
$user = null, | |||
$withcapability = '', | |||
$onlyactive = false ) |
Returns true if user is enrolled (is participating) in course this is intended for students and teachers.
Since 2.2 the result for active enrolments and current user are cached.
context | $context | |
int | stdClass | $user | if null $USER is used, otherwise user object or id expected |
string | $withcapability | extra capability name |
bool | $onlyactive | consider only active enrolments in enabled plugins and time restrictions |
bool |
is_float_problem | ( | ) |
Detects if float supports at least 10 decimal digits.
Detects if float supports at least 10 decimal digits and also if float-->string conversion works as expected.
bool | true if problem found |
is_https | ( | ) |
Determines whether or not the Moodle site is being served over HTTPS.
This is done simply by checking the value of $CFG->wwwroot, which seems to be the only reliable method.
boolean | True if site is served over HTTPS, false otherwise. |
is_in_popup | ( | ) |
is_internal_auth | ( | $auth | ) |
Returns true if an internal authentication method is being used.
if method not specified then, global default is assumed
string | $auth | Form of authentication required |
bool |
is_latest | ( | string | $version, |
string | $questionbankentryid ) |
Checks if question is the latest version.
string | $version | Question version to check. |
string | $questionbankentryid | Entry to check against. |
bool |
is_major_upgrade_required | ( | ) |
Check whether a major upgrade is needed.
That is defined as an upgrade that changes something really fundamental in the database, so nothing can possibly work until the database has been updated, and that is defined by the hard-coded version number in this function.
bool |
is_mnet_remote_user | ( | $user | ) |
Returns whether or not the user object is a remote MNET user.
This function is in moodlelib because it does not rely on loading any of the MNET code.
object | $user | A valid user object |
bool | True if the user is from a remote Moodle. |
is_moodle_cookie_secure | ( | ) |
Determine wether the secure flag should be set on cookies.
bool |
is_newnav | ( | $navigation | ) |
Check if the passed navigation is of the new style.
mixed | $navigation |
bool | true for yes false for no |
is_number | ( | $value | ) |
Return true if given value is integer or string with integer value.
mixed | $value | String or Int |
bool | true if number, false if not |
is_primary_admin | ( | $userid | ) |
Is a userid the primary administrator?
int | $userid | int id of user to check |
boolean |
is_proxybypass | ( | $url | ) |
Check if $url matches anything in proxybypass list.
Any errors just result in the proxy being used (least bad)
string | $url | url to check |
boolean | true if we should bypass the proxy |
is_restored_user | ( | $username | ) |
Returns true if the user is a 'restored' one.
Used in the login process to inform the user and allow him/her to reset the password
string | $username | username to be checked |
bool |
is_rtl_compatible | ( | $paramtype | ) |
Whether the PARAM_* type is compatible in RTL.
Being compatible with RTL means that the data they contain can flow from right-to-left or left-to-right without compromising the user experience.
Take URLs for example, they are not RTL compatible as they should always flow from the left to the right. This also applies to numbers, email addresses, configuration snippets, base64 strings, etc...
This function tries to best guess which parameters can contain localised strings.
string | $paramtype | Constant PARAM_*. |
bool |
is_valid_plugin_name | ( | $name | ) |
This method validates a plug name.
It is much faster than calling clean_param.
string | $name | a string that might be a plugin name. |
bool | if this string is a valid plugin name. |
|
static |
This method validates a plug name.
It is much faster than calling clean_param.
string | $plugintype | type of plugin |
string | $pluginname | a string that might be a plugin name. |
bool | if this string is a valid plugin name. |
is_web_crawler | ( | ) |
ismoving | ( | $courseid | ) |
Determines if the logged in user is currently moving an activity.
int | $courseid | The id of the course being tested |
bool |
js_minify | ( | ) |
ldap_addslashes | ( | $text | ) |
Quote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253.
string | the AttributeValue to quote |
string | the AttributeValue quoted |
ldap_connect_moodle | ( | $host_url, | |
$ldap_version, | |||
$user_type, | |||
$bind_dn, | |||
$bind_pw, | |||
$opt_deref, | |||
& | $debuginfo, | ||
$start_tls = false ) |
Tries connect to specified ldap servers.
Returns a valid LDAP connection or false.
string | $host_url | |
integer | $ldap_version | either 2 (LDAPv2) or 3 (LDAPv3). |
string | $user_type | the configured user type for this connection. |
string | $bind_dn | the binding user dn. If an emtpy string, anonymous binding is used. |
string | $bind_pw | the password for the binding user. Ignored for anonymous bindings. |
boolean | $opt_deref | whether to set LDAP_OPT_DEREF on this connection or not. |
string | &$debuginfo | the debugging information in case the connection fails. |
boolean | $start_tls | whether to use LDAP with TLS (not to be confused with LDAP+SSL) |
mixed | connection result or false. |
ldap_filter_addslashes | ( | $text | ) |
Quote control characters in texts used in LDAP filters - see RFC 4515/2254.
string | filter string to quote |
string | the filter string quoted |
ldap_find_userdn | ( | $ldapconnection, | |
$username, | |||
$contexts, | |||
$objectclass, | |||
$search_attrib, | |||
$search_sub ) |
Search specified contexts for username and return the user dn like: cn=username,ou=suborg,o=org.
mixed | $ldapconnection | a valid LDAP connection. |
mixed | $username | username (external LDAP encoding, no db slashes). |
array | $contexts | contexts to look for the user. |
string | $objectclass | objectlass of the user (in LDAP filter syntax). |
string | $search_attrib | the attribute use to look for the user. |
boolean | $search_sub | whether to search subcontexts or not. |
mixed | the user dn (external LDAP encoding, no db slashes) or false |
if(!defined( 'LDAP_DN_SPECIAL_CHARS')) if(!defined('LDAP_DN_SPECIAL_CHARS_QUOTED_NUM')) if(!defined( 'LDAP_DN_SPECIAL_CHARS_QUOTED_ALPHA')) if(!defined('LDAP_DN_SPECIAL_CHARS_QUOTED_ALPHA_REGEX')) ldap_get_dn_special_chars | ( | ) |
The order of the special characters in these arrays IS IMPORTANT.
Make sure '::::5C' (and '\') are the first elements of the arrays. Otherwise we'll double replace '::' with '\5C' which is Bad(tm)
ldap_get_entries_moodle | ( | $ldapconnection, | |
$searchresult ) |
Returns values like ldap_get_entries but is binary compatible and returns all attributes as array.
mixed | $ldapconnection | A valid LDAP connection |
mixed | $searchresult | A search result from ldap_search, ldap_list, etc. |
array | ldap-entries with lower-cased attributes as indexes |
ldap_getdefaults | ( | ) |
Initializes needed variables for ldap-module.
Uses names defined in ldap_supported_usertypes. $default is first defined as: $default['pseudoname'] = array( 'typename1' => 'value', 'typename2' => 'value' .... );
array | of default values |
ldap_isgroupmember | ( | $ldapconnection, | |
$userid, | |||
$group_dns, | |||
$member_attrib ) |
Checks if user belongs to specific group(s) or is in a subtree.
Returns true if user belongs to a group in grupdns string OR if the DN of the user is in a subtree of the DN provided as "group"
mixed | $ldapconnection | A valid LDAP connection. |
string | $userid | LDAP user id (dn/cn/uid/...) to test membership for. |
array | $group_dns | arrary of group dn |
string | $member_attrib | the name of the membership attribute. |
boolean |
ldap_normalise_objectclass | ( | $objectclass, | |
$default = '*' ) |
Normalise the supplied objectclass filter.
This normalisation is a rudimentary attempt to format the objectclass filter correctly.
string | $objectclass | The objectclass to normalise |
string | $default | The default objectclass value to use if no objectclass was supplied |
string | The normalised objectclass. |
ldap_paged_results_supported | ( | $ldapversion, | |
$ldapconnection = null ) |
Check if we can use paged results (see RFC 2696).
We need to use LDAP version 3 (or later), otherwise the server cannot use them. If we also pass in a valid LDAP connection handle, we also check whether the server actually supports them.
ldapversion | integer The LDAP protocol version we use. |
ldapconnection | resource An existing LDAP connection (optional). |
boolean | true is paged results can be used, false otherwise. |
ldap_stripslashes | ( | $text | ) |
Unquote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253.
string | the AttributeValue quoted |
string | the AttributeValue unquoted |
if(!defined('ROOTDSE')) if(!defined( 'LDAP_PAGED_RESULTS_CONTROL')) if(!defined('LDAP_DEFAULT_PAGESIZE')) ldap_supported_usertypes | ( | ) |
Returns predefined user types.
array | of predefined user types |
link_arrow_left | ( | $text, | |
$url = '', | |||
$accesshide = false, | |||
$addclass = '', | |||
$addparams = [] ) |
Return the left arrow with text ('previous'), and optionally embedded in a link.
string | $text | HTML/plain text label (set to blank only for breadcrumb separator cases). |
string | $url | An optional link to use in a surrounding HTML anchor. |
bool | $accesshide | True if text should be hidden (for screen readers only). |
string | $addclass | Additional class names for the link, or the arrow character. |
string | HTML string. |
link_arrow_right | ( | $text, | |
$url = '', | |||
$accesshide = false, | |||
$addclass = '', | |||
$addparams = [] ) |
Return the right arrow with text ('next'), and optionally embedded in a link.
string | $text | HTML/plain text label (set to blank only for breadcrumb separator cases). |
string | $url | An optional link to use in a surrounding HTML anchor. |
bool | $accesshide | True if text should be hidden (for screen readers only). |
string | $addclass | Additional class names for the link, or the arrow character. |
string | HTML string. |
load_course_context | ( | ) |
load_environment_xml | ( | $env_select = ENV_SELECT_NEWER | ) |
This function will load the environment.xml file and xmlize it.
@staticvar array $data @uses ENV_SELECT_NEWER @uses ENV_SELECT_DATAROOT @uses ENV_SELECT_RELEASE
int | string | $env_select | one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name. |
mixed | the xmlized structure or false on error |
|
protected |
Load all the filters required by this context.
context | $context | the context. |
|
staticprotected |
Loads the db/renamedclasses.php file from the given directory.
The renamedclasses.php should contain a key => value array ($renamedclasses) where the key is old class name, and the value is the new class name. It is only included when we are populating the component cache. After that is not needed.
string | null | $fulldir | The directory to the renamed classes. |
load_role_access_by_context | ( | ) |
|
protected |
Log a message to the progress tracer.
string | $message | |
int | $depth |
|
protected |
Log an end message to the progress tracer.
string | $message | |
int | $depth |
|
protected |
Log a start message to the progress tracer.
string | $message | |
int | $depth |
log_update_descriptions | ( | $component | ) |
Log_display description function used during install and upgrade.
string | $component | name of component (moodle, etc.) |
void |
login_attempt_failed | ( | $user | ) |
login_attempt_valid | ( | $user | ) |
To be called after valid user login.
stdClass | $user |
login_is_lockedout | ( | $user | ) |
Verify if user is locked out.
stdClass | $user |
bool | true if user locked out |
login_lock_account | ( | $user | ) |
Lockout user and send notification email.
stdClass | $user |
login_unlock_account | ( | $user | ) |
Unlock user account and reset timers.
stdClass | $user |
make_backup_temp_directory | ( | $directory, | |
$exceptiononerror = true ) |
Create a directory under $CFG->backuptempdir and make sure it is writable.
Do not use for storing generic temp files - see make_temp_directory() instead for this purpose.
Backup temporary files must be on a shared storage.
string | $directory | the relative path of the directory to be created under $CFG->backuptempdir |
bool | $exceptiononerror | throw exception if error encountered |
string|false | Returns full path to directory if successful, false if not; may throw exception |
make_cache_directory | ( | $directory, | |
$exceptiononerror = true ) |
Create a directory under cachedir and make sure it is writable.
Note: this cache directory is shared by all cluster nodes.
string | $directory | the full path of the directory to be created under $CFG->cachedir |
bool | $exceptiononerror | throw exception if error encountered |
string|false | Returns full path to directory if successful, false if not; may throw exception |
make_categories_list | ( | ) |
make_categories_options | ( | ) |
make_editing_buttons | ( | ) |
|
protected |
Factory method for creating a filter.
string | $filtername | The filter name, for example 'tex'. |
context | $context | context object. |
array | $localconfig | array of local configuration variables for this filter. |
moodle_text_filter | The filter, or null, if this type of filter is not recognised or could not be created. |
Reimplemented in performance_measuring_filter_manager.
|
protected |
Factory method for creating a filter.
string | $filtername | The filter name, for example 'tex'. |
context | $context | context object. |
array | $localconfig | array of local configuration variables for this filter. |
moodle_text_filter | The filter, or null, if this type of filter is not recognised or could not be created. |
Reimplemented from filter_manager.
make_grades_menu | ( | $gradingtype | ) |
Creates an array that represents all the current grades that can be chosen using the given grading type.
Negative numbers are scales, zero is no grade, and positive numbers are maximum grades.
int | $gradingtype |
array |
make_localcache_directory | ( | $directory, | |
$exceptiononerror = true ) |
Create a directory under localcachedir and make sure it is writable.
The files in this directory MUST NOT change, use revisions or content hashes to work around this limitation - this means you can only add new files here.
The content of this directory gets purged automatically on all cluster nodes after calling purge_all_caches() before new data is written to this directory.
Note: this local cache directory does not need to be shared by cluster nodes.
string | $directory | the relative path of the directory to be created under $CFG->localcachedir |
bool | $exceptiononerror | throw exception if error encountered |
string|false | Returns full path to directory if successful, false if not; may throw exception |
make_menu_from_list | ( | $list, | |
$separator = ',' ) |
Given a list (eg a,b,c,d,e) this function returns an array of 1->a, 2->b, 3->c etc.
string | $list | The string to explode into array bits |
string | $separator | The separator used within the list string |
array | The now assembled array |
make_request_directory | ( | bool | $exceptiononerror = true, |
bool | $forcecreate = false ) |
Create a per-request directory and make sure it is writable.
This can only be used during the current request and will be tidied away automatically afterwards.
A new, unique directory is always created within a shared base request directory.
In some exceptional cases an alternative base directory may be required. This can be accomplished using the $forcecreate parameter. Typically this will only be requried where the file may be required during a shutdown handler which may or may not be registered after a previous request directory has been created.
bool | $exceptiononerror | throw exception if error encountered |
bool | $forcecreate | Force creation of a new parent directory |
string | The full path to directory if successful, false if not; may throw exception |
make_temp_directory | ( | $directory, | |
$exceptiononerror = true ) |
Create a directory under tempdir and make sure it is writable.
Where possible, please use make_request_directory() and limit the scope of your data to the current HTTP request.
Do not use for storing cache files - see make_cache_directory(), and make_localcache_directory() instead for this purpose.
Temporary files must be on a shared storage, and heavy usage is discouraged due to the performance impact upon clustered environments.
string | $directory | the full path of the directory to be created under $CFG->tempdir |
bool | $exceptiononerror | throw exception if error encountered |
string|false | Returns full path to directory if successful, false if not; may throw exception |
make_timestamp | ( | $year, | |
$month = 1, | |||
$day = 1, | |||
$hour = 0, | |||
$minute = 0, | |||
$second = 0, | |||
$timezone = 99, | |||
$applydst = true ) |
Given Gregorian date parts in user time produce a GMT timestamp.
int | GMT timestamp |
make_unique_id_code | ( | $extra = '' | ) |
make_unique_id_code
@uses $_SERVER
string | $extra | Extra string to append to the end of the code |
string |
make_unique_writable_directory | ( | $basedir, | |
$exceptiononerror = true ) |
Create a new unique directory within the specified directory.
string | $basedir | The directory to create your new unique directory within. |
bool | $exceptiononerror | throw exception if error encountered |
string | The created directory |
invalid_dataroot_permissions |
make_upload_directory | ( | $directory, | |
$exceptiononerror = true ) |
Create a directory under dataroot and make sure it is writable.
Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
string | $directory | the full path of the directory to be created under $CFG->dataroot |
bool | $exceptiononerror | throw exception if error encountered |
string|false | Returns full path to directory if successful, false if not; may throw exception |
mark_context_dirty | ( | ) |
markdown_to_html | ( | $text | ) |
Given Markdown formatted text, make it into XHTML using external function.
string | $text | The markdown formatted text to be converted. |
string | Converted text |
match_grade_options | ( | $gradeoptionsfull, | |
$grade, | |||
$matchgrades = 'error' ) |
Check whether a given grade is one of a list of allowed options.
If not, depending on $matchgrades, either return the nearest match, or return false to signal an error.
array | $gradeoptionsfull | list of valid options |
int | $grade | grade to be tested |
string | $matchgrades | 'error' or 'nearest' |
false|int|string | either 'fixed' value or false if error. |
matching_page_type_patterns | ( | $pagetype | ) |
Given a specific page type, return all the page type patterns that might match it.
string | $pagetype | for example 'course-view-weeks' or 'mod-quiz-view'. |
array | an array of all the page type patterns that might match this page type. |
matching_page_type_patterns_from_pattern | ( | $pattern | ) |
Give an specific pattern, return all the page type patterns that would also match it.
string | $pattern | the pattern, e.g. 'mod-forum-*' or 'mod-quiz-view'. |
array | of all the page type patterns matching. |
Html2Text\mb_internal_encoding | ( | $encoding = null | ) |
Set the encoding to be used by our monkey patched mb_ functions.
When called with $encoding !== null, we set the static $intenalencoding variable, which is used for subsequent calls.
When called with no value for $encoding, we return the previously defined $internalencoding.
This is necessary as we need to maintain the state of mb_internal_encoding across calls to other mb_* functions. Check how it is used in the other mb_* functions defined here - if no encoding is provided we fallback to what was set here, otherwise we used the given encoding.
@staticvar string $internalencoding The encoding to be used across mb_* calls.
string | $encoding | When given, sets $internalencoding |
mixed |
Html2Text\mb_strlen | ( | $str, | |
$encoding = null ) |
Gets the length of a string.
string | $str | The string being checked for length. |
string | $encoding | The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used. |
int | The number of characters in str having character encoding $encoding. A multibyte character is counted as 1. |
Html2Text\mb_strtolower | ( | $str, | |
$encoding = null ) |
Returns $str with all alphabetic chatacters converted to lowercase.
string | $str | The string being lowercased. |
string | $encoding | The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used. |
string | The string with all alphabetic characters converted to lowercase. |
Html2Text\mb_strtoupper | ( | $str, | |
$encoding = null ) |
string | The string being uppercased | |
string | $encoding | The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used. |
string | The string with all alphabetic characters converted to uppercase. |
Html2Text\mb_substr | ( | $str, | |
$start, | |||
$length = null, | |||
$encoding = null ) |
Performs a multi-byte safe substr() operation based on number of characters.
Position is counted from the beginning of str. First character's position is 0. Second character position is 1, and so on.
string | $str | The string to extract the substring from. |
int | $start | If start is non-negative, the returned string will start at the start'th position in string, counting from zero. For instance, in the string 'abcdef', the character at position 0 is 'a', the character at position 2 is 'c', and so forth. |
int | $length | Maximum number of characters to use from str. If omitted or NULL is passed, extract all characters to the end of the string. |
string | $encoding | The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used. |
string | The portion of str specified by the start and length parameters. |
mdie | ( | $msg = '', | |
$errorcode = 1 ) |
Print an error to STDOUT and exit with a non-zero code.
For commandline scripts.
Default errorcode is 1.
Very useful for perl-like error-handling: do_somethting() or mdie("Something went wrong");
string | $msg | Error message |
integer | $errorcode | Error code to emit |
me | ( | ) |
Returns the name of the current script, WITH the querystring portion.
This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME return different things depending on a lot of things like your OS, Web server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.) NOTE: This function returns false if the global variables needed are not set.
mixed | String or false if the global variables needed are not set. |
merge_query_params | ( | array & | $target, |
array | $values ) |
Merge parsed POST chunks.
NOTE: this is not perfect, but it should work in most cases hopefully.
array | $target | |
array | $values |
message_add_contact | ( | ) |
message_block_contact | ( | ) |
message_can_delete_message | ( | ) |
message_can_post_message | ( | ) |
message_contact_link | ( | ) |
message_count_blocked_users | ( | ) |
message_count_messages | ( | ) |
message_count_unread_messages | ( | ) |
message_current_user_is_involved | ( | ) |
message_delete_message | ( | ) |
message_get_blocked_users | ( | ) |
message_get_contact | ( | ) |
message_get_contact_add_remove_link | ( | ) |
message_get_contact_block_link | ( | ) |
message_get_contacts | ( | ) |
message_get_course_contexts | ( | ) |
message_get_fragment | ( | ) |
message_get_history | ( | ) |
message_get_recent_conversations | ( | $userorid, | |
$limitfrom = 0, | |||
$limitto = 100 ) |
message_get_recent_notifications | ( | ) |
message_history_link | ( | ) |
message_is_user_blocked | ( | ) |
message_is_user_non_contact_blocked | ( | ) |
message_mark_message_read | ( | ) |
message_mark_messages_read | ( | ) |
message_move_userfrom_unread2read | ( | ) |
message_remove_contact | ( | ) |
message_remove_url_params | ( | ) |
message_search | ( | ) |
message_shorten_message | ( | ) |
message_unblock_contact | ( | ) |
microtime_diff | ( | $a, | |
$b ) |
Calculate the difference between two microtimes.
string | $a | The first Microtime |
string | $b | The second Microtime |
string |
min_clean_param | ( | $value, | |
$type ) |
Minimalistic parameter cleaning function.
Note: Can not use optional param because moodlelib.php is not loaded yet.
string | $value | |
string | $type |
mixed |
min_enable_zlib_compression | ( | ) |
This method tries to enable output compression if possible.
This function must be called before any output or headers.
(IE6 is not supported at all.)
boolean,true | if compression enabled |
min_fix_utf8 | ( | $value | ) |
Minimalistic UTF-8 sanitisation.
Note: This duplicates fix_utf8() intentionally for now.
string | $value |
string |
min_get_maximum_revision | ( | ) |
Get the highest possible currently valid revision number.
This is based on the current time, allowing for a small amount of clock skew between servers.
Future values beyond the clock skew are not allowed to avoid the possibility of cache poisoning.
int |
min_get_minimum_revision | ( | ) |
Get the lowest possible currently valid revision number.
This is based on the current Moodle version.
int | Unix timestamp |
min_get_slash_argument | ( | $clean = true | ) |
Returns the slashargument part of the URL.
Note: ".php" is NOT allowed in slasharguments, it is intended for ASCII characters only.
boolean | $clean | - Should we do cleaning on this path argument. If you set this to false you MUST be very careful and do the cleaning manually. |
string |
min_is_revision_valid_and_current | ( | int | $revision | ) |
Helper function to determine if the given revision number is valid.
int | $revision | A numeric revision to check for validity |
bool | Whether the revision is valid |
min_optional_param | ( | $name, | |
$default, | |||
$type ) |
Minimalistic parameter validation function.
Can not use optional param because moodlelib.php is not loaded yet
string | $name | |
mixed | $default | |
string | $type |
mixed |
mnet_get_idp_jump_url | ( | $user | ) |
return the jump url for a given remote user this is used for rewriting forum post links in emails, etc
stdclass | $user | the user to get the idp url for |
mod_page_type_list | ( | $pagetype, | |
$parentcontext = null, | |||
$currentcontext = null ) |
Generates the page type list for a module by either locating and using the modules callback or by generating a default list.
string | $pagetype | |
stdClass | $parentcontext | |
stdClass | $currentcontext |
array |
moodle_getlocale | ( | ) |
Gets the system locale.
string | Retuns the current locale. |
moodle_major_version | ( | $fromdisk = false | ) |
Returns the major version of this site.
Moodle version numbers consist of three numbers separated by a dot, for example 1.9.11 or 2.0.2. The first two numbers, like 1.9 or 2.0, represent so called major version. This function extracts the major version from either $CFG->release (default) or eventually from the $release variable defined in the main version.php.
bool | $fromdisk | should the version if source code files be used |
string|false | the major version like '2.3', false if could not be determined |
moodle_minimum_php_version_is_met | ( | $haltexecution = false | ) |
Tests the current PHP version against Moodle's minimum requirement.
When requirement is not met returns false or halts execution depending $haltexecution param.
bool | $haltexecution | Should execution be halted when requirement not met? Defaults to false. |
bool | returns true if requirement is met (false if not) |
moodle_needs_upgrading | ( | $checkupgradeflag = true | ) |
Determine if moodle installation requires update.
Checks version numbers of main code and all plugins to see if there are any mismatches.
bool | $checkupgradeflag | check the outagelessupgrade flag to see if an upgrade is running. |
bool |
moodle_process_email | ( | $modargs, | |
$body ) |
moodle_require_minimum_php_version | ( | ) |
Require our minimum php version or halt execution if requirement not met.
void | Execution is halted if version is not met. |
moodle_setlocale | ( | $locale = '' | ) |
Sets the system locale.
string | $locale | Can be used to force a locale |
move_category | ( | ) |
move_question_set_references | ( | int | $oldcategoryid, |
int | $newcatgoryid, | ||
int | $oldcontextid, | ||
int | $newcontextid, | ||
bool | $delete = false ) |
Update the questioncontextid field for all question_set_references records given a new context id.
int | $oldcategoryid | Old category to be moved. |
int | $newcatgoryid | New category that will receive the questions. |
int | $oldcontextid | Old context to be moved. |
int | $newcontextid | New context that will receive the questions. |
bool | $delete | If the action is delete. |
dml_exception |
mtrace | ( | $string, | |
$eol = "\n", | |||
$sleep = 0 ) |
For outputting debugging info.
string | $string | The string to write |
string | $eol | The end of line char(s) to use |
string | $sleep | Period to make the application sleep This ensures any messages have time to display before redirect |
mtrace_exception | ( | Throwable | $e | ) |
Helper to {.
Throwable | $e | the error to ouptput. |
my_page_type_list | ( | $pagetype, | |
$parentcontext = null, | |||
$currentcontext = null ) |
Generates the page type list for the my moodle page.
string | $pagetype | |
stdClass | $parentcontext | |
stdClass | $currentcontext |
array |
mygroupid | ( | ) |
navmenu | ( | ) |
navmenulist | ( | $course, | |
$sections, | |||
$modinfo, | |||
$strsection, | |||
$strjumpto, | |||
$width = 50, | |||
$cmid = 0 ) |
Returns a popup menu with course activity modules.
Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu outputs a simple list structure in XHTML. The data is taken from the serialised array stored in the course record.
stdClass | $course | A course object. |
array | $sections | |
course_modinfo | $modinfo | |
string | $strsection | |
string | $strjumpto | |
int | $width | |
string | $cmid |
string | The HTML block |
|
static |
Normalize the component name using the "frankenstyle" rules.
Normalize the component name using the "frankenstyle" names.
Note: this does not verify the validity of plugin or type names.
string | $component |
array | two-items list of [(string)type, (string|null)name] |
string | $component |
array | two-items list of [(string)type, (string|null)name] |
|
static |
Normalize the component name.
Note: this does not verify the validity of the plugin or component.
string | $component |
string |
normalize_version | ( | $version | ) |
This function will normalize any version to just a serie of numbers separated by dots.
Everything else will be removed.
string | $version | the original version |
string | the normalized version |
notice | ( | $message, | |
$link = '', | |||
$course = null ) |
Print a message and exit.
string | $message | The message to print in the notice |
moodle_url | string | $link | The link to use for the continue button |
object | $course | A course object. Unused. |
void | This function simply exits |
notify | ( | ) |
obfuscate_email | ( | ) |
Given an email address, this function will return an obfuscated version of it.
string | The email address to obfuscate |
string | The obfuscated email address |
obfuscate_mailto | ( | $email, | |
$label = '', | |||
$dimmed = false, | |||
$subject = '', | |||
$body = '' ) |
This function uses the obfuscate_email() and obfuscate_text() to generate a fully obfuscated email link, ready to use.
string | The email address to display | |
string | $label | The text to displayed as hyperlink to $email |
boolean | $dimmed | If true then use css class 'dimmed' for hyperlink |
string | $subject | The subject of the email in the mailto link |
string | $body | The content of the email in the mailto link |
string | The obfuscated mailto link |
obfuscate_text | ( | $plaintext | ) |
This function takes some text and replaces about half of the characters with HTML entity equivalents.
Return string is obviously longer.
string | $plaintext | The text to be obfuscated |
string | The obfuscated text |
object_array_unique | ( | $array, | |
$keepkeyassoc = true ) |
Returns an array without repeated objects.
This function is similar to array_unique, but for arrays that have objects as values
array | $array | |
bool | $keepkeyassoc |
array |
object_property_exists | ( | $obj, | |
$property ) |
Detect if an object or a class contains a given property will take an actual object or the name of a class.
mixed | $obj | Name of class or real object to test |
string | $property | name of property to find |
bool | true if property exists |
optional_param | ( | $parname, | |
$default, | |||
$type ) |
Returns a particular value for the named variable, taken from POST or GET, otherwise returning a given default.
This function should be used to initialise all optional values in a script that are based on parameters. Usually it will be used like this: $name = optional_param('name', 'Fred', PARAM_TEXT);
Please note the $type parameter is now required and the value can not be array.
string | $parname | the name of the page parameter we want |
mixed | $default | the default value to return if nothing is found |
string | $type | expected type of parameter |
mixed |
coding_exception |
optional_param_array | ( | $parname, | |
$default, | |||
$type ) |
Returns a particular array value for the named variable, taken from POST or GET, otherwise returning a given default.
This function should be used to initialise all optional values in a script that are based on parameters. Usually it will be used like this: $ids = optional_param('id', array(), PARAM_INT);
Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
string | $parname | the name of the page parameter we want |
mixed | $default | the default value to return if nothing is found |
string | $type | expected type of parameter |
array |
coding_exception |
order_in_string | ( | $values, | |
$stringformat ) |
Returns an array of values in order of occurance in a provided string.
The key in the result is the character postion in the string.
array | $values | Values to be found in the string format |
string | $stringformat | The string which may contain values being searched for. |
array | An array of values in order according to placement in the string format. |
over_bounce_threshold | ( | $user | ) |
Check whether the user has exceeded the bounce threshold.
stdClass | $user | A $USER object |
bool | true => User has exceeded bounce threshold |
p | ( | $var | ) |
page_doc_link | ( | $text = '' | ) |
Returns a string containing a link to the user documentation for the current page.
Also contains an icon by default. Shown to teachers and admin only.
string | $text | The text to be displayed for the link |
string | The link to user documentation for this current page |
page_get_doc_link_path | ( | moodle_page | $page | ) |
Returns the path to use when constructing a link to the docs.
moodle_page | $page |
string |
partial | ( | ) |
Helper function to do partial function binding.
so we can use it for preg_replace_callback, for example this works with php functions, user functions, static methods and class methods it returns you a callback that you can pass on like so:
$callback = partial('somefunction', $arg1, $arg2); or $callback = partial(array('someclass', 'somestaticmethod'), $arg1, $arg2); or even $obj = new someclass(); $callback = partial(array($obj, 'somemethod'), $arg1, $arg2);
and then the arguments that are passed through at calltime are appended to the argument list.
mixed | $function | a php callback |
mixed | $arg1,... | $argv arguments to partially bind with |
array | Array callback |
password_compat_not_supported | ( | ) |
password_is_legacy_hash | ( | $password | ) |
Check a password hash to see if it was hashed using the legacy hash algorithm (md5).
string | $password | String to check. |
boolean | True if the $password matches the format of an md5 sum. |
perf_get_reads_slave | ( | ) |
Returns the number of reads done by the read only database.
int | Number of reads. |
phpunit_bootstrap_error | ( | $errorcode, | |
$text = '' ) |
Print error and stop execution.
int | $errorcode | The exit error code |
string | $text | An error message to display |
void | stops code execution with error code |
plagiarism_get_file_results | ( | $cmid, | |
$userid, | |||
$file ) |
returns array of plagiarism details about specified file
int | $cmid | |
int | $userid | |
object | $file | moodle file object |
array | - sets of details about specified file, one array of details per plagiarism plugin
|
plagiarism_get_form_elements_module | ( | ) |
if(!defined('MOODLE_INTERNAL')) plagiarism_get_links | ( | $linkarray | ) |
displays the similarity score and provides a link to the full report if allowed.
object | $linkarray | contains all relevant information for the plugin to generate a link |
string | - url to allow login/viewing of a similarity report |
plagiarism_load_available_plugins | ( | ) |
Helper function - also loads lib file of plagiarism plugin.
array | of available plugins |
plagiarism_print_disclosure | ( | $cmid | ) |
Function that prints the student disclosure notifying that the files will be checked for plagiarism.
integer | $cmid | - the cmid of this module |
string |
plagiarism_save_form_elements | ( | ) |
plagiarism_update_status | ( | $course, | |
$cm ) |
Allows a plagiarism plugin to print a button/link at the top of activity overview report pages.
object | $course | - full Course object |
object | $cm | - full cm object |
string |
plugin_callback | ( | $type, | |
$name, | |||
$feature, | |||
$action, | |||
$params = null, | |||
$default = null ) |
Invoke plugin's callback functions.
string | $type | plugin type e.g. 'mod' |
string | $name | plugin name |
string | $feature | feature name |
string | $action | feature's action |
array | $params | parameters of callback function, should be an array |
mixed | $default | default value if callback function hasn't been defined, or if it retursn null. |
mixed |
plugin_supports | ( | $type, | |
$name, | |||
$feature, | |||
$default = null ) |
Checks whether a plugin supports a specified feature.
string | $type | Plugin type e.g. 'mod' |
string | $name | Plugin name e.g. 'forum' |
string | $feature | Feature code (FEATURE_xx constant) |
mixed | $default | default value if feature support unknown |
mixed | Feature result (false if not supported, null if feature is unknown, otherwise usually true but may have other feature-specific value such as array) |
coding_exception |
preload_course_contexts | ( | ) |
prevent_form_autofill_password | ( | ) |
object print_arrow | ( | $direction = 'up', | |
$strsort = null, | |||
$return = false ) |
Returns an image of an up or down arrow, used for column sorting.
To avoid unnecessary DB accesses, please provide this function with the language strings for sortasc and sortdesc.
If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
string | $direction | 'up' or 'down' |
string | $strsort | The language string used for the alt attribute of this image |
bool | $return | Whether to print directly or return the html string |
string|void | depending on $return |
print_badge_image | ( | badge | $badge, |
stdClass | $context, | ||
$size = 'small' ) |
Print badge image.
badge | $badge | Badge object |
stdClass | $context | |
string | $size |
print_category_info | ( | ) |
print_checkbox | ( | ) |
print_collapsible_region | ( | $contents, | |
$classes, | |||
$id, | |||
$caption, | |||
$userpref = '', | |||
$default = false, | |||
$return = false ) |
Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.
If JavaScript is off, then the region will always be expanded.
string | $contents | the contents of the box. |
string | $classes | class names added to the div that is output. |
string | $id | id added to the div that is output. Must not be blank. |
string | $caption | text displayed at the top. Clicking on this will cause the region to expand or contract. |
string | $userpref | the name of the user preference that stores the user's preferred default state. (May be blank if you do not wish the state to be persisted. |
boolean | $default | Initial collapsed state to use if the user_preference it not set. |
boolean | $return | if true, return the HTML as a string, rather than printing it. |
string|void | If $return is false, returns nothing, otherwise returns a string of HTML. |
print_collapsible_region_end | ( | $return = false | ) |
Close a region started with print_collapsible_region_start.
boolean | $return | if true, return the HTML as a string, rather than printing it. |
string|void | if $return is false, returns nothing, otherwise returns a string of HTML. |
print_collapsible_region_start | ( | $classes, | |
$id, | |||
$caption, | |||
$userpref = '', | |||
$default = false, | |||
$return = false, | |||
$extracontent = null ) |
Print (or return) the start of a collapsible region.
The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region will always be expanded.
string | $classes | class names added to the div that is output. |
string | $id | id added to the div that is output. Must not be blank. |
string | $caption | text displayed at the top. Clicking on this will cause the region to expand or contract. |
string | $userpref | the name of the user preference that stores the user's preferred default state. (May be blank if you do not wish the state to be persisted. |
boolean | $default | Initial collapsed state to use if the user_preference it not set. |
boolean | $return | if true, return the HTML as a string, rather than printing it. |
string | $extracontent | the extra content will show next to caption, eg.Help icon. |
string|void | if $return is false, returns nothing, otherwise returns a string of HTML. |
print_container | ( | ) |
print_container_end | ( | ) |
print_container_start | ( | ) |
print_context_name | ( | ) |
print_continue | ( | ) |
print_course | ( | ) |
print_course_search | ( | ) |
print_courses | ( | ) |
print_error | ( | $errorcode, | |
$module = 'error', | |||
$link = '', | |||
$a = null, | |||
$debuginfo = null ) |
Abort execution by throwing of a general exception, default exception handler displays the error message in most cases.
string | $errorcode | The name of the language string containing the error message. Normally this should be in the error.php lang file. |
string | $module | The language file to get the error message from. |
string | $link | The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page. |
object | $a | Extra words and phrases that might be required in the error string |
string | $debuginfo | optional debugging information |
void,always | throws exception! |
print_grade_menu | ( | $courseid, | |
$name, | |||
$current, | |||
$includenograde = true, | |||
$return = false ) |
Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.
Finish documenting this function
Deprecate: this is only used in a few contrib modules
int | $courseid | The course ID |
string | $name | |
string | $current | |
boolean | $includenograde | Include those with no grades |
boolean | $return | If set to true returns rather than echo's |
string|bool | Depending on value of $return |
print_grade_plugin_selector | ( | $plugin_info, | |
$active_type, | |||
$active_plugin, | |||
$return = false ) |
Print grading plugin selection popup form.
array | $plugin_info | An array of plugins containing information for the selector |
boolean | $return | return as string |
nothing | or string if $return true |
print_group_picture | ( | $group, | |
$courseid, | |||
$large = false, | |||
$return = false, | |||
$link = true, | |||
$includetoken = false ) |
Print a specified group's avatar.
array | stdClass | $group | A single group object OR array of groups. |
int | $courseid | The course ID. |
boolean | $large | Default small picture, or large. |
boolean | $return | If false print picture, otherwise return the output as string |
boolean | $link | Enclose image in a link to view specified course? |
boolean | $includetoken | Whether to use a user token when displaying this group image. True indicates to generate a token for current user, and integer value indicates to generate a token for the user whose id is the value indicated. If the group picture is included in an e-mail or some other location where the audience is a specific user who will not be logged in when viewing, then we use a token to authenticate the user. |
string|void | Depending on the setting of $return |
print_header | ( | ) |
print_header_simple | ( | ) |
print_location_comment | ( | $file, | |
$line, | |||
$return = false ) |
Outputs a HTML comment to the browser.
This is used for those hard-to-debug pages that use bits from many different files in very confusing ways (e.g. blocks).
print_location_comment(FILE, LINE);
string | $file | |
integer | $line | |
boolean | $return | Whether to return or print the comment |
string|void | Void unless true given as third parameter |
print_log | ( | ) |
print_log_csv | ( | ) |
print_log_ods | ( | ) |
print_log_xls | ( | ) |
print_mnet_log | ( | ) |
print_my_moodle | ( | ) |
print_navigation | ( | ) |
print_object | ( | $object | ) |
GENERAL HELPFUL THINGS ///////////////////////////////////.
Dumps a given object's information for debugging purposes
When used in a CLI script, the object's information is written to the standard error output stream. When used in a web script, the object is dumped to a pre-formatted block with the "notifytiny" CSS class.
mixed | $object | The data to be printed |
void | output is echo'd |
print_overview | ( | ) |
print_password_policy | ( | ) |
Returns a localized sentence in the current language summarizing the current password policy.
string |
print_question_icon | ( | $question | ) |
Print the icon for the question type.
object | $question | The question object for which the icon is required. Only $question->qtype is used. |
string | the HTML for the img tag. |
print_recent_activity | ( | ) |
print_recent_activity_note | ( | $time, | |
$user, | |||
$text, | |||
$link, | |||
$return = false, | |||
$viewfullnames = null ) |
Display a recent activity note.
@staticvar string $strftimerecent
int | $time | A timestamp int. |
stdClass | $user | A user object from the database. |
string | $text | Text for display for the note |
string | $link | The link to wrap around the text |
bool | $return | If set to true the HTML is returned rather than echo'd |
string | $viewfullnames |
string | If $retrun was true returns HTML for a recent activity notice. |
print_remote_course | ( | ) |
print_remote_host | ( | ) |
print_scale_menu_helpbutton | ( | ) |
print_section | ( | ) |
print_section_add_menus | ( | ) |
print_side_block | ( | ) |
print_string | ( | $identifier, | |
$component = '', | |||
$a = null ) |
Prints out a translated string.
Prints out a translated string using the return value from the get_string() function.
Example usage of this function when the string is in the moodle.php file:
echo ''; print_string('course'); echo '';
Example usage of this function when the string is not in the moodle.php file:
echo '
';
string | $identifier | The key identifier for the localized string |
string | $component | The module where the key identifier is stored. If none is specified then moodle.php is used. |
string | object | array | $a | An object, string or number that can be used within translation strings |
print_tabs | ( | $tabrows, | |
$selected = null, | |||
$inactive = null, | |||
$activated = null, | |||
$return = false ) |
Returns a string containing a nested list, suitable for formatting into tabs with CSS.
It is not recommended to use this function in Moodle 2.5 but it is left for backward compartibility.
Example how to print a single line tabs: $rows = array( new tabobject(...), new tabobject(...) ); echo $OUTPUT->tabtree($rows, $selectedid);
Multiple row tabs may not look good on some devices but if you want to use them you can specify ->subtree for the active tabobject.
array | $tabrows | An array of rows where each row is an array of tab objects |
string | $selected | The id of the selected tab (whatever row it's on) |
array | $inactive | An array of ids of inactive tabs that are not selectable. |
array | $activated | An array of ids of other tabs that are currently activated |
bool | $return | If true output is returned rather then echo'd |
string | HTML output if $return was set to true. |
print_textarea | ( | ) |
print_upgrade_part_end | ( | $plugin, | |
$installation, | |||
$verbose ) |
Default end upgrade callback.
string | $plugin | |
bool | $installation | true if installation, false means upgrade |
print_upgrade_part_start | ( | $plugin, | |
$installation, | |||
$verbose ) |
Default start upgrade callback.
string | $plugin | |
bool | $installation | true if installation, false means upgrade |
print_whole_category_list | ( | ) |
process_environment_bypass | ( | $xml, | |
& | $result ) |
This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer.
Every bypass function must be defined in this file and it'll return true/false to decide if the original test is bypassed or no. Also such bypass functions are able to directly handling the result object although it should be only under exceptional conditions.
string | xmldata containing the bypass data |
object | result object to be updated |
void |
process_environment_messages | ( | $xml, | |
& | $result ) |
This function will detect if there is some message available to be added to the result in order to clarify enviromental details.
@uses INCORRECT_FEEDBACK_FOR_REQUIRED @uses INCORRECT_FEEDBACK_FOR_OPTIONAL
string | xmldata containing the feedback data |
object | reult object to be updated |
process_environment_restrict | ( | $xml, | |
& | $result ) |
This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer.
Every restrict function must be defined in this file and it'll return true/false to decide if the original test is restricted or no. Also such restrict functions are able to directly handling the result object although it should be only under exceptional conditions.
string | xmldata containing the restrict data |
object | result object to be updated |
void |
process_environment_result | ( | $element, | |
& | $result ) |
Once the result has been determined, look in the XML for any messages, or other things that should be done depending on the outcome.
array | $element | the element from the environment.xml file which may have children defining what should be done with the outcome. |
object | $result | the result of the test, which may be modified by this function as specified in the XML. |
process_manual_revoke | ( | $recipientid, | |
$issuerid, | |||
$issuerrole, | |||
$badgeid ) |
Manually revoke awarded badges.
int | $recipientid | |
int | $issuerid | |
int | $issuerrole | |
int | $badgeid |
bool |
process_new_icon | ( | $context, | |
$component, | |||
$filearea, | |||
$itemid, | |||
$originalfile, | |||
$preferpng = false ) |
Stores optimised icon images in icon file area.
Since 2.9 this function will generate an icon in the same format as the original file when possible. To counter that behaviour, you can use the argument $preferpng to generate a PNG icon.
context | $context | |
string | $component | |
string | filearea | |
int | $itemid | |
string | $originalfile | |
boolean | $preferpng | When true, it will try to generate a PNG file regardless of the original file. |
mixed | new unique revision number or false if not saved |
profile_display_badges | ( | ) |
profiling_available | ( | ) |
Whether PHP profiling is available.
This check ensures that one of the available PHP Profiling extensions is available.
bool |
profiling_export_generate | ( | array | $runids, |
$tmpdir ) |
Generate the mpr contents (xml files) in the temporal directory.
array | $runids | list of runids to be generated. |
string | $tmpdir | filesystem fullpath of tmp generation. |
boolean | the mpr contents have been generated (true) or no (false). |
profiling_export_package | ( | $file, | |
$tmpdir ) |
Package (zip) the mpr contents (xml files) in the final location.
string | $file | filesystem fullpath to destination .mpr file. |
string | $tmpdir | filesystem fullpath of tmp generation. |
boolean | the mpr contents have been generated (true) or no (false). |
profiling_export_runs | ( | array | $runids, |
$file ) |
Export profiling runs to a .mpr (moodle profile runs) file.
This function gets an array of profiling runs (array of runids) and saves a .mpr file into destination for ulterior handling.
Format of .mpr files: mpr files are simple zip packages containing these files:
runid.xml: One file per each run detailed in the main file, containing the raw dump of the given runid in the profiling table.
Possible improvement: Start storing some extra information in the profiling table for each run (moodle version, database, git hash...).
array | $runids | list of runids to be exported. |
string | $file | filesystem fullpath to destination .mpr file. |
boolean | the mpr file has been successfully exported (true) or no (false). |
profiling_get_flag | ( | $flag | ) |
Check for profiling flags in all possible places.
string | $flag | name |
boolean |
profiling_get_import_main_schema | ( | ) |
Return the xml schema for the main import file.
string |
profiling_get_import_run_schema | ( | ) |
Return the xml schema for each individual run import file.
string |
profiling_get_script | ( | ) |
Returns the path to the php script being requested.
Note this function is a partial copy of initialise_fullme() and setup_get_remote_url(), in charge of setting $FULLME, $SCRIPT and friends. To be used by early profiling runs in situations where $SCRIPT isn't defined yet
string | absolute path (wwwroot based) of the script being executed |
profiling_import_runs | ( | $file, | |
$commentprefix = '' ) |
Import a .mpr (moodle profile runs) file into moodle.
See profiling_export_runs() for more details about the implementation of .mpr files.
string | $file | filesystem fullpath to target .mpr file. |
string | $commentprefix | prefix to add to the comments of all the imported runs. |
boolean | the mpr file has been successfully imported (true) or no (false). |
profiling_print_run | ( | $run, | |
$prevreferences = null ) |
Generate the output to print a profiling run including further actions you can then take.
object | $run | The profiling run object we are going to display. |
array | $prevreferences | A list of run objects to list as comparison targets. |
string | The output to display on the screen for this run. |
proxy_log_callback | ( | $code | ) |
Add http stream instrumentation.
This detects which any reads or writes to a php stream which uses the 'http' handler. Ideally 100% of traffic uses the Moodle curl libraries which do not use php streams.
array | $code | stream callback code |
purge_all_caches | ( | ) |
Invalidates browser caches and cached data in temp.
void |
purge_caches | ( | $options = [] | ) |
Selectively invalidate different types of cache.
Purges the cache areas specified. By default, this will purge all caches but can selectively purge specific areas alone or in combination.
bool[] | $options | Specific parts of the cache to purge. Valid options are: 'muc' Purge MUC caches? 'theme' Purge theme cache? 'lang' Purge language string cache? 'js' Purge javascript cache? 'filter' Purge text filter cache? 'other' Purge all other caches? |
purge_other_caches | ( | ) |
Purge all non-MUC caches not otherwise purged in purge_caches.
IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at phpunit_util::reset_dataroot()
purify_html | ( | $text, | |
$options = array() ) |
KSES replacement cleaning function - uses HTML Purifier.
string | $text | The (X)HTML string to purify |
array | $options | Array of options; currently only option supported is 'allowid' (if set, does not remove id attributes when cleaning) |
string |
put_records_csv | ( | ) |
qualified_me | ( | ) |
Guesses the full URL of the current script.
This function is using $PAGE->url, but may fall back to $FULLME which is constructed from PHP_SELF and REQUEST_URI or SCRIPT_NAME
mixed | full page URL string or false if unknown |
|
protected |
This should be called immediately after each db query.
It does a clean up of resources.
mixed | $result | The db specific result obtained from running a query. |
void |
|
protected |
Called before each db query.
string | $sql | |
array | null | $params | An array of parameters. |
int | $type | type of query |
mixed | $extrainfo | driver specific extra information |
void |
question_add_context_in_key | ( | $categories | ) |
Add context in categories key.
array | $categories | The list of categories. |
array |
question_add_tops | ( | ) |
question_category_delete_safe | ( | $category | ) |
Category is about to be deleted, 1/ All questions are deleted for this question category.
2/ Any questions that can't be deleted are moved to a new category NOTE: this function is called from lib/db/upgrade.php
object | core_course_category | $category | course category object |
question_category_in_use | ( | $categoryid, | |
$recursive = false ) |
Tests whether any question in a category is used by any part of Moodle.
integer | $categoryid | a question category id. |
boolean | $recursive | whether to check child categories too. |
boolean | whether any question in this category is in use. |
question_category_options | ( | $contexts, | |
$top = false, | |||
$currentcat = 0, | |||
$popupform = false, | |||
$nochildrenof = -1, | |||
$escapecontextnames = true ) |
Output an array of question categories.
array | $contexts | The list of contexts. |
bool | $top | Whether to return the top categories or not. |
int | $currentcat | |
bool | $popupform | |
int | $nochildrenof | |
boolean | $escapecontextnames | Whether the returned name of the thing is to be HTML escaped or not. |
array |
question_category_select_menu | ( | $contexts, | |
$top = false, | |||
$currentcat = 0, | |||
$selected = "", | |||
$nochildrenof = -1 ) |
Output a select menu of question categories.
Categories from this course and (optionally) published categories from other courses are included. Optionally, only categories the current user may edit can be included.
array | $contexts | |
bool | $top | |
int | $currentcat | |
integer | $selected | optionally, the id of a category to be selected by default in the dropdown. |
int | $nochildrenof |
question_categorylist | ( | $categoryid | ) |
Get the list of categories.
int | $categoryid |
array | of question category ids of the category and all subcategories. |
question_categorylist_parents | ( | int | $categoryid | ) |
Get all parent categories of a given question category in descending order.
int | $categoryid | for which you want to find the parents. |
array | of question category ids of all parents categories. |
question_context_has_any_questions | ( | $context | ) |
Determine whether there are any questions belonging to this context, that is whether any of its question categories contain any questions.
This will return true even if all the questions are hidden.
mixed | $context | either a context object, or a context id. |
boolean | whether any of the question categories beloning to this context have any questions in them. |
question_default_export_filename | ( | $course, | |
$category ) |
Create a reasonable default file name for exporting questions from a particular category.
object | $course | the course the questions are in. |
object | $category | the question category. |
string | the filename. |
question_delete_activity | ( | $cm, | |
$notused = false ) |
All question categories and their questions are deleted for this activity.
object | $cm | the course module object representing the activity |
bool | $notused | the argument is not used any more. Kept for backwards compatibility. |
boolean |
question_delete_context | ( | $contextid | ) |
All question categories and their questions are deleted for this context id.
int | $contextid | The contextid to delete question categories from |
array | only returns an empty array for backwards compatibility. |
question_delete_course | ( | $course, | |
$notused = false ) |
All question categories and their questions are deleted for this course.
stdClass | $course | an object representing the activity |
bool | $notused | this argument is not used any more. Kept for backwards compatibility. |
bool | always true. |
question_delete_course_category | ( | $category, | |
$newcategory, | |||
$notused = false ) |
Category is about to be deleted, 1/ All question categories and their questions are deleted for this course category.
2/ All questions are moved to new category
stdClass | core_course_category | $category | course category object |
stdClass | core_course_category | $newcategory | empty means everything deleted, otherwise id of category where content moved |
bool | $notused | this argument is no longer used. Kept for backwards compatibility. |
boolean |
question_delete_question | ( | $questionid | ) |
Deletes question and all associated data from the database.
It will not delete a question if it is used somewhere, instead it will just delete the reference.
int | $questionid | The id of the question being deleted |
question_edit_url | ( | $context | ) |
Gets the question edit url.
object | $context | a context |
string|bool | A URL for editing questions in this context. |
question_extend_settings_navigation | ( | navigation_node | $navigationnode, |
$context, | |||
$baseurl = '/question/edit.php' ) |
Adds question bank setting links to the given navigation node if caps are met and loads the navigation from the plugins.
Qbank plugins can extend the navigation_plugin_base and add their own navigation node, this method will help to autoload those nodes in the question bank navigation.
navigation_node | $navigationnode | The navigation node to add the question branch to |
object | $context | |
string | $baseurl | the url of the base where the api is implemented from |
navigation_node | Returns the question branch that was added |
question_fix_top_names | ( | $categories, | |
$escape = true ) |
Finds top categories in the given categories hierarchy and replace their name with a proper localised string.
array | $categories | An array of question categories. |
boolean | $escape | Whether the returned name of the thing is to be HTML escaped or not. |
array | The same question category list given to the function, with the top category names being translated. |
question_get_all_capabilities | ( | ) |
Get the question bank caps.
array | all the question bank capabilities. |
question_get_default_category | ( | $contextid | ) |
Get the default category for the context.
integer | $contextid | a context id. |
object|bool | the default question category for that context, or false if none. |
question_get_export_single_question_url | ( | $question | ) |
Get the URL to export a single question (exportone.php).
stdClass | question_definition | $question | the question definition as obtained from question_bank\load_question_data() or question_bank\make_question(). (Only ->id and ->contextid are used.) |
moodle_url | the requested URL. |
question_get_question_capabilities | ( | ) |
Get the array of capabilities for question.
array | all the capabilities that relate to accessing particular questions. |
question_get_top_categories_for_contexts | ( | $contextids | ) |
Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format.
array | $contextids | List of context ids |
array |
question_get_top_category | ( | $contextid, | |
$create = false ) |
Gets the top category in the given context.
This function can optionally create the top category if it doesn't exist.
int | $contextid | A context id. |
bool | $create | Whether create a top category if it doesn't exist. |
bool|stdClass | The top question category for that context, or false if none. |
question_has_capability_on | ( | $questionorid, | |
$cap, | |||
$notused = -1 ) |
Check capability on category.
int | stdClass | question_definition | $questionorid | object or id. If an object is passed, it should include ->contextid and ->createdby. |
string | $cap | 'add', 'edit', 'view', 'use', 'move' or 'tag'. |
int | $notused | no longer used. |
bool | this user has the capability $cap for this question $question? |
question_hash | ( | $question | ) |
Creates a stamp that uniquely identifies this version of the question.
In future we want this to use a hash of the question data to guarantee that identical versions have the same version stamp.
object | $question |
string | A unique version stamp |
question_is_only_toplevel_category_in_context | ( | ) |
question_load_questions | ( | $questionids, | |
$extrafields = '', | |||
$join = '' ) |
Load a set of questions, given a list of ids.
The $join and $extrafields arguments can be used together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and read the code below to see how the SQL is assembled. Throws exceptions on error.
array | $questionids | array of question ids. |
string | $extrafields | extra SQL code to be added to the query. |
string | $join | extra SQL code to be added to the query. |
array|string | question objects. |
question_make_default_categories | ( | $contexts | ) |
Gets the default category in the most specific context.
If no categories exist yet then default ones are created in all contexts.
array | $contexts | The context objects for this context and all parent contexts. |
object | The default category - the category in the course context |
question_make_export_url | ( | $contextid, | |
$categoryid, | |||
$format, | |||
$withcategories, | |||
$withcontexts, | |||
$filename ) |
Create url for question export.
int | $contextid | |
int | $categoryid | |
string | $format | |
string | $withcategories | |
string | $withcontexts | |
string | $filename |
moodle_url | export file url |
question_module_uses_questions | ( | $modname | ) |
Does an activity module use the question bank?
string | $modname | The name of the module (without mod_ prefix). |
bool | true if the module uses questions. |
question_move_category_to_context | ( | $categoryid, | |
$oldcontextid, | |||
$newcontextid ) |
This function helps move a question cateogry to a new context by moving all the files belonging to all the questions to the new context.
Also moves subcategories.
integer | $categoryid | the id of the category being moved. |
integer | $oldcontextid | the old context id. |
integer | $newcontextid | the new context id. |
question_move_question_tags_to_new_context | ( | array | $questions, |
context | $newcontext ) |
This function will handle moving all tag instances to a new context for a given list of questions.
Questions can be tagged in up to two contexts: 1.) The context the question exists in. 2.) The course context (if the question context is a higher context. E.g. course category context or system context.
This means a question that exists in a higher context (e.g. course cat or system context) may have multiple groups of tags in any number of child course contexts.
Questions in the course category context can be move "down" a context level into one of their child course contexts or activity contexts which affects the availability of that question in other courses / activities.
In this case it makes the questions no longer available in the other course or activity contexts so we need to make sure that the tag instances in those other contexts are removed.
stdClass[] | $questions | The list of question being moved (must include the id and contextid) |
context | $newcontext | The Moodle context the questions are being moved to |
question_move_questions_to_category | ( | $questionids, | |
$newcategoryid ) |
This function should be considered private to the question bank, it is called from question/editlib.php question/contextmoveq.php and a few similar places to to the work of actually moving questions and associated data.
However, callers of this function also have to do other work, which is why you should not call this method directly from outside the questionbank.
array | $questionids | of question ids. |
integer | $newcategoryid | the id of the category to move to. |
bool |
question_page_type_list | ( | $pagetype, | |
$parentcontext, | |||
$currentcontext ) |
Return a list of page types.
string | $pagetype | current page type |
stdClass | $parentcontext | Block's parent context |
stdClass | $currentcontext | Current context of block |
array |
question_pluginfile | ( | $course, | |
$context, | |||
$component, | |||
$filearea, | |||
$args, | |||
$forcedownload, | |||
$options = [] ) |
Called by pluginfile.php to serve files related to the 'question' core component and for files belonging to qtypes.
For files that relate to questions in a question_attempt, then we delegate to a function in the component that owns the attempt (for example in the quiz, or in core question preview) to get necessary inforation.
(Note that, at the moment, all question file areas relate to questions in attempts, so the If at the start of the last paragraph is always true.)
Does not return, either calls send_file_not_found(); or serves the file.
stdClass | $course | course settings object |
stdClass | $context | context object |
string | $component | the name of the component we are serving files for. |
string | $filearea | the name of the file area. |
array | $args | the remaining bits of the file path. |
bool | $forcedownload | whether the user must be forced to download the file. |
array | $options | additional options affecting the file serving |
array|bool |
question_preload_questions | ( | $questionids = null, | |
$extrafields = '', | |||
$join = '', | |||
$extraparams = [], | |||
$orderby = '' ) |
Given a list of ids, load the basic information about a set of questions from the questions table.
The $join and $extrafields arguments can be used together to pull in extra data. See, for example, the usage in {
array | $questionids | array of question ids to load. If null, then all questions matched by $join will be loaded. |
string | $extrafields | extra SQL code to be added to the query. |
string | $join | extra SQL code to be added to the query. |
array | $extraparams | values for any placeholders in $join. You must use named placeholders. |
string | $orderby | what to order the results by. Optional, default is unspecified order. |
array | partially complete question objects. You need to call get_question_options on them before they can be properly used. |
question_preview_popup_params | ( | ) |
Popup params for the question preview.
array | that can be passed as $params to the { |
question_preview_url | ( | $questionid, | |
$preferredbehaviour = null, | |||
$maxmark = null, | |||
$displayoptions = null, | |||
$variant = null, | |||
$context = null ) |
Generate the URL for starting a new preview of a given question with the given options.
integer | $questionid | the question to preview. |
string | $preferredbehaviour | the behaviour to use for the preview. |
float | $maxmark | the maximum to mark the question out of. |
question_display_options | $displayoptions | the display options to use. |
int | $variant | the variant of the question to preview. If null, one will be picked randomly. |
object | $context | context to run the preview in (affects things like filter settings, theme, lang, etc.) Defaults to $PAGE->context. |
moodle_url | the URL. |
question_remove_stale_questions_from_category | ( | $categoryid | ) |
Remove stale questions from a category.
While questions should not be left behind when they are not used any more, it does happen, maybe via restore, or old logic, or uncovered scenarios. When this happens, the users are unable to delete the question category unless they move those stale questions to another one category, but to them the category is empty as it does not contain anything. The purpose of this function is to detect the questions that may have gone stale and remove them.
You will typically use this prior to checking if the category contains questions.
The stale questions (unused and hidden to the user) handled are:
int | $categoryid | The category ID. |
question_reorder_qtypes | ( | $sortedqtypes, | |
$tomove, | |||
$direction ) |
Move one question type in a list of question types.
If you try to move one element off of the end, nothing will change.
array | $sortedqtypes | An array $qtype => anything. |
string | $tomove | one of the keys from $sortedqtypes |
integer | $direction | +1 or -1 |
array | an array $index => $qtype, with $index from 0 to n in order, and the $qtypes in the same order as $sortedqtypes, except that $tomove will have been moved one place. |
question_require_capability_on | ( | $question, | |
$cap ) |
Require capability on question.
int | stdClass | question_definition | $question | object or id. If an object is passed, it should include ->contextid and ->createdby. |
string | $cap | 'add', 'edit', 'view', 'use', 'move' or 'tag'. |
bool | true if the user has the capability. Throws exception if not. |
question_rewrite_question_preview_urls | ( | $text, | |
$questionid, | |||
$filecontextid, | |||
$filecomponent, | |||
$filearea, | |||
$itemid, | |||
$previewcontextid, | |||
$previewcomponent, | |||
$options = null ) |
Rewrite the PLUGINFILE urls in part of the content of a question, for use when viewing the question outside an attempt (for example, in the question bank listing or in the quiz statistics report).
string | $text | the question text. |
int | $questionid | the question id. |
int | $filecontextid | the context id of the question being displayed. |
string | $filecomponent | the component that owns the file area. |
string | $filearea | the file area name. |
int | null | $itemid | the file's itemid |
int | $previewcontextid | the context id where the preview is being displayed. |
string | $previewcomponent | component responsible for displaying the preview. |
array | $options | text and file options ('forcehttps'=>false) |
string\$questiontext | with URLs rewritten. |
question_save_from_deletion | ( | $questionids, | |
$newcontextid, | |||
$oldplace, | |||
$newcategory = null ) |
Creates a new category to save the questions in use.
array | $questionids | of question ids |
object | $newcontextid | the context to create the saved category in. |
string | $oldplace | a textual description of the think being deleted, e.g. from get_context_name |
object | $newcategory |
mixed | false on |
question_save_qtype_order | ( | $neworder, | |
$config = null ) |
Save a new question type order to the config_plugins table.
array | $neworder | An arra $index => $qtype. Indices should start at 0 and be in order. |
object | $config | get_config('question'), if you happen to have it around, to save one DB query. |
question_sort_tags | ( | $tagobjects, | |
$categorycontext, | |||
$filtercourses = null ) |
Sort question tags by course or normal tags.
This function also search tag instances that may have a context id that don't match either a course or question context and fix the data setting the correct context id.
core_tag_tag[] | $tagobjects | The tags for the given $question. |
stdClass | $categorycontext | The question categories context. |
stdClass[] | null | $filtercourses | The courses to filter the course tags by. |
stdClass\$sortedtagobjects | Sorted tag objects. |
questions_in_use | ( | $questionids | ) |
Check if the question is used.
array | $questionids | of question ids. |
boolean | whether any of these questions are being used by any part of Moodle. |
raise_memory_limit | ( | $newlimit | ) |
Function to raise the memory limit to a new value.
Will respect the memory limit if it is higher, thus allowing settings in php.ini, apache conf or command line switches to override it.
The memory limit should be expressed with a constant MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE. It is possible to use strings or integers too (eg:'128M').
mixed | $newlimit | the new memory limit |
bool | success |
random_bytes_emulate | ( | $length | ) |
Try to generates cryptographically secure pseudo-random bytes.
Note this is achieved by fallbacking between:
int | $length | requested length in bytes |
string | binary data |
random_string | ( | $length = 15 | ) |
Generate and return a random string of the specified length.
int | $length | The length of the string to be created. |
string |
|
abstractprotected |
Connect to db The real connection establisment, called from connect() and set_dbhwrite()
string | $dbhost | The database host. |
string | $dbuser | The database username. |
string | $dbpass | The database username's password. |
string | $dbname | The name of the database being connected to. |
mixed | $prefix | string means moodle db prefix, false used for external databases where prefix not used |
array | $dboptions | driver specific options |
bool | true |
dml_connection_exception | if error |
rc4decrypt | ( | $data | ) |
rc4decrypt
string | $data | Data to decrypt. |
string | The now decrypted data. |
rc4encrypt | ( | $data | ) |
rc4encrypt
string | $data | Data to encrypt. |
string | The now encrypted data. |
rebuild_contexts | ( | ) |
moodle_database rebuild_course_cache | ( | int | $courseid = 0, |
bool | $clearonly = false, | ||
bool | $partialrebuild = false ) |
Rebuilds or resets the cached list of course activities stored in MUC.
rebuild_course_cache() must NEVER be called from lib/db/upgrade.php. At the same time course cache may ONLY be cleared using this function in upgrade scripts of plugins.
During the bulk operations if it is necessary to reset cache of multiple courses it is enough to call increment_revision_number() for the table 'course' and field 'cacherev' specifying affected courses in select.
Cached course information is stored in MUC core/coursemodinfo and is validated with the DB field {course}.cacherev
$DB
int | $courseid | id of course to rebuild, empty means all |
boolean | $clearonly | only clear the cache, gets rebuild automatically on the fly. Recommended to set to true to avoid unnecessary multiple rebuilding. |
boolean | $partialrebuild | will not delete the whole cache when it's true. use purge_module_cache() or purge_section_cache() must be called before when partialrebuild is true. use purge_module_cache() to invalidate mod cache. use purge_section_cache() to invalidate section cache. |
void |
coding_exception |
rebuildnolinktag | ( | $text | ) |
This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI) will transform it to html entities.
string | $text | Text to search for nolink tag in |
string |
recaptcha_check_response | ( | $verifyurl, | |
$privkey, | |||
$remoteip, | |||
$response ) |
Calls an HTTP POST function to verify if the user's response was correct.
string | $verifyurl | URL for reCAPTCHA verification |
string | $privkey | The private key for reCAPTCHA |
string | $remoteip | The user's IP |
string | $response | The response from reCAPTCHA |
ReCaptchaResponse |
recaptcha_get_challenge_html | ( | $apiurl, | |
$pubkey, | |||
$lang = null ) |
Gets the challenge HTML This is called from the browser, and the resulting reCAPTCHA HTML widget is embedded within the HTML form it was called from.
string | $apiurl | URL for reCAPTCHA API |
string | $pubkey | The public key for reCAPTCHA |
string | $lang | Language to use. If not provided, get current language. |
string | - The HTML to be embedded in the user's form. |
recaptcha_lang | ( | $lang = null | ) |
Returns the language code the reCAPTCHA element should use.
Google reCAPTCHA uses different language codes than Moodle so we must convert. https://developers.google.com/recaptcha/docs/language
string | $lang | Language to use. If not provided, get current language. |
string | A language code |
redirect | ( | $url, | |
$message = '', | |||
$delay = null, | |||
$messagetype = core\output\notification::NOTIFY_INFO ) |
Redirects the user to another page, after printing a notice.
This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.
Good practice: You should call this method before starting page output by using any of the OUTPUT methods.
moodle_url | string | $url | A moodle_url to redirect to. Strings are not to be trusted! |
string | $message | The message to display to the user |
int | $delay | The delay before redirecting |
string | $messagetype | The type of notification to show the message in. See constants on core\output\notification. |
moodle_exception |
reduce_memory_limit | ( | $newlimit | ) |
Function to reduce the memory limit to a new value.
Will respect the memory limit if it is lower, thus allowing settings in php.ini, apache conf or command line switches to override it
The memory limit should be expressed with a string (eg:'64M')
string | $newlimit | the new memory limit |
bool |
remoteip_in_list | ( | $list | ) |
Is the current ip in a given list?
string | $list |
bool |
remove_course_contents | ( | $courseid, | |
$showfeedback = true, | |||
array | $options = null ) |
Clear a course out completely, deleting all content but don't delete the course itself.
This function does not verify any permissions.
Please note this function also deletes all user enrolments, enrolment instances and role assignments by default.
$options:
int | $courseid | The id of the course that is being deleted |
bool | $showfeedback | Whether to display notifications of each action the function performs. |
array | $options | extra options |
bool | true if all the removals succeeded. false if there were any failures. If this method returns false, some of the removals will probably have succeeded, and others failed, but you have no way of knowing which. |
remove_dir | ( | $dir, | |
$contentonly = false ) |
Delete directory or only its content.
string | $dir | directory path |
bool | $contentonly |
bool | success, true also if dir does not exist |
rename_to_unused_name | ( | string | $filepath, |
string | $prefix = '_temp_' ) |
Renames a file or directory to a unique name within the same directory.
This function is designed to avoid any potential race conditions, and select an unused name.
string | $filepath | Original filepath |
string | $prefix | Prefix to use for the temporary name |
string|bool | New file path or false if failed |
replace_ampersands_not_followed_by_entity | ( | $string | ) |
Given a string, performs a negative lookahead looking for any ampersand character that is not followed by a proper HTML entity.
If any is found, it is replaced by &. The string is then returned.
string | $string |
string |
report_insights_context_insights | ( | \context | $context | ) |
require_admin | ( | ) |
A convenience function for where we must be logged in as admin.
void |
require_phpunit_isolation | ( | ) |
A helper function for deprecated files to use to ensure that, when they are included for unit tests, they are run in an isolated process.
coding_exception | The exception thrown when the process is not isolated. |
require_user_key_login | ( | $script, | |
$instance = null, | |||
$keyvalue = null ) |
Require key login.
Function terminates with error if key not found or incorrect.
@uses NO_MOODLE_COOKIES @uses PARAM_ALPHANUM
string | $script | unique script identifier |
int | $instance | optional instance id |
string | $keyvalue | The key. If not supplied, this will be fetched from the current session. |
int | Instance ID |
required_param | ( | $parname, | |
$type ) |
Returns a particular value for the named variable, taken from POST or GET.
If the parameter doesn't exist then an error is thrown because we require this variable.
This function should be used to initialise all required values in a script that are based on parameters. Usually it will be used like this: $id = required_param('id', PARAM_INT);
Please note the $type parameter is now required and the value can not be array.
string | $parname | the name of the page parameter we want |
string | $type | expected type of parameter |
mixed |
coding_exception |
required_param_array | ( | $parname, | |
$type ) |
Returns a particular array value for the named variable, taken from POST or GET.
If the parameter doesn't exist then an error is thrown because we require this variable.
This function should be used to initialise all required values in a script that are based on parameters. Usually it will be used like this: $ids = required_param_array('ids', PARAM_INT);
Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
string | $parname | the name of the page parameter we want |
string | $type | expected type of parameter |
array |
coding_exception |
reset_course_userdata | ( | $data | ) |
This function will empty a course of user data.
It will retain the activities and the structure of the course.
object | $data | an object containing all the settings including courseid (without magic quotes) |
array | status array of array component, item, error |
reset_login_count | ( | ) |
reset_password_and_mail | ( | $user | ) |
Resets specified user's password and send the new password to the user via email.
stdClass | $user | A $USER object |
bool | Returns true if mail was sent OK and false if there was an error. |
reset_text_filters_cache | ( | $phpunitreset = false | ) |
Resets some data related to filters, called during upgrade or when general filter settings change.
bool | $phpunitreset | true means called from our PHPUnit integration test reset |
void |
resize_image | ( | $filepath, | |
$width, | |||
$height, | |||
$forcecanvas = false ) |
Resize an image from an image path.
This maintains the aspect ratio of the image. This will not enlarge the image.
string | $filepath | The full path to the original image file. |
int | null | $width | The max width of the resized image, or null to only use the height. |
int | null | $height | The max height of the resized image, or null to only use the width. |
bool | $forcecanvas | Whether the final dimensions should be set to $width and $height. |
string|bool | False if a problem occurs, else the resized image data. |
resize_image_from_image | ( | $original, | |
$imageinfo, | |||
$width, | |||
$height, | |||
$forcecanvas = false ) |
Resize an image from an image object.
resource | GdImage | $original | The image to work on. |
array | $imageinfo | Contains [0] => originalwidth, [1] => originalheight. |
int | null | $width | The max width of the resized image, or null to only use the height. |
int | null | $height | The max height of the resized image, or null to only use the width. |
bool | $forcecanvas | Whether the final dimensions should be set to $width and $height. |
string|bool | False if a problem occurs, else the resized image data. |
resourcelib_embed_general | ( | $fullurl, | |
$title, | |||
$clicktoopen, | |||
$mimetype ) |
Returns general link or file embedding html.
string | $fullurl | |
string | $title | |
string | $clicktoopen | |
string | $mimetype |
string | html |
resourcelib_embed_image | ( | $fullurl, | |
$title ) |
Returns image embedding html.
string | $fullurl | |
string | $title |
string | html |
resourcelib_embed_pdf | ( | $fullurl, | |
$title, | |||
$clicktoopen ) |
Returns general link or pdf embedding html.
string | $fullurl | |
string | $title | |
string | $clicktoopen |
string | html |
resourcelib_get_displayoptions | ( | array | $enabled, |
$current = null ) |
Returns list of available display options.
array | $enabled | list of options enabled in module configuration |
int | $current | current display options for existing instances |
array | of key=>name pairs |
resourcelib_get_extension | ( | $fullurl | ) |
Looks for the extension.
string | $fullurl |
string | file extension |
resourcelib_guess_url_mimetype | ( | $fullurl | ) |
Tries to guess correct mimetype for arbitrary URL.
string | $fullurl |
string | mimetype |
resourcelib_try_file_migration | ( | $filepath, | |
$cmid, | |||
$courseid, | |||
$component, | |||
$filearea, | |||
$itemid ) |
Try on demand migration of file from old course files.
string | $filepath | old file path |
int | $cmid | migrated course module if |
int | $courseid | |
string | $component | |
string | $filearea | new file area |
int | $itemid | migrated file item id |
mixed,false | if not found, stored_file instance if migrated to new area |
restrict_php_version | ( | & | $result, |
$version ) |
Check if the current PHP version is greater than or equal to an unsupported version.
object | $result | an environment_results instance |
string | $version | the version of PHP that can't be used |
bool | result of version check |
restrict_php_version_7 | ( | & | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 7.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_71 | ( | & | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 7.1.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_72 | ( | & | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 7.2.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_73 | ( | & | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 7.3.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_74 | ( | & | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 7.4.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_80 | ( | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 8.0.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_81 | ( | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 8.1.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_82 | ( | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 8.2.
object | $result | an environment_results instance |
bool | result of version check |
restrict_php_version_83 | ( | $result | ) |
Check if the current PHP version is greater than or equal to PHP version 8.3.
object | $result | an environment_results instance |
bool | result of version check |
right_to_left | ( | ) |
Returns true if the user is using a right-to-left language.
boolean | true if the current language is right-to-left (Hebrew, Arabic etc) |
s | ( | $var | ) |
Add quotes to HTML characters.
Returns $var with HTML characters (like "<", ">", etc.) properly quoted. Related function p() simply prints the output of this function.
string | $var | the string potentially containing HTML characters |
string |
object search_generate_SQL | ( | $parsetree, | |
$datafield, | |||
$metafield, | |||
$mainidfield, | |||
$useridfield, | |||
$userfirstnamefield, | |||
$userlastnamefield, | |||
$timefield, | |||
$instancefield, | |||
$tagfields = [] ) |
Primitive function to generate a SQL string from a parse tree.
Parameters:
$parsetree should be a parse tree generated by a search_lexer/search_parser combination. Other fields are database table names to search.
@global object
search_generate_text_SQL | ( | $parsetree, | |
$datafield, | |||
$metafield, | |||
$mainidfield, | |||
$useridfield, | |||
$userfirstnamefield, | |||
$userlastnamefield, | |||
$timefield, | |||
$instancefield ) |
Primitive function to generate a SQL string from a parse tree using TEXT indexes.
If searches aren't suitable to use TEXT this function calls the default search_generate_SQL() one.
object search_users | ( | $courseid, | |
$groupid, | |||
$searchtext, | |||
$sort = '', | |||
array | $exceptions = null ) |
Search through course users.
If $coursid specifies the site course then this function searches through all undeleted and confirmed users
@uses SITEID @uses SQL_PARAMS_NAMED @uses CONTEXT_COURSE
int | $courseid | The course in question. |
int | $groupid | The group in question. |
string | $searchtext | The string to search for |
string | $sort | A field to sort by |
array | $exceptions | A list of IDs to ignore, eg 2,4,5,8,9,10 |
array |
|
protected |
Select appropriate db handle - readwrite or readonly.
int | $type | type of query |
string | $sql |
void |
send_confirmation_email | ( | $user, | |
$confirmationurl = null ) |
Send email to specified user with confirmation text and activation link.
stdClass | $user | A $USER object |
string | $confirmationurl | user confirmation URL |
bool | Returns true if mail was sent OK and false if there was an error. |
send_headers | ( | $contenttype, | |
$cacheable = true ) |
Send the HTTP headers that Moodle requires.
There is a backwards compatibility hack for legacy code that needs to add custom IE compatibility directive.
Example: if (!isset($CFG->additionalhtmlhead)) { $CFG->additionalhtmlhead = ''; } $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" >'; header('X-UA-Compatible: IE=8'); echo $OUTPUT->header();
Please note the $CFG->additionalhtmlhead alone might not work, you should send the IE compatibility header() too.
string | $contenttype | |
bool | $cacheable | Can this page be cached on back? |
void,sends | HTTP headers |
send_password_change_confirmation_email | ( | $user, | |
$resetrecord ) |
Sends a password change confirmation email.
stdClass | $user | A $USER object |
stdClass | $resetrecord | An object tracking metadata regarding password reset request |
bool | Returns true if mail was sent OK and false if there was an error. |
send_password_change_info | ( | $user | ) |
Sends an email containing information on how to change your password.
stdClass | $user | A $USER object |
bool | Returns true if mail was sent OK and false if there was an error. |
serialise_tool_proxy | ( | ) |
session_get_instance | ( | ) |
session_get_realuser | ( | ) |
session_is_legacy | ( | ) |
session_is_loggedinas | ( | ) |
session_kill | ( | ) |
session_kill_all | ( | ) |
session_kill_user | ( | ) |
session_loginas | ( | ) |
session_set_user | ( | ) |
session_touch | ( | ) |
sesskey | ( | ) |
Makes sure that $USER->sesskey exists, if $USER itself exists.
It sets a new sesskey if one does not already exist, but does not overwrite existing sesskeys. Returns the sesskey string if $USER exists, or boolean false if not.
@uses $USER
string |
set_bounce_count | ( | $user, | |
$reset = false ) |
Increment or reset user's email bounce count.
stdClass | $user | object containing an id |
bool | $reset | will reset the count to 0 |
set_cache_flag | ( | $type, | |
$name, | |||
$value, | |||
$expiry = null ) |
Set a volatile flag.
string | $type | the "type" namespace for the key |
string | $name | the key to set |
string | $value | the value to set (without magic quotes) - null will remove the flag |
int | $expiry | (optional) epoch indicating expiry - defaults to now()+ 24hs |
bool | Always returns true |
set_config | ( | $name, | |
$value, | |||
$plugin = null ) |
Set a key in global configuration.
Set a key/value pair in both this session's $CFG global variable and in the 'config' database table for future sessions.
Can also be used to update keys for plugin-scoped configs in config_plugin table. In that case it doesn't affect $CFG.
A NULL value will delete the entry.
NOTE: this function is called from lib/db/upgrade.php
string | $name | the key to set |
string | $value | the value to set (without magic quotes) |
string | $plugin | (optional) the plugin scope, default null |
bool | true or exception |
set_cron_lock | ( | $name, | |
$until, | |||
$ignorecurrent = false ) |
Try to obtain or release the cron lock.
string | $name | name of lock |
int | $until | timestamp when this lock considered stale, null means remove lock unconditionally |
bool | $ignorecurrent | ignore current lock state, usually extend previous lock, defaults to false |
bool | true if lock obtained |
set_current_group | ( | ) |
|
abstractprotected |
Sets db handle to be used with subsequent queries.
resource | $dbh |
void |
set_debugging | ( | $level, | |
$debugdisplay = null ) |
Alter debugging level for the current request, the change is not saved in database.
int | $level | one of the DEBUG_* constants |
bool | $debugdisplay |
set_mnet_remote_client | ( | $client | ) |
during the xmlrpc server code execution, this will be called to setup the object returned by get_mnet_remote_client
mnet_remote_client | $client | the client to set up |
moodle_exception |
set_moodle_cookie | ( | $username | ) |
Sets a moodle cookie with a weakly encrypted username.
string | $username | to encrypt and place in a cookie, '' means delete current cookie |
void |
set_send_count | ( | $user, | |
$reset = false ) |
Used to increment or reset email sent count.
stdClass | $user | object containing an id |
bool | $reset | will reset the count to 0 |
void |
set_user_device_type | ( | ) |
set_user_preference | ( | $name, | |
$value, | |||
$user = null ) |
Sets a preference for the specified user.
If a $user object is submitted it's 'preference' property is used for the preferences cache.
When additional validation/permission check is needed it is better to use {
string | $name | The key to set as preference for the specified user |
string | $value | The value to set for the $name key in the specified user's record, null means delete current value. |
stdClass | int | null | $user | A moodle user object or id, null means current user |
coding_exception |
bool | Always true or exception |
set_user_preferences | ( | array | $prefarray, |
$user = null ) |
Sets a whole array of preferences for the current user.
If a $user object is submitted it's 'preference' property is used for the preferences cache.
array | $prefarray | An array of key/value pairs to be set |
stdClass | int | null | $user | A moodle user object or id, null means current user |
bool | Always true or exception |
setnew_password_and_mail | ( | $user, | |
$fasthash = false ) |
Sets specified user's password and send the new password to the user via email.
stdClass | $user | A $USER object |
bool | $fasthash | If true, use a low cost factor when generating the hash for speed. |
bool|string | Returns "true" if mail was sent OK and "false" if there was an error |
moodle_text_filter::setup | ( | $page, | |
$context ) |
Setup page with filter requirements and other prepare stuff.
Override this method if the filter needs to setup page requirements or needs other stuff to be executed.
Note this method is invoked from {
moodle_page | $page | the page we are going to add requirements to. |
context | $context | the context which contents are going to be filtered. |
Reimplemented in filter_glossary, filter_mathjaxloader, and filter_mediaplugin.
stdClass setup_DB | ( | ) |
Sets up global $DB moodle_database instance.
$CFG The global configuration instance.
void|bool | Returns true when finished setting up $DB. Returns void when $DB has already been set. |
setup_get_remote_url | ( | ) |
Get the URL that PHP/the web server thinks it is serving.
Private function used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
array | in the same format that parse_url returns, with the addition of a 'fullpath' element, which includes any slasharguments path. |
filter_manager::setup_page_for_filters | ( | $page, | |
$context ) |
Setup page with filters requirements and other prepare stuff.
This method is used by {
Note it's executed for each piece of text filtered, so filter implementations are responsible of controlling the cardinality of the executions that may be different depending of the stuff to prepare.
moodle_page | $page | the page we are going to add requirements to. |
context | $context | the context which contents are going to be filtered. |
filter_manager::setup_page_for_globally_available_filters | ( | $page | ) |
Setup the page for globally available filters.
This helps setting up the page for filters which may be applied to the page, even if they do not belong to the current context, or are not yet visible because the content is lazily added (ajax). This method always uses to the system context which determines the globally available filters.
This should only ever be called once per request.
moodle_page | $page | The page. |
shift_course_mod_dates | ( | $modname, | |
$fields, | |||
$timeshift, | |||
$courseid, | |||
$modid = 0 ) |
Change dates in module - used from course reset.
string | $modname | forum, assignment, etc |
array | $fields | array of date fields from mod table |
int | $timeshift | time difference |
int | $courseid | |
int | $modid | (Optional) passed if specific mod instance in course needs to be updated. |
bool | success |
shorten_filename | ( | $filename, | |
$length = MAX_FILENAME_SIZE, | |||
$includehash = false ) |
Shortens a given filename by removing characters positioned after the ideal string length.
When the filename is too long, the file cannot be created on the filesystem due to exceeding max byte size. Limiting the filename to a certain size (considering multibyte characters) will prevent this.
string | $filename | file name |
int | $length | ideal string length |
bool | $includehash | Whether to include a file hash in the shortened version. This ensures uniqueness. |
string\$shortened | shortened file name |
shorten_filenames | ( | array | $path, |
$length = MAX_FILENAME_SIZE, | |||
$includehash = false ) |
Shortens a given array of filenames by removing characters positioned after the ideal string length.
array | $path | The paths to reduce the length. |
int | $length | Ideal string length |
bool | $includehash | Whether to include a file hash in the shortened version. This ensures uniqueness. |
array\$result | Shortened paths in array. |
shorten_text | ( | $text, | |
$ideal = 30, | |||
$exact = false, | |||
$ending = '...' ) |
Given some text (which may contain HTML) and an ideal length, this function truncates the text neatly on a word boundary if possible.
string | $text | text to be shortened |
int | $ideal | ideal string length |
boolean | $exact | if false, $text will not be cut mid-word |
string | $ending | The string to append if the passed string is truncated |
string\$truncate | shortened string |
show_event | ( | ) |
signup_captcha_enabled | ( | ) |
Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.
bool |
signup_get_user_confirmation_authplugin | ( | ) |
Check if user confirmation is enabled on this site and return the auth plugin handling registration if enabled.
stdClass | the current auth plugin handling user registration or false if registration not enabled |
signup_is_enabled | ( | ) |
Check if sign-up is enabled in the site.
If is enabled, the function will return the authplugin instance.
mixed | false if sign-up is not enabled, the authplugin instance otherwise. |
signup_setup_new_user | ( | $user | ) |
Add the missing fields to a user that is going to be created.
stdClass | $user | the new user object |
stdClass | the user filled |
signup_validate_data | ( | $data, | |
$files ) |
Validates the standard sign-up data (except recaptcha that is validated by the form element).
array | $data | the sign-up data |
array | $files | files among the data |
array | list of errors, being the key the data element name and the value the error itself |
site_is_public | ( | ) |
Tries to guess if $CFG->wwwroot is publicly accessible or not.
Never put your faith on this function and rely on its accuracy as there might be false positives. It just performs some simple checks, and mainly is used for places where we want to hide some options such as site registration when $CFG->wwwroot is not publicly accessible. Good thing is there is no false negative. Note that it's possible to force the result of this check by specifying $CFG->site_is_public in config.php
bool |
site_scale_used | ( | ) |
skip_main_destination | ( | ) |
soap_call | ( | $connection, | |
$call, | |||
$params ) |
Make a call to a SoapClient.
SoapClient | $connection | The SoapClient to call |
string | $call | Operation to be performed by client |
array | $params | Parameters for the call |
mixed | The return parameters of the operation or a SoapFault If the operation returned several parameters then these are returned as an object rather than an array |
soap_connect | ( | $wsdl, | |
$trace = false ) |
Create a new SoapClient object.
string | $wsdl | URI of the WSDL file |
boolean | $trace | indicates if the soap messages should be saved (i.e. if get_soap_messages is used) and should be used only for debugging |
mixed | Returns either a SoapClient object or, if the connection failed, a SoapFault object. |
sort_categories_by_tree | ( | & | $categories, |
$id = 0, | |||
$level = 1 ) |
Returns the categories with their names ordered following parent-child relationships.
finally it tries to return pending categories (those being orphaned, whose parent is incorrect) to avoid missing any category from original array.
array | $categories | |
int | $id | |
int | $level |
array |
start_delegated_transaction | ( | ) |
On DBs that support it, switch to transaction mode and begin a transaction.
moodle_transaction |
stats_cron_daily | ( | $maxdays = 1 | ) |
Execute daily statistics gathering.
int | $maxdays | maximum number of days to be processed |
boolean | success |
stats_cron_monthly | ( | ) |
Execute monthly statistics gathering.
boolean | success |
stats_cron_weekly | ( | ) |
Execute weekly statistics gathering.
boolean | success |
stats_fix_zeros | ( | $stats, | |
$timeafter, | |||
$timestr, | |||
$line2 = true, | |||
$line3 = false ) |
Fix missing entries in the statistics.
This creates a dummy stat when nothing happened during a day/week/month.
array | $stats | array of statistics. |
int | $timeafter | unused. |
string | $timestr | type of statistics to generate (dayly, weekly, monthly). |
boolean | $line2 | |
boolean | $line3 |
array | of fixed statistics. |
stats_get_base_daily | ( | $time = 0 | ) |
Start of day.
int | $time | timestamp |
int | start of day |
stats_get_base_monthly | ( | $time = 0 | ) |
Start of month.
int | $time | timestamp |
int | start of month |
stats_get_base_weekly | ( | $time = 0 | ) |
Start of week.
int | $time | timestamp |
int | start of week |
stats_get_next_day_start | ( | $time | ) |
Start of next day.
int | $time | timestamp |
start | of next day |
stats_get_next_month_start | ( | $time | ) |
Start of next month.
int | $time | timestamp |
start | of next month |
stats_get_next_week_start | ( | $time | ) |
Start of next week.
int | $time | timestamp |
start | of next week |
stats_get_start_from | ( | $str | ) |
Return starting date of stats processing.
string | $str | name of table - daily, weekly or monthly |
int | timestamp |
stats_progress | ( | $ident | ) |
Print daily cron progress.
string | $ident |
stats_run_query | ( | $sql, | |
$parameters = array() ) |
Execute individual daily statistics queries.
string | $sql | The query to run |
boolean | success |
stats_temp_table_clean | ( | ) |
Deletes summary logs table for stats calculation.
bool | success (true) or failure(false) |
stats_temp_table_fill | ( | $timestart, | |
$timeend ) |
Fills the temporary stats tables with new data.
This function is meant to be called to get a new day of data
int | timestamp of the start time of logs view |
int | timestamp of the end time of logs view |
bool | success (true) or failure(false) |
stats_temp_table_setup | ( | ) |
Fills the temporary stats tables with new data.
This function is meant to be called once at the start of stats generation
int | timestart timestamp of the start time of logs view |
int | timeend timestamp of the end time of logs view |
bool | success (true) or failure(false) |
strip_links | ( | $string | ) |
Given a string, replaces all .
* by .* and returns the string.
string | $string |
string |
strip_pluginfile_content | ( | $source | ) |
Removes the usage of Moodle files from a text.
In some rare cases we need to re-use a text that already has embedded links to some files hosted within Moodle. But the new area in which we will push this content does not support files... therefore we need to remove those files.
string | $source | The text |
string | The stripped text |
strip_querystring | ( | $url | ) |
Remove query string from url.
Takes in a URL and returns it without the querystring portion.
string | $url | the url which may have a query string attached. |
string | The remaining URL. |
swapshuffle | ( | $array | ) |
Given a simple array, this shuffles it up just like shuffle() Unlike PHP's shuffle() this function works on any machine.
array | $array | The array to be rearranged |
array |
swapshuffle_assoc | ( | $array | ) |
Like swapshuffle(), but works on associative arrays.
array | $array | The associative array to be rearranged |
array |
|
protected |
Parse table names from query.
string | $sql |
array |
tag_add | ( | ) |
tag_assign | ( | ) |
tag_autocomplete | ( | ) |
tag_bulk_delete_instances | ( | ) |
tag_cleanup | ( | ) |
tag_cloud_sort | ( | ) |
tag_compute_correlations | ( | ) |
tag_cron | ( | ) |
tag_delete | ( | ) |
tag_delete_instance | ( | ) |
tag_delete_instances | ( | ) |
tag_description_set | ( | ) |
tag_display_name | ( | ) |
tag_find_records | ( | ) |
tag_find_tags | ( | ) |
tag_get | ( | ) |
tag_get_correlated | ( | ) |
tag_get_id | ( | ) |
tag_get_name | ( | ) |
tag_get_related_tags | ( | ) |
tag_get_related_tags_csv | ( | ) |
tag_get_tags | ( | ) |
tag_get_tags_array | ( | ) |
tag_get_tags_csv | ( | ) |
tag_get_tags_ids | ( | ) |
tag_normalize | ( | ) |
tag_print_cloud | ( | ) |
tag_print_description_box | ( | ) |
tag_print_management_box | ( | ) |
tag_print_search_box | ( | ) |
tag_print_search_results | ( | ) |
tag_print_tagged_users_table | ( | ) |
tag_print_user_box | ( | ) |
tag_print_user_list | ( | ) |
tag_process_computed_correlation | ( | ) |
tag_record_count | ( | ) |
tag_record_tagged_with | ( | ) |
tag_rename | ( | ) |
tag_set | ( | ) |
tag_set_add | ( | ) |
tag_set_delete | ( | ) |
tag_set_flag | ( | ) |
tag_type_set | ( | ) |
tag_unset_flag | ( | ) |
testing_cli_argument_path | ( | $moodlepath | ) |
Returns relative path against current working directory, to be used for shell execution hints.
string | $moodlepath | starting with "/", ex: "/admin/tool/cli/init.php" |
string | path relative to current directory or absolute path |
testing_cli_fix_directory_separator | ( | $path | ) |
Fix DIRECTORY_SEPARATOR for windows.
In PHP on Windows, DIRECTORY_SEPARATOR is set to the backslash (::) character. However, if you're running a Cygwin/Msys/Git shell exec() calls will return paths using the forward slash (/) character.
NOTE: Because PHP on Windows will accept either forward or backslashes, paths should be built using ONLY forward slashes, regardless of OS. MOODLE_DIRECTORY_SEPARATOR should only be used when parsing paths returned by the shell.
string | $path |
string |
testing_error | ( | $errorcode, | |
$text = '' ) |
Prints an error and stops execution.
integer | $errorcode | |
string | $text |
void | exits |
testing_fix_file_permissions | ( | $file | ) |
Try to change permissions to $CFG->dirroot or $CFG->dataroot if possible.
string | $file |
bool | success |
testing_initdataroot | ( | $dataroot, | |
$framework ) |
Mark empty dataroot to be used for testing.
string | $dataroot | The dataroot directory |
string | $framework | The test framework |
void |
testing_is_cygwin | ( | ) |
Find out if running under Cygwin on Windows.
bool |
testing_is_mingw | ( | ) |
Returns whether a mingw CLI is running.
MinGW sets $_SERVER['TERM'] to cygwin, but it can not run .bat files; this function may be useful when we need to output proposed commands to users using Windows CLI interfaces.
@externalurl http://sourceforge.net/p/mingw/bugs/1902
bool |
testing_update_composer_dependencies | ( | bool | $selfupdate = true, |
bool | $updatedependencies = true ) |
Perform necessary steps to install and/or upgrade composer and its dependencies.
Installation is mandatory, but upgrade is optional.
Note: This function does not return, but will call exit()
on error.
bool | $selfupdate | Perform a composer self-update to update the composer.phar utility |
bool | $updatedependencies | Upgrade dependencies |
filter_manager::text_filtering_hash | ( | ) |
null_filter_manager::text_filtering_hash | ( | ) |
As for the equivalent filter_manager method.
text_to_html | ( | $text, | |
$smileyignored = null, | |||
$para = true, | |||
$newlines = true ) |
Given plain text, makes it into HTML as nicely as possible.
May contain HTML tags already.
Do not abuse this function. It is intended as lower level formatting feature used by format_text() to convert FORMAT_MOODLE to HTML. You are supposed to call format_text() in most of cases.
string | $text | The string to convert. |
boolean | $smileyignored | Was used to determine if smiley characters should convert to smiley images, ignored now |
boolean | $para | If true then the returned string will be wrapped in div tags |
boolean | $newlines | If true then lines newline breaks will be converted to HTML newline breaks. |
string |
textlib_get_instance | ( | ) |
theme_build_css_for_themes | ( | $themeconfigs = [], | |
$directions = ['rtl', 'ltr'], | |||
$cache = true, | |||
$mtraceprogress = false ) |
Generates and saves the CSS files for the given theme configs.
theme_config[] | $themeconfigs | An array of theme_config instances. |
array | $directions | Must be a subset of ['rtl', 'ltr']. |
bool | $cache | Should the generated files be stored in local cache. |
array | The built theme content in a multi-dimensional array of name => direction => content |
theme_get_config_file_path | ( | $themename | ) |
Get the path to a theme config.php file.
string | $themename | The non-frankenstyle name of the theme to check |
theme_get_css_filename | ( | $themename, | |
$globalrevision, | |||
$themerevision, | |||
$direction ) |
Get the path to the local cached CSS file.
string | $themename | The non-frankenstyle theme name. |
int | $globalrevision | The global theme revision. |
int | $themerevision | The theme specific revision. |
string | $direction | Either 'ltr' or 'rtl' (case sensitive). |
theme_get_locked_theme_for_device | ( | $device | ) |
Returns the theme named defined in config.php for the given device.
string | or null |
theme_get_next_revision | ( | ) |
Calculates and returns the next theme revision number.
int |
theme_get_next_sub_revision_for_theme | ( | $themename | ) |
Calculates and returns the next theme revision number.
string | $themename | The non-frankenstyle name of the theme |
int |
theme_get_revision | ( | ) |
Returns current theme revision number.
int |
theme_get_sub_revision_for_theme | ( | $themename | ) |
Returns current theme sub revision number.
This is the revision for this theme exclusively, not the global theme revision.
string | $themename | The non-frankenstyle name of the theme |
int |
theme_is_device_locked | ( | $device | ) |
Checks if the given device has a theme defined in config.php.
bool |
theme_reset_all_caches | ( | ) |
Invalidate all server and client side caches.
This method deletes the physical directory that is used to cache the theme files used for serving. Because it deletes the main theme cache directory all themes are reset by this function.
theme_reset_static_caches | ( | ) |
Reset static caches.
This method indicates that all running cron processes should exit at the next opportunity.
theme_set_designer_mod | ( | $state | ) |
Enable or disable theme designer mode.
bool | $state |
theme_set_revision | ( | $revision | ) |
Sets the current theme revision number.
int | $revision | The new theme revision number |
theme_set_sub_revision_for_theme | ( | $themename, | |
$revision ) |
Sets the current theme revision number for a specific theme.
This does not affect the global themerev value.
string | $themename | The non-frankenstyle name of the theme |
int | $revision | The new theme revision number |
truncate_userinfo | ( | array | $info | ) |
Will truncate userinfo as it comes from auth_get_userinfo (from external auth) which may have large fields.
array | $info | Array of user properties to truncate if needed |
array | The now truncated information that was passed in |
trusttext_active | ( | ) |
Is trusttext feature active?
bool |
trusttext_pre_edit | ( | $object, | |
$field, | |||
$context ) |
Must be called before editing of all texts with trust flag.
Removes all XSS nasties from texts stored in database if needed.
stdClass | $object | data object with xxx, xxxformat and xxxtrust fields |
string | $field | name of text field |
context | $context | active context |
stdClass | updated $object |
trusttext_trusted | ( | $context | ) |
Is current user trusted to enter no dangerous XSS in this context?
Please note the user must be in fact trusted everywhere on this server!!
context | $context |
bool | true if user trusted |
unformat_float | ( | $localefloat, | |
$strict = false ) |
Converts locale specific floating point/comma number back to standard PHP float value Do NOT try to do any math operations before this conversion on any user submitted floats!
string | $localefloat | locale aware float representation |
bool | $strict | If true, then check the input and return false if it is not a valid number. |
mixed | float|bool - false or the parsed float. |
uninstall_plugin | ( | $type, | |
$name ) |
Automatically clean-up all plugin data and remove the plugin DB tables.
NOTE: do not call directly, use new /admin/plugins.php?uninstall=component instead!
string | $type | The plugin type, eg. 'mod', 'qtype', 'workshopgrading' etc. |
string | $name | The plugin name, eg. 'forum', 'multichoice', 'accumulative' etc. @uses global $OUTPUT to produce notices and other messages |
void |
|
protected |
Unloads all filters and other cached information.
Reimplemented in performance_measuring_filter_manager.
|
protected |
Unloads all filters and other cached information.
Reimplemented from filter_manager.
unserialize_array | ( | $expression | ) |
Safe analogue of unserialize() that can only parse arrays.
Arrays may contain only integers or strings as both keys and values. Nested arrays are allowed.
string | $expression |
array|bool | either parsed array or false if parsing was impossible. |
unserialize_object | ( | string | $input | ) |
Safe method for unserializing given input that is expected to contain only a serialized instance of an stdClass object.
If any class type other than stdClass is included in the input string, it will not be instantiated and will be cast to an stdClass object. The initial cast to array, then back to object is to ensure we are always returning the correct type, otherwise we would return an instances of {
string | $input |
stdClass |
unset_all_config_for_plugin | ( | $plugin | ) |
Remove all the config variables for a given plugin.
NOTE: this function is called from lib/db/upgrade.php
string | $plugin | a plugin, for example 'quiz' or 'qtype_multichoice'; |
boolean | whether the operation succeeded. |
unset_cache_flag | ( | $type, | |
$name ) |
Removes a single volatile flag.
string | $type | the "type" namespace for the key |
string | $name | the key to set |
bool |
unset_config | ( | $name, | |
$plugin = null ) |
Removes a key from global configuration.
NOTE: this function is called from lib/db/upgrade.php
string | $name | the key to set |
string | $plugin | (optional) the plugin scope |
boolean | whether the operation succeeded. |
unset_user_preference | ( | $name, | |
$user = null ) |
Unsets a preference completely by deleting it from the database.
If a $user object is submitted it's 'preference' property is used for the preferences cache.
string | $name | The key to unset as preference for the specified user |
stdClass | int | null | $user | A moodle user object or id, null means current user |
coding_exception |
bool | Always true or exception |
object unzip_file | ( | $zipfile, | |
$destination = '', | |||
$showstatus_ignored = true ) |
Unzip one zip file to a destination dir Both parameters must be FULL paths If destination isn't specified, it will be the SAME directory where the zip file resides.
string | $zipfile | The zip file to unzip |
string | $destination | The location to unzip to |
bool | $showstatus_ignored | Unused |
update_category_button | ( | ) |
update_event | ( | ) |
update_field_with_unique_index | ( | $table, | |
$field, | |||
array | $newvalues, | ||
array | $otherconditions, | ||
$unusedvalue = -1 ) |
This method can update the values in mulitple database rows for a colum with a unique index, without violating that constraint.
Suppose we have a table with a unique index on (otherid, sortorder), and for a particular value of otherid, we want to change all the sort orders. You have to do this carefully or you will violate the unique index at some time. This method takes care of the details for you.
Note that, it is the responsibility of the caller to make sure that the requested rename is legal. For example, if you ask for [1 => 2, 2 => 2] then you will get a unique key violation error from the database.
string | $table | The database table to modify. |
string | $field | the field that contains the values we are going to change. |
array | $newvalues | oldvalue => newvalue how to change the values. E.g. [1 => 4, 2 => 1, 3 => 3, 4 => 2]. |
array | $otherconditions | array fieldname => requestedvalue extra WHERE clause conditions to restrict which rows are affected. E.g. array('otherid' => 123). |
int | $unusedvalue | (defaults to -1) a value that is never used in $ordercol. |
update_internal_user_password | ( | $user, | |
$password, | |||
$fasthash = false ) |
Update password hash in user object (if necessary).
The password is updated if:
Updating the password will modify the $user object and the database record to use the current hashing algorithm. It will remove Web Services user tokens too.
stdClass | $user | User object (password property may be updated). |
string | $password | Plain text password. |
bool | $fasthash | If true, use a low cost factor when generating the hash This is much faster to generate but makes the hash less secure. It is used when lots of hashes need to be generated quickly. |
bool | Always returns true. |
update_log_display_entry | ( | ) |
update_login_count | ( | ) |
update_module_button | ( | ) |
update_timezone_records | ( | ) |
update_user_login_times | ( | ) |
Modify the user table by setting the currently logged in user's last login to now.
bool | Always returns true |
update_user_record | ( | $username | ) |
Will update a local user record from an external source (MNET users can not be updated using this method!).
string | $username | user's username to update the record |
stdClass | A complete user object |
update_user_record_by_id | ( | $id | ) |
Will update a local user record from an external source (MNET users can not be updated using this method!).
int | $id | user id |
stdClass | A complete user object |
upgrade_block_savepoint | ( | $result, | |
$version, | |||
$blockname, | |||
$allowabort = true ) |
Blocks upgrade savepoint, marks end of blocks upgrade blocks It stores block version, resets upgrade timeout and abort upgrade if user cancels page loading.
bool | $result | false if upgrade step failed, true if completed |
string | or float $version main version | |
string | $blockname | name of block |
bool | $allowabort | allow user to abort script execution here |
void |
upgrade_component_updated | ( | string | $component, |
string | $messageplug = '', | ||
bool | $coreinstall = false ) |
After upgrading a module, block, or generic plugin, various parts of the system need to be informed.
string | $component | Frankenstyle component or 'moodle' for core |
string | $messageplug | Set to the name of a message plugin if this is one |
bool | $coreinstall | Set to true if this is the core install |
upgrade_core | ( | $version, | |
$verbose ) |
Upgrade moodle core.
float | $version | target version |
bool | $verbose |
void,may | throw exception |
upgrade_ensure_not_running | ( | $warningonly = false | ) |
Makes sure that upgrade process is not running.
To be inserted in the core functions that can not be called by pluigns during upgrade. Core upgrade should not use any API functions at all. See
moodle_exception | if executed from inside of upgrade script and $warningonly is false |
bool | $warningonly | if true displays a warning instead of throwing an exception |
bool | true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only |
object upgrade_finished | ( | $continueurl = null | ) |
Indicates upgrade is finished.
This function may be called repeatedly.
@global object
upgrade_install_plugins | ( | array | $installable, |
$confirmed, | |||
$heading = '', | |||
$continue = null, | |||
$return = null ) |
Helper procedure/macro for installing remote plugins at admin/index.php.
Does not return, always redirects or exits.
array | $installable | list of core\update\remote_info |
bool | $confirmed | false: display the validation screen, true: proceed installation |
string | $heading | validation screen heading |
moodle_url | string | null | $continue | URL to proceed with installation at the validation screen |
moodle_url | string | null | $return | URL to go back on cancelling at the validation screen |
upgrade_language_pack | ( | $lang = null | ) |
Try to upgrade the given language pack (or current language)
string | $lang | the code of the language to update, defaults to the current language |
upgrade_log | ( | $type, | |
$plugin, | |||
$info, | |||
$details = null, | |||
$backtrace = null ) |
Adds log entry into upgrade_log table.
int | $type | UPGRADE_LOG_NORMAL, UPGRADE_LOG_NOTICE or UPGRADE_LOG_ERROR |
string | $plugin | frankenstyle component name |
string | $info | short description text of log entry |
string | $details | long problem description |
string | $backtrace | string used for errors only |
void |
upgrade_main_savepoint | ( | $result, | |
$version, | |||
$allowabort = true ) |
Upgrade savepoint, marks end of each upgrade block.
It stores new main version, resets upgrade timeout and abort upgrade if user cancels page loading.
Please do not make large upgrade blocks with lots of operations, for example when adding tables keep only one table operation per block.
bool | $result | false if upgrade step failed, true if completed |
string | or float $version main version | |
bool | $allowabort | allow user to abort script execution here |
void |
upgrade_mod_savepoint | ( | $result, | |
$version, | |||
$modname, | |||
$allowabort = true ) |
Module upgrade savepoint, marks end of module upgrade blocks It stores module version, resets upgrade timeout and abort upgrade if user cancels page loading.
bool | $result | false if upgrade step failed, true if completed |
string | or float $version main version | |
string | $modname | name of module |
bool | $allowabort | allow user to abort script execution here |
void |
upgrade_noncore | ( | $verbose | ) |
Upgrade/install other parts of moodle.
bool | $verbose |
void,may | throw exception |
upgrade_plugin_mnet_functions | ( | $component | ) |
upgrades the mnet rpc definitions for the given component.
this method doesn't return status, an exception will be thrown in the case of an error
string | $component | the plugin to upgrade, eg auth_mnet |
upgrade_plugin_savepoint | ( | $result, | |
$version, | |||
$type, | |||
$plugin, | |||
$allowabort = true ) |
Plugins upgrade savepoint, marks end of blocks upgrade blocks It stores plugin version, resets upgrade timeout and abort upgrade if user cancels page loading.
bool | $result | false if upgrade step failed, true if completed |
string | or float $version main version | |
string | $type | The type of the plugin. |
string | $plugin | The name of the plugin. |
bool | $allowabort | allow user to abort script execution here |
void |
upgrade_plugins | ( | $type, | |
$startcallback, | |||
$endcallback, | |||
$verbose ) |
Upgrade plugins.
string | $type | The type of plugins that should be updated (e.g. 'enrol', 'qtype') return void |
object upgrade_plugins_blocks | ( | $startcallback, | |
$endcallback, | |||
$verbose ) |
This function finds all available blocks and install them into blocks table or do all the upgrade process if newer.
@global object
object upgrade_plugins_modules | ( | $startcallback, | |
$endcallback, | |||
$verbose ) |
Find and check all modules and load them up or upgrade them if necessary.
@global object
upgrade_set_timeout | ( | $max_execution_time = 300 | ) |
Sets maximum expected time needed for upgrade task.
Please always make sure that upgrade will not run longer!
The script may be automatically aborted if upgrade times out.
int | $max_execution_time | in seconds (can not be less than 60 s) |
upgrade_stale_php_files_present | ( | ) |
Detect if there are leftovers in PHP source files.
During main version upgrades administrators MUST move away old PHP source files and start from scratch (or better use git).
bool | true means borked upgrade, false means previous PHP files were properly removed |
object upgrade_started | ( | $preinstall = false | ) |
Marks start of upgrade, blocks any other access to site.
The upgrade is finished at the end of script or after timeout.
@global object @global object
stdClass user_accesstime_log | ( | $courseid = 0 | ) |
Store user last access times - called when use enters a course or site.
$USER @global stdClass $CFG @global moodle_database $DB @uses LASTACCESS_UPDATE_SECS @uses SITEID
int | $courseid | empty courseid means site |
void |
object user_can_create_courses | ( | ) |
@uses CONTEXT_COURSECAT
boolean | Whether the user can create courses in any category in the system. |
user_get_participants | ( | $courseid, | |
$groupid, | |||
$accesssince, | |||
$roleid, | |||
$enrolid, | |||
$statusid, | |||
$search, | |||
$additionalwhere = '', | |||
$additionalparams = array(), | |||
$sort = '', | |||
$limitfrom = 0, | |||
$limitnum = 0 ) |
Returns the participants for a given course.
int | $courseid | The course id |
int | $groupid | The groupid, 0 means all groups and USERSWITHOUTGROUP no group |
int | $accesssince | The time since last access |
int | $roleid | The role id |
int | $enrolid | The applied filter for the user enrolment ID. |
int | $status | The applied filter for the user's enrolment status. |
string | $search | The search that was performed |
string | $additionalwhere | Any additional SQL to add to where |
array | $additionalparams | The additional params |
string | $sort | The SQL sort |
int | $limitfrom | return a subset of records, starting at this point (optional). |
int | $limitnum | return a subset comprising this many records (optional, required if $limitfrom is set). |
moodle_recordset |
user_get_participants_sql | ( | $courseid, | |
$groupid = 0, | |||
$accesssince = 0, | |||
$roleid = 0, | |||
$enrolid = 0, | |||
$statusid = -1, | |||
$search = '', | |||
$additionalwhere = '', | |||
$additionalparams = array() ) |
Returns the SQL used by the participants table.
int | $courseid | The course id |
int | $groupid | The groupid, 0 means all groups and USERSWITHOUTGROUP no group |
int | $accesssince | The time since last access, 0 means any time |
int | $roleid | The role id, 0 means all roles and -1 no roles |
int | $enrolid | The enrolment id, 0 means all enrolment methods will be returned. |
int | $statusid | The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed. |
string | array | $search | The search that was performed, empty means perform no search |
string | $additionalwhere | Any additional SQL to add to where |
array | $additionalparams | The additional params |
array |
user_get_total_participants | ( | $courseid, | |
$groupid = 0, | |||
$accesssince = 0, | |||
$roleid = 0, | |||
$enrolid = 0, | |||
$statusid = -1, | |||
$search = '', | |||
$additionalwhere = '', | |||
$additionalparams = array() ) |
Returns the total number of participants for a given course.
int | $courseid | The course id |
int | $groupid | The groupid, 0 means all groups and USERSWITHOUTGROUP no group |
int | $accesssince | The time since last access, 0 means any time |
int | $roleid | The role id, 0 means all roles |
int | $enrolid | The applied filter for the user enrolment ID. |
int | $status | The applied filter for the user's enrolment status. |
string | array | $search | The search that was performed, empty means perform no search |
string | $additionalwhere | Any additional SQL to add to where |
array | $additionalparams | The additional params |
int |
user_not_fully_set_up | ( | $user, | |
$strict = true ) |
Determines if a user has completed setting up their account.
The lax mode (with $strict = false) has been introduced for special cases only where we want to skip certain checks intentionally. This is valid in certain mnet or ajax scenarios when the user cannot / should not be redirected to edit their profile. In most cases, you should perform the strict check.
stdClass | $user | A $USER object to test for the existence of a valid name and email |
bool | $strict | Be more strict and assert id and custom profile fields set, too |
bool |
user_preference_allow_ajax_update | ( | $name, | |
$paramtype ) |
You need to call this function if you wish to use the set_user_preference method in javascript_static.php, to white-list the preference you want to update from JavaScript, and to specify the type of cleaning you expect to be done on values.
string | $name | the name of the user_perference we should allow to be updated by remote calls. |
integer | $paramtype | one of the PARAM_{TYPE} constants, user to clean submitted values before set_user_preference is called. |
null |
userdate | ( | $date, | |
$format = '', | |||
$timezone = 99, | |||
$fixday = true, | |||
$fixhour = true ) |
Returns a formatted string that represents a date in user time.
string | the formatted date/time. |
userdate_htmltime | ( | $date, | |
$format = '', | |||
$timezone = 99, | |||
$fixday = true, | |||
$fixhour = true ) |
Returns a html "time" tag with both the exact user date with timezone information as a datetime attribute in the W3C format, and the user readable date and time as text.
string | the formatted date/time. |
useredit_shared_definition_preferences | ( | ) |
usergetdate | ( | $time, | |
$timezone = 99 ) |
Given a $time timestamp in GMT (seconds since epoch), returns an array that represents the Gregorian date in user time.
int | $time | Timestamp in GMT |
float | int | string | $timezone | user timezone |
array | An array that represents the date in user time |
usergetmidnight | ( | $date, | |
$timezone = 99 ) |
Given a time, return the GMT timestamp of the most recent midnight for the current user.
int | $date | Timestamp in GMT |
float | int | string | $timezone | user timezone |
int | Returns a GMT timestamp |
username_load_fields_from_object | ( | $addtoobject, | |
$secondobject, | |||
$prefix = null, | |||
$additionalfields = null ) |
Reduces lines of duplicated code for getting user name fields.
See also user_picture::unalias()
object | $addtoobject | Object to add user name fields to. |
object | $secondobject | Object that contains user name field information. |
string | $prefix | prefix to be added to all fields (including $additionalfields) e.g. authorfirstname. |
array | $additionalfields | Additional fields to be matched with data in the second object. The key can be set to the user table field name. |
object | User name fields. |
users_order_by_sql | ( | string | $usertablealias = '', |
string | $search = null, | ||
context | $context = null, | ||
array | $customfieldmappings = [] ) |
This function generates the standard ORDER BY clause for use when generating lists of users.
If you don't have a reason to use a different order, then you should use this method to generate the order when displaying lists of users.
If the optional $search parameter is passed, then exact matches to the search will be sorted first. For example, suppose you have two users 'Al Zebra' and 'Alan Aardvark'. The default sort is Alan, then Al. If, however, you search for 'Al', then Al will be listed first. (With two users, this is not a big deal, but with thousands of users, it is essential.)
The list of fields scanned for exact matches are:
If named parameters are used (which is the default, and highly recommended), then the parameter names are like :usersortexactN, where N is an int.
The simplest possible example use is: list($sort, $params) = users_order_by_sql(); $sql = 'SELECT * FROM {users} ORDER BY ' . $sort;
A more complex example, showing that this sort can be combined with other sorts: list($sort, $sortparams) = users_order_by_sql('u'); $sql = "SELECT g.id AS groupid, gg.groupingid, u.id AS userid, u.firstname, u.lastname, u.idnumber, u.username FROM {groups} g LEFT JOIN {groupings_groups} gg ON g.id = gg.groupid LEFT JOIN {groups_members} gm ON g.id = gm.groupid LEFT JOIN {user} u ON gm.userid = u.id WHERE g.courseid = :courseid $groupwhere $groupingwhere ORDER BY g.name, $sort"; $params += $sortparams;
An example showing the use of $search: list($sort, $sortparams) = users_order_by_sql('u', $search, $this->get_context()); $order = ' ORDER BY ' . $sort; $params += $sortparams; $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);
string | $usertablealias | (optional) any table prefix for the {users} table. E.g. 'u'. |
string | $search | (optional) a current search string. If given, any exact matches to this string will be sorted first. |
context | null | $context | the context we are in. Used by core_user\fields\get_identity_fields. Defaults to $PAGE->context. |
array | $customfieldmappings | associative array of mappings for custom fields returned by core_user\fields\get_sql. |
array | with two elements: string SQL fragment to use in the ORDER BY clause. For example, "firstname, lastname". array of parameters used in the SQL fragment. If $search is not given, this is guaranteed to be an empty array. |
users_search_sql | ( | string | $search, |
string | $u = 'u', | ||
bool | $searchanywhere = true, | ||
array | $extrafields = [], | ||
array | $exclude = null, | ||
array | $includeonly = null ) |
Returns SQL used to search through user table to find users (in a query which may also join and apply other conditions).
You can combine this SQL with an existing query by adding 'AND $sql' to the WHERE clause of your query (where $sql is the first element in the array returned by this function), and merging in the $params array to the parameters of your query (where $params is the second element). Your query should use named parameters such as :param, rather than the question mark style.
There are examples of basic usage in the unit test for this function.
string | $search | the text to search for (empty string = find all) |
string | $u | the table alias for the user table in the query being built. May be ''. |
bool | $searchanywhere | If true (default), searches in the middle of names, otherwise only searches at start |
array | $extrafields | Array of extra user fields to include in search, must be prefixed with table alias if they are not in the user table. |
array | $exclude | Array of user ids to exclude (empty = don't exclude) |
array | $includeonly | If specified, only returns users that have ids incldued in this array (empty = don't restrict) |
array | an array with two elements, a fragment of SQL to go in the where clause the query, and an associative array containing any required parameters (using named placeholders). |
usertime | ( | $date, | |
$timezone = 99 ) |
Given a GMT timestamp (seconds since epoch), offsets it by the timezone.
eg 3pm in India is 3pm GMT - 7 * 3600 seconds
NOTE: this function does not include DST properly, you should use the PHP date stuff instead!
int | $date | Timestamp in GMT |
float | int | string | $timezone | user timezone |
int |
usertimezone | ( | $timezone = 99 | ) |
Returns a string that prints the user's timezone.
float | int | string | $timezone | user timezone |
string |
valid_uploaded_file | ( | $newfile | ) |
Returns current name of file on disk if it exists.
string | $newfile | File to be verified |
string | Current name of file on disk if true |
validate_email | ( | $address | ) |
Validates an email to make sure it makes sense.
string | $address | The email address to validate. |
boolean |
validate_internal_user_password | ( | $user, | |
$password ) |
Compare password against hash stored in user object to determine if it is valid.
If necessary it also updates the stored hash to the current format.
stdClass | $user | (Password property may be updated). |
string | $password | Plain text password. |
bool | True if password is valid. |
validate_param | ( | $param, | |
$type, | |||
$allownull = NULL_NOT_ALLOWED, | |||
$debuginfo = '' ) |
Strict validation of parameter values, the values are only converted to requested PHP type.
Internally it is using clean_param, the values before and after cleaning must be equal - otherwise an invalid_parameter_exception is thrown. Objects and classes are not accepted.
mixed | $param | |
string | $type | PARAM_ constant |
bool | $allownull | are nulls valid value? |
string | $debuginfo | optional debug information |
mixed | the $param value converted to PHP type |
invalid_parameter_exception | if $param is not of given type |
validate_user_key | ( | $keyvalue, | |
$script, | |||
$instance ) |
Validates a user key, checking if the key exists, is not expired and the remote ip is correct.
string | $keyvalue | the key value |
string | $script | unique script identifier |
int | $instance | instance id |
stdClass | the key entry in the user_private_key table |
moodle_exception |
want_read_slave | ( | ) |
Returns whether we want to connect to slave database for read queries.
bool | Want read only connection |
wikify_links | ( | $string | ) |
This expression turns links into something nice in a text format.
(Russell Jungwirth)
string | $string |
string |
xmldb_debug | ( | $message, | |
$object ) |
This function is the official hook inside XMLDB stuff to delegate its debug to one external function.
Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
@uses DEBUG_DEVELOPER
string | $message | string contains the error message |
object | $object | object XMLDB object that fired the debug |
xmlize | ( | $data, | |
$whitespace = 1, | |||
$encoding = 'UTF-8', | |||
$reporterrors = false ) |
XML parsing function calles into class.
Note: Used by xml element handler as callback.
string | $data | the XML source to parse. |
int | $whitespace | If set to 1 allows the parser to skip "space" characters in xml document. Default is 1 |
string | $encoding | Specify an OUTPUT encoding. If not specified, it defaults to UTF-8. |
bool | $reporterrors | if set to true, then a xml_format_exception exception will be thrown if the XML is not well-formed. Otherwise errors are ignored. |
array | representation of the parsed XML. |
object zip_files | ( | $originalfiles, | |
$destination ) |
Zip an array of files/dirs to a destination zip file Both parameters must be FULL paths to the files/dirs.
array | $originalfiles | Files to zip |
string | $destination | The destination path |
bool | Outcome |
$capabilities |
$definitions |
bool filterobject::$fullmatch |
whether to match complete words.
If true, 'T' won't be matched in 'Tim'.
$handlers |
foreach( $plugins as $plugin) if($hassiteconfig) if( $hassiteconfig) if($hassiteconfig) if ( $hassiteconfig) $plugins = core_plugin_manager::instance()->get_plugins_of_type('tool') |
Add all admin tools.
Add all local plugins - must be always last!
$plugins |
null string filterobject::$replacementphrase |
replacement text to go inside begin and end.
If not set, the body of the replacement will be the original phrase.
|
protected |
This list of active filters, by context, for filtering strings.
An array contextid => ordered array of filter name => filter objects.
$tasks |
|
protected |
This list of active filters, by context, for filtering content.
An array contextid => ordered array of filter name => filter objects.
const BEHAT_EXITCODE_CONFIG 250 |
alert danger |
defined('HUB_STATSPUBLICKEY')||define('HUB_STATSPUBLICKEY' | ( | 'HUB_MOODLEORGHUBURL' | ) |
URL of the Moodle sites registration portal.
URL of the statistic server public key.
if (isset( $_REQUEST[ 'lang'])) else |
if (isset( $_REQUEST[ 'admin'])) else |
if(!function_exists('iconv')) if (PHP_INT_SIZE > 4) else |
if (!empty( $_POST)) else |
if (defined( 'COMPONENT_CLASSLOADER')) else |
if ( $distro) else |
const ENROL_EXT_REMOVED_SUSPEND 2 |
When user disappears from external source, user enrolment is suspended, roles are kept as is.
In some cases user needs a role with some capability to be visible in UI - suc has in gradebook, assignments, etc.
const ENROL_EXT_REMOVED_SUSPENDNOROLES 3 |
When user disappears from external source, the enrolment is suspended and roles assigned by enrol instance are removed.
Please note that user may "disappear" from gradebook and other areas.
const ENROL_INSTANCE_DISABLED 1 |
Course enrol instance disabled, user may enter course if other enrol instance enabled.
(used in enrol->status)
const ENROL_INSTANCE_ENABLED 0 |
Course enrol instance enabled.
(used in enrol->status)
const ENROL_REQUIRE_LOGIN_CACHE_PERIOD 1800 |
const ENROL_RESTORE_TYPE 'enrolrestore' |
const ENV_SELECT_NEWER 0 |
Define algorithm used to select the xml file.
To select the newer file available to perform checks
const EXTERNAL_TOKEN_EMBEDDED 1 |
Security token used for allowing access of embedded applications, the code is executed in the active user session.
Token is invalidated after user logs out. Scripts are executed serially - normal session locking is used.
const EXTERNAL_TOKEN_PERMANENT 0 |
Security token used for allowing access from external application such as web services.
Scripts do not use any session, performance is relatively low because we need to load access info in each request. Scripts are executed in parallel.
const FEATURE_GROUPMEMBERSONLY 'groupmembersonly' |
True if module supports groupmembersonly (which no longer exists)
const FORMAT_WIKI '3' |
Wiki-formatted text.
Deprecated: left here just to note that '3' is not used (at the moment) and to catch any latent wiki-like text (which generates an error)
h1 |
const LIST_NONE 1 |
#-
#+ list defines
trait core::task\logging_trait |
This trait includes functions to assist with logging in tasks.
const MEMORY_EXTRA -3 |
Large memory limit for given platform - used in cron, upgrade, and other places that need a lot of memory.
Can be overridden with $CFG->extramemorylimit setting.
trait moodle_read_slave_trait |
Trait to wrap connect() method of database driver classes that gives ability to use read only slave instances for SELECT queries.
For the databases that support replication and read only connections to the slave. If the slave connection is configured there will be two database handles created, one for the master and another one for the slave. If there's no slave specified everything uses master handle.
Classes that use this trait need to rename existing connect() method to raw_connect(). In addition, they need to provide get_db_handle() and set_db_handle() methods, due to dbhandle attributes not being named consistently across the database driver classes.
Read only slave connection is configured in the $CFG->dboptions['readonly'] array.
Choice of the database handle is based on following:
A 'latency' example:
const NO_ERROR 0 |
Add required files.
Include the necessary Define a bunch of XML processing errors XML Processing Error
const PAGE_COURSE_VIEW 'course-view' |
PAGE_COURSE_VIEW is a definition of a page type.
For more information on the page class see moodle/lib/pagelib.php.
const PARAM_ACTION 'alphanumext' |
PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls NOTE: originally alias for PARAM_APLHA.
const PARAM_AREA 'area' |
PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
It is usually used together with context id and component. Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
const PARAM_CAPABILITY 'capability' |
PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'.
Actually checked against the list of capabilities in the database.
const PARAM_CLEAN 'clean' |
PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
It was one of the first types, that is why it is abused so much ;-)
const PARAM_CLEANHTML 'cleanhtml' |
PARAM_CLEANHTML - cleans submitted HTML code.
Note that you almost never want to use this. The normal mode of operation is to use PARAM_RAW when receiving the input (required/optional_param or formslib) and then sanitise the HTML using format_text on output. This is for the rare cases when you want to sanitise the HTML on input. This cleaning may also fix xhtml strictness.
const PARAM_COMPONENT 'component' |
PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'. Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter. NOTE: numbers and underscores are strongly discouraged in plugin names!
const PARAM_FLOAT 'float' |
PARAM_FLOAT - a real/floating point number.
Note that you should not use PARAM_FLOAT for numbers typed in by the user. It does not work for languages that use , as a decimal separator. Use PARAM_LOCALISEDFLOAT instead.
const PARAM_FORMAT 'alphanumext' |
PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
NOTE: originally alias for PARAM_APLHA
const PARAM_INTEGER 'int' |
PARAM_INTEGER - deprecated alias for PARAM_INT.
const PARAM_LOCALISEDFLOAT 'localisedfloat' |
PARAM_LOCALISEDFLOAT - a localised real/floating point number.
This is preferred over PARAM_FLOAT for numbers typed in by the user. Cleans localised numbers to computer readable numbers; false for invalid numbers.
const PARAM_LOCALURL 'localurl' |
PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself.
(NOT orthogonal to the others! Implies PARAM_URL!)
const PARAM_MULTILANG 'text' |
PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
const PARAM_NOTAGS 'notags' |
PARAM_NOTAGS - all html tags are stripped from the text.
Do not abuse this type.
const PARAM_NUMBER 'float' |
PARAM_NUMBER - deprecated alias of PARAM_FLOAT.
const PARAM_PLUGIN 'plugin' |
PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'paypal', 'completionstatus'.
Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter. NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
const PARAM_SAFEPATH 'safepath' |
PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths and other references to Moodle code files.
This is NOT intended to be used for absolute paths or any user uploaded files.
const PARAM_SEQUENCE 'sequence' |
PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.
Numbers and comma only.
const PARAM_TEXT 'text' |
PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
Please note '<', or '>' are allowed here.
const PARAM_TIMEZONE 'timezone' |
PARAM_TIMEZONE - expected timezone.
Timezone can be int +-(0-13) or float +-(0.5-12.5) or string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem America/Port-au-Prince)
const PARAM_URL 'url' |
PARAM_URL - expected properly formatted URL.
Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
const PARAM_USERNAME 'username' |
PARAM_USERNAME - Clean username to only contains allowed characters.
This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
const PHPUNIT_EXITCODE_PHPUNITMISSING 129 |
const TABLE_P_TOP 1 |
#-
#+ Constants that indicate whether the paging bar for the table appears above or below the table.
const TABLE_SHOW_ALL_PAGE_SIZE 5000 |
#-
Constant that defines the 'Show all' page size.
const TAG_MAX_LENGTH 50 |
To prevent problems with multibytes strings,Flag updating in nav not working on the review page.
this should not exceed the length of "varchar(255) / 3 (bytes / utf-8 character) = 85". TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
const TESTING_EXITCODE_COMPOSER 255 |
Composer error exit status.
const TEXTFILTER_EXCL_SEPARATOR chr(0x1F) . '%' . chr(0x1F) |
Define one exclusive separator that we'll use in the temp saved tags keys.
It must be something rare enough to avoid having matches with filterobjects. MDL-18165
const TOKEN_USER "0" |
Constants for the various types of tokens.