Repository plugin files: Difference between revisions
(Created page with "This is an overview of the files that are found within Repository plugins. * /repository/myplugin/'''lib.php''' - this contains the core functionality for your plugin. Within...") |
No edit summary |
||
| Line 34: | Line 34: | ||
) | ) | ||
); | ); | ||
</code> | |||
Once the capabilities have been defined, it is good practice to add a language string for them to the '''lang/en/repository_myplugin.php''' file: | |||
<code php> | |||
$string['myplugin:view'] = 'View the myplugin repository'; | |||
</code> | </code> | ||
Revision as of 10:07, 5 December 2012
This is an overview of the files that are found within Repository plugins.
- /repository/myplugin/lib.php - this contains the core functionality for your plugin. Within it you must define a class:
class repository_myplugin extends repository {
// See Repository plugins for a list of functions to override in here
}
- /repository/myplugin/pix/icon.png - an icon to display in the file picker (16x16)
- /repository/myplugin/version.php - contains the current version number of the plugin and other important details ( https://docs.moodle.org/dev/version.php )
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2012061700; //The current plugin version (Date: YYYYMMDDXX)
$plugin->requires = 2012061700; //Requires this Moodle version
$plugin->component = 'repository_myplugin'; //Full name of the plugin (used for diagnostics)
$plugin->cron = 0; // How often to run automatic updates (0 to disable)
$plugin->release = 'Human-readable version number';
- /repository/myplugin/lang/en/repository_myplugin.php - contains the English language strings for display by your plugin. As a minimum, this must include:
defined('MOODLE_INTERNAL') || die();
$string['pluginname'] = 'My plugin repository';
$string['configplugin'] = 'Configuration for my plugin repository';
- /repository/myplugin/db/access.php - defines any user capabilities related to the plugin. A basic access.php file will look like this:
defined('MOODLE_INTERNAL') || die();
$capabilities = array(
'repository/myplugin:view' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'user' => CAP_ALLOW
)
)
);
Once the capabilities have been defined, it is good practice to add a language string for them to the lang/en/repository_myplugin.php file:
$string['myplugin:view'] = 'View the myplugin repository';
