core

Topics
	admin
	analytics
	cache
	check
	comment
	csv
	dml
	event
	external
	files
	lock
	log
	message
	navigation
	output
	page
	phpunit
	preference
	privacy
	string
	table
	task
	test
	upgrade

Directories
directory	analytics
directory	analytics
directory	analytics
directory	content
directory	dataformat
directory	favourites
directory	local
directory	local
directory	media
directory	mod
directory	navigation
directory	output
directory	privacy
directory	reportbuilder
directory	reportbuilder
directory	reportbuilder
directory	reportbuilder

Namespaces
namespace	core
namespace	core\access
	Helper functions to implement the complex get_user_capability_course function.
namespace	core\analytics\analyser
	Courses analyser working at course level (insights for the course teachers).
namespace	core\analytics\indicator
	Any access after the official end of the course.
namespace	core\analytics\time_splitting
	10 parts time splitting method.
namespace	core\check\performance
	Backups check.
namespace	core\content\export
namespace	core\content\export\exportable_items
namespace	core\content\export\exporters
	Activity module exporter for the content API.
namespace	core\dataformat
	Base class for dataformat.
namespace	core\event
namespace	core\external
	Class for exporting summary information for a course category.
namespace	core\files
	Contains a class providing functions used to check the allowed/blocked host/ports for curl.
namespace	core\form
	Moodle 404 Error page feedback form.
namespace	core\hook
namespace	core\hook\navigation
namespace	core\hub
	Class communication.
namespace	core\local\cli
	CLI script shutdown helper class.
namespace	core\local\guzzle
namespace	core\lock
namespace	core\log
	Dummy storage manager, returns nothing.
namespace	core\moodlenet
namespace	core\oauth2
	Loads/stores oauth2 access tokens in DB for system accounts in order to use a single token across multiple sessions.
namespace	core\oauth2\client
namespace	core\oauth2\discovery
namespace	core\oauth2\service
namespace	core\output
namespace	core\output\dynamic_tabs
namespace	core\plugininfo
	Defines classes used for plugin info.
namespace	core\progress
namespace	core\reportbuilder\local\entities
namespace	core\session
	Database based session handler.
namespace	core\session\utility
namespace	core\task
	Adhoc task abstract class.
namespace	core\update
	The class core\update\api is defined here.
namespace	core\upgrade
	PayPal enrolment plugin utility class.
namespace	core_admin\form
	Form for selective purging of caches.
namespace	core_admin\local\settings
	Auto complete admin setting.
namespace	core_badges
	Communicate with backpacks.
namespace	core_badges\form
	Form class for mybackpack.php.
namespace	core_badges\output
	Issued badge renderable.
namespace	core_course\analytics\indicator
	Activities due indicator.
namespace	core_course\cache
namespace	core_course\local\entity
	Activity Chooser footer data class.
namespace	core_course\local\exporters
	Contains the course_content_item_exporter class.
namespace	core_course\local\repository
	Contains class caching_content_item_repository, for fetching content_items, with additional caching.
namespace	core_course\local\service
	Contains the content_item_service class.
namespace	core_course\output
namespace	core_h5p\event
	H5P deleted event class.
namespace	core_question\statistics\questions
	A collection of all the question statistics calculated for an activity instance ie.
namespace	core_user
namespace	core_user\analytics\target
	Upcoming activities due target.
namespace	core_user\external
namespace	mod_quiz\event
	The mod_quiz attempt abandoned event.
namespace	Moodle\BehatExtension\Context
namespace	Moodle\BehatExtension\Context\ContextClass
namespace	Moodle\BehatExtension\Context\Initializer
namespace	Moodle\BehatExtension\Context\Step
namespace	Moodle\BehatExtension\Definition\Cli
namespace	Moodle\BehatExtension\Definition\Printer
namespace	Moodle\BehatExtension\Driver
namespace	Moodle\BehatExtension\EventDispatcher\Tester
namespace	Moodle\BehatExtension\Exception
namespace	Moodle\BehatExtension\Output\Formatter
namespace	Moodle\BehatExtension\Output\Printer
namespace	Moodle\BehatExtension\ServiceContainer

Classes
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	behat_config_util
	Behat configuration manager. More...
class	block_manager
	This class keeps track of the block that should appear on a moodle_page. 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	cached_cm_info
	Class that is the return value for the _get_coursemodule_info module API function. More...
class	calc_formula
	This class abstracts evaluation of spreadsheet formulas. More...
class	cm_info
	Data about a single module on a course. More...
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	component_installer
	This class is used to check, download and install items from download.moodle.org to the moodledata directory. 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\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\performance\debugging
	Debugging check. 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
	Cron and adhoc task functionality. More...
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\encryption
	Class used to encrypt or decrypt data. More...
class	core\event\antivirus_scan_data_error
	Antivirus scan data error event. More...
class	core\event\antivirus_scan_file_error
	Antivirus scan file error event. More...
class	core\event\assessable_submitted
	Abstract assessable submitted event class. More...
class	core\event\assessable_uploaded
	Abstract assessable uploaded event class. More...
class	core\event\badge_awarded
	Event triggered after a badge is awarded to a user. More...
class	core\event\badge_criteria_created
	Event triggered after criteria is created for a badge. More...
class	core\event\badge_criteria_deleted
	Event triggered after criteria is deleted from a badge. More...
class	core\event\badge_criteria_updated
	Event triggered after criteria is updated to a badge. More...
class	core\event\badge_deleted
	Event triggered after a badge is deleted. More...
class	core\event\badge_listing_viewed
	Event triggered after a badge is viewed. More...
class	core\event\badge_revoked
	Event triggered after a badge is revoked from a user. More...
class	core\event\base
	Base event class. More...
class	core\event\blog_association_deleted
	Class for event to be triggered when a new blog entry is deleted with a context. More...
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 for event to be triggered when blog entries are viewed. More...
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 for event to be triggered when an external blog is viewed to moodle. More...
class	core\event\calendar_subscription_created
	Event triggered after a calendar subscription is added. More...
class	core\event\calendar_subscription_deleted
	Event triggered after a calendar subscription is deleted. More...
class	core\event\calendar_subscription_updated
	Event triggered after a calendar subscription is updated. More...
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
	Event class for when an admin config log is created. More...
class	core\event\contentbank_content_created
	Content bank content created class. More...
class	core\event\contentbank_content_deleted
	Content bank content deleted class. More...
class	core\event\contentbank_content_updated
	Content bank content updated class. More...
class	core\event\contentbank_content_uploaded
	Content bank content uploaded class. More...
class	core\event\contentbank_content_viewed
	Content bank content updated class. More...
class	core\event\course_backup_created
	Course backup created event class. More...
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
	Course completed event class. More...
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 course_module_deleted. More...
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
	Course section deleted event class. More...
class	core\event\course_updated
	Course updated event class. More...
class	core\event\course_user_report_viewed
	Course user report viewed event class. More...
class	core\event\course_viewed
	Course viewed event class. More...
class	core\event\dashboard_reset
	Dashboard reset event class. More...
class	core\event\dashboard_viewed
	Dashboard viewed event class. More...
class	core\event\dashboards_reset
	Dashboards reset event class. More...
class	core\event\database_text_field_content_replaced
	The database text field content replaced event class. More...
class	core\event\grade_exported
	Abstract grade report exported event class. More...
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
	Group message sent 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
	New event manager class. More...
class	core\event\message_deleted
	Message deleted event class. More...
class	core\event\message_sent
	Message sent event class. More...
class	core\event\message_viewed
	Message viewed event class. More...
class	core\event\moodlenet_resource_exported
	MoodleNet send attempt event. More...
class	core\event\mycourses_viewed
	My courses viewed event class. More...
class	core\event\notes_viewed
	Class note_viewed. More...
class	core\event\notification_sent
	Notification sent event class. More...
class	core\event\qbank_plugin_base
	Question bank plugin event. More...
class	core\event\qbank_plugin_disabled
	Question bank plugin was disabled. More...
class	core\event\qbank_plugin_enabled
	Question bank plugin was enabled. More...
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
	Question created event class. More...
class	core\event\question_deleted
	Question deleted event class. More...
class	core\event\question_moved
	Question moved event class. More...
class	core\event\question_updated
	Question updated event class. More...
class	core\event\question_viewed
	Question previewed event class. More...
class	core\event\questions_exported
	Question category exported event class. More...
class	core\event\questions_imported
	Question category imported event class. More...
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
	Search results viewed. More...
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
	Tag created event class. More...
class	core\event\tag_deleted
	Tag deleted event class. More...
class	core\event\tag_flagged
	Tag flagged event class. More...
class	core\event\tag_unflagged
	Tag unflagged event. More...
class	core\event\tag_updated
	Tag updated event. More...
class	core\event\unknown_logged
	Unknown event class. More...
class	core\event\url_blocked
	URL blocked event class. More...
class	core\event\user_deleted
	User deleted event class. More...
class	core\event\user_enrolment_created
	Event class for when user is enrolled in a course. More...
class	core\event\user_enrolment_updated
	Event class for when user enrolment is updated. More...
class	core\event\user_graded
	Event triggered after teacher edits manual grade or overrides activity/aggregated grade. More...
class	core\event\user_list_viewed
	Defines the user list viewed event. More...
class	core\event\user_loggedout
	Event when user logout. More...
class	core\event\user_login_failed
	User login failed event class. More...
class	core\event\user_password_policy_failed
	Event when user's current password fails the password policy. More...
class	core\event\user_password_updated
	Event when user password is changed or reset. More...
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
	Web service service created event class. More...
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
	Web service token created event class. More...
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
	External method for getting tab contents. More...
class	core\external\editmode
	Web service to change the edit mode. More...
class	core\external\moodlenet_auth_check
	The external API to check whether a user has authorized for a given MoodleNet OAuth 2 issuer. More...
class	core\external\moodlenet_get_share_info_activity
	The external API to het the activity information for MoodleNet sharing. More...
class	core\external\moodlenet_get_shared_course_info
	The external API to get MoodleNet information about the course to be shared. More...
class	core\external\moodlenet_send_activity
	The external API to send activity to MoodleNet. More...
class	core\external\moodlenet_send_course
	The external API to send course to MoodleNet. More...
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
	The external API to record users action on the feedback notification. More...
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...
interface	core\hook\deprecated_callback_replacement
	Interface for describing of lib.php callbacks that were deprecated by the hook. More...
interface	core\hook\described_hook
	Interface for a hook to provide a description of itself for administrator information. More...
interface	core\hook\discovery_agent
	This interface describes a class which can discover all hook classes of a plugin. More...
class	core\hook\manager
	Hook manager implementing "Dispatcher" and "Event Provider" from PSR-14. More...
class	core\hook\navigation\primary_extend
	Allows plugins to insert nodes into site primary navigation. More...
class	core\hooks
	Standard hook discovery agent for Moodle which lists all non-abstract classes in hooks namespace of core and all plugins unless there is a hook discovery agent in a plugin. More...
class	core\http_client
	Guzzle Integration for Moodle. More...
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 to handle and generates CacheItemPoolInterface objects. More...
class	core\local\guzzle\cache_item
	Class to define an interface for interacting with objects inside a cache. More...
class	core\local\guzzle\cache_storage
	Cache storage handler to handle cache objects, TTL etc. More...
class	core\local\guzzle\check_request
	Class to check request against curl security helper. More...
class	core\local\guzzle\redirect_middleware
	Class to check that each URL is valid in a redirect. More...
class	core\locale
	Helper utility to interact with Locales. More...
class	core\lock\lock_utils
	Lock utilities. More...
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\moodlenet\activity_packager
	Packager to prepare appropriate backup of an activity to share to MoodleNet. More...
class	core\moodlenet\activity_sender
	API for sharing Moodle LMS activities to MoodleNet instances. More...
class	core\moodlenet\course_packager
	Packager to prepare appropriate backup of a course to share to MoodleNet. More...
class	core\moodlenet\course_partial_packager
	Packager to prepare appropriate backup of a number of activities in a course to share to MoodleNet. More...
class	core\moodlenet\course_partial_sender
	API for sharing a number of Moodle LMS activities as a course backup to MoodleNet instances. More...
class	core\moodlenet\course_sender
	API for sharing Moodle LMS courses to MoodleNet instances. More...
class	core\moodlenet\helpers
	Helper for tests related to MoodleNet integration. More...
class	core\moodlenet\moodlenet_client
	MoodleNet client which handles direct outbound communication with MoodleNet instances. More...
class	core\moodlenet\resource_packager
	Base packager to prepare appropriate backup of a resource to share to MoodleNet. More...
class	core\moodlenet\resource_sender
	API for sharing Moodle LMS resources to MoodleNet instances. More...
class	core\moodlenet\share_progress_table
	MoodleNet share progress table. More...
class	core\moodlenet\share_recorder
	Record the sharing of content to MoodleNet. More...
class	core\moodlenet\utilities
	Class containing static utilities (such as various checks) required by the MoodleNet API. More...
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 clever - Custom client handler to fetch data from Clever. More...
class	core\oauth2\client\linkedin
	Class linkedin - Custom client handler to fetch data from linkedin. More...
class	core\oauth2\discovery\auth_server_config_reader
	Simple reader class, allowing OAuth 2 Authorization Server Metadata to be read from an auth server's well-known. More...
class	core\oauth2\discovery\base_definition
	Class for provider discovery definition, to allow services easily discover and process information. More...
class	core\oauth2\discovery\imsbadgeconnect
	Class for IMS Open Badge Connect API (aka OBv2.1) discovery definition. More...
class	core\oauth2\discovery\openidconnect
	Class for Open ID Connect discovery definition. More...
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 for Clever OAuth service, with the specific methods related to it. More...
class	core\oauth2\service\custom
	Class for Custom services, with the specific methods related to it. More...
class	core\oauth2\service\facebook
	Class for Facebook oAuth service, with the specific methods related to it. More...
class	core\oauth2\service\google
	Class for Google oAuth service, with the specific methods related to it. More...
class	core\oauth2\service\imsobv2p1
	Class for IMS Open Badges v2.1 oAuth service, with the specific methods related to it. More...
interface	core\oauth2\service\issuer_interface
	Interface for services, with the methods to be implemented by all the issuer implementing it. More...
class	core\oauth2\service\linkedin
	Class linkedin. More...
class	core\oauth2\service\microsoft
	Class for Microsoft oAuth service, with the specific methods related to it. More...
class	core\oauth2\service\moodlenet
	MoodleNet OAuth 2 configuration. More...
class	core\oauth2\service\nextcloud
	Class for Nextcloud oAuth service, with the specific methods related to it. More...
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\checkbox_toggleall
	The checkbox-toggleall renderable class. More...
class	core\output\choicelist
	A generic user choice output 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
	The filter renderable class. More...
class	core\output\dynamic_tabs
	Class dynamic tabs. More...
class	core\output\dynamic_tabs\base
	Class tab_base. More...
class	core\output\external
	This class contains a list of webservice functions related to output. More...
interface	core\output\named_templatable
	A subset of templatable which provides the name of the template to use. More...
class	core\output\participants_action_bar
	Class responsible for generating the action bar (tertiary nav) elements in the participants page and related pages. More...
interface	core\output\url_rewriter
	URL rewriter interface. More...
class	core\persistent
	Abstract class for core objects saved to the DB. More...
class	core\plugininfo\auth
	Class for authentication plugins. More...
class	core\plugininfo\availability
	Class for availability plugins. More...
class	core\plugininfo\base
	Base class providing access to the information about a plugin. More...
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\communication
	Class for communication provider. 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\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\reportbuilder\local\entities\context
	Context entity. 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
	Helper class providing utils dealing with cookies, particularly 3rd party cookies. 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
	Report task for core automation backup. More...
class	core\task\automated_backup_task
	Simple task to run the backup cron. More...
class	core\task\badges_adhoc_task
	Class badges_adhoc_task. More...
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
	Retroactively fixes file timestamps that are older than the containing folder record. More...
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
	A task to get the latest content types from the official H5P repository. More...
class	core\task\hide_ended_courses_task
	Simple task to automatically set the course visibility to hidden when the course end date matches the current day. 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\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\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
	Adhoc task that send login notifications. More...
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\show_started_courses_task
	Simple task to automatically set the course visibility to shown when the course start date matches the current day. 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_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...
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\code_manager
	General purpose class managing the plugins source code files deployment. 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
	Standard HTML output renderer for core_admin subsystem. More...
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_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 to describe cache data source for course image. More...
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 responsible for generating the action bar (tertiary nav) elements in an individual category page. More...
class	core_course\output\manage_categories_action_bar
	Class responsible for generating the action bar (tertiary nav) elements in the category management page. More...
class	core_course_category
	Class to store, cache, render and manage course category. More...
class	core_course_list_element
	Class to store information about one course in a list of courses. More...
class	core_cssparser
	Moodle CSS parser. More...
class	core_date
	Core date and time related code. More...
class	core_files_renderer
	Rendering of files viewer related widgets. More...
class	core_filetypes
	Class to manage the custom filetypes list that is stored in a config variable. More...
class	core_geopattern
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
	Defines classes used for plugins management. More...
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_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_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
	Update public key against registered user device. More...
class	core_user\external\update_user_device_public_key
	Update public key against registered user device. More...
class	core_useragent
	Environment class to aid with the detection and establishment of the working environment. 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_modinfo
	Information about a course that is cached in the course table 'modinfo' field (and then in memory) in order to reduce the need for other database queries. More...
class	course_reset_form
	Defines the course reset settings form. 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	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	edit_criteria_form
	Form to edit badge criteria. More...
class	edit_relatedbadge_form
	Form to edit badge details. 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_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	flexible_table
class	flickr_client
	Simple Flickr API client implementing the features needed by Moodle. 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	html_list_progress_trace
	HTML List Progress Tree. More...
class	html_progress_trace
	This subclass of progress_trace outputs as HTML. 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	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	lang_installer
	End of component_installer class. More...
class	lang_installer_exception
	Exception thrown by lang_installer. 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	Moodle\BehatExtension\Context\ContextClass\ClassResolver
	Moodle behat context class resolver. More...
class	Moodle\BehatExtension\Context\Initializer\MoodleAwareInitializer
	MoodleContext initializer. More...
class	Moodle\BehatExtension\Context\MoodleContext
	Moodle contexts loader. More...
class	Moodle\BehatExtension\Context\Step\ChainedStep
	Chained Step base class. More...
class	Moodle\BehatExtension\Context\Step\Given
	Chained Given step. More...
class	Moodle\BehatExtension\Context\Step\Then
	Chained Then ChainedStep. More...
class	Moodle\BehatExtension\Context\Step\When
	Chained When step. More...
class	Moodle\BehatExtension\Definition\Cli\AvailableDefinitionsController
	Available definition controller, for calling moodle information printer. More...
class	Moodle\BehatExtension\Definition\Printer\ConsoleDefinitionInformationPrinter
	Moodle console definition information printer. More...
class	Moodle\BehatExtension\Driver\WebDriver
	WebDriver Driver to allow extra selenium capabilities required by Moodle. More...
class	Moodle\BehatExtension\Driver\WebDriverFactory
	Driver factory for the Moodle WebDriver. More...
class	Moodle\BehatExtension\EventDispatcher\Tester\ChainedStepTester
	Override step tester to ensure chained steps gets executed. More...
class	Moodle\BehatExtension\EventDispatcher\Tester\MoodleEventDispatchingStepTester
	Step tester dispatching BEFORE/AFTER events during tests. More...
class	Moodle\BehatExtension\Exception\SkippedException
	Skipped exception (throw this to mark step as "skipped"). More...
class	Moodle\BehatExtension\Output\Formatter\MoodleListFormatter
	Feature step counter for distributing features between parallel runs. More...
class	Moodle\BehatExtension\Output\Formatter\MoodleProgressFormatterFactory
	Moodle behat context class resolver. More...
class	Moodle\BehatExtension\Output\Formatter\MoodleScreenshotFormatter
	Feature step counter for distributing features between parallel runs. More...
class	Moodle\BehatExtension\Output\Formatter\MoodleStepcountFormatter
	Feature step counter for distributing features between parallel runs. More...
class	Moodle\BehatExtension\Output\Printer\MoodleProgressPrinter
	Prints hooks in a pretty fashion. More...
class	moodle_exception
	Base Moodle Exception class. More...
class	moodle_list
	Clues to reading this code: More...
class	moodle_text_filter
	Base class for text filters. More...
class	moodle_url
	Class for creating and manipulating urls. 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	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	performance_measuring_filter_manager
	Filter manager subclass that tracks how much work it does. 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	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...
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	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
	Data about a single section on a course. More...
class	table_dataformat_export_format
	Dataformat exporter. More...
class	table_default_export_format_parent
class	table_sql
class	text_progress_trace
	This subclass of progress_trace outputs to plain text. More...
class	texteditor
	Base abstract text editor class. More...
class	upload_manager
	This class handles all aspects of fileuploading. 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	webservice_parameter_exception
	Web service parameter exception class. More...
class	WikiToMarkdown
	#- More...
class	xml_format_exception

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.
	abort_all_db_transactions ()
	Unconditionally abort all database transactions, this function should be called from exception handlers only.
	add_event ()
	CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////.
	add_mod_to_section ()
	add_to_log ()
	addslashes_js ($var)
	Does proper javascript quoting.
	ajaxenabled ()
	allow_assign ()
	allow_override ()
	allow_switch ()
	filter_manager::apply_filter_chain ($text, $filterchain, array $options=array(), array $skipfilters=null)
	Apply a list of filters to some content.
	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 ()
	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_badge_by_hash (string $hash)
	Get badge by hash.
	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 ()
	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_prepare_badge_for_external (stdClass $badge, stdClass $user)
	Update badge instance to external functions.
	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 ()
	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.
	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 ()
	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_use_html_editor ()
	can_use_rotated_text ()
	category_delete_full ()
	category_delete_move ()
	check_browser_operating_system ()
	check_browser_version ()
	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_moodle_environment ($version, $env_select=ENV_SELECT_NEWER)
	This function checks all the requirements defined in environment.xml.
	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_text ($text, $format=FORMAT_HTML, $options=array())
	Cleans raw text removing nasties.
	cleanup_contexts ()
	cli_error ($text, $errorcode=1)
	Write to standard error output and exit with the given code.
	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)
	Command line utility functions and classes.
	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 ()
	completion_cron ()
	confirm_sesskey ($sesskey=NULL)
	Check the sesskey and return true of false for whether it is valid.
	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_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.
	count_enrolled_users (context $context, $withcapability='', $groupids=0, $onlyactive=false)
	Counts list of users enrolled into course (as per above function)
	count_login_failures ()
	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 ()
	cron_bc_hack_plugin_functions ()
	cron_execute_plugin_type ()
	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_theme ()
	data_submitted ()
	Determine if there is data waiting to be processed from a form.
	debugging ($message='', $level=DEBUG_NORMAL, $backtrace=null)
	Standard Debugging Function.
	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_module ()
	delete_event ()
	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.
	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)
	dataformatlib.php - Contains core dataformat related functions.
	dst_changes_for_year ()
	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.
	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 ()
	external_function_info ()
	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.
	fix_align_rtl ($align)
	Returns swapped left<=> right if in RTL environment.
	format_backtrace ($callers, $plaintext=false)
	Formats a backtrace ready for output.
	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_weeks_get_section_dates ()
	formerr ()
	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_uuid ()
	get_accesshide ($text, $elem='span', $class='', $attrs='')
	Return a HTML element with the class "accesshide", for accessibility.
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_mods ()
	get_all_sections ()
	get_all_subcategories ()
	get_all_user_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_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_categories ()
	get_category_courses_array ()
	get_category_courses_array_recursively ()
	get_child_categories ()
	get_child_contexts ()
	get_clam_error_code ()
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_from_classname (string $classname)
	Fetch the component name from a Moodle PSR-like namespace.
static	get_component_list ()
	Returns a list of frankenstyle component names and their paths, for all components (plugins and subsystems).
static	get_component_names (bool $includecore=false,)
	Returns a list of frankenstyle component names, including all plugins, subplugins, and subsystems.
	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_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_participants ()
	get_course_section ()
	get_courseid_from_context ()
	get_courses_page ()
	get_courses_wmanagers ()
	get_current_group ()
	get_device_cfg_var_name ()
	get_device_type ()
	get_device_type_list ()
	get_docs_url ($path=null)
	Returns the Moodle Docs URL in the users language for a given 'More help' link.
	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 ()
	get_extra_user_fields_sql ()
	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_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_group_picture_url ($group, $courseid, $large=false, $includetoken=false)
	Return the url to the group picture.
	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_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_environment_versions ($contents)
	This function will return the list of Moodle versions available.
	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_logs ()
	get_logs_usercourse ()
	get_logs_userday ()
	get_module_metadata ()
	get_moodle_cookie ()
	Gets a moodle cookie with a weakly encrypted username.
static	core\event::get_other_mapping ()
	Used for maping events on restore.
	get_parent_contextid ()
	get_parent_contexts ()
	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_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_print_section_cm_text ()
	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_selected_theme_for_device_type ()
	get_separator ()
	Return the breadcrumb trail navigation separator.
	filter_manager::get_string_filters ($context)
	Get all the filters that apply to a given context for calls to format_string.
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_timezone_offset ()
	get_timezone_record ()
	core\task::get_trace ()
	Get the progress_trace.
	get_user_access_sitewide ()
	get_user_courses_bycap ()
	get_user_device_type ()
	get_user_field_name ()
	get_user_timezone_offset ()
	grade_print_tabs ($active_type, $active_plugin, $plugin_info, $return=false)
	Print grading plugin selection tab-based navigation.
	groupmode ()
	groups_course_module_visible ()
	groups_filter_users_by_course_module_visible ()
	groups_get_all_groups_for_courses ()
	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_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_to_text ($html, $width=75, $dolinks=true)
	Given HTML text, make it into plain text using external function.
	httpsrequired ()
	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.
	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_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.
static	invalidate_opcode_php_cache ($file)
	Invalidate opcode cache for given file, this is intended for php files that are stored in dataroot.
	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_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_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_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_major_upgrade_required ()
	Check whether a major upgrade is needed.
	is_moodle_cookie_secure ()
	Determine wether the secure flag should be set on cookies.
static	is_valid_plugin_name ($plugintype, $pluginname)
	This method validates a plug name.
	is_web_crawler ()
	core\hook::isPropagationStopped ()
	Is propagation stopped?
	js_minify ()
	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.
	login_attempt_failed ($user)
	To be called after failed user login.
	login_attempt_valid ($user)
	To be called after valid user login.
	login_captcha_enabled ()
	Returns whether the captcha element is enabled for the login form, and the admin settings fulfil its requirements.
	login_is_lockedout ($user)
	Verify if user is locked out.
	login_lock_account ($user)
	Lockout user and send notification email.
	login_unlock_account ($user, bool $notify=false)
	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_localcache_directory ($directory, $exceptiononerror=true)
	Create a directory under localcachedir and make sure it is writable.
	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_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.
	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.
	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 ()
	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 library, usable even when no other moodle libs are loaded.
	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_minimum_php_version_is_met ($haltexecution=false)
	Tests the current PHP version against Moodle's minimum requirement.
	moodle_require_minimum_php_version ()
	A set of PHP-compatible convenience functions to check Moodle minimum PHP version in a unified place.
	move_category ()
	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.
	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.
	password_compat_not_supported ()
	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)
	plagiarismlib.php - Contains core Plagiarism related functions.
	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.
	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_overview ()
	print_password_policy ()
	Returns a localized sentence in the current language summarizing the current password policy.
	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_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_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 ()
	profile_display_fields ()
	profile_edit_category ()
	profile_edit_field ()
	proxy_log_callback ($code)
	Add http stream instrumentation.
	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.
	question_add_tops ()
	question_is_only_toplevel_category_in_context ()
	raise_memory_limit ($newlimit)
	Function to raise the memory limit to a new value.
	random_bytes_emulate ($length)
	Try to generate cryptographically secure pseudo-random bytes.
	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, bool $compactmode=false)
	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.
	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_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.
static	filter_manager::reset_caches ()
	Resets the caches, usually to be called between unit tests.
	reset_login_count ()
	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.
	send_headers ($contenttype, $cacheable=true)
	Send the HTTP headers that Moodle requires.
	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_current_group ()
	set_debugging ($level, $debugdisplay=null)
	Alter debugging level for the current request, the change is not saved in database.
	set_moodle_cookie ($username)
	Sets a moodle cookie with a weakly encrypted username.
	set_user_device_type ()
	moodle_text_filter::setup ($page, $context)
	Setup page with filter requirements and other prepare stuff.
	setup_get_remote_url ()
	Get the URL that PHP/the web server thinks it is serving.
	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.
	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_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)
	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.
	core\hook::stop_propagation ()
	Allows plugins to notify the hook dispatcher that hook propagation should be stopped.
	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.
	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 ()
	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_get_locked_theme_for_device ($device)
	Returns the theme named defined in config.php for the given device.
	theme_is_device_locked ($device)
	Checks if the given device has a theme defined in config.php.
	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?
	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.
	unzip_file ()
	update_category_button ()
	update_event ()
	update_log_display_entry ()
	update_login_count ()
	update_module_button ()
	update_timezone_records ()
	upgrade_ensure_not_running ($warningonly=false)
	Makes sure that upgrade process is not running.
	user_get_participants ()
	user_get_participants_sql ()
	user_get_total_participants ()
	useredit_shared_definition_preferences ()
	validate_email ($address)
	Validates an email to make sure it makes sense.
	validate_login_captcha (string|bool $captcha)
	Check the submitted captcha is valid or not.
	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.
	xmlize ($data, $whitespace=1, $encoding='UTF-8', $reporterrors=false)
	XML parsing function calles into class.
	zip_files ()

Variables
	$branch = '403'
	$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()
	$distro = null
if(file_exists(__DIR__.'/../config.php'))	$files = array('boost/style/moodle.css')
	This script prints basic CSS for the installer.
int	performance_measuring_filter_manager::$filterscreated = 0
	number of filter objects created.
bool	filterobject::$fullmatch
	whether to match complete words.
	$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.
	$maturity = MATURITY_STABLE
	$memlimit = @ini_get('memory_limit')
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.
	$release = '4.3.6 (Build: 20240812)'
	$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
	This file defines settingpages and externalpages under the "badges" section.
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 to be included on the pages for configuring a single host $mnet_peer object must be set and bootstrapped $currenttab string must be set.
	$tabs = array()
	$tagareas
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 = 2023100906.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
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_FAILED_RECAPTCHA 6
	Can not login, failed reCaptcha challenge.
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_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'
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	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	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
$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
	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
	This script creates config.php file during installation.
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_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)
font	family
	Moodle Generic plain page.
$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.
	h1
line	height
**ingroup core **copyright Darko Miletic< dmiletic @moodlerooms.com > *license	http
**ingroup core **copyright Darko Miletic< dmiletic @moodlerooms.com > *license	http
$CFG	httpswwwroot = $CFG->wwwroot
$COURSE	id = 1
	if (!defined( 'MOODLE_INTERNAL'))
	Allows the admin to configure a list of profile fields that are sent/recieved.
	if (!defined( 'MOODLE_INTERNAL'))
	The form for configuring which services are subscribed and published on a host.
	if (!defined( 'MOODLE_INTERNAL'))
	Form class for editing badges preferences.
	if (!empty( $memlimit) and $memlimit !=-1)
const	IGNORE_COMPONENT_CACHE true
const	INCORRECT_FEEDBACK_FOR_OPTIONAL 17
	XML Processing Error.
const	INCORRECT_FEEDBACK_FOR_REQUIRED 16
	XML Processing Error.
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"
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	MDL_PERF false
const	MDL_PERF_TEST false
const	MDL_PERFINC false
const	MDL_PERFTOFOOT false
const	MDL_PERFTOLOG 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	MOODLE_INTERNAL true
	Used by library scripts to check they are being called by Moodle.
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
	This file is used to call any registered externallib function in Moodle.
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.
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	PHPUNIT_TEST false
$config	prefix = 'mdl_'
const	PWRESET_STATUS_ALREADYSENT 4
const	PWRESET_STATUS_NOEMAILSENT 1
const	PWRESET_STATUS_OTHEREMAILSENT 3
const	PWRESET_STATUS_TOKENSENT 2
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	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
trait	core\hook::stoppable_trait
	Moodle specific implementation of Psr\EventDispatcher\StoppableEventInterface interface from PSR-14.
**Library file of miscellaneous general purpose LDAP functions and *data	structures
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.
$CFG	target_release = $release
$CFG	tempdir = $CFG->dataroot.'/temp'
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	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.
font	weight
max	width
$CFG	wwwroot = install_guess_wwwroot()
	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.

Detailed Description

Function Documentation

__construct() [1/3]

filter_manager::__construct ( )

protected

Constructor.

Protected. Use instance() instead.

__construct() [2/3]

filterobject::__construct	(		$phrase,
			$hreftagbegin = '<span class="highlight">',
			$hreftagend = '</span>',
			$casesensitive = false,
			$fullmatch = false,
			$replacementphrase = null,
			$replacementcallback = null,
		array	$replacementcallbackdata = null )

Constructor.

Parameters

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).

__construct() [3/3]

moodle_text_filter::__construct	(		$context,
		array	$localconfig )

Set any context-specific configuration for this filter.

Parameters

context	$context	The current context.
array	$localconfig	Any context-specific configuration for this filter.

abort_all_db_transactions()

abort_all_db_transactions

(

)

Unconditionally abort all database transactions, this function should be called from exception handlers only.

Return values

void

add_event()

add_event

(

)

CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////.

Deprecated

please use calendar_event\create() instead.

add_mod_to_section()

add_mod_to_section

(

)

Deprecated

since 2.4

add_to_log()

add_to_log

(

)

Deprecated

since 2.7 use new events instead

addslashes_js()

addslashes_js

(

$var

)

Does proper javascript quoting.

Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.

Parameters

mixed

$var

String, Array, or Object to add slashes to

Return values

mixed

quoted result

ajaxenabled()

ajaxenabled

(

)

Deprecated

since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.

allow_assign()

allow_assign

(

)

Deprecated

since Moodle 3.4. MDL-50666

allow_override()

allow_override

(

)

Deprecated

since Moodle 3.4. MDL-50666

allow_switch()

allow_switch

(

)

Deprecated

since Moodle 3.4. MDL-50666

apply_filter_chain()

filter_manager::apply_filter_chain ( $text, $filterchain, array $options = array(), array $skipfilters = null )

protected

Apply a list of filters to some content.

Parameters

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.

Return values

string\$text

badge_assemble_notification()

badge_assemble_notification

(

stdClass

$badge

)

Creates single message for all notification and sends it out.

Parameters

object

$badge

A badge which is notified about.

badge_award_criteria_competency_has_records_for_competencies()

badge_award_criteria_competency_has_records_for_competencies

(

$competencyids

)

Check if any badge has records for competencies.

Parameters

array

$competencyids

Array of competencies ids.

Return values

boolean

Return true if competencies were found in any badge.

badge_message_from_template()

badge_message_from_template	(		$message,
			$params )

Replaces variables in a message template and returns text ready to be emailed to a user.

Parameters

string

$message

Message body.

Return values

string

Message with replaced values

badges_add_course_navigation()

badges_add_course_navigation	(	navigation_node	$coursenode,
		stdClass	$course )

Extends the course administration navigation with the Badges page.

Parameters

navigation_node	$coursenode
object	$course

badges_award_handle_manual_criteria_review()

badges_award_handle_manual_criteria_review

(

stdClass

$data

)

Triggered when badge is manually awarded.

Parameters

object

$data

Return values

boolean

badges_bake()

badges_bake	(		$hash,
			$badgeid,
			$userid = 0,
			$pathhash = false )

Bake issued badge.

Parameters

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).

Return values

string|url

Returns either new file path hash or new file URL

badges_calculate_message_schedule()

badges_calculate_message_schedule

(

$schedule

)

Caclulates date for the next message digest to badge creators.

Parameters

in

$schedule

Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.

Return values

int	Timestamp for next cron

badges_change_sortorder_backpacks()

badges_change_sortorder_backpacks	(	int	$backpackid,
		int	$direction )

Moves the backpack in the list one position up or down.

Parameters

int	$backpackid	The backpack identifier to be moved.
int	$direction	The direction (BACKPACK_MOVE_UP/BACKPACK_MOVE_DOWN) where to move the backpack.

Exceptions

moodle_exception

if attempting to use invalid direction value.

badges_check_backpack_accessibility()

badges_check_backpack_accessibility

(

)

Deprecated

Since Moodle 3.11.

badges_create_site_backpack()

badges_create_site_backpack

(

$data

)

Create the site backpack with this data.

Parameters

stdClass

$data

The new backpack data.

Return values

boolean

badges_delete_site_backpack()

badges_delete_site_backpack

(

$id

)

Delete the backpack with this id.

Parameters

integer

$id

The backpack to delete.

Return values

boolean

badges_disconnect_user_backpack()

badges_disconnect_user_backpack

(

$userid

)

Disconnect from the user backpack by deleting the user preferences.

Parameters

integer

$userid

The user to diconnect.

Return values

boolean

badges_download()

badges_download

(

$userid

)

Download all user badges in zip archive.

Parameters

int

$userid

ID of badge owner.

badges_external_create_mapping()

badges_external_create_mapping	(		$sitebackpackid,
			$type,
			$internalid,
			$externalid )

Save the info about which objects we connected with a backpack before.

Parameters

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.

Return values

boolean

badges_external_delete_mapping()

badges_external_delete_mapping	(		$sitebackpackid,
			$type,
			$internalid )

Delete a specific external mapping information for a backpack.

Parameters

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.

Return values

boolean

badges_external_delete_mappings()

badges_external_delete_mappings

(

$sitebackpackid

)

Delete all external mapping information for a backpack.

Parameters

integer

$sitebackpackid

The site backpack to connect to.

Return values

boolean

badges_external_get_mapping()

badges_external_get_mapping	(		$sitebackpackid,
			$type,
			$internalid,
			$param = 'externalid' )

Used to remember which objects we connected with a backpack before.

Parameters

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.

Return values

mixed

The id or false if it doesn't exist.

badges_generate_badgr_open_url()

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.

Parameters

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

Return values

string

The public URL to access Badgr objects

badges_get_badge_api_versions()

badges_get_badge_api_versions

(

)

List the supported badges api versions.

Return values

array(version)

badges_get_badge_by_hash()

badges_get_badge_by_hash

(

string

$hash

)

Get badge by hash.

Parameters

string

$hash

Return values

object|bool

badges_get_badges()

badges_get_badges	(		$type,
			$courseid = 0,
			$sort = '',
			$dir = '',
			$page = 0,
			$perpage = BADGE_PERPAGE,
			$user = 0 )

Get all badges.

Parameters

	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

Return values

array\$badge

Array of records matching criteria

badges_get_default_issuer()

badges_get_default_issuer

(

)

Get the default issuer for a badge from this site.

Return values

array

badges_get_issued_badge_info()

badges_get_issued_badge_info

(

)

Deprecated

since Moodle 2.6

badges_get_oauth2_service_options()

badges_get_oauth2_service_options

(

)

Get OAuth2 services for the external backpack.

Return values

array

Exceptions

coding_exception

Deprecated

since 4.3.

badges_get_site_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)

Parameters

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

Return values

stdClass

badges_get_site_backpacks()

badges_get_site_backpacks

(

)

List the backpacks at site level.

Return values

array(stdClass)

badges_get_site_primary_backpack()

badges_get_site_primary_backpack

(

)

Get the primary backpack for the site.

Return values

stdClass

badges_get_user_backpack()

badges_get_user_backpack

(

?int

$userid = 0

)

Get the user backpack for the currently logged in user OR the provided user.

Parameters

int | null

$userid

The user whose backpack you're requesting for. If null, get the logged in user's backpack

Return values

mixed

The user's backpack or none.

Exceptions

dml_exception

badges_get_user_badges()

badges_get_user_badges	(		$userid,
			$courseid = 0,
			$page = 0,
			$perpage = 0,
			$search = '',
			$onlypublic = false )

Get badges for a specific user.

Parameters

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

Return values

array

of badges ordered by decreasing date of issue

badges_handle_course_deletion()

badges_handle_course_deletion

(

$courseid

)

Handles what happens to the course badges when a course is deleted.

Parameters

int

$courseid

course ID.

Return values

void.

badges_list_criteria()

badges_list_criteria

(

$enabled = true

)

Return all the enabled criteria types for this site.

Parameters

boolean

$enabled

Return values

array

badges_local_backpack_js()

badges_local_backpack_js

(

)

Deprecated

Since Moodle 3.11.

badges_notify_badge_award()

badges_notify_badge_award	(	badge	$badge,
			$userid,
			$issued,
			$filepathhash )

Sends notifications to users about awarded badges.

Parameters

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()

badges_open_badges_backpack_api

(

?int

$backpackid = null

)

Is any backpack enabled that supports open badges V1?

Parameters

int | null

$backpackid

Check the version of the given id OR if null the sitewide backpack

Return values

boolean

badges_prepare_badge_for_external()

badges_prepare_badge_for_external	(	stdClass	$badge,
		stdClass	$user )

Update badge instance to external functions.

Parameters

stdClass	$badge
stdClass	$user

Return values

object

badges_process_badge_image()

badges_process_badge_image	(	badge	$badge,
			$iconfile )

Process badge image from form data.

Parameters

badge	$badge	Badge object
string	$iconfile	Original file

badges_save_backpack_credentials()

badges_save_backpack_credentials

(

stdClass

$data

)

Create a backpack with the provided details.

Stores the auth details of the backpack

Parameters

stdClass

$data

Backpack specific data.

Return values

int	The id of the external backpack that the credentials correspond to

badges_save_external_backpack()

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.

Parameters

stdClass

$data

The backpack data we are updating/inserting

Return values

int	Returns the id of the new/updated record

badges_send_verification_email()

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.

Parameters

string	$email	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

Return values

true	if the email was sent successfully, false otherwise.

badges_setup_backpack_js()

badges_setup_backpack_js

(

)

Deprecated

Since Moodle 3.11.

badges_update_site_backpack()

badges_update_site_backpack	(		$id,
			$data )

Update the backpack with this id.

Parameters

integer	$id	The backpack to edit
stdClass	$data	The new backpack data.

Return values

boolean

badges_user_has_backpack()

badges_user_has_backpack

(

$userid

)

Checks if user has external backpack connected.

Parameters

int

$userid

ID of a user.

Return values

bool	True|False whether backpack connection exists.

badges_verify_backpack()

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.

Parameters

int

$backpackid

Backpack identifier to verify.

Return values

string

The result of the verification process.

badges_verify_site_backpack()

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.

Return values

string

block_add_block_ui()

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.

Return values

block_contents

an appropriate block_contents, or null if the user cannot add any blocks here.

block_instance()

block_instance	(		$blockname,
			$instance = NULL,
			$page = NULL )

Creates a new instance of the specified block class.

Parameters

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.

Return values

block_base

the requested block instance.

block_instance_by_id()

block_instance_by_id

(

$blockinstanceid

)

Returns a new instance of the specified block instance id.

Parameters

int

$blockinstanceid

Return values

block_base

the requested block instance.

block_load_class()

block_load_class

(

$blockname

)

Load the block class for a particular type of block.

Parameters

string

$blockname

the name of the block.

Return values

boolean

success or failure.

block_method_result()

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.

Parameters

string	$blockname	the name of the block.
string	$method	the method name.
array	$param	parameters to pass to the method.

Return values

mixed

whatever the method returns.

blocks_add_default_course_blocks()

blocks_add_default_course_blocks

(

$course

)

Add the default blocks to a course.

Parameters

object

$course

a course object.

blocks_add_default_system_blocks()

blocks_add_default_system_blocks

(

)

Add the default system-context blocks.

E.g. the admin tree.

blocks_delete_all_for_context()

blocks_delete_all_for_context

(

$contextid

)

Delete all the blocks that belong to a particular context.

Parameters

int

$contextid

the context id.

blocks_delete_instance()

blocks_delete_instance	(		$instance,
			$nolongerused = false,
			$skipblockstables = false )

Delete a block, and associated data.

Parameters

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

See also

blocks_delete_all_for_context() more efficient.

blocks_delete_instances()

blocks_delete_instances

(

$instanceids

)

Delete multiple blocks at once.

Parameters

array

$instanceids

A list of block instance ID.

blocks_find_block()

blocks_find_block	(		$blockid,
			$blocksarray )

Find a given block by its blockid within a provide array.

Parameters

int	$blockid
array	$blocksarray

Return values

bool|object

Instance if found else false

blocks_get_default_site_course_blocks()

blocks_get_default_site_course_blocks

(

)

Return values

array

the blocks that should be added to the site course by default.

blocks_get_record()

blocks_get_record	(		$blockid = NULL,
			$notusedanymore = false )

Get the block record for a particular blockid - that is, a particular type os block.

Parameters

	$int	blockid block type id. If null, an array of all block types is returned.
bool	$notusedanymore	No longer used.

Return values

array|object

row from block table, or all rows.

blocks_name_allowed_in_format()

blocks_name_allowed_in_format	(		$name,
			$pageformat )

Check that a given name is in a permittable format.

Parameters

string	$name
string	$pageformat

Return values

bool

blocks_parse_default_blocks_list()

blocks_parse_default_blocks_list

(

$blocksstr

)

Parse a list of default blocks.

See config-dist for a description of the format.

Parameters

string

$blocksstr

Determines the starting point that the blocks are added in the region.

Return values

array

the parsed list of default blocks

blocks_remove_inappropriate()

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.

Todo

Write/Fix this function. Currently returns immediately

Parameters

$course

blocks_set_visibility()

blocks_set_visibility	(		$instance,
			$page,
			$newvisibility )

Set a block to be visible or hidden on a particular page.

Parameters

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()

blog_get_context_url

(

)

Deprecated

since Moodle 2.5 MDL-27814 - please do not use this function any more.

break_up_long_words()

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.

Parameters

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

Return values

string

build_context_path()

build_context_path

(

)

Deprecated

since 2.2

build_logs_array()

build_logs_array

(

)

Deprecated

since Moodle 3.2

build_navigation()

build_navigation

(

)

Deprecated

Please use $PAGE->navabar methods instead.

calculate_user_dst_table()

calculate_user_dst_table

(

)

Deprecated

since Moodle 2.9

calendar_cron()

calendar_cron

(

)

Deprecated

since 3.3

calendar_get_all_allowed_types()

calendar_get_all_allowed_types

(

)

Deprecated

since 3.6

calendar_get_block_upcoming()

calendar_get_block_upcoming

(

)

Deprecated

since 3.3

calendar_get_mini()

calendar_get_mini

(

)

Deprecated

since Moodle 3.4. MDL-59333

calendar_get_upcoming()

calendar_get_upcoming

(

)

Deprecated

since Moodle 3.4. MDL-59333

calendar_import_icalendar_events()

calendar_import_icalendar_events	(		$ical,
			$unused = null,
			$subscriptionid = null )

Import events from an iCalendar object into a course calendar.

Parameters

iCalendar	$ical	The iCalendar object.
int	$unused	Deprecated
int	$subscriptionid	The subscription ID.

Return values

string

A log of the import progress, including errors.

calendar_normalize_tz()

calendar_normalize_tz

(

)

Deprecated

since Moodle 2.9

calendar_preferences_button()

calendar_preferences_button

(

)

Deprecated

since Moodle 3.2

calendar_print_month_selector()

calendar_print_month_selector

(

)

Deprecated

since 3.3

calendar_process_subscription_row()

calendar_process_subscription_row	(		$subscriptionid,
			$pollinterval,
			$action )

Update a subscription from the form data in one of the rows in the existing subscriptions table.

Parameters

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.

Exceptions

dml_exception

if invalid subscriptionid is provided

Return values

string

A log of the import progress, including errors

Deprecated

since Moodle 4.0 MDL-71953

calendar_wday_name()

calendar_wday_name

(

)

Deprecated

since 3.3

can_use_html_editor()

can_use_html_editor

(

)

Deprecated

since 2.6

can_use_rotated_text()

can_use_rotated_text

(

)

Deprecated

since 2.5 - do not use, the textrotate.js will work it out automatically

category_delete_full()

category_delete_full

(

)

Deprecated

since 2.5

category_delete_move()

category_delete_move

(

)

Deprecated

since 2.5

check_browser_operating_system()

check_browser_operating_system

(

)

Deprecated

since 2.6

check_browser_version()

check_browser_version

(

)

Deprecated

since 2.6

check_dir_exists()

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.

Parameters

string	$dir	absolute directory path
boolean	$create	directory if does not exist
boolean	$recursive	create directory recursively

Return values

boolean

true if directory exists or created, false otherwise

check_gd_version()

check_gd_version

(

)

Deprecated

check_moodle_environment()

check_moodle_environment	(		$version,
			$env_select = ENV_SELECT_NEWER )

This function checks all the requirements defined in environment.xml.

Parameters

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)

Return values

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.

choose_from_menu()

choose_from_menu

(

)

Deprecated

since Moodle 2.0

clam_change_log()

clam_change_log

(

)

Deprecated

since 2.7 - use new file picker instead

clam_handle_infected_file()

clam_handle_infected_file

(

)

Deprecated

since 2.7

clam_log_infected()

clam_log_infected

(

)

Deprecated

since 2.7 - use new file picker instead

clam_log_upload()

clam_log_upload

(

)

Deprecated

since 2.7 - use new file picker instead

clam_message_admins()

clam_message_admins

(

)

Deprecated

since Moodle 3.0 - this is a part of clamav plugin now.

clam_replace_infected_file()

clam_replace_infected_file

(

)

Deprecated

since 2.7 - infected files are now deleted in file picker

clam_scan_moodle_file()

clam_scan_moodle_file

(

)

Deprecated

since 2.7

clean_text()

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.

Parameters

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)

Return values

string

The cleaned up text

cleanup_contexts()

cleanup_contexts

(

)

Deprecated

since 2.2

cli_error()

cli_error	(		$text,
			$errorcode = 1 )

Write to standard error output and exit with the given code.

Parameters

string	$text
int	$errorcode

Return values

void	(does not return)

cli_get_params()

cli_get_params	(	array	$longoptions,
		array	$shortmapping = null )

Returns cli script parameters.

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')

Return values

array

array of arrays, options, unrecognised as optionlongname=>value

cli_heading()

cli_heading	(		$string,
			$return = false )

Print or return section heading string.

Parameters

string	$string	text
bool	$return	false means print, true return as string

Return values

mixed

void or string

cli_input()

cli_input	(		$prompt,
			$default = '',
		array	$options = null,
			$casesensitiveoptions = false )

Get input from user.

Parameters

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

Return values

string

entered text

cli_logo()

cli_logo	(		$padding = 2,
			$return = false )

Print an ASCII version of the Moodle logo.

Parameters

int	$padding	left padding of the logo
bool	$return	should we print directly (false) or return the string (true)

Return values

mixed

void or string

cli_problem()

cli_problem

(

$text

)

Write error notification.

Parameters

$text

Return values

void

cli_separator()

cli_separator

(

$return = false

)

Print or return section separator string.

Parameters

bool

$return

false means print, true return as string

Return values

mixed

void or string

cli_set_process_title_suffix()

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.

Parameters

string

$suffix

process suffix

cli_write()

cli_write	(		$text,
			$stream = STDOUT )

Command line utility functions and classes.

Copyright

2009 Petr Skoda (http://skodak.org)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Write a text to the given stream

Parameters

string	$text	text to be written
resource	$stream	output stream to be written to, defaults to STDOUT

cli_writeln()

cli_writeln	(		$text,
			$stream = STDOUT )

Write a text followed by an end of line symbol to the given stream.

Parameters

string	$text	text to be written
resource	$stream	output stream to be written to, defaults to STDOUT

close_window()

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

Parameters

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()

cohort_get_visible_list

(

)

Deprecated

since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead

completion_cron()

completion_cron

(

)

Deprecated

since Moodle 3.0 MDL-50287 - please do not use this function any more.

confirm_sesskey()

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.

Parameters

string

$sesskey

The sesskey value to check (optional). Normally leave this blank and this function will do required_param('sesskey', ...).

Return values

bool	whether the sesskey sent in the request matches the one stored in the session.

content_to_text()

content_to_text	(		$content,
			$contentformat )

Converts texts or strings to plain text.

• When used to convert user input introduced in an editor the text format needs to be passed in $contentformat like we usually do in format_text.
• When this function is used for strings that are usually passed through format_string before displaying them we need to set $contentformat to false. This will execute html_to_text as these strings can contain multilang tags if multilang filter is applied to headings.

Parameters

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

Return values

string

Plain text.

context_instance_preload()

context_instance_preload

(

)

Deprecated

since 2.2

context_instance_preload_sql()

context_instance_preload_sql

(

)

Deprecated

since 2.2

context_moved()

context_moved

(

)

Deprecated

since Moodle 2.2

convert_tabrows_to_tree()

convert_tabrows_to_tree

(

)

Deprecated

since 2.5

convert_tree_to_html()

convert_tree_to_html

(

)

Deprecated

since 2.5

core_login_extend_change_password_form()

core_login_extend_change_password_form	(		$mform,
			$user )

Plugins can extend forms.

Inject form elements into change_password_form.

Parameters

mform	$mform	the form to inject elements into.
stdClass	$user	the user object to use for context.

core_login_extend_forgot_password_form()

core_login_extend_forgot_password_form

(

$mform

)

Inject form elements into forgot_password_form.

Parameters

mform

$mform

the form to inject elements into.

core_login_extend_set_password_form()

core_login_extend_set_password_form	(		$mform,
			$user )

Inject form elements into set_password_form.

Parameters

mform	$mform	the form to inject elements into.
stdClass	$user	the user object to use for context.

core_login_extend_signup_form()

core_login_extend_signup_form

(

$mform

)

Inject form elements into signup_form.

Parameters

mform

$mform

the form to inject elements into.

core_login_generate_password_reset()

core_login_generate_password_reset

(

$user

)

Create a new record in the database to track a new password set request for user.

Parameters

object

$user

the user record, the requester would like a new password set for.

Return values

record

created.

core_login_get_return_url()

core_login_get_return_url

(

)

Determine where a user should be redirected after they have been logged in.

Return values

string

url the user should be redirected to.

core_login_post_change_password_requests()

core_login_post_change_password_requests

(

$data

)

Plugins can perform post submission actions.

Post change_password_form submission actions.

Parameters

stdClass

$data

the data object from the submitted form.

core_login_post_forgot_password_requests()

core_login_post_forgot_password_requests

(

$data

)

Post forgot_password_form submission actions.

Parameters

stdClass

$data

the data object from the submitted form.

core_login_post_set_password_requests()

core_login_post_set_password_requests	(		$data,
			$user )

Post set_password_form submission actions.

Parameters

stdClass	$data	the data object from the submitted form.
stdClass	$user	the user object for set_password context.

core_login_post_signup_requests()

core_login_post_signup_requests

(

$data

)

Post signup_form submission actions.

Parameters

stdClass

$data

the data object from the submitted form.

core_login_process_password_reset()

core_login_process_password_reset	(		$username,
			$email )

Process the password reset for the given user (via username or email).

Parameters

string	$username	the user name
string	$email	the user email

Return values

array

an array containing fields indicating the reset status, a info notice and redirect URL.

Since

Moodle 3.4

core_login_process_password_reset_request()

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()

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.

Parameters

string

$token

the one-use identifier which should verify the password reset request as being valid.

Return values

void

core_login_validate_extend_change_password_form()

core_login_validate_extend_change_password_form	(		$data,
			$user )

Plugins can add additional validation to forms.

Inject validation into change_password_form.

Parameters

array	$data	the data array from submitted form values.
stdClass	$user	the user object to use for context.

Return values

array\$errors

the updated array of errors from validation.

core_login_validate_extend_forgot_password_form()

core_login_validate_extend_forgot_password_form

(

$data

)

Inject validation into forgot_password_form.

Parameters

array

$data

the data array from submitted form values.

Return values

array\$errors

the updated array of errors from validation.

core_login_validate_extend_set_password_form()

core_login_validate_extend_set_password_form	(		$data,
			$user )

Inject validation into set_password_form.

Parameters

array	$data	the data array from submitted form values.
stdClass	$user	the user object to use for context.

Return values

array\$errors

the updated array of errors from validation.

core_login_validate_extend_signup_form()

core_login_validate_extend_signup_form

(

$data

)

Inject validation into signup_form.

Parameters

array

$data

the data array from submitted form values.

Return values

array\$errors

the updated array of errors from validation.

core_login_validate_forgot_password_data()

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.

Parameters

array

$data

array containing the data to be validated (email and username)

Return values

array

array of errors compatible with mform

Since

Moodle 3.4

core_myprofile_navigation()

core_myprofile_navigation	(	core_user\output\myprofile\tree	$tree,
			$user,
			$iscurrentuser,
			$course )

Defines core nodes for my profile navigation tree.

Parameters

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

Return values

bool

count_enrolled_users()

count_enrolled_users	(	context	$context,
			$withcapability = '',
			$groupids = 0,
			$onlyactive = false )

Counts list of users enrolled into course (as per above function)

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

Return values

int	number of users enrolled into course

count_login_failures()

count_login_failures

(

)

Deprecated

since Moodle 2.7, use user_count_login_failures() instead.

course_category_hide()

course_category_hide

(

)

Deprecated

since 2.5

course_category_show()

course_category_show

(

)

Deprecated

since 2.5

course_get_cm_rename_action()

course_get_cm_rename_action

(

)

Deprecated

since 3.1

course_scale_used()

course_scale_used

(

)

Deprecated

since Moodle 3.1

coursemodule_visible_for_user()

coursemodule_visible_for_user

(

)

Deprecated

Since Moodle 2.7 MDL-44070

coursetag_delete_course_tags()

coursetag_delete_course_tags

(

)

Deprecated

since 3.0

coursetag_delete_keyword()

coursetag_delete_keyword

(

)

Deprecated

since 3.0

coursetag_get_all_tags()

coursetag_get_all_tags

(

)

Deprecated

since 3.0

coursetag_get_jscript()

coursetag_get_jscript

(

)

Deprecated

since 3.0

coursetag_get_jscript_links()

coursetag_get_jscript_links

(

)

Deprecated

since 3.0

coursetag_get_records()

coursetag_get_records

(

)

Deprecated

since 3.0

coursetag_get_tagged_courses()

coursetag_get_tagged_courses

(

)

Deprecated

since 3.0

coursetag_get_tags()

coursetag_get_tags

(

)

Deprecated

since 3.0

coursetag_store_keywords()

coursetag_store_keywords

(

)

Deprecated

since 3.0

create_contexts()

create_contexts

(

)

Deprecated

since 2.2

create_course_category()

create_course_category

(

)

Deprecated

since 2.5

cron_bc_hack_plugin_functions()

cron_bc_hack_plugin_functions

(

)

Deprecated

since Moodle 3.9 MDL-52846. Please use new task API.

cron_execute_plugin_type()

cron_execute_plugin_type

(

)

Deprecated

since Moodle 3.9 MDL-52846. Please use new task API.

cron_prepare_core_renderer()

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.

Parameters

bool

$restore

Whether to restore the original PAGE and OUTPUT

Deprecated

since 4.2 Use core\cron\prepare_core_renderer() instead.

cron_run()

cron_run

(

?int

$keepalive = null

)

Execute cron tasks.

Parameters

int | null

$keepalive

The keepalive time for this cron run.

Deprecated

since 4.2 Use core\cron\run_main_process() instead.

cron_run_adhoc_tasks()

cron_run_adhoc_tasks	(	int	$timenow,
			$keepalive = 0,
			$checklimits = true )

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

Parameters

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?

Deprecated

since 4.2 Use core\cron\run_adhoc_tasks() instead.

cron_run_inner_adhoc_task()

cron_run_inner_adhoc_task

(

\core\task\adhoc_task

$task

)

Shared code that handles running of a single adhoc task within the cron.

Parameters

core\task\adhoc_task

$task

Deprecated

since 4.2 Use core\cron\run_inner_adhoc_task() instead.

cron_run_inner_scheduled_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!

Parameters

core\task\task_base

$task

Deprecated

since 4.2 Use core\cron\run_inner_scheduled_task() instead.

cron_run_scheduled_tasks()

cron_run_scheduled_tasks

(

int

$timenow

)

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

Parameters

int

$timenow

The time this process started.

Deprecated

since 4.2 Use core\cron\run_scheduled_tasks() instead.

cron_run_single_task()

cron_run_single_task

(

)

Deprecated

since Moodle 3.9 MDL-63580. Please use the core\task\manager\run_from_cli($task).

cron_set_process_title()

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.

Parameters

string

$title

process status title

Deprecated

since 4.2 Use core\cron\set_process_title() instead.

cron_setup_user()

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!

Parameters

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

Deprecated

since 4.2. Use core\core\setup_user() instead.

Return values

void

cron_trace_time_and_memory()

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.

Deprecated

since 4.2 Use core\cron\trace_time_and_memory() instead.

css_is_colour()

css_is_colour

(

)

Deprecated

since Moodle 3.2

css_is_width()

css_is_width

(

)

Deprecated

since Moodle 3.2

css_minify_css()

css_minify_css

(

)

Deprecated

since 2.6

css_send_cached_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.

Parameters

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()

css_send_cached_css_content	(		$csscontent,
			$etag )

Sends a cached CSS content.

Parameters

string	$csscontent	The actual CSS markup.
string	$etag	The revision to make sure we utilise any caches.

css_send_temporary_css()

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.

Parameters

string

$css

The CSS content to send

css_send_uncached_css()

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.

Parameters

string

$css

css_send_unmodified()

css_send_unmodified	(		$lastmodified,
			$etag )

Send file not modified headers.

Parameters

int	$lastmodified
string	$etag

css_sort_by_count()

css_sort_by_count

(

)

Deprecated

since Moodle 3.2

css_store_css()

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.

Parameters

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()

css_write_file	(		$filename,
			$content )

Writes a CSS file.

Parameters

string	$filename
string	$content

current_theme()

current_theme

(

)

Deprecated

use $PAGE->theme->name instead.

data_submitted()

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.

Return values

mixed

false or object

debugging()

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.

Parameters

string	$message	a message to print
int	$level	the level at which this debugging statement should show
array	$backtrace	use different backtrace

Return values

bool

dedupe_user_access()

dedupe_user_access

(

)

Deprecated

since Moodle 3.4 and removed immediately. MDL-49398.

default_error_handler()

default_error_handler	(		$errno,
			$errstr,
			$errfile,
			$errline )

Default error handler, prevents some white screens.

Parameters

int	$errno
string	$errstr
string	$errfile
int	$errline

Return values

bool	false means use default error handler

default_exception_handler()

default_exception_handler

(

$ex

)

Default exception handler.

Parameters

Exception

$ex

Return values

void	-does not return. Terminates execution!

default_page_type_list()

default_page_type_list	(		$pagetype,
			$parentcontext = null,
			$currentcontext = null )

Generates a default page type list when a more appropriate callback cannot be decided upon.

Parameters

string	$pagetype
stdClass	$parentcontext
stdClass	$currentcontext

Return values

array

delete_context()

delete_context

(

)

Deprecated

since Moodle 2.2

delete_course_module()

delete_course_module

(

)

Deprecated

since 2.5

delete_event()

delete_event

(

)

Deprecated

please use calendar_event->delete() instead.

detect_munged_arguments()

detect_munged_arguments

(

)

Deprecated

use clean_param($string, PARAM_FILE) instead.

display_auth_lock_options()

display_auth_lock_options	(		$settings,
			$auth,
			$userfields,
			$helptext,
			$mapremotefields,
			$updateremotefields,
			$customfields = array() )

Helper function used to print locking for auth plugins on admin pages.

Parameters

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

Since

Moodle 3.3

dndupload_add_to_course()

dndupload_add_to_course	(		$course,
			$modnames )

Add the Javascript to enable drag and drop upload to a course page.

Parameters

object	$course	The currently displayed course
array	$modnames	The list of enabled (visible) modules on this site

Return values

void

download_as_dataformat()

download_as_dataformat	(		$filename,
			$dataformat,
			$columns,
			$iterator,
			$callback = null )

dataformatlib.php - Contains core dataformat related functions.

Copyright

2016 Brendan Heywood (brend.nosp@m.an@c.nosp@m.ataly.nosp@m.st-a.nosp@m.u.net)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Sends a formated data file to the browser

Parameters

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

Exceptions

coding_exception

Deprecated

since Moodle 3.9 - MDL-68500 please use core\dataformat\download_data

dst_changes_for_year()

dst_changes_for_year

(

)

Deprecated

since Moodle 2.9

during_initial_install()

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.

Return values

boolean

true if the initial install is not complete.

editors_get_available()

editors_get_available

(

)

Get the list of available editors.

Return values

array

Array ('editorname'=>'localised editor name')

editors_get_enabled()

editors_get_enabled

(

)

Returns list of enabled text editors.

Return values

array

of name=>texteditor

editors_get_preferred_editor()

editors_get_preferred_editor

(

$format = NULL

)

Returns users preferred editor for given format.

Parameters

int

$format

text format or null of none

Return values

texteditor

object

editors_get_preferred_format()

editors_get_preferred_format

(

)

Returns users preferred text format.

Return values

int	standard text format

editors_head_setup()

editors_head_setup

(

)

Setup all JS and CSS needed for editors.

Return values

void

enrol_accessing_via_instance()

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.

Parameters

stdClass

$instance

enrol instance

Return values

bool

enrol_add_course_navigation()

enrol_add_course_navigation	(	navigation_node	$coursenode,
			$course )

Add navigation nodes.

Parameters

navigation_node	$coursenode
object	$course

Return values

void

enrol_calculate_duration()

enrol_calculate_duration	(		$timestart,
			$timeend )

Calculate duration base on start time and end time.

Parameters

int	$timestart	Time start
int	$timeend	Time end

Return values

float|int

Calculated duration

enrol_check_plugins()

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.

Parameters

stdClass	$user	User object.
bool	$ignoreintervalcheck	Force to ignore checking configured sync intervals.

Return values

void

enrol_cohort_can_view_cohort()

enrol_cohort_can_view_cohort

(

)

Deprecated

since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()

enrol_cohort_enrol_all_users()

enrol_cohort_enrol_all_users

(

)

Deprecated

since Moodle 2.8 MDL-35618 this functionality is removed

enrol_cohort_get_cohorts()

enrol_cohort_get_cohorts

(

)

Deprecated

since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed

enrol_cohort_search_cohorts()

enrol_cohort_search_cohorts

(

)

Deprecated

since Moodle 2.8 MDL-35618 this functionality is removed

enrol_course_delete()

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.

Parameters

stdClass	$course
int | null	$userid

Return values

void

enrol_course_edit_form()

enrol_course_edit_form	(	MoodleQuickForm	$mform,
			$data,
			$context )

This function adds necessary enrol plugins UI into the course edit form.

Parameters

MoodleQuickForm	$mform
object	$data	course edit form data
object	$context	context of existing course or parent category if course does not exist

Return values

void

enrol_course_edit_validation()

enrol_course_edit_validation	(	array	$data,
			$context )

Validate course edit form data.

Parameters

array	$data	raw form data
object	$context	context of existing course or parent category if course does not exist

Return values

array

errors array

enrol_course_updated()

enrol_course_updated	(		$inserted,
			$course,
			$data )

Update enrol instances after course edit form submission.

Parameters

bool	$inserted	true means new course added, false course already existed
object	$course
object	$data	form data

Return values

void

enrol_get_all_users_courses()

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.

Parameters

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.

Return values

array

enrol_get_course_by_user_enrolment_id()

enrol_get_course_by_user_enrolment_id

(

$ueid

)

Returns the course where a user enrolment belong to.

Parameters

int

$ueid

user_enrolments id

Return values

stdClass

enrol_get_course_description_texts()

enrol_get_course_description_texts

(

$course

)

Returns course enrolment detailed information.

Parameters

object

$course

Return values

array

of html fragments - can be used to construct lists

enrol_get_course_info_icons()

enrol_get_course_info_icons	(		$course,
		array	$instances = NULL )

Returns course enrolment information icons.

Parameters

object	$course
array	$instances	enrol instances of this course, improves performance

Return values

array

of pix_icon

enrol_get_course_users()

enrol_get_course_users	(		$courseid = false,
			$onlyactive = false,
			$usersfilter = [],
			$uefilter = [],
			$usergroups = [] )

Return all users enrolled in a course.

Parameters

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.

Return values

stdClass[]

enrol_get_course_users_roles()

enrol_get_course_users_roles

(

int

$courseid

)

Returns list of roles per users into course.

Parameters

int

$courseid

Course id.

Return values

array

Array[$userid][$roleid] = role_assignment.

enrol_get_courses_sortingsql()

enrol_get_courses_sortingsql

(

$sort = null

)

Returns SQL ORDER arguments which reflect the admin settings to sort my courses.

Parameters

string | null

$sort

SQL ORDER arguments which were originally requested (optionally).

Return values

string

SQL ORDER arguments.

enrol_get_enrolment_end()

enrol_get_enrolment_end	(		$courseid,
			$userid )

This function returns the end of current active user enrolment.

It deals correctly with multiple overlapping user enrolments.

Parameters

int	$courseid
int	$userid

Return values

int|bool

timestamp when active enrolment ends, false means no active enrolment now, 0 means never

enrol_get_instances()

enrol_get_instances	(		$courseid,
			$enabled )

Returns enrolment instances in given course.

Parameters

int	$courseid
bool	$enabled

Return values

array

of enrol instances

enrol_get_my_courses()

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).

Parameters

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

Return values

array

enrol_get_period_list()

enrol_get_period_list

(

)

Get the list of options for the enrolment period dropdown.

Return values

array

List of options for the enrolment period dropdown

enrol_get_plugin()

enrol_get_plugin

(

$name

)

Returns instance of enrol plugin.

Parameters

string

$name

name of enrol plugin ('manual', 'guest', ...)

Return values

enrol_plugin

enrol_get_plugins()

enrol_get_plugins

(

$enabled

)

Returns instances of enrol plugins.

Parameters

bool

$enabled

return enabled only

Return values

array

of enrol plugins name=>instance

enrol_get_shared_courses()

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

Parameters

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.

Return values

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()

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.

Parameters

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.

Return values

array

enrol_is_enabled()

enrol_is_enabled

(

$enrol

)

Checks if a given plugin is in the list of enabled enrolment plugins.

Parameters

string

$enrol

Enrolment plugin name

Return values

boolean

Whether the plugin is enabled

enrol_output_fragment_user_enrolment_form()

enrol_output_fragment_user_enrolment_form

(

$args

)

Serve the user enrolment form as a fragment.

Parameters

array

$args

List of named arguments for the fragment loader.

Return values

string

enrol_selfenrol_available()

enrol_selfenrol_available

(

$courseid

)

Is there a chance users might self enrol.

Parameters

int

$courseid

Return values

bool

enrol_send_welcome_email_options()

enrol_send_welcome_email_options

(

)

Send welcome email "from" options.

Return values

array

list of from options

enrol_sharing_course()

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 {

See also

enrol_get_shared_courses()} setting checkexistsonly to true.

Parameters

stdClass | int	$user1
stdClass | int	$user2

Return values

bool

enrol_try_internal_enrol()

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

Parameters

$courseid
$userid
$roleid
$timestart
$timeend

Return values

bool

success

enrol_user_delete()

enrol_user_delete

(

$user

)

Called when user is about to be deleted.

Parameters

object

$user

Return values

void

enrol_user_sees_own_courses()

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!

Parameters

int | stdClass

$user

null means use current user

Return values

bool

environment_check()

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.

Parameters

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.

Return values

environment_results[]

array of results encapsulated in one environment_result object

environment_check_database()

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

Parameters

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.

Return values

object

results encapsulated in one environment_result object

environment_check_moodle()

environment_check_moodle	(		$version,
			$env_select )

This function will check if Moodle requirements are satisfied.

@uses NO_VERSION_DATA_FOUND

Parameters

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.

Return values

object

results encapsulated in one environment_result object

environment_check_pcre_unicode()

environment_check_pcre_unicode	(		$version,
			$env_select )

Looks for buggy PCRE implementation, we need unicode support in Moodle...

Parameters

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.

Return values

stdClass

results encapsulated in one environment_result object, null if irrelevant

environment_check_php()

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

Parameters

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.

Return values

object

results encapsulated in one environment_result object

environment_check_php_extensions()

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

Parameters

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.

Return values

array

array of results encapsulated in one environment_result object

environment_check_php_settings()

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

Parameters

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.

Return values

array

array of results encapsulated in one environment_result object

environment_check_unicode()

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

Parameters

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.

Return values

object

results encapsulated in one environment_result object

environment_custom_checks()

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

Parameters

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.

Return values

array

array of results encapsulated in environment_result objects.

environment_get_errors()

environment_get_errors

(

$environment_results

)

Returns array of critical errors in plain text format.

Parameters

array

$environment_results

array of results gathered

Return values

array

errors

environment_verify_plugin()

environment_verify_plugin	(		$plugin,
			$pluginxml )

Checks if a plugin tag has a name attribute and it matches the plugin being tested.

Parameters

string	$plugin	the name of the plugin.
array	$pluginxml	the xmlised structure for the plugin tag being tested.

Return values

boolean

true if the name attribute exists and matches the plugin being tested.

error()

error

(

)

Deprecated

since 2.0

events_cleanup()

events_cleanup

(

)

Deprecated

since Moodle 3.6. Please use the Events 2 API.

events_cron()

events_cron

(

)

Deprecated

since Moodle 3.1

events_dequeue()

events_dequeue

(

)

Deprecated

since Moodle 3.6. Please use the Events 2 API.

events_dispatch()

events_dispatch

(

)

Deprecated

since Moodle 3.1

events_get_cached()

events_get_cached

(

)

Deprecated

since Moodle 3.6. Please use the Events 2 API.

events_get_handlers()

events_get_handlers

(

)

Deprecated

since Moodle 3.6. Please use the Events 2 API.

events_is_registered()

events_is_registered

(

)

Deprecated

since Moodle 3.1

events_load_def()

events_load_def

(

)

Deprecated

since Moodle 3.1

events_pending_count()

events_pending_count

(

)

Deprecated

since Moodle 3.1

events_process_queued_handler()

events_process_queued_handler

(

)

Deprecated

since Moodle 3.1

events_queue_handler()

events_queue_handler

(

)

Deprecated

since Moodle 3.1

events_trigger()

events_trigger

(

)

Deprecated

since 2.6

events_trigger_legacy()

events_trigger_legacy

(

)

Deprecated

since Moodle 3.1

events_uninstall()

events_uninstall

(

)

Deprecated

since Moodle 3.6. Please use the Events 2 API.

events_update_definition()

events_update_definition

(

)

Deprecated

since Moodle 3.1

external_function_info()

external_function_info

(

)

Deprecated

since Moodle 3.1. Use external_api\external_function_info().

extract_draft_file_urls_from_text()

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.

Parameters

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.

Return values

array

fetch_context_capabilities()

fetch_context_capabilities

(

)

Deprecated

since 2.2

filter()

moodle_text_filter::filter ( $text, array $options = array() )

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.

Parameters

string	$text	some HTML content to process.
array	$options	options passed to the filters

Return values

string

the HTML content after the filtering has been applied.

Reimplemented in filter_activitynames, filter_algebra, filter_codehighlighter, filter_displayh5p, filter_emoticon, filter_glossary, filter_mathjaxloader, filter_mediaplugin, filter_multilang, filter_tidy, and filter_urltolink.

filter_add_javascript()

filter_add_javascript

(

$text

)

Add missing openpopup javascript to HTML files.

Parameters

string

$text

Return values

string

filter_context_may_have_filter_settings()

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.

Parameters

object

$context

a context.

Return values

boolean

whether this context may have local filter settings.

filter_delete_all_for_context()

filter_delete_all_for_context

(

$contextid

)

Delete all the data in the database relating to a context, used when contexts are deleted.

Parameters

integer

$contextid

The id of the context being deleted.

filter_delete_all_for_filter()

filter_delete_all_for_filter

(

$filter

)

Delete all the data in the database relating to a filter, prior to deleting it.

Parameters

string

$filter

The filter name, for example 'tex'.

filter_get_active_in_context()

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.

Parameters

context

$context

a context

Return values

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()

filter_get_active_state	(	string	$filtername,
			$contextid = null )

Returns the active state for a filter in the given context.

Parameters

string	$filtername	The filter name, for example 'tex'.
integer	$contextid	The id of the context to get the data for.

Return values

int	value of active field for the given filter.

filter_get_all_installed()

filter_get_all_installed

(

)

Get the names of all the filters installed in this Moodle.

Return values

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()

filter_get_all_local_settings

(

$contextid

)

This function is for use by backup.

Gets all the filter information specific to one context.

Parameters

int

$contextid

Return values

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()

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.

Parameters

context

$context

a context that is not the system context.

Return values

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()

filter_get_global_states

(

)

This function is for use by the filter administration page.

Return values

array

'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder'

filter_get_globally_enabled()

filter_get_globally_enabled

(

)

Return a list of all the filters that may be in use somewhere.

Return values

array

where the keys and values are both the filter name, like 'tex'.

filter_get_globally_enabled_filters_with_config()

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.

Return values

array

Keys are filter names, and values the config.

filter_get_local_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.

Parameters

string	$filter	The filter name, for example 'tex'.
integer	$contextid	The ID of the context to get the local config for.

Return values

array

of name => value pairs.

filter_get_name()

filter_get_name

(

$filter

)

Look up the name of this filter.

Parameters

string

$filter

the filter name

Return values

string

the human-readable name for this filter.

filter_get_string_filters()

filter_get_string_filters

(

)

Return the names of the filters that should also be applied to strings (when they are enabled).

Return values

array

where the keys and values are both the filter name, like 'tex'.

filter_has_global_settings()

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.)

Parameters

string

$filter

The filter name, for example 'tex'.

Return values

boolean

Whether there should be a 'Settings' link on the config page.

filter_has_local_settings()

filter_has_local_settings

(

$filter

)

Does this filter have local (per-context) settings?

Parameters

string

$filter

The filter name, for example 'tex'.

Return values

boolean

Whether there should be a 'Settings' link on the manage filters in context page.

filter_is_enabled()

filter_is_enabled

(

$filtername

)

Parameters

string

$filtername

The filter name, for example 'tex'.

Return values

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()

filter_phrases	(		$text,
			$linkarray,
			$ignoretagsopen = null,
			$ignoretagsclose = null,
			$overridedefaultignore = false,
			$linkarrayalreadyprepared = false )

Process phrases intelligently found within a HTML text (such as adding links).

Parameters

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.

Return values

string

filter_preload_activities()

filter_preload_activities

(

course_modinfo

$modinfo

)

Preloads the list of active filters for all activities (modules) on the course using two database queries.

Parameters

course_modinfo

$modinfo

Course object from get_fast_modinfo

filter_prepare_phrase_for_replacement()

filter_prepare_phrase_for_replacement

(

filterobject

$linkobject

)

Fill in the remaining ->work... fields, that would be needed to replace the phrase.

Parameters

filterobject

$linkobject

the link object on which to set additional fields.

filter_prepare_phrases_for_filtering()

filter_prepare_phrases_for_filtering

(

array

$linkarray

)

Prepare a list of link for processing with filter_phrases().

Parameters

filterobject[]

$linkarray

the links that will be passed to filter_phrases().

Return values

filterobject[]

the updated list of links with necessary pre-processing done.

filter_remove_duplicates()

filter_remove_duplicates

(

$linkarray

)

Remove duplicate from a list of filterobject.

Parameters

filterobject[]

$linkarray

a list of filterobject.

Return values

filterobject[]

the same list, but with dupicates removed.

filter_save_ignore_tags()

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.

Parameters

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()

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.

Parameters

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_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.

Parameters

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()

filter_set_global_state	(		$filtername,
			$state,
			$move = 0 )

Set the global activated state for a text filter.

Parameters

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_set_local_config	(		$filter,
			$contextid,
			$name,
			$value )

Set a particular local config variable for a filter in a context.

Parameters

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_set_local_state	(		$filter,
			$contextid,
			$state )

Set the local activated state for a text filter.

Parameters

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.

Return values

void

filter_stage_post_clean()

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.

Parameters

string	$text
array	$options

Return values

string

filter_stage_pre_clean()

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.

Parameters

string	$text
array	$options

Return values

string

filter_stage_pre_format()

moodle_text_filter::filter_stage_pre_format	(	string	$text,
		array	$options )

Filter text before changing format to HTML.

Parameters

string	$text
array	$options

Return values

string

filter_stage_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.

Parameters

string	$text
array	$options

Return values

string

filter_string() [1/3]

filter_manager::filter_string	(		$string,
			$context )

Filter a piece of string.

Parameters

string	$string	The text to filter
context	$context	the context.

Return values

string

resulting string

Reimplemented in performance_measuring_filter_manager.

filter_string() [2/3]

null_filter_manager::filter_string	(		$string,
			$context )

As for the equivalent filter_manager method.

Parameters

string	$string	The text to filter
context	$context	not used.

Return values

string

resulting string

filter_string() [3/3]

performance_measuring_filter_manager::filter_string	(		$string,
			$context )

Filter a piece of string.

Parameters

string	$string	The text to filter
context	$context	the context.

Return values

string

resulting string

Reimplemented from filter_manager.

filter_text() [1/4]

filter_manager::filter_text	(		$text,
			$context,
		array	$options = array(),
		array	$skipfilters = null )

Filter some text.

Parameters

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.

Return values

string

resulting text

Reimplemented in performance_measuring_filter_manager.

filter_text() [2/4]

filter_text

(

)

Deprecated

use the text formatting in a standard way instead (https://moodledev.io/docs/apis/subsystems/output#output-functions) this was abused mostly for embedding of attachments

filter_text() [3/4]

null_filter_manager::filter_text	(		$text,
			$context,
		array	$options = array(),
		array	$skipfilters = null )

As for the equivalent filter_manager method.

Parameters

string	$text	The text to filter
context	$context	not used.
array	$options	not used
array	$skipfilters	not used

Return values

string

resulting text.

filter_text() [4/4]

performance_measuring_filter_manager::filter_text	(		$text,
			$context,
		array	$options = array(),
		array	$skipfilters = null )

Filter some text.

Parameters

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.

Return values

string

resulting text

Reimplemented from filter_manager.

filter_unset_local_config()

filter_unset_local_config	(		$filter,
			$contextid,
			$name )

Remove a particular local config variable for a filter in a context.

Parameters

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.

fix_align_rtl()

fix_align_rtl

(

$align

)

Returns swapped left<=> right if in RTL environment.

Part of RTL Moodles support.

Parameters

string

$align

align to check

Return values

string

format_backtrace()

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.

Parameters

array	$callers	backtrace array, as returned by debug_backtrace().
boolean	$plaintext	if false, generates HTML, if true generates plain text.

Return values

string

formatted backtrace, ready for output.

format_module_intro()

format_module_intro	(		$module,
			$activity,
			$cmid,
			$filter = true )

Formats activity intro text.

Parameters

string	$module	name of module
object	$activity	instance of activity
int	$cmid	course module id
bool	$filter	filter resulting html text

Return values

string

format_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

Parameters

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

Return values

string

format_text()

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

Parameters

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

Return values

string

format_text_email()

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.

Parameters

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]

Return values

string

format_text_menu()

format_text_menu

(

)

Just returns an array of text formats suitable for a popup menu.

Return values

array

format_weeks_get_section_dates()

format_weeks_get_section_dates

(

)

Deprecated

since 2.4

formerr()

formerr

(

)

Deprecated

generate_email_supportuser()

generate_email_supportuser

(

)

Deprecated

since Moodle 2.6

generate_image_thumbnail()

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.

Parameters

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

Return values

string|bool

false if a problem occurs, the thumbnail image data otherwise

generate_image_thumbnail_from_image()

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.

Parameters

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.

Return values

string|bool

False if a problem occurs, the thumbnail image data otherwise.

generate_image_thumbnail_from_string()

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.

Parameters

string	$filedata	The image content as a string
int	$width	the width of the requested thumbnail
int	$height	the height of the requested thumbnail

Return values

string|bool

false if a problem occurs, the thumbnail image data otherwise

generate_page_type_patterns()

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.

Parameters

string	$pagetype	for example 'course-view-weeks' or 'mod-quiz-view'.
stdClass	$parentcontext	Block's parent context
stdClass	$currentcontext	Current context of block

Return values

array

an array of all the page type patterns that might match this page type.

generate_uuid()

generate_uuid

(

)

Deprecated

since Moodle 3.8 MDL-61038 - please do not use this function any more.

See also

core\uuid\generate()

get_accesshide()

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!

Parameters

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'"

Return values

string

HTML string.

get_all_component_hash()

static get_all_component_hash ( ?array $components = null )

static

Returns hash of all core + plugin /db/ directories.

This is relatively slow and not fully cached, use with care!

Parameters

array | null

$components

optional component directory => hash array to use. Only used in PHPUnit.

Return values

string

sha1 hash.

get_all_directory_hashes()

static get_all_directory_hashes ( ?array $directories = null )

static

Get the hashes of all core + plugin /db/ directories.

Parameters

array | null

$directories

optional component directory array to hash. Only used in PHPUnit.

Return values

array

of directory => hash.

get_all_mods()

get_all_mods

(

)

Deprecated

since 2.4

get_all_sections()

get_all_sections

(

)

Deprecated

since 2.4

get_all_subcategories()

get_all_subcategories

(

)

Deprecated

since 2.5. Please use core_course_category\get() and core_course_category\get_children()

get_all_user_name_fields()

get_all_user_name_fields

(

)

Deprecated

since Moodle 3.11 MDL-45242

get_all_versions()

static get_all_versions ( )

static

Returns hash of all versions including core and all plugins.

This is relatively slow and not fully cached, use with care!

Return values

array

as (string)plugintype_pluginname => (int)version

get_all_versions_hash()

static get_all_versions_hash ( )

static

Returns hash of all versions including core and all plugins.

This is relatively slow and not fully cached, use with care!

Return values

string

sha1 hash

get_array_of_activities()

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:

Parameters

int	$courseid	course id
bool	$usecache	get activities from cache if modinfo exists when $usecache is true

Return values

array

list of activities

Deprecated

since Moodle 4.0. Please use course_modinfo::get_array_of_activities() instead.

get_backpack_settings()

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.

Parameters

int	$userid	Backpack user ID.
boolean	$refresh	Refresh badges collection in cache.

Return values

null|object

Returns null is there is no backpack or object with backpack settings.

get_backup_temp_directory()

get_backup_temp_directory

(

$directory

)

Get the full path of a directory under $CFG->backuptempdir.

Parameters

string

$directory

the relative path of the directory under $CFG->backuptempdir

Return values

string|false

Returns full path to directory given a valid string; otherwise, false.

get_browser_version_classes()

get_browser_version_classes

(

)

Deprecated

since 2.6

get_categories()

get_categories

(

)

Deprecated

since 2.5

get_category_courses_array()

get_category_courses_array

(

)

Deprecated

since 2.5

get_category_courses_array_recursively()

get_category_courses_array_recursively

(

)

Deprecated

since 2.5

get_child_categories()

get_child_categories

(

)

Deprecated

since 2.5. Please use core_course_category\get($parentid)->get_children().

get_child_contexts()

get_child_contexts

(

)

Deprecated

since 2.2

get_clam_error_code()

get_clam_error_code

(

)

Deprecated

since Moodle 3.0 - this is a part of clamav plugin now.

get_component_classes_in_namespace()

static get_component_classes_in_namespace ( $component = null, $namespace = '' )

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')

Parameters

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.

Return values

array

The full class name as key and the class path as value, empty array if $component is null and $namespace is empty.

get_component_directory()

get_component_directory ( $component )

static

Return exact absolute path to a plugin directory.

Parameters

string

$component

name such as 'moodle', 'mod_forum'

Return values

string

full path to component directory; NULL if not found

Deprecated

since 2.6, use core_component\normalize_component()

Parameters

string

$component

name such as 'moodle', 'mod_forum'

Return values

string

full path to component directory; NULL if not found

get_component_from_classname()

static get_component_from_classname ( string $classname )

static

Fetch the component name from a Moodle PSR-like namespace.

Note: Classnames in the flat underscore_class_name_format are not supported.

Parameters

string

$classname

Return values

null|string

The component name, or null if a matching component was not found

get_component_list()

static get_component_list ( )

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, ... ] ]

Return values

array

an associative array of components and their corresponding paths.

get_component_names()

static get_component_names ( bool $includecore = false )

static

Returns a list of frankenstyle component names, including all plugins, subplugins, and subsystems.

Note: By default the 'core' subsystem is not included.

Parameters

bool

$includecore

Whether to include the 'core' subsystem

Return values

string[]

the list of frankenstyle component names.

get_context_instance()

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.

Deprecated

since 2.2, use context_course\instance() or other relevant class instead

Todo

This will be deleted in Moodle 2.8, refer MDL-34472

Parameters

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

Return values

context

The context object.

get_context_instance_by_id()

get_context_instance_by_id

(

)

Deprecated

since Moodle 2.2 MDL-35009 - please do not use this function any more.

get_context_url()

get_context_url

(

)

Deprecated

since 2.2

get_contextlevel_name()

get_contextlevel_name

(

)

Deprecated

since 2.2

get_core_api_names()

static get_core_api_names ( )

static

Returns the list of available API names.

Return values

string[]

the list of available API names.

get_core_apis()

static get_core_apis ( )

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:

• component: the component, usually a subsystem or core, the API belongs to.
• allowedlevel2: if the API is allowed as level2 namespace or no.
• allowedspread: if the API can spread out from its component or no.

Return values

stdClass[]

array of APIs (as keys) with their attributes as object instances.

get_core_subsystems() [1/2]

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.

Deprecated

since 2.6, use core_component\get_core_subsystems()

Parameters

bool

$fullpaths

false means relative paths from dirroot, use true for performance reasons

Return values

array

of (string)name => (string|null)location

get_core_subsystems() [2/2]

static get_core_subsystems ( )

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.

Return values

array

of (string)name => (string|null)full dir location

get_course_and_cm_from_cmid()

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.

Parameters

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)

Return values

array

Array with 2 elements $course and $cm

Exceptions

moodle_exception

If the item doesn't exist or is of wrong module name

get_course_and_cm_from_instance()

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.

Parameters

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)

Return values

array

Array with 2 elements $course and $cm

Exceptions

moodle_exception

If the item doesn't exist or is of wrong module name

get_course_category()

get_course_category

(

)

Deprecated

since 2.5. Please use core_course_category\get($catid, IGNORE_MISSING) or core_course_category\get($catid, MUST_EXIST).

get_course_category_tree()

get_course_category_tree

(

)

Deprecated

since 2.5

get_course_context()

get_course_context

(

)

Deprecated

since 2.2

get_course_participants()

get_course_participants

(

)

Deprecated

use get_enrolled_users($context) instead.

get_course_section()

get_course_section

(

)

Deprecated

since 2.4

get_courseid_from_context()

get_courseid_from_context

(

)

Deprecated

since 2.2

get_courses_page()

get_courses_page

(

)

Deprecated

since Moodle 3.7

get_courses_wmanagers()

get_courses_wmanagers

(

)

Deprecated

since 2.5

get_current_group()

get_current_group

(

)

Deprecated

Since year 2006 - please do not use this function any more.

get_device_cfg_var_name()

get_device_cfg_var_name

(

)

Deprecated

since 2.6

get_device_type()

get_device_type

(

)

Deprecated

since 2.6

get_device_type_list()

get_device_type_list

(

)

Deprecated

since 2.6

get_docs_url()

get_docs_url

(

$path = null

)

Returns the Moodle Docs URL in the users language for a given 'More help' link.

There are three cases:

1. In the normal case, $path will be a short relative path 'component/thing', like 'mod/folder/view' 'group/import'. This gets turned into an link to MoodleDocs in the user's language, and for the appropriate Moodle version. E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'. The 'http://docs.moodle.org' bit comes from $CFG->docroot.

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.

1. $path may be an absolute URL, starting http:// or https://. In this case, the link is used as is.
2. $path may start %WWWROOT%%, in which case that is replaced by $CFG->wwwroot to make the link.

Parameters

string

$path

the place to link to. See above for details.

Return values

string

The MoodleDocs URL in the user's language. for example $path}

get_enrolled_join()

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.

Exceptions

coding_exception

Parameters

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.

Return values

core\dml\sql_join

Contains joins, wheres, params

get_enrolled_sql()

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.

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.

Return values

array

list($sql, $params)

get_enrolled_users()

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.

Parameters

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

Return values

array

of user records

get_enrolled_with_capabilities_join()

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.

Parameters

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.

Return values

core\dml\sql_join

Contains joins, wheres, params and cannotmatchanyrows

get_environment_for_version()

get_environment_for_version	(		$version,
			$env_select )

This function will return the xmlized data belonging to one Moodle version.

Parameters

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.

Return values

mixed

the xmlized structure or false on error

get_exception_info()

get_exception_info

(

$ex

)

Returns detailed information about specified exception.

Parameters

Throwable

$ex

any sort of exception or throwable.

Return values

stdClass

standardised info to display. Fields are clear if you look at the end of this function.

get_extra_user_fields()

get_extra_user_fields

(

)

Deprecated

since Moodle 3.11 MDL-45242

get_extra_user_fields_sql()

get_extra_user_fields_sql

(

)

Deprecated

since Moodle 3.11 MDL-45242

get_fast_modinfo()

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

Parameters

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

Return values

course_modinfo|null

Module information for course, or null if resetting

Exceptions

moodle_exception

when course is not found (nothing is thrown if resetting)

get_file_argument()

get_file_argument

(

)

Extracts file argument either from file parameter or PATH_INFO.

Note: $scriptname parameter is not needed anymore

Return values

string

file path (only safe characters)

get_file_url()

get_file_url

(

)

Deprecated

since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example: The moodle_url\make_legacyfile_url() method can be used to generate a legacy course file url. To generate course module file.php url the moodle_url\make_file_url() should be used.

get_formatted_help_string()

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.

Parameters

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

Return values

stdClass

An object containing: heading: Any heading that there may be for this help string. text: The wiki-formatted help string. doclink: An object containing a link, the linktext, and any additional CSS classes to apply to that link. Only present if $ajax = false. completedoclink: A text representation of the doclink. Only present if $ajax = true.

get_generic_section_name()

get_generic_section_name

(

)

Deprecated

since 2.4

get_group_picture_url()

get_group_picture_url	(		$group,
			$courseid,
			$large = false,
			$includetoken = false )

Return the url to the group picture.

Parameters

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.

Return values

moodle_url

Returns the url for the group picture.

get_html_lang()

get_html_lang

(

$dir = false

)

Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.

Internationalisation, for print_header and backup/restorelib.

Parameters

bool

$dir

Default false

Return values

string

Attributes

get_html_lang_attribute_value()

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.

Parameters

string

$langcode

The language code to convert.

Return values

string

get_latest_version_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.

Parameters

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.

Return values

string|bool

string more recent version or false if not found

get_level()

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)

Parameters

array

$element

the element from the environment.xml file that should have either a level="required" or level="optional" attribute.

Return values

string

"required" or "optional".

get_list_of_environment_versions()

get_list_of_environment_versions

(

$contents

)

This function will return the list of Moodle versions available.

Return values

array

of versions

get_list_of_timezones()

get_list_of_timezones

(

)

Deprecated

since Moodle 2.9

get_local_referer()

get_local_referer

(

$stripquery = true

)

Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required.

Parameters

bool

$stripquery

if true, also removes the query part of the url.

Return values

string

The resulting referer or empty string.

get_logs()

get_logs

(

)

Deprecated

since Moodle 3.2

get_logs_usercourse()

get_logs_usercourse

(

)

Deprecated

since Moodle 3.2

get_logs_userday()

get_logs_userday

(

)

Deprecated

since Moodle 3.2

get_module_metadata()

get_module_metadata

(

)

Deprecated

since 3.9

get_moodle_cookie()

get_moodle_cookie

(

)

Gets a moodle cookie with a weakly encrypted username.

Return values

string

username

get_other_mapping()

static core\event\get_other_mapping ( )

static

Used for maping events on restore.

Return values

bool

get_parent_contextid()

get_parent_contextid

(

)

Deprecated

since Moodle 2.2

get_parent_contexts()

get_parent_contexts

(

)

Deprecated

since 2.2, use $context->get_parent_context_ids() instead

get_performance_summary()

performance_measuring_filter_manager::get_performance_summary

(

)

Return performance information, in the form required by get_performance_info().

Return values

array

the performance info.

get_plugin_directory()

get_plugin_directory ( $plugintype, $name )

static

Returns the exact absolute path to plugin directory.

Parameters

string	$plugintype	type of plugin
string	$pluginname	name of the plugin

Return values

string

full path to plugin directory; null if not found

Deprecated

since 2.6, use core_component\get_plugin_directory()

Parameters

string	$plugintype	type of plugin
string	$name	name of the plugin

Return values

string

full path to plugin directory; NULL if not found

get_plugin_list()

get_plugin_list ( $plugintype )

static

Get list of plugins of given type.

Use when listing real plugins of one type.

Parameters

string

$plugintype

Return values

array

as (string)pluginname => (string)fulldir

Deprecated

since 2.6, use core_component\get_plugin_list()

Parameters

string

$plugintype

type of plugin

Return values

array

name=>fulllocation pairs of plugins of given type

get_plugin_list_with_class()

get_plugin_list_with_class ( $plugintype, $class, $file = null )

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.

Parameters

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.

Return values

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.

Deprecated

since 2.6, use core_component\get_plugin_list_with_class()

Parameters

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.

Return values

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').

get_plugin_list_with_file() [1/2]

static get_plugin_list_with_file ( $plugintype, $file, $include = false )

static

Get a list of all the plugins of a given type that contain a particular file.

Parameters

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.

Return values

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() [2/2]

get_plugin_list_with_file

(

)

Deprecated

since 2.6

get_plugin_types() [1/2]

get_plugin_types

(

$fullpaths = true

)

Lists all plugin types.

Deprecated

since 2.6, use core_component\get_plugin_types()

Parameters

bool

$fullpaths

false means relative paths from dirroot

Return values

array

Array of strings - name=>location

get_plugin_types() [2/2]

static get_plugin_types ( )

static

Get list of available plugin types together with their location.

Return values

array

as (string)plugintype => (string)fulldir

get_plugin_types_with_subplugins()

static get_plugin_types_with_subplugins ( )

static

Returns list of plugin types that allow subplugins.

Return values

array

as (string)plugintype => (string)fulldir

get_print_section_cm_text()

get_print_section_cm_text

(

)

Deprecated

since 2.5

get_real_size()

get_real_size

(

$size = 0

)

Converts numbers like 10M into bytes.

Parameters

string

$size

The size to be converted

Return values

int

get_recent_enrolments()

get_recent_enrolments

(

)

Deprecated

get_records_csv()

get_records_csv

(

)

Deprecated

since Moodle 3.2

See also

csv_import_reader\load_csv_content()

get_referer()

get_referer

(

)

Deprecated

since Moodle 3.0 MDL-49360 - please do not use this function any more.

get_related_contexts_string()

get_related_contexts_string

(

)

Deprecated

since 2.2

get_request_storage_directory()

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.

Parameters

bool	$exceptiononerror	throw exception if error encountered
bool	$forcecreate	Force creation of a new parent directory

Return values

string

Returns full path to directory if successful, false if not; may throw exception

get_role_context_caps()

get_role_context_caps

(

)

Deprecated

since Moodle 2.2

get_roles_on_exact_context()

get_roles_on_exact_context

(

)

Deprecated

since Moodle 3.6. Please use the get_roles_used_in_context().

get_roles_with_assignment_on_context()

get_roles_with_assignment_on_context

(

)

Deprecated

since Moodle 3.6. Please use the get_roles_used_in_context().

get_selected_theme_for_device_type()

get_selected_theme_for_device_type

(

)

Deprecated

since 2.6

get_separator()

get_separator

(

)

Return the breadcrumb trail navigation separator.

Return values

string

HTML string.

get_string_filters()

filter_manager::get_string_filters ( $context )

protected

Get all the filters that apply to a given context for calls to format_string.

Parameters

context

$context

the context.

Return values

moodle_text_filter[]

A text filter

get_subplugins()

static get_subplugins ( $component )

static

Return all subplugins of this component.

Parameters

string

$component,.

Return values

array\$subtype,=>array($component,..),null

if no subtypes defined

get_subsystem_directory()

static get_subsystem_directory ( $subsystem )

static

Returns the exact absolute path to plugin directory.

Parameters

string

$subsystem

type of core subsystem

Return values

string

full path to subsystem directory; null if not found

get_subtype_parent()

static get_subtype_parent ( $type )

static

Returns parent of this subplugin type.

Parameters

string

$type

Return values

string

parent component or null

get_system_context()

get_system_context

(

$cache = true

)

Returns system context or null if can not be created yet.

See also

context_system\instance()

Deprecated

since 2.2

Parameters

bool

$cache

use caching

Return values

context

system context (null if context table not created yet)

get_text_filters()

filter_manager::get_text_filters ( $context )

protected

Get all the filters that apply to a given context for calls to format_text.

Parameters

context

$context

Return values

moodle_text_filter[]

A text filter

get_texteditor()

get_texteditor

(

$editorname

)

Returns instance of text editor.

Parameters

string

$editorname

name of editor (textarea, tiny, ...)

Return values

object|bool

texeditor instance or false if does not exist

get_timezone_offset()

get_timezone_offset

(

)

Deprecated

since Moodle 2.9

get_timezone_record()

get_timezone_record

(

)

Deprecated

since Moodle 2.9

get_trace()

core\task\get_trace ( )

protected

Get the progress_trace.

Return values

progress_trace

get_user_access_sitewide()

get_user_access_sitewide

(

)

Deprecated

since Moodle 3.4. MDL-49398.

get_user_courses_bycap()

get_user_courses_bycap

(

)

Deprecated

since 2.2

get_user_device_type()

get_user_device_type

(

)

Deprecated

since 2.6

get_user_field_name()

get_user_field_name

(

)

Deprecated

since Moodle 3.11 MDL-45242

get_user_timezone_offset()

get_user_timezone_offset

(

)

Deprecated

since Moodle 2.9

grade_print_tabs()

grade_print_tabs	(		$active_type,
			$active_plugin,
			$plugin_info,
			$return = false )

Print grading plugin selection tab-based navigation.

Deprecated

since Moodle 4.0. Tabs navigation has been replaced with tertiary navigation.

Parameters

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

Return values

nothing

or string if $return true

groupmode()

groupmode

(

)

Deprecated

since Moodle 2.0 MDL-14617 - please do not use this function any more.

groups_course_module_visible()

groups_course_module_visible

(

)

Deprecated

Since Moodle 2.8

groups_filter_users_by_course_module_visible()

groups_filter_users_by_course_module_visible

(

)

Deprecated

Since Moodle 2.8

groups_get_all_groups_for_courses()

groups_get_all_groups_for_courses

(

)

Deprecated

since Moodle 3.6.

has_monologo_icon()

static has_monologo_icon ( string $plugintype, string $pluginname )

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.

Parameters

string	$plugintype	The plugin type.
string	$pluginname	The plugin name.

Return values

bool	True if the plugin has a monologo icon

hash()

moodle_text_filter::hash

(

)

Deprecated

Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more.

hash_local_config_cache()

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.

Return values

string

md5 hash of all the sensible bits deciding if cached config is stale or no.

hide_event()

hide_event

(

)

Deprecated

please use calendar_event->toggle_visibility(false) instead.

highlight()

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.

Parameters

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.

Return values

string

The highlighted HTML.

highlightfast()

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.

Parameters

string	$needle	The string to search for
string	$haystack	The string to search for $needle in

Return values

string

The highlighted HTML

html_to_text()

html_to_text	(		$html,
			$width = 75,
			$dolinks = true )

Given HTML text, make it into plain text using external function.

Parameters

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.

Return values

string

plain text equivalent of the HTML.

httpsrequired()

httpsrequired

(

)

Deprecated

Loginhttps is no longer supported

imagecopybicubic()

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

Parameters

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

Return values

bool	tru on success, false otherwise

ini_get_bool()

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

Parameters

string

$ini_get_arg

The argument to get

Return values

bool	True for on false for not

init_performance_info()

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()

initialise_fullme

(

)

Initialises $FULLME and friends.

Private function. Should only be called from setup.php.

initialise_fullme_cli()

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()

initialise_local_config_cache

(

)

Cache any immutable config locally to avoid constant DB lookups.

Only to be used only from lib/setup.php

install_cli_database()

install_cli_database	(	array	$options,
			$interactive )

Install Moodle DB, config.php must exist, there must not be any tables in db yet.

Parameters

array	$options	adminpass is mandatory
bool	$interactive

Return values

void

install_db_validate()

install_db_validate	(		$database,
			$dbhost,
			$dbuser,
			$dbpass,
			$dbname,
			$prefix,
			$dboptions )

This is in function because we want the /install.php to parse in PHP4.

Parameters

object	$database
string	$dbhsot
string	$dbuser
string	$dbpass
string	$dbname
string	$prefix
mixed	$dboptions

Return values

string

install_generate_configphp()

install_generate_configphp	(		$database,
			$cfg )

Returns content of config.php file.

Uses PHP_EOL for generating proper end of lines for the given platform.

Parameters

moodle_database	$database	database instance
object	$cfg	copy of $CFG

Return values

string

install_guess_wwwroot()

install_guess_wwwroot

(

)

Tries to detect the right www root setting.

Return values

string

detected www root

install_helpbutton()

install_helpbutton	(		$url,
			$title = '' )

Print help button.

Parameters

string	$url
string	$titel

Return values

void

install_ini_get_bool()

install_ini_get_bool

(

$ini_get_arg

)

Copy of.

See also

{ini_get_bool()}

Parameters

string

$ini_get_arg

Return values

bool

install_init_dataroot()

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.

Parameters

string	$dataroot	full path to dataroot
int	$dirpermissions

Return values

bool

success

install_print_footer()

object install_print_footer	(		$config,
			$reload = false )

Prints installation page header, we can not use weblib yet in installer.

Parameters

stdClass	$config
bool	$reload	print reload button instead of next

Return values

void

install_print_header()

object install_print_header	(		$config,
			$stagename,
			$heading,
			$stagetext,
			$stageclass = "alert-info" )

Prints installation page header, we can not use weblib yet in installer.

Parameters

stdClass	$config
string	$stagename
string	$heading
string	$stagetext
string	$stageclass

Return values

void

install_print_help_page()

object install_print_help_page

(

$help

)

Prints complete help page used during installation.

Does not return.

Parameters

string

$help

instance()

static filter_manager::instance ( )

static

Factory method.

Use this to get the filter manager.

Return values

filter_manager

the singleton instance.

invalidate_opcode_php_cache()

static invalidate_opcode_php_cache ( $file )

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.

Parameters

string

$file

iplookup_find_location()

iplookup_find_location

(

$ip

)

Returns location information.

Parameters

string

$ip

Return values

array

is_core_api()

static is_core_api ( $apiname )

static

Return true if apiname is a core API.

Parameters

string

$apiname

name of the API.

Return values

bool	true if core API.

is_core_subsystem()

static is_core_subsystem ( $subsystemname )

static

Return true if subsystemname is core subsystem.

Parameters

string

$subsystemname

name of the subsystem.

Return values

bool	true if core subsystem.

is_course_participant()

is_course_participant

(

)

Deprecated

use is_enrolled($context, $userid) instead.

is_early_init()

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.

Parameters

array

$backtrace

the stack trace to analyse.

Return values

boolean

whether the stack trace is somewhere in output initialisation.

is_enrolled()

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.

Parameters

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

Return values

bool

is_https()

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.

Return values

boolean

True if site is served over HTTPS, false otherwise.

is_in_popup()

is_in_popup

(

)

Returns true if the page is displayed in a popup window.

Gets the information from the URL parameter inpopup.

Todo

Use a central function to create the popup calls all over Moodle and In the moment only works with resources and probably questions.

Return values

boolean

is_major_upgrade_required()

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.

Return values

bool

is_moodle_cookie_secure()

is_moodle_cookie_secure

(

)

Determine wether the secure flag should be set on cookies.

Return values

bool

is_valid_plugin_name()

static is_valid_plugin_name ( $plugintype, $pluginname )

static

This method validates a plug name.

It is much faster than calling clean_param.

Parameters

string	$plugintype	type of plugin
string	$pluginname	a string that might be a plugin name.

Return values

bool	if this string is a valid plugin name.

is_web_crawler()

is_web_crawler

(

)

Deprecated

since Moodle 3.0 use core_useragent\is_web_crawler instead.

isPropagationStopped()

core\hook\isPropagationStopped

(

)

Is propagation stopped?

This will typically only be used by the Dispatcher to determine if the previous listener halted propagation.

Return values

bool	True if the Event is complete and no further listeners should be called. False to continue calling listeners.

js_minify()

js_minify

(

)

Deprecated

since 2.6

ldap_addslashes()

ldap_addslashes

(

$text

)

Quote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253.

Parameters

string

the AttributeValue to quote

Return values

string

the AttributeValue quoted

ldap_connect_moodle()

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.

Parameters

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)

Return values

mixed

connection result or false.

ldap_filter_addslashes()

ldap_filter_addslashes

(

$text

)

Quote control characters in texts used in LDAP filters - see RFC 4515/2254.

Parameters

string

filter string to quote

Return values

string

the filter string quoted

ldap_find_userdn()

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.

Parameters

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.

Return values

mixed

the user dn (external LDAP encoding, no db slashes) or false

ldap_get_dn_special_chars()

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()

ldap_get_entries_moodle	(		$ldapconnection,
			$searchresult )

Returns values like ldap_get_entries but is binary compatible and returns all attributes as array.

Parameters

mixed	$ldapconnection	A valid LDAP connection
mixed	$searchresult	A search result from ldap_search, ldap_list, etc.

Return values

array

ldap-entries with lower-cased attributes as indexes

ldap_getdefaults()

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' .... );

Return values

array

of default values

ldap_isgroupmember()

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"

Parameters

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.

Return values

boolean

ldap_normalise_objectclass()

ldap_normalise_objectclass	(		$objectclass,
			$default = '*' )

Normalise the supplied objectclass filter.

This normalisation is a rudimentary attempt to format the objectclass filter correctly.

Parameters

string	$objectclass	The objectclass to normalise
string	$default	The default objectclass value to use if no objectclass was supplied

Return values

string

The normalised objectclass.

ldap_paged_results_supported()

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.

Parameters

ldapversion	integer The LDAP protocol version we use.
ldapconnection	resource An existing LDAP connection (optional).

Return values

boolean

true is paged results can be used, false otherwise.

ldap_stripslashes()

ldap_stripslashes

(

$text

)

Unquote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253.

Parameters

string

the AttributeValue quoted

Return values

string

the AttributeValue unquoted

ldap_supported_usertypes()

if(!defined('ROOTDSE')) if(!defined( 'LDAP_PAGED_RESULTS_CONTROL')) if(!defined('LDAP_DEFAULT_PAGESIZE')) ldap_supported_usertypes

(

)

Returns predefined user types.

Return values

array

of predefined user types

link_arrow_left()

link_arrow_left	(		$text,
			$url = '',
			$accesshide = false,
			$addclass = '',
			$addparams = [] )

Return the left arrow with text ('previous'), and optionally embedded in a link.

Parameters

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.

Return values

string

HTML string.

link_arrow_right()

link_arrow_right	(		$text,
			$url = '',
			$accesshide = false,
			$addclass = '',
			$addparams = [] )

Return the right arrow with text ('next'), and optionally embedded in a link.

Parameters

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.

Return values

string

HTML string.

load_course_context()

load_course_context

(

)

Deprecated

since Moodle 3.4 and removed immediately. MDL-49398.

load_environment_xml()

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

Parameters

int | string

$env_select

one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

mixed

the xmlized structure or false on error

load_filters()

filter_manager::load_filters ( $context )

protected

Load all the filters required by this context.

Parameters

context

$context

the context.

load_renamed_classes()

static load_renamed_classes ( ?string $fulldir )

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.

Parameters

string | null

$fulldir

The directory to the renamed classes.

load_role_access_by_context()

load_role_access_by_context

(

)

Deprecated

since Moodle 3.4 and removed immediately. MDL-49398.

log()

core\task\log ( $message, $depth = 1 )

protected

Log a message to the progress tracer.

Parameters

string	$message
int	$depth

log_finish()

core\task\log_finish ( $message, $depth = 0 )

protected

Log an end message to the progress tracer.

Parameters

string	$message
int	$depth

log_start()

core\task\log_start ( $message, $depth = 0 )

protected

Log a start message to the progress tracer.

Parameters

string	$message
int	$depth

login_attempt_failed()

login_attempt_failed

(

$user

)

To be called after failed user login.

Parameters

stdClass

$user

Exceptions

moodle_exception

login_attempt_valid()

login_attempt_valid

(

$user

)

To be called after valid user login.

Parameters

stdClass

$user

login_captcha_enabled()

login_captcha_enabled

(

)

Returns whether the captcha element is enabled for the login form, and the admin settings fulfil its requirements.

Return values

bool

login_is_lockedout()

login_is_lockedout

(

$user

)

Verify if user is locked out.

Parameters

stdClass

$user

Return values

bool	true if user locked out

login_lock_account()

login_lock_account

(

$user

)

Lockout user and send notification email.

Parameters

stdClass

$user

login_unlock_account()

login_unlock_account	(		$user,
		bool	$notify = false )

Unlock user account and reset timers.

Parameters

stdClass	$user
bool	$notify	Notify the user their account has been unlocked.

make_backup_temp_directory()

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.

Parameters

string	$directory	the relative path of the directory to be created under $CFG->backuptempdir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false

Returns full path to directory if successful, false if not; may throw exception

make_cache_directory()

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.

Parameters

string	$directory	the full path of the directory to be created under $CFG->cachedir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false

Returns full path to directory if successful, false if not; may throw exception

make_categories_list()

make_categories_list

(

)

Deprecated

since 2.5

make_categories_options()

make_categories_options

(

)

Deprecated

since Moodle 3.10

make_editing_buttons()

make_editing_buttons

(

)

Deprecated

since 2.5. Please use: $courserenderer = $PAGE->get_renderer('core', 'course'); $actions = course_get_cm_edit_actions($mod, $indent, $section); return ' ' . $courserenderer->course_section_cm_edit_actions($actions);

make_filter_object() [1/2]

filter_manager::make_filter_object ( $filtername, $context, $localconfig )

protected

Factory method for creating a filter.

Parameters

string	$filtername	The filter name, for example 'tex'.
context	$context	context object.
array	$localconfig	array of local configuration variables for this filter.

Return values

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.

make_filter_object() [2/2]

performance_measuring_filter_manager::make_filter_object ( $filtername, $context, $localconfig )

protected

Factory method for creating a filter.

Parameters

string	$filtername	The filter name, for example 'tex'.
context	$context	context object.
array	$localconfig	array of local configuration variables for this filter.

Return values

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_localcache_directory()

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.

Parameters

string	$directory	the relative path of the directory to be created under $CFG->localcachedir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false

Returns full path to directory if successful, false if not; may throw exception

make_request_directory()

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.

Parameters

bool	$exceptiononerror	throw exception if error encountered
bool	$forcecreate	Force creation of a new parent directory

Return values

string

The full path to directory if successful, false if not; may throw exception

make_temp_directory()

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.

Parameters

string	$directory	the full path of the directory to be created under $CFG->tempdir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false

Returns full path to directory if successful, false if not; may throw exception

make_unique_writable_directory()

make_unique_writable_directory	(		$basedir,
			$exceptiononerror = true )

Create a new unique directory within the specified directory.

Parameters

string	$basedir	The directory to create your new unique directory within.
bool	$exceptiononerror	throw exception if error encountered

Return values

string

The created directory

Exceptions

invalid_dataroot_permissions

make_upload_directory()

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().

Parameters

string	$directory	the full path of the directory to be created under $CFG->dataroot
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false

Returns full path to directory if successful, false if not; may throw exception

mark_context_dirty()

mark_context_dirty

(

)

Deprecated

since 2.2, use $context->mark_dirty() instead

markdown_to_html()

markdown_to_html

(

$text

)

Given Markdown formatted text, make it into XHTML using external function.

Parameters

string

$text

The markdown formatted text to be converted.

Return values

string

Converted text

matching_page_type_patterns()

matching_page_type_patterns

(

$pagetype

)

Given a specific page type, return all the page type patterns that might match it.

Parameters

string

$pagetype

for example 'course-view-weeks' or 'mod-quiz-view'.

Return values

array

an array of all the page type patterns that might match this page type.

matching_page_type_patterns_from_pattern()

matching_page_type_patterns_from_pattern

(

$pattern

)

Give an specific pattern, return all the page type patterns that would also match it.

Parameters

string

$pattern

the pattern, e.g. 'mod-forum-*' or 'mod-quiz-view'.

Return values

array

of all the page type patterns matching.

mdie()

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");

Parameters

string	$msg	Error message
integer	$errorcode	Error code to emit

me()

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.

Return values

mixed

String or false if the global variables needed are not set.

merge_query_params()

merge_query_params	(	array &	$target,
		array	$values )

Merge parsed POST chunks.

NOTE: this is not perfect, but it should work in most cases hopefully.

Parameters

array	$target
array	$values

message_add_contact()

message_add_contact

(

)

Deprecated

since Moodle 3.6

message_block_contact()

message_block_contact

(

)

Deprecated

since Moodle 3.6

message_can_delete_message()

message_can_delete_message

(

)

Deprecated

since Moodle 3.5

message_can_post_message()

message_can_post_message

(

)

Deprecated

since Moodle 3.2

message_contact_link()

message_contact_link

(

)

Deprecated

since Moodle 3.2

message_count_blocked_users()

message_count_blocked_users

(

)

Deprecated

since Moodle 3.2

message_count_messages()

message_count_messages

(

)

Deprecated

since Moodle 3.2

message_count_unread_messages()

message_count_unread_messages

(

)

Deprecated

since 3.10

message_current_user_is_involved()

message_current_user_is_involved

(

)

Deprecated

since Moodle 2.9 MDL-49371 - please do not use this function any more.

message_delete_message()

message_delete_message

(

)

Deprecated

since Moodle 3.5

message_get_blocked_users()

message_get_blocked_users

(

)

Deprecated

since Moodle 3.5

message_get_contact()

message_get_contact

(

)

Deprecated

since Moodle 3.6

message_get_contact_add_remove_link()

message_get_contact_add_remove_link

(

)

Deprecated

since Moodle 3.2

message_get_contact_block_link()

message_get_contact_block_link

(

)

Deprecated

since Moodle 3.2

message_get_contacts()

message_get_contacts

(

)

Deprecated

since Moodle 3.5

message_get_course_contexts()

message_get_course_contexts

(

)

Deprecated

since Moodle 3.2

message_get_fragment()

message_get_fragment

(

)

Deprecated

since Moodle 3.2

message_get_history()

message_get_history

(

)

Deprecated

since Moodle 3.2

message_get_recent_conversations()

message_get_recent_conversations	(		$userorid,
			$limitfrom = 0,
			$limitto = 100 )

Deprecated

since Moodle 3.3 MDL-57370

message_get_recent_notifications()

message_get_recent_notifications

(

)

Deprecated

since Moodle 3.2

message_history_link()

message_history_link

(

)

Deprecated

since Moodle 3.2

message_is_user_blocked()

message_is_user_blocked

(

)

Deprecated

since Moodle 3.2

message_is_user_non_contact_blocked()

message_is_user_non_contact_blocked

(

)

Deprecated

since Moodle 3.2

message_mark_message_read()

message_mark_message_read

(

)

Deprecated

since Moodle 3.5

message_mark_messages_read()

message_mark_messages_read

(

)

Deprecated

since Moodle 3.2

message_move_userfrom_unread2read()

message_move_userfrom_unread2read

(

)

Deprecated

since Moodle 3.5

message_remove_contact()

message_remove_contact

(

)

Deprecated

since Moodle 3.6

message_remove_url_params()

message_remove_url_params

(

)

Deprecated

since Moodle 3.2

message_search()

message_search

(

)

Deprecated

since Moodle 3.2

message_shorten_message()

message_shorten_message

(

)

Deprecated

since Moodle 3.2

message_unblock_contact()

message_unblock_contact

(

)

Deprecated

since Moodle 3.6

min_clean_param()

min_clean_param	(		$value,
			$type )

Minimalistic parameter cleaning function.

Note: Can not use optional param because moodlelib.php is not loaded yet.

Parameters

string	$value
string	$type

Return values

mixed

min_enable_zlib_compression()

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.)

Return values

boolean,true

if compression enabled

min_fix_utf8()

min_fix_utf8

(

$value

)

Minimalistic UTF-8 sanitisation.

Note: This duplicates fix_utf8() intentionally for now.

Parameters

string

$value

Return values

string

min_get_maximum_revision()

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.

Return values

int

min_get_minimum_revision()

min_get_minimum_revision

(

)

Get the lowest possible currently valid revision number.

This is based on the current Moodle version.

Return values

int	Unix timestamp

min_get_slash_argument()

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.

Parameters

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.

Return values

string

min_is_revision_valid_and_current()

min_is_revision_valid_and_current

(

int

$revision

)

Helper function to determine if the given revision number is valid.

Parameters

int

$revision

A numeric revision to check for validity

Return values

bool	Whether the revision is valid

min_optional_param()

min_optional_param	(		$name,
			$default,
			$type )

Minimalistic library, usable even when no other moodle libs are loaded.

The only library that gets loaded if you define ABORT_AFTER_CONFIG before including main config.php. You can resume normal script operation if you define ABORT_AFTER_CONFIG_CANCEL and require the setup.php

Copyright

2009 Petr Skoda (skodak)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Minimalistic parameter validation function. Can not use optional param because moodlelib.php is not loaded yet

Parameters

string	$name
mixed	$default
string	$type

Return values

mixed

mod_page_type_list()

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.

Parameters

string	$pagetype
stdClass	$parentcontext
stdClass	$currentcontext

Return values

array

moodle_minimum_php_version_is_met()

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.

Parameters

bool

$haltexecution

Should execution be halted when requirement not met? Defaults to false.

Return values

bool	returns true if requirement is met (false if not)

moodle_require_minimum_php_version()

moodle_require_minimum_php_version

(

)

A set of PHP-compatible convenience functions to check Moodle minimum PHP version in a unified place.

PLEASE NOTE: This file is made to be both php-version compatible and without requirement on any moodle functions or installation so it can be used in installer or incompatible PHP versions.

Copyright

2017 Dan Poltawski dan@m.nosp@m.oodl.nosp@m.e.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Require our minimum php version or halt execution if requirement not met.

Return values

void	Execution is halted if version is not met.

move_category()

move_category

(

)

Deprecated

since 2.5

my_page_type_list()

my_page_type_list	(		$pagetype,
			$parentcontext = null,
			$currentcontext = null )

Generates the page type list for the my moodle page.

Parameters

string	$pagetype
stdClass	$parentcontext
stdClass	$currentcontext

Return values

array

mygroupid()

mygroupid

(

)

Deprecated

use groups_get_all_groups() instead.

navmenu()

navmenu

(

)

Deprecated

not relevant with global navigation in Moodle 2.x+

navmenulist()

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.

Parameters

stdClass	$course	A course object.
array	$sections
course_modinfo	$modinfo
string	$strsection
string	$strjumpto
int	$width
string	$cmid

Return values

string

The HTML block

normalize_component()

normalize_component ( $component )

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.

Parameters

string

$component

Return values

array

two-items list of [(string)type, (string|null)name]

Deprecated

since 2.6, use core_component\normalize_component()

Parameters

string

$component

Return values

array

two-items list of [(string)type, (string|null)name]

normalize_componentname()

static normalize_componentname ( $componentname )

static

Normalize the component name.

Note: this does not verify the validity of the plugin or component.

Parameters

string

$component

Return values

string

normalize_version()

normalize_version

(

$version

)

This function will normalize any version to just a serie of numbers separated by dots.

Everything else will be removed.

Parameters

string

$version

the original version

Return values

string

the normalized version

notice()

notice	(		$message,
			$link = '',
			$course = null )

Print a message and exit.

Parameters

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.

Return values

void	This function simply exits

notify()

notify

(

)

Deprecated

since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.

obfuscate_email()

obfuscate_email

(

$email

)

Given an email address, this function will return an obfuscated version of it.

Parameters

string

$email

The email address to obfuscate

Return values

string

The obfuscated email address

obfuscate_mailto()

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.

Parameters

string	$email	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

Return values

string

The obfuscated mailto link

obfuscate_text()

obfuscate_text

(

$plaintext

)

This function takes some text and replaces about half of the characters with HTML entity equivalents.

Return string is obviously longer.

Parameters

string

$plaintext

The text to be obfuscated

Return values

string

The obfuscated text

p()

p

(

$var

)

Add quotes to HTML characters.

Prints $var with HTML characters (like "<", ">", etc.) properly quoted. This function simply calls & displays s().

See also

s()

Parameters

string

$var

the string potentially containing HTML characters

page_doc_link()

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.

Parameters

string

$text

The text to be displayed for the link

Return values

string

The link to user documentation for this current page

page_get_doc_link_path()

page_get_doc_link_path

(

moodle_page

$page

)

Returns the path to use when constructing a link to the docs.

Since

Moodle 2.5.1 2.6

Parameters

moodle_page

$page

Return values

string

password_compat_not_supported()

password_compat_not_supported

(

)

Deprecated

since 2.7 PHP 5.4.x should be always compatible.

plagiarism_get_file_results()

plagiarism_get_file_results	(		$cmid,
			$userid,
			$file )

returns array of plagiarism details about specified file

Deprecated

Since Moodle 4.0. - this function was a placeholder and not used in core.

Todo

MDL-71326 This is to be moved from here to deprecatedlib.php in Moodle 4.4

Parameters

int	$cmid
int	$userid
object	$file	moodle file object

Return values

array

- sets of details about specified file, one array of details per plagiarism plugin each set contains at least 'analyzed', 'score', 'reporturl'

plagiarism_get_form_elements_module()

plagiarism_get_form_elements_module

(

)

Deprecated

Since Moodle 3.9. MDL-65835

plagiarism_get_links()

if(!defined('MOODLE_INTERNAL')) plagiarism_get_links

(

$linkarray

)

plagiarismlib.php - Contains core Plagiarism related functions.

Since

Moodle 2.0

Copyright

2010 Dan Marsden http://danmarsden.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later displays the similarity score and provides a link to the full report if allowed.

Parameters

object

$linkarray

contains all relevant information for the plugin to generate a link

Return values

string

- url to allow login/viewing of a similarity report

plagiarism_load_available_plugins()

plagiarism_load_available_plugins

(

)

Helper function - also loads lib file of plagiarism plugin.

Return values

array

of available plugins

plagiarism_print_disclosure()

plagiarism_print_disclosure

(

$cmid

)

Function that prints the student disclosure notifying that the files will be checked for plagiarism.

Parameters

integer

$cmid

- the cmid of this module

Return values

string

plagiarism_save_form_elements()

plagiarism_save_form_elements

(

)

Deprecated

Since Moodle 3.9. MDL-65835

plagiarism_update_status()

plagiarism_update_status	(		$course,
			$cm )

Allows a plagiarism plugin to print a button/link at the top of activity overview report pages.

Deprecated

Since Moodle 4.0 - Please use {plugin name}_before_standard_top_of_body_html instead.

Todo

MDL-71326 Remove this method.

Parameters

object	$course	- full Course object
object	$cm	- full cm object

Return values

string

preload_course_contexts()

preload_course_contexts

(

)

Deprecated

since Moodle 2.2

prevent_form_autofill_password()

prevent_form_autofill_password

(

)

Deprecated

since Moodle 3.2

print_arrow()

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.

Deprecated

use $OUTPUT->arrow() instead.

Todo

final deprecation of this function once MDL-45448 is resolved

If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.

Parameters

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

Return values

string|void

depending on $return

print_badge_image()

print_badge_image	(	badge	$badge,
		stdClass	$context,
			$size = 'small' )

Print badge image.

Parameters

badge	$badge	Badge object
stdClass	$context
string	$size

print_category_info()

print_category_info

(

)

Deprecated

since 2.5

print_checkbox()

print_checkbox

(

)

Deprecated

use html_writer\checkbox() instead.

print_collapsible_region()

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.

Parameters

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.

Return values

string|void

If $return is false, returns nothing, otherwise returns a string of HTML.

print_collapsible_region_end()

print_collapsible_region_end

(

$return = false

)

Close a region started with print_collapsible_region_start.

Parameters

boolean

$return

if true, return the HTML as a string, rather than printing it.

Return values

string|void

if $return is false, returns nothing, otherwise returns a string of HTML.

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.

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.

Parameters

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.

Return values

string|void

if $return is false, returns nothing, otherwise returns a string of HTML.

print_container()

print_container

(

)

Deprecated

use $OUTPUT->container() instead.

print_container_end()

print_container_end

(

)

Deprecated

use $OUTPUT->container_end() instead.

print_container_start()

print_container_start

(

)

Deprecated

use $OUTPUT->container_start() instead.

print_context_name()

print_context_name

(

)

Deprecated

since 2.2

print_continue()

print_continue

(

)

Deprecated

use $OUTPUT->continue_button() instead.

print_course()

print_course

(

)

Deprecated

since 2.5

print_course_search()

print_course_search

(

)

Deprecated

since 2.5

print_courses()

print_courses

(

)

Deprecated

since 2.5

print_error()

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.

Deprecated

since Moodle 4.1

Todo

MDL-74484 Final deprecation in Moodle 4.5.

Parameters

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

Return values

void,always

throws exception!

print_grade_menu()

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.

Todo

Finish documenting this function

Deprecate: this is only used in a few contrib modules

Parameters

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

Return values

string|bool

Depending on value of $return

print_grade_plugin_selector()

print_grade_plugin_selector	(		$plugin_info,
			$active_type,
			$active_plugin,
			$return = false )

Print grading plugin selection popup form.

Deprecated

since Moodle 4.0. Dropdown box navigation has been replaced with tertiary navigation.

Parameters

array	$plugin_info	An array of plugins containing information for the selector
boolean	$return	return as string

Return values

nothing

or string if $return true

print_group_picture()

print_group_picture	(		$group,
			$courseid,
			$large = false,
			$return = false,
			$link = true,
			$includetoken = false )

Print a specified group's avatar.

Parameters

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.

Return values

string|void

Depending on the setting of $return

print_header()

print_header

(

)

Deprecated

use $PAGE methods instead.

print_header_simple()

print_header_simple

(

)

Deprecated

use $PAGE methods instead.

print_location_comment()

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);

Parameters

string	$file
integer	$line
boolean	$return	Whether to return or print the comment

Return values

string|void

Void unless true given as third parameter

print_log()

print_log

(

)

Deprecated

since Moodle 3.2

print_log_csv()

print_log_csv

(

)

Deprecated

since Moodle 3.2

print_log_ods()

print_log_ods

(

)

Deprecated

since Moodle 3.2

print_log_xls()

print_log_xls

(

)

Deprecated

since Moodle 3.2

print_mnet_log()

print_mnet_log

(

)

Deprecated

since Moodle 3.2

print_my_moodle()

print_my_moodle

(

)

Deprecated

since 2.5

print_navigation()

print_navigation

(

)

Deprecated

use $OUTPUT->navbar() instead

print_overview()

print_overview

(

)

Deprecated

since 2.5

print_password_policy()

print_password_policy

(

)

Returns a localized sentence in the current language summarizing the current password policy.

Todo

this should be handled by a function/method in the language pack library once we have a support for it @uses $CFG

Return values

string

print_recent_activity()

print_recent_activity

(

)

Deprecated

since 2.5

print_recent_activity_note()

print_recent_activity_note	(		$time,
			$user,
			$text,
			$link,
			$return = false,
			$viewfullnames = null )

Display a recent activity note.

@staticvar string $strftimerecent

Parameters

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

Return values

string

If $retrun was true returns HTML for a recent activity notice.

print_remote_course()

print_remote_course

(

)

Deprecated

since 2.5

print_remote_host()

print_remote_host

(

)

Deprecated

since 2.5

print_scale_menu_helpbutton()

print_scale_menu_helpbutton

(

)

Deprecated

use $OUTPUT->help_icon_scale($courseid, $scale) instead.

print_section()

print_section

(

)

Deprecated

since 2.5

print_section_add_menus()

print_section_add_menus

(

)

Deprecated

since 2.5

print_side_block()

print_side_block

(

)

Deprecated

use $OUTPUT->block() instead.

print_tabs()

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.

Parameters

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

Return values

string

HTML output if $return was set to true.

print_textarea()

print_textarea

(

)

Deprecated

since Moodle 3.6

print_whole_category_list()

print_whole_category_list

(

)

Deprecated

since 2.5

process_environment_bypass()

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.

Parameters

string	xmldata containing the bypass data
object	result object to be updated

Return values

void

process_environment_messages()

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

Parameters

string	xmldata containing the feedback data
object	reult object to be updated

process_environment_restrict()

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.

Parameters

string	xmldata containing the restrict data
object	result object to be updated

Return values

void

process_environment_result()

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.

Parameters

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()

process_manual_revoke	(		$recipientid,
			$issuerid,
			$issuerrole,
			$badgeid )

Manually revoke awarded badges.

Parameters

int	$recipientid
int	$issuerid
int	$issuerrole
int	$badgeid

Return values

bool

process_new_icon()

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.

Parameters

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.

Return values

mixed

new unique revision number or false if not saved

profile_display_badges()

profile_display_badges

(

)

Deprecated

since Moodle 2.9 MDL-45898 - please do not use this function any more.

profile_display_fields()

profile_display_fields

(

)

Deprecated

since Moodle 3.11 MDL-71051

profile_edit_category()

profile_edit_category

(

)

Deprecated

since Moodle 3.11 MDL-71051

profile_edit_field()

profile_edit_field

(

)

Deprecated

since Moodle 3.11 MDL-71051

proxy_log_callback()

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.

Parameters

array

$code

stream callback code

purify_html()

purify_html	(		$text,
			$options = array() )

KSES replacement cleaning function - uses HTML Purifier.

Parameters

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)

Return values

string

put_records_csv()

put_records_csv

(

)

Deprecated

since Moodle 3.2

See also

download_as_dataformat (lib/dataformatlib.php)

qualified_me()

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

Return values

mixed

full page URL string or false if unknown

question_add_tops()

question_add_tops

(

)

Deprecated

since Moodle 3.5. MDL-61132

question_is_only_toplevel_category_in_context()

question_is_only_toplevel_category_in_context

(

)

Deprecated

since Moodle 3.5. MDL-61132

raise_memory_limit()

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').

Parameters

mixed

$newlimit

the new memory limit

Return values

bool

success

random_bytes_emulate()

random_bytes_emulate

(

$length

)

Try to generate cryptographically secure pseudo-random bytes.

Note this is achieved by fallbacking between:

• PHP 7 random_bytes().
• OpenSSL openssl_random_pseudo_bytes().
• In house random generator getting its entropy from various, hard to guess, pseudo-random sources.

Parameters

int

$length

requested length in bytes

Deprecated

since 4.3.

Return values

string

binary data

rebuild_contexts()

rebuild_contexts

(

)

Deprecated

since 2.2

rebuild_course_cache()

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

Parameters

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.

Return values

void

Exceptions

coding_exception

rebuildnolinktag()

rebuildnolinktag

(

$text

)

This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI) will transform it to html entities.

Parameters

string

$text

Text to search for nolink tag in

Return values

string

recaptcha_check_response()

recaptcha_check_response	(		$verifyurl,
			$privkey,
			$remoteip,
			$response )

Calls an HTTP POST function to verify if the user's response was correct.

Parameters

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

Return values

ReCaptchaResponse

recaptcha_get_challenge_html()

recaptcha_get_challenge_html	(		$apiurl,
			$pubkey,
			$lang = null,
		bool	$compactmode = false )

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.

Parameters

string	$apiurl	URL for reCAPTCHA API
string	$pubkey	The public key for reCAPTCHA
string	$lang	Language to use. If not provided, get current language.
bool	$compactmode	If true, use the compact widget.

Return values

string

- The HTML to be embedded in the user's form.

recaptcha_lang()

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

Parameters

string

$lang

Language to use. If not provided, get current language.

Return values

string

A language code

redirect()

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.

Parameters

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.

Exceptions

moodle_exception

reduce_memory_limit()

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')

Parameters

string

$newlimit

the new memory limit

Return values

bool

replace_ampersands_not_followed_by_entity()

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.

Parameters

string

$string

Return values

string

report_insights_context_insights()

report_insights_context_insights

(

\context

$context

)

Deprecated

since Moodle 3.8

require_phpunit_isolation()

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.

Exceptions

coding_exception

The exception thrown when the process is not isolated.

reset_login_count()

reset_login_count

(

)

Deprecated

reset_text_filters_cache()

reset_text_filters_cache

(

$phpunitreset = false

)

Resets some data related to filters, called during upgrade or when general filter settings change.

Parameters

bool

$phpunitreset

true means called from our PHPUnit integration test reset

Return values

void

resize_image()

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.

Parameters

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.

Return values

string|bool

False if a problem occurs, else the resized image data.

resize_image_from_image()

resize_image_from_image	(		$original,
			$imageinfo,
			$width,
			$height,
			$forcecanvas = false )

Resize an image from an image object.

Parameters

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.

Return values

string|bool

False if a problem occurs, else the resized image data.

resourcelib_embed_general()

resourcelib_embed_general	(		$fullurl,
			$title,
			$clicktoopen,
			$mimetype )

Returns general link or file embedding html.

Parameters

string	$fullurl
string	$title
string	$clicktoopen
string	$mimetype

Return values

string

html

resourcelib_embed_image()

resourcelib_embed_image	(		$fullurl,
			$title )

Returns image embedding html.

Parameters

string	$fullurl
string	$title

Return values

string

html

resourcelib_embed_pdf()

resourcelib_embed_pdf	(		$fullurl,
			$title,
			$clicktoopen )

Returns general link or pdf embedding html.

Parameters

string	$fullurl
string	$title
string	$clicktoopen

Return values

string

html

resourcelib_get_displayoptions()

resourcelib_get_displayoptions	(	array	$enabled,
			$current = null )

Returns list of available display options.

Parameters

array	$enabled	list of options enabled in module configuration
int	$current	current display options for existing instances

Return values

array

of key=>name pairs

resourcelib_get_extension()

resourcelib_get_extension

(

$fullurl

)

Looks for the extension.

Parameters

string

$fullurl

Return values

string

file extension

resourcelib_guess_url_mimetype()

resourcelib_guess_url_mimetype

(

$fullurl

)

Tries to guess correct mimetype for arbitrary URL.

Parameters

string

$fullurl

Return values

string

mimetype

resourcelib_try_file_migration()

resourcelib_try_file_migration	(		$filepath,
			$cmid,
			$courseid,
			$component,
			$filearea,
			$itemid )

Try on demand migration of file from old course files.

Parameters

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

Return values

mixed,false

if not found, stored_file instance if migrated to new area

restrict_php_version()

restrict_php_version	(	&	$result,
			$version )

Check if the current PHP version is greater than or equal to an unsupported version.

Parameters

object	$result	an environment_results instance
string	$version	the version of PHP that can't be used

Return values

bool	result of version check

restrict_php_version_7()

restrict_php_version_7

(

&

$result

)

Check if the current PHP version is greater than or equal to PHP version 7.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_71()

restrict_php_version_71

(

&

$result

)

Check if the current PHP version is greater than or equal to PHP version 7.1.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_72()

restrict_php_version_72

(

&

$result

)

Check if the current PHP version is greater than or equal to PHP version 7.2.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_73()

restrict_php_version_73

(

&

$result

)

Check if the current PHP version is greater than or equal to PHP version 7.3.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_74()

restrict_php_version_74

(

&

$result

)

Check if the current PHP version is greater than or equal to PHP version 7.4.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_80()

restrict_php_version_80

(

$result

)

Check if the current PHP version is greater than or equal to PHP version 8.0.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_81()

restrict_php_version_81

(

$result

)

Check if the current PHP version is greater than or equal to PHP version 8.1.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_82()

restrict_php_version_82

(

$result

)

Check if the current PHP version is greater than or equal to PHP version 8.2.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

restrict_php_version_83()

restrict_php_version_83

(

$result

)

Check if the current PHP version is greater than or equal to PHP version 8.3.

Parameters

object

$result

an environment_results instance

Return values

bool	result of version check

right_to_left()

right_to_left

(

)

Returns true if the user is using a right-to-left language.

Return values

boolean

true if the current language is right-to-left (Hebrew, Arabic etc)

s()

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.

Parameters

string

$var

the string potentially containing HTML characters

Return values

string

search_generate_SQL()

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()

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.

Deprecated

since Moodle 2.9 MDL-48939

Todo

MDL-48940 This will be deleted in Moodle 3.2

See also

search_generate_SQL()

send_headers()

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.

Parameters

string	$contenttype
bool	$cacheable	Can this page be cached on back?

Return values

void,sends

HTTP headers

serialise_tool_proxy()

serialise_tool_proxy

(

)

Deprecated

since 3.10

session_get_instance()

session_get_instance

(

)

Deprecated

since 2.6

session_get_realuser()

session_get_realuser

(

)

Deprecated

since 2.6

session_is_legacy()

session_is_legacy

(

)

Deprecated

since 2.6

session_is_loggedinas()

session_is_loggedinas

(

)

Deprecated

since 2.6

session_kill()

session_kill

(

)

Deprecated

since 2.6

session_kill_all()

session_kill_all

(

)

Deprecated

since 2.6

session_kill_user()

session_kill_user

(

)

Deprecated

since 2.6

session_loginas()

session_loginas

(

)

Deprecated

since 2.6

session_set_user()

session_set_user

(

)

Deprecated

since 2.6

session_touch()

session_touch

(

)

Deprecated

since 2.6

sesskey()

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

Return values

string

set_current_group()

set_current_group

(

)

Deprecated

Since year 2006 - please do not use this function any more.

set_debugging()

set_debugging	(		$level,
			$debugdisplay = null )

Alter debugging level for the current request, the change is not saved in database.

Parameters

int	$level	one of the DEBUG_* constants
bool	$debugdisplay

set_moodle_cookie()

set_moodle_cookie

(

$username

)

Sets a moodle cookie with a weakly encrypted username.

Parameters

string

$username

to encrypt and place in a cookie, '' means delete current cookie

Return values

void

set_user_device_type()

set_user_device_type

(

)

Deprecated

since 2.6

setup()

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 {

See also

setup_page_for_filters()} for each piece of text being filtered, so it is responsible for controlling its own execution cardinality.

Parameters

moodle_page	$page	the page we are going to add requirements to.
context	$context	the context which contents are going to be filtered.

Since

Moodle 2.3

Reimplemented in filter_glossary, filter_mathjaxloader, and filter_mediaplugin.

setup_get_remote_url()

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.

Return values

array

in the same format that parse_url returns, with the addition of a 'fullpath' element, which includes any slasharguments path.

setup_page_for_filters()

filter_manager::setup_page_for_filters	(		$page,
			$context )

Setup page with filters requirements and other prepare stuff.

This method is used by {

See also

format_text()} and {

format_string()} in order to allow filters to setup any page requirement (js, css...) or perform any action needed to get them prepared before filtering itself happens by calling to each every active setup() method.

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.

Parameters

moodle_page	$page	the page we are going to add requirements to.
context	$context	the context which contents are going to be filtered.

Since

Moodle 2.3

setup_page_for_globally_available_filters()

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.

Parameters

moodle_page

$page

The page.

Since

Moodle 3.2

show_event()

show_event

(

)

Deprecated

please use calendar_event->toggle_visibility(true) instead.

signup_captcha_enabled()

signup_captcha_enabled

(

)

Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.

Return values

bool

signup_get_user_confirmation_authplugin()

signup_get_user_confirmation_authplugin

(

)

Check if user confirmation is enabled on this site and return the auth plugin handling registration if enabled.

Return values

stdClass

the current auth plugin handling user registration or false if registration not enabled

Since

Moodle 3.2

signup_is_enabled()

signup_is_enabled

(

)

Check if sign-up is enabled in the site.

If is enabled, the function will return the authplugin instance.

Return values

mixed

false if sign-up is not enabled, the authplugin instance otherwise.

Since

Moodle 3.2

signup_setup_new_user()

signup_setup_new_user

(

$user

)

Add the missing fields to a user that is going to be created.

Parameters

stdClass

$user

the new user object

Return values

stdClass

the user filled

Since

Moodle 3.2

signup_validate_data()

signup_validate_data	(		$data,
			$files )

Validates the standard sign-up data (except recaptcha that is validated by the form element).

Parameters

array	$data	the sign-up data
array	$files	files among the data

Return values

array

list of errors, being the key the data element name and the value the error itself

Since

Moodle 3.2

site_scale_used()

site_scale_used

(

)

Deprecated

since Moodle 3.1

skip_main_destination()

skip_main_destination

(

)

Deprecated

use $OUTPUT->skip_link_target() in instead.

soap_call()

soap_call	(		$connection,
			$call,
			$params )

Make a call to a SoapClient.

Parameters

SoapClient	$connection	The SoapClient to call
string	$call	Operation to be performed by client
array	$params	Parameters for the call

Return values

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()

soap_connect	(		$wsdl,
			$trace = false )

Create a new SoapClient object.

Parameters

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

Return values

mixed

Returns either a SoapClient object or, if the connection failed, a SoapFault object.

stats_cron_daily()

stats_cron_daily

(

$maxdays = 1

)

Execute daily statistics gathering.

Parameters

int

$maxdays

maximum number of days to be processed

Return values

boolean

success

stats_cron_monthly()

stats_cron_monthly

(

)

Execute monthly statistics gathering.

Return values

boolean

success

stats_cron_weekly()

stats_cron_weekly

(

)

Execute weekly statistics gathering.

Return values

boolean

success

stats_fix_zeros()

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.

Parameters

array	$stats	array of statistics.
int	$timeafter	unused.
string	$timestr	type of statistics to generate (dayly, weekly, monthly).
boolean	$line2
boolean	$line3

Return values

array

of fixed statistics.

stats_get_base_daily()

stats_get_base_daily

(

$time = 0

)

Start of day.

Parameters

int

$time

timestamp

Return values

int	start of day

stats_get_base_monthly()

stats_get_base_monthly

(

$time = 0

)

Start of month.

Parameters

int

$time

timestamp

Return values

int	start of month

stats_get_base_weekly()

stats_get_base_weekly

(

$time = 0

)

Start of week.

Parameters

int

$time

timestamp

Return values

int	start of week

stats_get_next_day_start()

stats_get_next_day_start

(

$time

)

Start of next day.

Parameters

int

$time

timestamp

Return values

start

of next day

stats_get_next_month_start()

stats_get_next_month_start

(

$time

)

Start of next month.

Parameters

int

$time

timestamp

Return values

start

of next month

stats_get_next_week_start()

stats_get_next_week_start

(

$time

)

Start of next week.

Parameters

int

$time

timestamp

Return values

start

of next week

stats_get_start_from()

stats_get_start_from

(

$str

)

Return starting date of stats processing.

Parameters

string

$str

name of table - daily, weekly or monthly

Return values

int

timestamp

stats_progress()

stats_progress

(

$ident

)

Print daily cron progress.

Parameters

string

$ident

stats_run_query()

stats_run_query	(		$sql,
			$parameters = array() )

Execute individual daily statistics queries.

Parameters

string

$sql

The query to run

Return values

boolean

success

stats_temp_table_clean()

stats_temp_table_clean

(

)

Deletes summary logs table for stats calculation.

Return values

bool	success (true) or failure(false)

stats_temp_table_fill()

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

Parameters

int	timestamp of the start time of logs view
int	timestamp of the end time of logs view

Return values

bool	success (true) or failure(false)

stats_temp_table_setup()

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

Parameters

int	timestart timestamp of the start time of logs view
int	timeend timestamp of the end time of logs view

Return values

bool	success (true) or failure(false)

strip_links()

strip_links

(

$string

)

Given a string, replaces all .

* by .* and returns the string.

Parameters

string

$string

Return values

string

strip_pluginfile_content()

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.

Parameters

string

$source

The text

Return values

string

The stripped text

strip_querystring()

strip_querystring

(

$url

)

Remove query string from url.

Takes in a URL and returns it without the querystring portion.

Parameters

string

$url

the url which may have a query string attached.

Return values

string

The remaining URL.

tag_add()

tag_add

(

)

Deprecated

since 3.1

tag_assign()

tag_assign

(

)

Deprecated

since 3.1. Use core_tag_tag\set_item_tags() or core_tag_tag\add_item_tag() instead

tag_autocomplete()

tag_autocomplete

(

)

Deprecated

since 3.0

tag_bulk_delete_instances()

tag_bulk_delete_instances

(

)

Deprecated

since 3.1

tag_cleanup()

tag_cleanup

(

)

Deprecated

since 3.1

tag_cloud_sort()

tag_cloud_sort

(

)

Deprecated

since 3.1

tag_compute_correlations()

tag_compute_correlations

(

)

Deprecated

since 3.1

tag_cron()

tag_cron

(

)

Deprecated

since 3.1

tag_delete()

tag_delete

(

)

Deprecated

since 3.1

tag_delete_instance()

tag_delete_instance

(

)

Deprecated

since 3.1. Use core_tag_tag\remove_item_tag() instead

tag_delete_instances()

tag_delete_instances

(

)

Deprecated

since 3.1

tag_description_set()

tag_description_set

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->update() instead

tag_display_name()

tag_display_name

(

)

Deprecated

since 3.1

tag_find_records()

tag_find_records

(

)

Deprecated

since 3.1. Use core_tag_tag\get_by_name()->get_tagged_items() instead

tag_find_tags()

tag_find_tags

(

)

Deprecated

since 3.1

tag_get()

tag_get

(

)

Deprecated

since 3.1

tag_get_correlated()

tag_get_correlated

(

)

Deprecated

since 3.1

tag_get_id()

tag_get_id

(

)

Deprecated

since 3.1. Use core_tag_tag\get_by_name() or core_tag_tag\get_by_name_bulk()

tag_get_name()

tag_get_name

(

)

Deprecated

since 3.1

tag_get_related_tags()

tag_get_related_tags

(

)

Deprecated

since 3.1

tag_get_related_tags_csv()

tag_get_related_tags_csv

(

)

Deprecated

since 3.1

tag_get_tags()

tag_get_tags

(

)

Deprecated

since 3.1. Use core_tag_tag\get_item_tags() instead

tag_get_tags_array()

tag_get_tags_array

(

)

Deprecated

since 3.1

tag_get_tags_csv()

tag_get_tags_csv

(

)

Deprecated

since 3.1. Use core_tag_tag\get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag\get_item_tags())

tag_get_tags_ids()

tag_get_tags_ids

(

)

Deprecated

since 3.1. Use core_tag_tag\get_item_tags() instead

tag_normalize()

tag_normalize

(

)

Deprecated

since 3.1

tag_print_cloud()

tag_print_cloud

(

)

Deprecated

since 3.1

tag_print_description_box()

tag_print_description_box

(

)

Deprecated

since 3.1

tag_print_management_box()

tag_print_management_box

(

)

Deprecated

since 3.1

tag_print_search_box()

tag_print_search_box

(

)

Deprecated

since 3.1

tag_print_search_results()

tag_print_search_results

(

)

Deprecated

since 3.1

tag_print_tagged_users_table()

tag_print_tagged_users_table

(

)

Deprecated

since 3.1

tag_print_user_box()

tag_print_user_box

(

)

Deprecated

since 3.1

tag_print_user_list()

tag_print_user_list

(

)

Deprecated

since 3.1

tag_process_computed_correlation()

tag_process_computed_correlation

(

)

Deprecated

since 3.1

tag_record_count()

tag_record_count

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->count_tagged_items() instead

tag_record_tagged_with()

tag_record_tagged_with

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->is_item_tagged_with() instead

tag_rename()

tag_rename

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->update() instead

tag_set()

tag_set

(

)

Deprecated

since 3.1

tag_set_add()

tag_set_add

(

)

Deprecated

since 3.1

tag_set_delete()

tag_set_delete

(

)

Deprecated

since 3.1

tag_set_flag()

tag_set_flag

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->flag() instead

tag_type_set()

tag_type_set

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->update() instead

tag_unset_flag()

tag_unset_flag

(

)

Deprecated

since 3.1. Use core_tag_tag\get($tagid)->reset_flag() instead

text_filtering_hash() [1/2]

filter_manager::text_filtering_hash

(

)

Deprecated

Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more.

text_filtering_hash() [2/2]

null_filter_manager::text_filtering_hash

(

)

As for the equivalent filter_manager method.

Deprecated

Since Moodle 3.0 MDL-50491.

text_to_html()

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.

Parameters

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.

Return values

string

textlib_get_instance()

textlib_get_instance

(

)

Deprecated

since Moodle 2.2 use core_text\xxxx() instead.

theme_get_locked_theme_for_device()

theme_get_locked_theme_for_device

(

$device

)

Returns the theme named defined in config.php for the given device.

Parameters

string

$device

The device

Deprecated

since 4.3.

Return values

string

or null

theme_is_device_locked()

theme_is_device_locked

(

$device

)

Checks if the given device has a theme defined in config.php.

Parameters

string

$device

The device

Deprecated

since 4.3.

Return values

bool

trusttext_active()

trusttext_active

(

)

Is trusttext feature active?

Return values

bool

trusttext_pre_edit()

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.

Parameters

stdClass	$object	data object with xxx, xxxformat and xxxtrust fields
string	$field	name of text field
context	$context	active context

Return values

stdClass

updated $object

trusttext_trusted()

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!!

Parameters

context

$context

Return values

bool	true if user trusted

unload_all_filters() [1/2]

filter_manager::unload_all_filters ( )

protected

Unloads all filters and other cached information.

Reimplemented in performance_measuring_filter_manager.

unload_all_filters() [2/2]

performance_measuring_filter_manager::unload_all_filters ( )

protected

Unloads all filters and other cached information.

Reimplemented from filter_manager.

unzip_file()

unzip_file

(

)

Deprecated

since 2.0 MDL-15919

update_category_button()

update_category_button

(

)

Deprecated

since 2.5

update_event()

update_event

(

)

Deprecated

please calendar_event->update() instead.

update_log_display_entry()

update_log_display_entry

(

)

Deprecated

update_login_count()

update_login_count

(

)

Deprecated

update_module_button()

update_module_button

(

)

Deprecated

since Moodle 3.2

update_timezone_records()

update_timezone_records

(

)

Deprecated

since Moodle 2.9

upgrade_ensure_not_running()

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

Exceptions

moodle_exception

if executed from inside of upgrade script and $warningonly is false

Parameters

bool

$warningonly

if true displays a warning instead of throwing an exception

Return values

bool	true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only

user_get_participants()

user_get_participants

(

)

Deprecated

since Moodle 3.9 MDL-68612 - See core_user\table\participants_search for an improved way to fetch participants.

user_get_participants_sql()

user_get_participants_sql

(

)

Deprecated

since Moodle 3.9 MDL-68612 - See core_user\table\participants_search for an improved way to fetch participants.

user_get_total_participants()

user_get_total_participants

(

)

Deprecated

since Moodle 3.9 MDL-68612 - See core_user\table\participants_search for an improved way to fetch participants.

useredit_shared_definition_preferences()

useredit_shared_definition_preferences

(

)

Deprecated

since Moodle 2.9 MDL-45774 - Please do not use this function any more.

validate_email()

validate_email

(

$address

)

Validates an email to make sure it makes sense.

Parameters

string

$address

The email address to validate.

Return values

boolean

validate_login_captcha()

validate_login_captcha

(

string|bool

$captcha

)

Check the submitted captcha is valid or not.

Parameters

string | bool

$captcha

The value submitted in the login form that we are validating. If false is passed for the captcha, this function will always return true.

Return values

boolean

If the submitted captcha is valid.

wikify_links()

wikify_links

(

$string

)

This expression turns links into something nice in a text format.

(Russell Jungwirth)

Parameters

string

$string

Return values

string

xmlize()

xmlize	(		$data,
			$whitespace = 1,
			$encoding = 'UTF-8',
			$reporterrors = false )

XML parsing function calles into class.

Note: Used by xml element handler as callback.

Parameters

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.

Return values

array

representation of the parsed XML.

zip_files()

zip_files

(

)

Deprecated

since 2.0 MDL-15919

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    'moodle/backup:backupcourse',
    'moodle/category:manage',
    'moodle/course:create',
    'moodle/site:approvecourse',
    'moodle/restore:restorecourse'
)

$files

if (file_exists(__DIR__.'/../config.php')) $files = array('boost/style/moodle.css')

This script prints basic CSS for the installer.

Copyright

2011 Petr Skoda (http://skodak.org)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

$fullmatch

bool filterobject::$fullmatch

whether to match complete words.

If true, 'T' won't be matched in 'Tim'.

$plugins

foreach($plugins as $plugin) if( $hassiteconfig) if($hassiteconfig) if( $hassiteconfig &&core_communication\api::is_available()) 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!

$replacementphrase

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.

$SITE

global $SITE

This file defines settingpages and externalpages under the "badges" section.

Copyright

2012 onwards Totara Learning Solutions Ltd

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Author

Yuliya Bozhko yuliy.nosp@m.a.bo.nosp@m.zhko@.nosp@m.tota.nosp@m.ralms.nosp@m..com

$stringfilters

moodle_text_filter [][] filter_manager::$stringfilters = array()

protected

This list of active filters, by context, for filtering strings.

An array contextid => ordered array of filter name => filter objects.

$strmnetservices

if (!defined( 'MOODLE_INTERNAL')) $strmnetservices = get_string('mnetservices', 'mnet')

Tabs to be included on the pages for configuring a single host $mnet_peer object must be set and bootstrapped $currenttab string must be set.

Copyright

2007 Donal McMullan

2007 Martin Langhoff

2010 Penny Leach

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

$textfilters

moodle_text_filter [][] filter_manager::$textfilters = array()

protected

This list of active filters, by context, for filtering content.

An array contextid => ordered array of filter name => filter objects.

danger

alert danger

Initial value:

{
    color: #6e211e

else [1/7]

if (isset( $mnet_peer->id) &&$mnet_peer->id > 0) else

Initial value:

{
    $tabs[] = new tabobject('mnetdetails', '#', $strmnetedithost, $strmnetedithost, false)

else [2/7]

if (isset( $_REQUEST[ 'lang'])) else

Initial value:

{
    $lang = 'en'

This script creates config.php file during installation.

Copyright

2009 Petr Skoda (http://skodak.org)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

else [3/7]

if (isset( $_REQUEST[ 'admin'])) else

Initial value:

{
    $admin = 'admin'

else [4/7]

if(!function_exists('iconv')) if (PHP_INT_SIZE > 4) else

Initial value:

{
    
    $minrequiredmemory = '40M'

else [5/7]

if (!empty( $_POST)) else

Initial value:

{
    $config->stage    = INSTALL_WELCOME

else [6/7]

if (defined( 'COMPONENT_CLASSLOADER')) else

Initial value:

{
    spl_autoload_register('core_component::classloader')

else [7/7]

if ( $distro) else

Initial value:

{
    install_print_header($config, get_string('language'),
                                  get_string('chooselanguagehead', 'install'),
                                  get_string('chooselanguagesub', 'install'))

ENROL_EXT_REMOVED_SUSPEND

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.

ENROL_EXT_REMOVED_SUSPENDNOROLES

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.

ENROL_INSTANCE_DISABLED

const ENROL_INSTANCE_DISABLED 1

Course enrol instance disabled, user may enter course if other enrol instance enabled.

(used in enrol->status)

ENROL_INSTANCE_ENABLED

const ENROL_INSTANCE_ENABLED 0

Course enrol instance enabled.

(used in enrol->status)

ENROL_REQUIRE_LOGIN_CACHE_PERIOD

const ENROL_REQUIRE_LOGIN_CACHE_PERIOD 1800

Deprecated

• enrol caching was reworked, use ENROL_MAX_TIMESTAMP instead

ENROL_RESTORE_TYPE

const ENROL_RESTORE_TYPE 'enrolrestore'

Deprecated

since 2.4 not used any more, migrate plugin to new restore methods

ENV_SELECT_NEWER

const ENV_SELECT_NEWER 0

Define algorithm used to select the xml file.

To select the newer file available to perform checks

family

font family

Moodle Generic plain page.

This is used for various pages, usually errors, early in the Moodle bootstrap. It can be safetly customized by editing this file directly but it MUST NOT contain any Moodle resources such as theme files generated by php, it can only contain references to static css and images, and as a precaution its recommended that everything is inlined rather than references. This is why this file is located here as it cannot be inside a Moodle theme.

Copyright

2020 Brendan Heywood brend.nosp@m.an@c.nosp@m.ataly.nosp@m.st-a.nosp@m.u.net

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

FORMAT_WIKI

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)

Deprecated

since 2005!

h1

h1

Initial value:

{
    font-size: 2.34rem

if [1/3]

if(!defined('MOODLE_INTERNAL'))

(

!

defined 'MOODLE_INTERNAL'

)

Allows the admin to configure a list of profile fields that are sent/recieved.

Copyright

2010 onwards Penny Leach penny.nosp@m.@lii.nosp@m.p.ch

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

if [2/3]

if(!defined('MOODLE_INTERNAL'))

(

!

defined 'MOODLE_INTERNAL'

)

The form for configuring which services are subscribed and published on a host.

Copyright

2010 Penny Leach

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

if [3/3]

if(!defined('MOODLE_INTERNAL'))

(

!

defined 'MOODLE_INTERNAL'

)

Form class for editing badges preferences.

Copyright

2013 onwards Totara Learning Solutions Ltd

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Author

Yuliya Bozhko yuliy.nosp@m.a.bo.nosp@m.zhko@.nosp@m.tota.nosp@m.ralms.nosp@m..com

LIST_NONE

const LIST_NONE 1

#-

#+ list defines

logging_trait

trait core::task\logging_trait

Initial value:

{
 
    
    protected progress_trace $trace = null

This trait includes functions to assist with logging in tasks.

Copyright

2018 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

MEMORY_EXTRA

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.

NO_ERROR

const NO_ERROR 0

Add required files.

Include the necessary Define a bunch of XML processing errors XML Processing Error

NO_MOODLE_COOKIES

const NO_MOODLE_COOKIES true

This file is used to call any registered externallib function in Moodle.

It will process more than one request and return more than one response if required. It is recommended to add webservice functions and re-use this script instead of writing any new custom ajax scripts.

Since

Moodle 2.9

Copyright

2015 Damyon Wiese

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

stoppable_trait

trait core::hook\stoppable_trait

Initial value:

{
    
    private bool $propagationstopped = false

Moodle specific implementation of Psr\EventDispatcher\StoppableEventInterface interface from PSR-14.

Author

Petr Skoda

Copyright

2023 Open LMS

License

https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

TABLE_P_TOP

const TABLE_P_TOP 1

#-

#+ Constants that indicate whether the paging bar for the table appears above or below the table.

TABLE_SHOW_ALL_PAGE_SIZE

const TABLE_SHOW_ALL_PAGE_SIZE 5000

#-

Constant that defines the 'Show all' page size.

TEXTFILTER_EXCL_SEPARATOR

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

TOKEN_USER

const TOKEN_USER "0"

Constants for the various types of tokens.

See also

lexer.php