Access API - Revision history

Devdocsbot: Protected "Access API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-06T07:26:53Z

Protected "Access API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 07:26, 6 May 2022
(No difference)

Devdocsbot: Update migration status and path

2022-04-28T07:01:03Z

Update migration status and path

← Older revision		Revision as of 07:01, 28 April 2022
Line 1:		Line 1:
	{{Template:Migrated\|newDocId=/docs/apis/access}}		{{Template:Migrated\|newDocId=/docs/apis/subsystems/access}}
	{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.		{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.

Andrewnicols: Update migration status and path

2022-04-20T06:45:49Z

Update migration status and path

← Older revision		Revision as of 06:45, 20 April 2022
Line 1:		Line 1:
	{{Template:Migrated\|newDocId=docs/apis/access}}		{{Template:Migrated\|newDocId=/docs/apis/access}}
	{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.		{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.

Andrewnicols: Typo fix

2022-04-11T03:33:59Z

Typo fix

← Older revision		Revision as of 03:33, 11 April 2022
Line 1:		Line 1:
	{{Template:~~Migrate~~\|newDocId=docs/apis/access}}		{{Template:Migrated\|newDocId=docs/apis/access}}
	{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.		{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.

Andrewnicols: Add migration note

2022-04-11T03:32:46Z

Add migration note

← Older revision		Revision as of 03:32, 11 April 2022
Line 1:		Line 1:
			{{Template:Migrate\|newDocId=docs/apis/access}}
	{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.		{{Moodle_2.2}}The Access API gives you functions so you can determine what the current user is allowed to do. It also allows modules to extend Moodle with new capabilities.

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:34, 14 July 2021
				
Line 12:
Line 12:



For example: For example:
<code php> <syntaxhighlight lang="php">
  $capabilities = [   $capabilities = [
     'mod/folder:managefiles' => [      'mod/folder:managefiles' => [
Line 36:
Line 36:



The capability names are defined in plugin language files, the name of the string consists of "pluginname:capabilityname", in the example above it would be: The capability names are defined in plugin language files, the name of the string consists of "pluginname:capabilityname", in the example above it would be:
<code php> <syntaxhighlight lang="php">
$string['folder:managefiles'] = 'Manage files in folder module'; $string['folder:managefiles'] = 'Manage files in folder module';
</syntaxhighlight> </syntaxhighlight>
Line 47:
Line 47:



Fetching by object id: Fetching by object id:
<code php> <syntaxhighlight lang="php">
$systemcontext = context_system::instance(); $systemcontext = context_system::instance();
$usercontext = context_user::instance($user->id); $usercontext = context_user::instance($user->id);
Line 57:
Line 57:



Fetching by context id: Fetching by context id:
<code php> <syntaxhighlight lang="php">
$context = context::instance_by_id($contextid); $context = context::instance_by_id($contextid);
</syntaxhighlight> </syntaxhighlight>
Line 67:
Line 67:



There are multiple deprecated context related functions since 2.2, it is not necessary to replace them immediately. The following two functions are equivalent to the context fetching examples above: There are multiple deprecated context related functions since 2.2, it is not necessary to replace them immediately. The following two functions are equivalent to the context fetching examples above:
<code php> <syntaxhighlight lang="php">
function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING)
function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) function get_context_instance_by_id($id, $strictness = IGNORE_MISSING)
Line 78:
Line 78:
====has_capability()==== ====has_capability()====
has_capability() is the most important function: has_capability() is the most important function:
<code php> <syntaxhighlight lang="php">
  function has_capability($capability, context $context, $user = null, $doanything = true)   function has_capability($capability, context $context, $user = null, $doanything = true)
</syntaxhighlight> </syntaxhighlight>



Check whether a user has a particular capability in a given context. For example: Check whether a user has a particular capability in a given context. For example:
<code php> <syntaxhighlight lang="php">
$context = context_module::instance($cm->id); $context = context_module::instance($cm->id);
if (has_capability('mod/folder:managefiles', $context)) { if (has_capability('mod/folder:managefiles', $context)) {
Line 95:
Line 95:
Function require_capability() is very similar, it is throwing access control exception if user does not have the capability. Function require_capability() is very similar, it is throwing access control exception if user does not have the capability.



<code php> <syntaxhighlight lang="php">
function require_capability($capability, context $context, $userid = null, $doanything = true, $errormessage = 'nopermissions', $stringfile = '') { function require_capability($capability, context $context, $userid = null, $doanything = true, $errormessage = 'nopermissions', $stringfile = '') {
</syntaxhighlight> </syntaxhighlight>
Line 105:
Line 105:
===Other related functions=== ===Other related functions===



<code php> <syntaxhighlight lang="php">
  function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)   function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)
  function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)   function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)

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

2021-07-14T13:06:01Z

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

← Older revision		Revision as of 13:06, 14 July 2021
Line 23:		Line 23:
	],		],
	];		];
	</~~code~~>		</syntaxhighlight>

	Where the meaning of array keys is:		Where the meaning of array keys is:
Line 38:		Line 38:
	<code php>		<code php>
	$string['folder:managefiles'] = 'Manage files in folder module';		$string['folder:managefiles'] = 'Manage files in folder module';
	</~~code~~>		</syntaxhighlight>

	==Useful functions and classes==		==Useful functions and classes==
Line 54:		Line 54:
	$contextmodule = context_module::instance($cm->id);		$contextmodule = context_module::instance($cm->id);
	$contextblock = context_block::instance($this->instance->id);		$contextblock = context_block::instance($this->instance->id);
	</~~code~~>		</syntaxhighlight>

	Fetching by context id:		Fetching by context id:
	<code php>		<code php>
	$context = context::instance_by_id($contextid);		$context = context::instance_by_id($contextid);
	</~~code~~>		</syntaxhighlight>

	Notes:		Notes:
Line 70:		Line 70:
	function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING)		function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING)
	function get_context_instance_by_id($id, $strictness = IGNORE_MISSING)		function get_context_instance_by_id($id, $strictness = IGNORE_MISSING)
	</~~code~~>		</syntaxhighlight>

	===Determining that a user has a given capability===		===Determining that a user has a given capability===
Line 80:		Line 80:
	<code php>		<code php>
	function has_capability($capability, context $context, $user = null, $doanything = true)		function has_capability($capability, context $context, $user = null, $doanything = true)
	</~~code~~>		</syntaxhighlight>

	Check whether a user has a particular capability in a given context. For example:		Check whether a user has a particular capability in a given context. For example:
Line 88:		Line 88:
	// Do or display something.		// Do or display something.
	}		}
	</~~code~~>		</syntaxhighlight>

	By default checks the capabilities of the current user, but you can pass a different userid. By default will return true for admin users, it is not recommended to use false here.		By default checks the capabilities of the current user, but you can pass a different userid. By default will return true for admin users, it is not recommended to use false here.
Line 97:		Line 97:
	<code php>		<code php>
	function require_capability($capability, context $context, $userid = null, $doanything = true, $errormessage = 'nopermissions', $stringfile = '') {		function require_capability($capability, context $context, $userid = null, $doanything = true, $errormessage = 'nopermissions', $stringfile = '') {
	</~~code~~>		</syntaxhighlight>

	===Enrolment functions===		===Enrolment functions===
Line 115:		Line 115:
	function is_guest(context $context, $user = null)		function is_guest(context $context, $user = null)
	function is_viewing(context $context, $user = null, $withcapability = '')		function is_viewing(context $context, $user = null, $withcapability = '')
	</~~code~~>		</syntaxhighlight>

	====require_login()====		====require_login()====

Mudrd8mz: /* How to define new capabilities in plugins */ Array syntax update

2020-10-02T07:17:50Z

How to define new capabilities in plugins: Array syntax update

← Older revision		Revision as of 07:17, 2 October 2020
Line 13:		Line 13:
	For example:		For example:
	<code php>		<code php>
	$capabilities = ~~array(~~		$capabilities = [
	'mod/folder:managefiles' => ~~array(~~		'mod/folder:managefiles' => [
	'riskbitmask' => RISK_SPAM,		'riskbitmask' => RISK_SPAM,
	'captype' => 'write',		'captype' => 'write',
	'contextlevel' => CONTEXT_MODULE,		'contextlevel' => CONTEXT_MODULE,
	'archetypes' => ~~array(~~		'archetypes' => [
	'editingteacher' => CAP_ALLOW		'editingteacher' => CAP_ALLOW,
	)		],
	),		],
	);		];
	</code>		</code>

Mudrd8mz: /* has_capability() */

2020-10-01T19:44:11Z

has_capability()

← Older revision		Revision as of 19:44, 1 October 2020
Line 85:		Line 85:
	<code php>		<code php>
	$context = context_module::instance($cm->id);		$context = context_module::instance($cm->id);
	has_capability('mod/folder:managefiles', $context)		if (has_capability('mod/folder:managefiles', $context)) {
			// Do or display something.
			}
	</code>		</code>

Danielneis: /* Context fetching */

2019-03-15T17:11:32Z

Context fetching

← Older revision		Revision as of 17:11, 15 March 2019
Line 53:		Line 53:
	$coursecontext = context_course::instance($course->id);		$coursecontext = context_course::instance($course->id);
	$contextmodule = context_module::instance($cm->id);		$contextmodule = context_module::instance($cm->id);
			$contextblock = context_block::instance($this->instance->id);
	</code>		</code>

← Older revision		Revision as of 13:34, 14 July 2021
Line 12:		Line 12:

	For example:		For example:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$capabilities = [		$capabilities = [
	'mod/folder:managefiles' => [		'mod/folder:managefiles' => [
Line 36:		Line 36:

	The capability names are defined in plugin language files, the name of the string consists of "pluginname:capabilityname", in the example above it would be:		The capability names are defined in plugin language files, the name of the string consists of "pluginname:capabilityname", in the example above it would be:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$string['folder:managefiles'] = 'Manage files in folder module';		$string['folder:managefiles'] = 'Manage files in folder module';
	</syntaxhighlight>		</syntaxhighlight>
Line 47:		Line 47:

	Fetching by object id:		Fetching by object id:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$systemcontext = context_system::instance();		$systemcontext = context_system::instance();
	$usercontext = context_user::instance($user->id);		$usercontext = context_user::instance($user->id);
Line 57:		Line 57:

	Fetching by context id:		Fetching by context id:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$context = context::instance_by_id($contextid);		$context = context::instance_by_id($contextid);
	</syntaxhighlight>		</syntaxhighlight>
Line 67:		Line 67:

	There are multiple deprecated context related functions since 2.2, it is not necessary to replace them immediately. The following two functions are equivalent to the context fetching examples above:		There are multiple deprecated context related functions since 2.2, it is not necessary to replace them immediately. The following two functions are equivalent to the context fetching examples above:
	<~~code~~ php>		<syntaxhighlight lang="php">
	function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING)		function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING)
	function get_context_instance_by_id($id, $strictness = IGNORE_MISSING)		function get_context_instance_by_id($id, $strictness = IGNORE_MISSING)
Line 78:		Line 78:
	====has_capability()====		====has_capability()====
	has_capability() is the most important function:		has_capability() is the most important function:
	<~~code~~ php>		<syntaxhighlight lang="php">
	function has_capability($capability, context $context, $user = null, $doanything = true)		function has_capability($capability, context $context, $user = null, $doanything = true)
	</syntaxhighlight>		</syntaxhighlight>

	Check whether a user has a particular capability in a given context. For example:		Check whether a user has a particular capability in a given context. For example:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$context = context_module::instance($cm->id);		$context = context_module::instance($cm->id);
	if (has_capability('mod/folder:managefiles', $context)) {		if (has_capability('mod/folder:managefiles', $context)) {
Line 95:		Line 95:
	Function require_capability() is very similar, it is throwing access control exception if user does not have the capability.		Function require_capability() is very similar, it is throwing access control exception if user does not have the capability.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function require_capability($capability, context $context, $userid = null, $doanything = true, $errormessage = 'nopermissions', $stringfile = '') {		function require_capability($capability, context $context, $userid = null, $doanything = true, $errormessage = 'nopermissions', $stringfile = '') {
	</syntaxhighlight>		</syntaxhighlight>
Line 105:		Line 105:
	===Other related functions===		===Other related functions===

	<~~code~~ php>		<syntaxhighlight lang="php">
	function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)		function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)
	function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)		function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false)