Repository plugin files - Revision history

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:22:43Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:22, 14 July 2021
Line 6:		Line 6:
	// See [[Repository plugins]] for a list of functions to override in here		// See [[Repository plugins]] for a list of functions to override in here
	}		}
	</~~code~~>		</syntaxhighlight>
	* /repository/myplugin/'''pix/icon.png''' - an icon to display in the file picker (16x16)		* /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 )		* /repository/myplugin/'''[[version.php]]''' - contains the current version number of the plugin and other important details ( https://docs.moodle.org/dev/version.php )
Line 16:		Line 16:
	$plugin->cron = 0; // How often to run automatic updates (0 to disable)		$plugin->cron = 0; // How often to run automatic updates (0 to disable)
	$plugin->release = 'Human-readable version number';		$plugin->release = 'Human-readable version number';
	</~~code~~>		</syntaxhighlight>
	* /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include:		* /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 23:		Line 23:
	$string['pluginname'] = 'My plugin repository';		$string['pluginname'] = 'My plugin repository';
	$string['pluginname_help'] = 'A few more details about my repository';		$string['pluginname_help'] = 'A few more details about my repository';
	</~~code~~>		</syntaxhighlight>
	* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:		* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 36:		Line 36:
	)		)
	);		);
	</~~code~~>		</syntaxhighlight>

	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:		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:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$string['myplugin:view'] = 'View the myplugin repository';		$string['myplugin:view'] = 'View the myplugin repository';
	</~~code~~>		</syntaxhighlight>

	==See also==		==See also==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:34:24Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:34, 14 July 2021
				
Line 2:
Line 2:
This is an overview of the files that are found within [[Repository plugins]]. 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: * /repository/myplugin/'''lib.php''' - this contains the core functionality for your plugin. Within it you must define a class:
<code php> <syntaxhighlight lang="php">
class repository_myplugin extends repository { class repository_myplugin extends repository {
   // See [[Repository plugins]] for a list of functions to override in here    // See [[Repository plugins]] for a list of functions to override in here
Line 9:
Line 9:
* /repository/myplugin/'''pix/icon.png''' - an icon to display in the file picker (16x16) * /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 ) * /repository/myplugin/'''[[version.php]]''' - contains the current version number of the plugin and other important details ( https://docs.moodle.org/dev/version.php )
<code php> <syntaxhighlight lang="php">
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
$plugin->version = 2012061700; //The current plugin version (Date: YYYYMMDDXX) $plugin->version = 2012061700; //The current plugin version (Date: YYYYMMDDXX)
Line 18:
Line 18:
</code> </code>
* /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include: * /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include:
<code php> <syntaxhighlight lang="php">
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
$string['configplugin'] = 'Configuration for my plugin repository'; $string['configplugin'] = 'Configuration for my plugin repository';
Line 25:
Line 25:
</code> </code>
* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this: * /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:
<code php> <syntaxhighlight lang="php">
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
$capabilities = array( $capabilities = array(
Line 39:
Line 39:



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: 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> <syntaxhighlight lang="php">
$string['myplugin:view'] = 'View the myplugin repository'; $string['myplugin:view'] = 'View the myplugin repository';
</code> </code>



Davosmith at 11:45, 5 December 2012
2012-12-05T11:45:12Z


				
				
				
				
				
				← Older revision
				Revision as of 11:45, 5 December 2012
				
Line 20:
Line 20:
<code php> <code php>
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
$string['configplugin'] = 'Configuration for my plugin repository';
$string['pluginname'] = 'My plugin repository'; $string['pluginname'] = 'My plugin repository';
$string['configplugin'] = 'Configuration for my plugin repository'; $string['pluginname_help'] = 'A few more details about my repository';
</code> </code>
* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this: * /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:



Davosmith at 11:43, 5 December 2012
2012-12-05T11:43:12Z


				
				
				
				
				
				← Older revision
				Revision as of 11:43, 5 December 2012
				
Line 1:
Line 1:
{{Repository plugins}}
This is an overview of the files that are found within [[Repository plugins]]. 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: * /repository/myplugin/'''lib.php''' - this contains the core functionality for your plugin. Within it you must define a class:



Davosmith at 10:07, 5 December 2012
2012-12-05T10:07:37Z


				
				
				
				
				
				← Older revision
				Revision as of 10:07, 5 December 2012
				
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>






Davosmith: 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..."
2012-12-05T10:05:06Z
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..."
New page
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:

<code php>

class repository_myplugin extends repository {

  // See [[Repository plugins]] for a list of functions to override in here

}

</code>

* /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 )

<code 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';

</code>

* /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include:

<code php>

defined('MOODLE_INTERNAL') || die();

$string['pluginname'] = 'My plugin repository';

$string['configplugin'] = 'Configuration for my plugin repository';

</code>

* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:

<code php>

defined('MOODLE_INTERNAL') || die();

$capabilities = array(

    'repository/myplugin:view' => array(

        'captype' => 'read',

        'contextlevel' => CONTEXT_MODULE,

        'archetypes' => array(

            'user' => CAP_ALLOW 

        )

    )

);

</code>



==See also==



*[[Repository plugins]]



[[Category:Repositories]]

[[Category:Plugins]]

← Older revision		Revision as of 13:34, 14 July 2021
Line 2:		Line 2:
	This is an overview of the files that are found within [[Repository plugins]].		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:		* /repository/myplugin/'''lib.php''' - this contains the core functionality for your plugin. Within it you must define a class:
	<~~code~~ php>		<syntaxhighlight lang="php">
	class repository_myplugin extends repository {		class repository_myplugin extends repository {
	// See [[Repository plugins]] for a list of functions to override in here		// See [[Repository plugins]] for a list of functions to override in here
Line 9:		Line 9:
	* /repository/myplugin/'''pix/icon.png''' - an icon to display in the file picker (16x16)		* /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 )		* /repository/myplugin/'''[[version.php]]''' - contains the current version number of the plugin and other important details ( https://docs.moodle.org/dev/version.php )
	<~~code~~ php>		<syntaxhighlight lang="php">
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
	$plugin->version = 2012061700; //The current plugin version (Date: YYYYMMDDXX)		$plugin->version = 2012061700; //The current plugin version (Date: YYYYMMDDXX)
Line 18:		Line 18:
	</code>		</code>
	* /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include:		* /repository/myplugin/'''lang/en/repository_myplugin.php''' - contains the English language strings for display by your plugin. As a minimum, this must include:
	<~~code~~ php>		<syntaxhighlight lang="php">
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
	$string['configplugin'] = 'Configuration for my plugin repository';		$string['configplugin'] = 'Configuration for my plugin repository';
Line 25:		Line 25:
	</code>		</code>
	* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:		* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:
	<~~code~~ php>		<syntaxhighlight lang="php">
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
	$capabilities = array(		$capabilities = array(
Line 39:		Line 39:

	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:		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>		<syntaxhighlight lang="php">
	$string['myplugin:view'] = 'View the myplugin repository';		$string['myplugin:view'] = 'View the myplugin repository';
	</code>		</code>

← Older revision		Revision as of 11:45, 5 December 2012
Line 20:		Line 20:
	<code php>		<code php>
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
			$string['configplugin'] = 'Configuration for my plugin repository';
	$string['pluginname'] = 'My plugin repository';		$string['pluginname'] = 'My plugin repository';
	$string['~~configplugin~~'] = '~~Configuration for~~ my ~~plugin~~ repository';		$string['pluginname_help'] = 'A few more details about my repository';
	</code>		</code>
	* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:		* /repository/myplugin/'''db/access.php''' - defines any user capabilities related to the plugin. A basic access.php file will look like this:

← Older revision		Revision as of 11:43, 5 December 2012
Line 1:		Line 1:
			{{Repository plugins}}
	This is an overview of the files that are found within [[Repository plugins]].		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:		* /repository/myplugin/'''lib.php''' - this contains the core functionality for your plugin. Within it you must define a class:

← Older revision		Revision as of 10:07, 5 December 2012
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>