[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/classes/plugininfo/ -> dataformat.php (summary)

Defines classes used for plugin info.

Copyright: 2016 Brendan Heywood (brendan@catalyst-au.net)
License: http://www.gnu.org/copyleft/gpl.html GNU Public License
File Size: 166 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

dataformat:: (7 methods):
  init_display_name()
  get_plugins()
  get_enabled_plugins()
  get_settings_section_name()
  load_settings()
  is_uninstall_allowed()
  get_manage_url()


Class: dataformat  - X-Ref

Class for dataformats

init_display_name()   X-Ref
Display name


get_plugins($type, $typerootdir, $typeclass, $pluginman)   X-Ref
Gathers and returns the information about all plugins of the given type

param: string $type the name of the plugintype, eg. mod, auth or workshopform
param: string $typerootdir full path to the location of the plugin dir
param: string $typeclass the name of the actually called class
param: core_plugin_manager $pluginman the plugin manager calling this method
return: array of plugintype classes, indexed by the plugin name

get_enabled_plugins()   X-Ref
Finds all enabled plugins, the result may include missing plugins.

return: array|null of enabled plugins $pluginname=>$pluginname, null means unknown

get_settings_section_name()   X-Ref
Returns the node name used in admin settings menu for this plugin settings (if applicable)

return: null|string node name or null if plugin does not create settings node (default)

load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig)   X-Ref
Loads plugin settings to the settings tree

This function usually includes settings.php file in plugins folder.
Alternatively it can create a link to some settings page (instance of admin_externalpage)

param: \part_of_admin_tree $adminroot
param: string $parentnodename
param: bool $hassiteconfig whether the current user has moodle/site:config capability

is_uninstall_allowed()   X-Ref
dataformats can be uninstalled

return: bool

get_manage_url()   X-Ref
Return URL used for management of plugins of this type.

return: moodle_url



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1