|
Moodle PHP Documentation 5.0
Moodle 5.0.1+ (Build: 20250711) (61af040cd5f)
|
Namespaces | |
| namespace | access |
| | |
| namespace | antivirus |
| | |
| namespace | attribute |
| | |
| namespace | aws |
| | |
| namespace | check |
| | |
| namespace | context |
| | |
| namespace | dataformat |
| | |
| namespace | dml |
| | |
| namespace | event |
| | |
| namespace | exception |
| | |
| namespace | external |
| | |
| namespace | files |
| | |
| namespace | form |
| | |
| namespace | hook |
| | |
| namespace | hub |
| | |
| namespace | lock |
| | |
| namespace | log |
| | |
| namespace | message |
| namespace | moodlenet |
| | |
| namespace | oauth2 |
| | |
| namespace | output |
| | |
| namespace | plugininfo |
| | |
| namespace | privacy |
| | |
| namespace | progress |
| | |
| namespace | router |
| | |
| namespace | session |
| | |
| namespace | task |
| | |
| namespace | test |
| | |
| namespace | tests |
| | |
| namespace | update |
| | |
| namespace | upgrade |
| | |
Classes | |
| class | activity_dates |
| Class for fetching the important dates of an activity module for a given module instance and a user. More... | |
| class | attribute_helper |
| class | chart_axis |
| Chart axis class. More... | |
| class | chart_bar |
| Chart bar class. More... | |
| class | chart_base |
| Chart base class. More... | |
| class | chart_line |
| Chart line class. More... | |
| class | chart_pie |
| Chart pie class. More... | |
| class | chart_series |
| Chart series class. More... | |
| interface | clock |
| class | component |
| Collection of components related methods. More... | |
| class | content |
| The Content API allows all parts of Moodle to determine details about content within a component, or plugintype. More... | |
| class | context |
| class | context_helper |
| class | cron |
| class | dataformat |
| Dataformat utility class. More... | |
| class | deprecation |
| class | di |
| class | emoticon_manager |
| class | encryption |
| class | formatting |
| class | hooks |
| class | http_client |
| class | invalid_persistent_exception |
| Invalid persistent exception class. More... | |
| class | ip_utils |
| Static helper class providing some useful internet-protocol-related functions. More... | |
| class | lang_string |
| class | locale |
| class | notification |
| class | param_clientside_regex |
| class | persistent |
| class | plugin_manager |
| class | report_helper |
| class | router |
| class | system_clock |
| class | url |
| class | user |
| class | uuid |
| V4 UUID generator class. More... | |
Enumerations | |
| enum | param : string { replacement = 'stringid' , since , reason , false , replacement = 'stringid' , since , reason , true , replacement = 'stringid' , since , reason , true , replacement = 'stringid' , since , reason , true , replacement = 'stringid' , since , reason , true , replacement = 'stringid' , since , reason , true , replacement = 'stringid' , since , reason , from_type } |
Functions | |
| static | fetch_plugins ($plugintype, $fulldir) |
| Returns list of plugins of given type in given directory. | |
| static | fill_classmap_cache () |
| Find all classes that can be autoloaded including frankenstyle namespaces. | |
| static | fill_classmap_renames_cache () |
| Records all class renames that have been made to facilitate autoloading. | |
| static | fill_filemap_cache () |
| Fills up the cache defining what plugins have certain files. | |
| 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. | |
| static | get_all_plugin_types () |
| Gets list of all plugin types, comprising available plugin types as well as any plugin types currently in deprecation. | |
| static | get_all_plugins_list (string $plugintype) |
| Get list of all plugins of a given type, comprising all available plugins as well as any plugins in deprecation. | |
| static | get_all_subplugins ($component) |
| Return all subplugins for the component, comprising all available subplugins plus any in deprecation. | |
| 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. | |
| 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, bool $includedeprecated=false) |
| Returns a list of frankenstyle component names, including all plugins, subplugins, and subsystems. | |
| static | get_core_api_names () |
| Returns the list of available API names. | |
| static | get_core_apis () |
| List all core APIs and their attributes. | |
| static | get_core_subsystems () |
| List all core subsystems and their location. | |
| static | get_deleted_plugin_list ($plugintype) |
| Get list of deleted plugins of a given type. | |
| static | get_deleted_plugin_types () |
| Get a list of all deleted plugin types and their locations. | |
| static | get_deprecated_plugin_list ($plugintype) |
| Get list of deprecated plugins of a given type. | |
| static | get_deprecated_plugin_types () |
| Get a list of deprecated plugin types and their locations. | |
| 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. | |
| 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. | |
| static | get_subplugins ($component) |
| Return all available 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. | |
| static | has_monologo_icon (string $plugintype, string $pluginname) |
| Checks for the presence of monologo icons within a plugin. | |
| static | invalidate_opcode_php_cache ($file) |
| Invalidate opcode cache for given file, this is intended for php files that are stored in dataroot. | |
| 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. | |
| static | is_deleted_plugin_type (string $plugintype) |
| Is the plugintype deleted. | |
| static | is_deprecated_plugin_type (string $plugintype) |
| Is the plugintype deprecated. | |
| static | is_plugintype_in_deprecation (string $plugintype) |
| Is the plugintype in deprecation. | |
| static | is_valid_plugin_name ($plugintype, $pluginname) |
| This method validates a plug name. | |
| static | load_classes ($component, $fulldir, $namespace='') |
| Find classes in directory and recurse to subdirs. | |
| static | load_legacy_classes (?string $fulldir, bool $allowsubsystems=false,) |
| Load legacy classes based upon the db/legacyclasses.php file. | |
| static | load_renamed_classes (?string $fulldir) |
| Loads the db/renamedclasses.php file from the given directory. | |
| static | normalize_component ($component) |
| Normalize the component name using the "frankenstyle" rules. | |
| static | normalize_componentname ($componentname) |
| Normalize the component name. | |
Variables | |
| if(function_exists('debugging') &&debugging()) else if(file_exists("$ownerdir/db/subplugins.php")) foreach($subtypesregister as $key=> $subtypes) return | $types |
| const | ANY_VERSION 'any' |
| Any version - special value that can be used in $plugin->dependencies in version.php files. | |
| else | |
| 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. | |