NEWMODULE Adding capabilities - Revision history

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:34, 14 July 2021
				
Line 7:
Line 7:
This should contain a list of the capabilities that you want to define. For example: This should contain a list of the capabilities that you want to define. For example:



<code php> <syntaxhighlight lang="php">
$capabilities = array( $capabilities = array(
     'mod/<<NEWMODULE>>:<<CAPABILITYNAME>>' => array(      'mod/<<NEWMODULE>>:<<CAPABILITYNAME>>' => array(
Line 56:
Line 56:



If you don't want to specify any roles that will be given your capability by default, you can pass a blank array to the 'archetypes' parameter: If you don't want to specify any roles that will be given your capability by default, you can pass a blank array to the 'archetypes' parameter:
<code php> <syntaxhighlight lang="php">
'mod/newmodule:dosomething' => array( 'mod/newmodule:dosomething' => array(
     'captype' => 'read',      'captype' => 'read',
Line 76:
Line 76:



1. First we need to get the $cm id, and verify that it is correct (there are lots of different ways you might do this, this is only an example. 1. First we need to get the $cm id, and verify that it is correct (there are lots of different ways you might do this, this is only an example.
<code php> <syntaxhighlight lang="php">
$cmid = required_param('cmid', PARAM_INT); $cmid = required_param('cmid', PARAM_INT);
if (!$cm = get_coursemodule_from_id('<<NEWMODULE>>', $cmid)) { if (!$cm = get_coursemodule_from_id('<<NEWMODULE>>', $cmid)) {
Line 84:
Line 84:



2. Then you get the module context: 2. Then you get the module context:
<code php> <syntaxhighlight lang="php">
$context = context_module::instance($cm->id); $context = context_module::instance($cm->id);
//for course use below code //for course use below code
Line 93:
Line 93:



3. Finally, you can actually check the permission 3. Finally, you can actually check the permission
<code php> <syntaxhighlight lang="php">
if (has_capability('mod/<<NEWMODULE>>:<<CAPABILITYNAME>>', $context)) { if (has_capability('mod/<<NEWMODULE>>:<<CAPABILITYNAME>>', $context)) {
</syntaxhighlight> </syntaxhighlight>
Line 104:
Line 104:



Suppose you have a page that should only be available to users with a particular capability. For example, only users with mod/quiz:viewreports should be able to access mod/quiz/report.php. In cases like this, you can use the require_capability function: Suppose you have a page that should only be available to users with a particular capability. For example, only users with mod/quiz:viewreports should be able to access mod/quiz/report.php. In cases like this, you can use the require_capability function:
<code php> <syntaxhighlight lang="php">
require_capability($capability, $context); require_capability($capability, $context);
</syntaxhighlight> </syntaxhighlight>
near the top of your script. (As soon as you have got the context and called require_login is a good time.) All this does internally is near the top of your script. (As soon as you have got the context and called require_login is a good time.) All this does internally is
<code php> <syntaxhighlight lang="php">
if (!has_capability($capability, $context)) { if (!has_capability($capability, $context)) {
     // Display error and exit.      // Display error and exit.
Line 122:
Line 122:



There is an optional 3rd parameter to has_capability that you can use to check another user's permissions: There is an optional 3rd parameter to has_capability that you can use to check another user's permissions:
<code php> <syntaxhighlight lang="php">
has_capability($capability, $context, $otheruser->id); has_capability($capability, $context, $otheruser->id);
</syntaxhighlight> </syntaxhighlight>
Line 129:
Line 129:



Administrators have a magic 'moodle/site:doanything' capability that gives them every other capability. If you wish to disable that magic override for one particular capability check, you can use the optional 4th parameter to has capability: Administrators have a magic 'moodle/site:doanything' capability that gives them every other capability. If you wish to disable that magic override for one particular capability check, you can use the optional 4th parameter to has capability:
<code php> <syntaxhighlight lang="php">
has_capability($capability, $context, NULL, false); has_capability($capability, $context, NULL, false);
</syntaxhighlight> </syntaxhighlight>
Line 137:
Line 137:



The has_capability function has been carefully optimised, and is pretty fast and you should not really worry. However, it has to perform a fairly complex computation, and if you are going to make exactly the same has_capability call several times in a page (perhaps in a loop) it is probably worth moving the permission check outside the loop. For example don't do: The has_capability function has been carefully optimised, and is pretty fast and you should not really worry. However, it has to perform a fairly complex computation, and if you are going to make exactly the same has_capability call several times in a page (perhaps in a loop) it is probably worth moving the permission check outside the loop. For example don't do:
<code php> <syntaxhighlight lang="php">
foreach ($attempts as $attempt) { foreach ($attempts as $attempt) {
     if (has_capability('mod/quiz:viewreports', $context)) {      if (has_capability('mod/quiz:viewreports', $context)) {
Line 145:
Line 145:
</syntaxhighlight> </syntaxhighlight>
Instead do Instead do
<code php> <syntaxhighlight lang="php">
$canviewreports = has_capability('mod/quiz:viewreports', $context); $canviewreports = has_capability('mod/quiz:viewreports', $context);
foreach ($attempts as $attempt) { foreach ($attempts as $attempt) {

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

2021-07-14T13:10:04Z

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

← Older revision		Revision as of 13:10, 14 July 2021
Line 23:		Line 23:
	// Add more capabilities here ...		// Add more capabilities here ...
	)		)
	</~~code~~>		</syntaxhighlight>

	The various parts of the capability definition are:		The various parts of the capability definition are:
Line 62:		Line 62:
	'archetypes' => array()		'archetypes' => array()
	),		),
	</~~code~~>		</syntaxhighlight>

	==2. Get Moodle to load the updated capabilities==		==2. Get Moodle to load the updated capabilities==
Line 81:		Line 81:
	error("Course module ID was incorrect");		error("Course module ID was incorrect");
	}		}
	</~~code~~>		</syntaxhighlight>

	2. Then you get the module context:		2. Then you get the module context:
Line 90:		Line 90:
	//for system		//for system
	//$context = context_system::instance($cm->id);		//$context = context_system::instance($cm->id);
	</~~code~~>		</syntaxhighlight>

	3. Finally, you can actually check the permission		3. Finally, you can actually check the permission
	<code php>		<code php>
	if (has_capability('mod/<<NEWMODULE>>:<<CAPABILITYNAME>>', $context)) {		if (has_capability('mod/<<NEWMODULE>>:<<CAPABILITYNAME>>', $context)) {
	</~~code~~>		</syntaxhighlight>

	Normally, you do 1. and 2. once at the top of a script, and then call has_capability as needed within the script with the appropriate capabilities.		Normally, you do 1. and 2. once at the top of a script, and then call has_capability as needed within the script with the appropriate capabilities.
Line 106:		Line 106:
	<code php>		<code php>
	require_capability($capability, $context);		require_capability($capability, $context);
	</~~code~~>		</syntaxhighlight>
	near the top of your script. (As soon as you have got the context and called require_login is a good time.) All this does internally is		near the top of your script. (As soon as you have got the context and called require_login is a good time.) All this does internally is
	<code php>		<code php>
Line 112:		Line 112:
	// Display error and exit.		// Display error and exit.
	}		}
	</~~code~~>		</syntaxhighlight>
	but using require_capability makes your code simpler and is recommended. (Of course, anywhere you might print a link to a page like this, you should only print the link if the user has the right capability.)		but using require_capability makes your code simpler and is recommended. (Of course, anywhere you might print a link to a page like this, you should only print the link if the user has the right capability.)

Line 124:		Line 124:
	<code php>		<code php>
	has_capability($capability, $context, $otheruser->id);		has_capability($capability, $context, $otheruser->id);
	</~~code~~>		</syntaxhighlight>

	====Excluding administrators====		====Excluding administrators====
Line 131:		Line 131:
	<code php>		<code php>
	has_capability($capability, $context, NULL, false);		has_capability($capability, $context, NULL, false);
	</~~code~~>		</syntaxhighlight>
	However, you normally should not do this.		However, you normally should not do this.

Line 143:		Line 143:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>
	Instead do		Instead do
	<code php>		<code php>
Line 152:		Line 152:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	get_users_by_capability is a very expensive computation. If you are calling it more than once in your script, you are probably doing something wrong ;-)		get_users_by_capability is a very expensive computation. If you are calling it more than once in your script, you are probably doing something wrong ;-)

Sadaf3d at 13:57, 3 February 2021

2021-02-03T13:57:37Z

← Older revision		Revision as of 13:57, 3 February 2021
Line 86:		Line 86:
	<code php>		<code php>
	$context = context_module::instance($cm->id);		$context = context_module::instance($cm->id);
			//for course use below code
			//$context = context_course::instance($cm->id);
			//for system
			//$context = context_system::instance($cm->id);
	</code>		</code>

Sadaf3d at 13:38, 3 February 2021

2021-02-03T13:38:25Z

← Older revision		Revision as of 13:38, 3 February 2021
Line 85:		Line 85:
	2. Then you get the module context:		2. Then you get the module context:
	<code php>		<code php>
	$context = ~~get_context_instance~~(~~CONTEXT_MODULE,~~ $cm->id);		$context = context_module::instance($cm->id);
	</code>		</code>

Libertymoodle: /* archetypes */

2018-04-25T13:38:21Z

archetypes

← Older revision		Revision as of 13:38, 25 April 2018
Line 55:		Line 55:
	Note that once a capability is established, permissions will not be automatically overwritten when a module is updated. If permissions have changed, an administrator must manually change or force capabilities to be [[:en:Manage_roles#Reset_role_to_defaults\|reset to default]] for a role.		Note that once a capability is established, permissions will not be automatically overwritten when a module is updated. If permissions have changed, an administrator must manually change or force capabilities to be [[:en:Manage_roles#Reset_role_to_defaults\|reset to default]] for a role.

	If you don't want to specify any roles that will be given your capability by default you can pass a blank array to the 'archetypes' parameter:		If you don't want to specify any roles that will be given your capability by default, you can pass a blank array to the 'archetypes' parameter:
	<code php>		<code php>
	'mod/newmodule:dosomething' => array(		'mod/newmodule:dosomething' => array(

Libertymoodle: /* archetypes */

2018-04-25T13:37:47Z

archetypes

← Older revision		Revision as of 13:37, 25 April 2018
Line 57:		Line 57:
	If you don't want to specify any roles that will be given your capability by default you can pass a blank array to the 'archetypes' parameter:		If you don't want to specify any roles that will be given your capability by default you can pass a blank array to the 'archetypes' parameter:
	<code php>		<code php>
	'mod/newmodule:dosomething' => array(		'mod/newmodule:dosomething' => array(
	'captype' => 'read',		'captype' => 'read',
	'contextlevel' => CONTEXT_MODULE,		'contextlevel' => CONTEXT_MODULE,
	'archetypes' => array()		'archetypes' => array()
	),		),
	</code>		</code>

Libertymoodle: /* Add archetypes array */

2018-04-25T13:36:04Z

Add archetypes array

← Older revision		Revision as of 13:36, 25 April 2018
Line 51:		Line 51:
	This section defines, for each role type, what default permissions those roles should be given when your module is first installed (or when a new capability is detected on upgrade).		This section defines, for each role type, what default permissions those roles should be given when your module is first installed (or when a new capability is detected on upgrade).

	Normally, you just add one line for each role that you want to give the capability to. The line should look like 'roletype' => CAP_ALLOW. Just leave out roles that you do not want to get the capability be default. Very exceptionally, you may need to specify a default permission of CAP_PREVENT, CAP_PROHIBIT.		Normally, you just add one line for each role that you want to give the capability to. The line should look like 'roletype' => CAP_ALLOW. Just leave out roles that you do not want to get the capability by default. Very exceptionally, you may need to specify a default permission of CAP_PREVENT, CAP_PROHIBIT.

	Note that once a capability is established, permissions will not be automatically overwritten when a module is updated. If permissions have changed, an administrator must manually change or force capabilities to be [[:en:Manage_roles#Reset_role_to_defaults\|reset to default]] for a role.		Note that once a capability is established, permissions will not be automatically overwritten when a module is updated. If permissions have changed, an administrator must manually change or force capabilities to be [[:en:Manage_roles#Reset_role_to_defaults\|reset to default]] for a role.

			If you don't want to specify any roles that will be given your capability by default you can pass a blank array to the 'archetypes' parameter:
			<code php>
			'mod/newmodule:dosomething' => array(
			'captype' => 'read',
			'contextlevel' => CONTEXT_MODULE,
			'archetypes' => array()
			),
			</code>

	==2. Get Moodle to load the updated capabilities==		==2. Get Moodle to load the updated capabilities==

Gb2048: Fixed typo

2014-02-08T10:41:21Z

Fixed typo

← Older revision		Revision as of 10:41, 8 February 2014
Line 47:		Line 47:
	The context level where this capability is most relevant. If you are writing a module this will almost always be [[Context\|CONTEXT_MODULE]]. (This does not have much effect. It is just used to sort and group capabilities on the define roles and override roles pages.)		The context level where this capability is most relevant. If you are writing a module this will almost always be [[Context\|CONTEXT_MODULE]]. (This does not have much effect. It is just used to sort and group capabilities on the define roles and override roles pages.)

	===~~archtypes~~===		===archetypes===

	This section defines, for each role type, what default permissions those roles should be given when your module is first installed (or when a new capability is detected on upgrade).		This section defines, for each role type, what default permissions those roles should be given when your module is first installed (or when a new capability is detected on upgrade).

Maherne: Changed admin to manager

2013-03-05T16:12:53Z

Changed admin to manager

← Older revision		Revision as of 16:12, 5 March 2013
Line 17:		Line 17:
	'teacher' => CAP_ALLOW,		'teacher' => CAP_ALLOW,
	'editingteacher' => CAP_ALLOW,		'editingteacher' => CAP_ALLOW,
	'~~admin~~' => CAP_ALLOW		'manager' => CAP_ALLOW
	)		)
	),		),

Marina.glancy: /* See also */

2013-01-22T23:12:00Z

← Older revision		Revision as of 23:12, 22 January 2013
Line 145:		Line 145:
	==See also==		==See also==

			* [[Access API]]
	* [[Roles]]		* [[Roles]]
	* [[Hardening_new_Roles_system]] - information about risks		* [[Hardening_new_Roles_system]] - information about risks

← Older revision		Revision as of 13:34, 14 July 2021
Line 7:		Line 7:
	This should contain a list of the capabilities that you want to define. For example:		This should contain a list of the capabilities that you want to define. For example:

	<~~code~~ php>		<syntaxhighlight lang="php">
	$capabilities = array(		$capabilities = array(
	'mod/<<NEWMODULE>>:<<CAPABILITYNAME>>' => array(		'mod/<<NEWMODULE>>:<<CAPABILITYNAME>>' => array(
Line 56:		Line 56:

	If you don't want to specify any roles that will be given your capability by default, you can pass a blank array to the 'archetypes' parameter:		If you don't want to specify any roles that will be given your capability by default, you can pass a blank array to the 'archetypes' parameter:
	<~~code~~ php>		<syntaxhighlight lang="php">
	'mod/newmodule:dosomething' => array(		'mod/newmodule:dosomething' => array(
	'captype' => 'read',		'captype' => 'read',
Line 76:		Line 76:

	1. First we need to get the $cm id, and verify that it is correct (there are lots of different ways you might do this, this is only an example.		1. First we need to get the $cm id, and verify that it is correct (there are lots of different ways you might do this, this is only an example.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$cmid = required_param('cmid', PARAM_INT);		$cmid = required_param('cmid', PARAM_INT);
	if (!$cm = get_coursemodule_from_id('<<NEWMODULE>>', $cmid)) {		if (!$cm = get_coursemodule_from_id('<<NEWMODULE>>', $cmid)) {
Line 84:		Line 84:

	2. Then you get the module context:		2. Then you get the module context:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$context = context_module::instance($cm->id);		$context = context_module::instance($cm->id);
	//for course use below code		//for course use below code
Line 93:		Line 93:

	3. Finally, you can actually check the permission		3. Finally, you can actually check the permission
	<~~code~~ php>		<syntaxhighlight lang="php">
	if (has_capability('mod/<<NEWMODULE>>:<<CAPABILITYNAME>>', $context)) {		if (has_capability('mod/<<NEWMODULE>>:<<CAPABILITYNAME>>', $context)) {
	</syntaxhighlight>		</syntaxhighlight>
Line 104:		Line 104:

	Suppose you have a page that should only be available to users with a particular capability. For example, only users with mod/quiz:viewreports should be able to access mod/quiz/report.php. In cases like this, you can use the require_capability function:		Suppose you have a page that should only be available to users with a particular capability. For example, only users with mod/quiz:viewreports should be able to access mod/quiz/report.php. In cases like this, you can use the require_capability function:
	<~~code~~ php>		<syntaxhighlight lang="php">
	require_capability($capability, $context);		require_capability($capability, $context);
	</syntaxhighlight>		</syntaxhighlight>
	near the top of your script. (As soon as you have got the context and called require_login is a good time.) All this does internally is		near the top of your script. (As soon as you have got the context and called require_login is a good time.) All this does internally is
	<~~code~~ php>		<syntaxhighlight lang="php">
	if (!has_capability($capability, $context)) {		if (!has_capability($capability, $context)) {
	// Display error and exit.		// Display error and exit.
Line 122:		Line 122:

	There is an optional 3rd parameter to has_capability that you can use to check another user's permissions:		There is an optional 3rd parameter to has_capability that you can use to check another user's permissions:
	<~~code~~ php>		<syntaxhighlight lang="php">
	has_capability($capability, $context, $otheruser->id);		has_capability($capability, $context, $otheruser->id);
	</syntaxhighlight>		</syntaxhighlight>
Line 129:		Line 129:

	Administrators have a magic 'moodle/site:doanything' capability that gives them every other capability. If you wish to disable that magic override for one particular capability check, you can use the optional 4th parameter to has capability:		Administrators have a magic 'moodle/site:doanything' capability that gives them every other capability. If you wish to disable that magic override for one particular capability check, you can use the optional 4th parameter to has capability:
	<~~code~~ php>		<syntaxhighlight lang="php">
	has_capability($capability, $context, NULL, false);		has_capability($capability, $context, NULL, false);
	</syntaxhighlight>		</syntaxhighlight>
Line 137:		Line 137:

	The has_capability function has been carefully optimised, and is pretty fast and you should not really worry. However, it has to perform a fairly complex computation, and if you are going to make exactly the same has_capability call several times in a page (perhaps in a loop) it is probably worth moving the permission check outside the loop. For example don't do:		The has_capability function has been carefully optimised, and is pretty fast and you should not really worry. However, it has to perform a fairly complex computation, and if you are going to make exactly the same has_capability call several times in a page (perhaps in a loop) it is probably worth moving the permission check outside the loop. For example don't do:
	<~~code~~ php>		<syntaxhighlight lang="php">
	foreach ($attempts as $attempt) {		foreach ($attempts as $attempt) {
	if (has_capability('mod/quiz:viewreports', $context)) {		if (has_capability('mod/quiz:viewreports', $context)) {
Line 145:		Line 145:
	</syntaxhighlight>		</syntaxhighlight>
	Instead do		Instead do
	<~~code~~ php>		<syntaxhighlight lang="php">
	$canviewreports = has_capability('mod/quiz:viewreports', $context);		$canviewreports = has_capability('mod/quiz:viewreports', $context);
	foreach ($attempts as $attempt) {		foreach ($attempts as $attempt) {

NEWMODULE Adding capabilities - Revision history

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Sadaf3d at 13:57, 3 February 2021

Sadaf3d at 13:38, 3 February 2021

Libertymoodle: /* archetypes */

Libertymoodle: /* archetypes */

Libertymoodle: /* Add archetypes array */

Gb2048: Fixed typo

Maherne: Changed admin to manager

Marina.glancy: /* See also */

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

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