Availability API - Revision history

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

2022-07-22T14:28:42Z

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

← Older revision	Revision as of 14:28, 22 July 2022
(No difference)

Devdocsbot: Update migration status and path

2022-07-22T13:49:48Z

Update migration status and path

← Older revision		Revision as of 13:49, 22 July 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/availability/}}
	{{Infobox Project		{{Infobox Project
	\|name = Availability API		\|name = Availability API

Mudrd8mz at 15:35, 19 July 2021

2021-07-19T15:35:53Z

← Older revision		Revision as of 15:35, 19 July 2021
Line 1:		Line 1:
	~~{{Moodle 2.7}}~~

	{{Infobox Project		{{Infobox Project
	\|name = Availability API		\|name = Availability API
Line 8:		Line 6:
	\|assignee = sam marshall (OU)		\|assignee = sam marshall (OU)
	}}		}}
			{{Moodle 2.7}}
	~~= Availability API =~~

	The availability API controls access to activities and sections. For example, a teacher could restrict access so that an activity cannot be accessed until a certain date, or so that a section cannot be accessed unless users have a certain grade in a quiz.		The availability API controls access to activities and sections. For example, a teacher could restrict access so that an activity cannot be accessed until a certain date, or so that a section cannot be accessed unless users have a certain grade in a quiz.

Mudrd8mz: /* Programmatically setting availability conditions */ Fix syntaxhighlight syntax

2021-07-19T14:02:37Z

Programmatically setting availability conditions: Fix syntaxhighlight syntax

← Older revision		Revision as of 14:02, 19 July 2021
Line 92:		Line 92:
	If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:		If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:

	<syntaxhighlight ~~lang="~~lang="php"">		<syntaxhighlight lang="php">
	$restriction = \core_availability\tree::get_root_json(		$restriction = \core_availability\tree::get_root_json(
	[\availability_group\condition::get_json($group->id)]);		[\availability_group\condition::get_json($group->id)]);

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


2021-07-15T08:13:48Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:13, 15 July 2021
				
Line 92:
Line 92:
If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is: If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:



<code lang="php"> <syntaxhighlight lang="lang="php"">
$restriction = \core_availability\tree::get_root_json( $restriction = \core_availability\tree::get_root_json(
         [\availability_group\condition::get_json($group->id)]);          [\availability_group\condition::get_json($group->id)]);



Mudrd8mz: Text replacement - "" to ""

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

				
				
				
				
				
				← Older revision
				Revision as of 13:37, 14 July 2021
				
Line 37:
Line 37:
To check if the current user can access an activity (supposing you have a $course and $cmid): To check if the current user can access an activity (supposing you have a $course and $cmid):



<code php> <syntaxhighlight lang="php">
$modinfo = get_fast_modinfo($course); $modinfo = get_fast_modinfo($course);
$cm = $modinfo->get_cm($cmid); $cm = $modinfo->get_cm($cmid);
Line 73:
Line 73:
If you have a list of users (for example you could obtain this using one of the 'get enrolled users' functions), you can filter it to include only those users who are allowed to see an activity with this code: If you have a list of users (for example you could obtain this using one of the 'get enrolled users' functions), you can filter it to include only those users who are allowed to see an activity with this code:



<code php> <syntaxhighlight lang="php">
$info = new \core_availability\info_module($cm); $info = new \core_availability\info_module($cm);
$filtered = $info->filter_user_list($users); $filtered = $info->filter_user_list($users);



Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:05:13Z
Text replacement - "</code>" to "</syntaxhighlight>"

				
				
				
				
				
				← Older revision
				Revision as of 13:05, 14 July 2021
				
Line 49:
Line 49:
     // User cannot access the activity and they will not see it at all.      // User cannot access the activity and they will not see it at all.
} }
</code> </syntaxhighlight>



There are similar properties for sections. There are similar properties for sections.
Line 76:
Line 76:
$info = new \core_availability\info_module($cm); $info = new \core_availability\info_module($cm);
$filtered = $info->filter_user_list($users); $filtered = $info->filter_user_list($users);
</code> </syntaxhighlight>



* This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting. * This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting.
Line 98:
Line 98:
         json_encode($restriction), ['id' => $cmid]);          json_encode($restriction), ['id' => $cmid]);
rebuild_course_cache($course->id, true); rebuild_course_cache($course->id, true);
</code> </syntaxhighlight>



TimHunt at 13:11, 4 June 2019
2019-06-04T13:11:36Z


				
				
				
				
				
				← Older revision
				Revision as of 13:11, 4 June 2019
				
Line 87:
Line 87:



The availability API is provided for activities (course-modules) and sections. It is also possible to use it in other areas such as within a module. See [[Availability API for items within a module]]. The availability API is provided for activities (course-modules) and sections. It is also possible to use it in other areas such as within a module. See [[Availability API for items within a module]].

== Programmatically setting availability conditions ==

If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:

<code lang="php">
$restriction = \core_availability\tree::get_root_json(
        [\availability_group\condition::get_json($group->id)]);
$DB->set_field('course_modules', 'availability',
        json_encode($restriction), ['id' => $cmid]);
rebuild_course_cache($course->id, true);
</code>



Quen: /* Display a list of users who may be able to access the current activity */
2018-08-13T10:51:03Z
Display a list of users who may be able to access the current activity

				
				
				
				
				
				← Older revision
				Revision as of 10:51, 13 August 2018
				
Line 78:
Line 78:
</code> </code>



* This does not currently include the groupmembersonly flag (if enabled). You can filter separately for this setting. 
* This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting. * This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting.






Quen: /* Implementing new availability conditions */
2014-04-30T11:05:27Z
Implementing new availability conditions

				
				
				
				
				
				← Older revision
				Revision as of 11:05, 30 April 2014
				
Line 84:
Line 84:



It is easy to write new availability conditions. See [[Availability conditions]]. It is easy to write new availability conditions. See [[Availability conditions]].

== Using availability conditions in other areas ==

The availability API is provided for activities (course-modules) and sections. It is also possible to use it in other areas such as within a module. See [[Availability API for items within a module]].

← Older revision		Revision as of 08:13, 15 July 2021
Line 92:		Line 92:
	If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:		If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:

	<~~code~~ lang="php">		<syntaxhighlight lang="lang="php"">
	$restriction = \core_availability\tree::get_root_json(		$restriction = \core_availability\tree::get_root_json(
	[\availability_group\condition::get_json($group->id)]);		[\availability_group\condition::get_json($group->id)]);

← Older revision		Revision as of 13:37, 14 July 2021
Line 37:		Line 37:
	To check if the current user can access an activity (supposing you have a $course and $cmid):		To check if the current user can access an activity (supposing you have a $course and $cmid):

	<~~code~~ php>		<syntaxhighlight lang="php">
	$modinfo = get_fast_modinfo($course);		$modinfo = get_fast_modinfo($course);
	$cm = $modinfo->get_cm($cmid);		$cm = $modinfo->get_cm($cmid);
Line 73:		Line 73:
	If you have a list of users (for example you could obtain this using one of the 'get enrolled users' functions), you can filter it to include only those users who are allowed to see an activity with this code:		If you have a list of users (for example you could obtain this using one of the 'get enrolled users' functions), you can filter it to include only those users who are allowed to see an activity with this code:

	<~~code~~ php>		<syntaxhighlight lang="php">
	$info = new \core_availability\info_module($cm);		$info = new \core_availability\info_module($cm);
	$filtered = $info->filter_user_list($users);		$filtered = $info->filter_user_list($users);

← Older revision		Revision as of 13:05, 14 July 2021
Line 49:		Line 49:
	// User cannot access the activity and they will not see it at all.		// User cannot access the activity and they will not see it at all.
	}		}
	</~~code~~>		</syntaxhighlight>

	There are similar properties for sections.		There are similar properties for sections.
Line 76:		Line 76:
	$info = new \core_availability\info_module($cm);		$info = new \core_availability\info_module($cm);
	$filtered = $info->filter_user_list($users);		$filtered = $info->filter_user_list($users);
	</~~code~~>		</syntaxhighlight>

	* This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting.		* This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting.
Line 98:		Line 98:
	json_encode($restriction), ['id' => $cmid]);		json_encode($restriction), ['id' => $cmid]);
	rebuild_course_cache($course->id, true);		rebuild_course_cache($course->id, true);
	</~~code~~>		</syntaxhighlight>

← Older revision		Revision as of 13:11, 4 June 2019
Line 87:		Line 87:

	The availability API is provided for activities (course-modules) and sections. It is also possible to use it in other areas such as within a module. See [[Availability API for items within a module]].		The availability API is provided for activities (course-modules) and sections. It is also possible to use it in other areas such as within a module. See [[Availability API for items within a module]].

			== Programmatically setting availability conditions ==

			If you want to programmatically set up an availability condition (e.g. set an activity to only be available to users of a particular group, the best code to do that is:

			<code lang="php">
			$restriction = \core_availability\tree::get_root_json(
			[\availability_group\condition::get_json($group->id)]);
			$DB->set_field('course_modules', 'availability',
			json_encode($restriction), ['id' => $cmid]);
			rebuild_course_cache($course->id, true);
			</code>

← Older revision		Revision as of 10:51, 13 August 2018
Line 78:		Line 78:
	</code>		</code>

	* This does not currently include the groupmembersonly flag (if enabled). You can filter separately for this setting.
	* This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting.		* This does not currently include the $cm->visible setting, nor does it take into account the viewhiddenactivities setting.

← Older revision		Revision as of 11:05, 30 April 2014
Line 84:		Line 84:

	It is easy to write new availability conditions. See [[Availability conditions]].		It is easy to write new availability conditions. See [[Availability conditions]].

			== Using availability conditions in other areas ==

			The availability API is provided for activities (course-modules) and sections. It is also possible to use it in other areas such as within a module. See [[Availability API for items within a module]].