mod_page

Namespaces
namespace	mod_page\analytics\indicator
namespace	mod_page\content
namespace	mod_page\event
namespace	mod_page\privacy
namespace	mod_page\search

Classes
class	backup_page_activity_structure_step
	Define all the backup steps that will be used by the backup_page_activity_task. More...
class	backup_page_activity_task
	Provides the steps to perform one complete backup of the Page instance. More...
class	mod_page\analytics\indicator\activity_base
	Activity base class. More...
class	mod_page\analytics\indicator\cognitive_depth
	Cognitive depth indicator - page. More...
class	mod_page\analytics\indicator\social_breadth
	Social breadth indicator - page. More...
class	mod_page\content\exporter
	A class which assists a component to export content. More...
class	mod_page\event\course_module_instance_list_viewed
	The mod_page instance list viewed event class. More...
class	mod_page\event\course_module_viewed
	The mod_page course module viewed event class. More...
class	mod_page\privacy\provider
	The mod_page module does not store any data. More...
class	mod_page\search\activity
	Search area for mod_page activities. More...
class	mod_page_external
	Page external functions. More...
class	mod_page_generator
	Page module data generator class. More...
class	mod_page_mod_form
class	moodle1_mod_page_handler
	Page conversion handler. More...
class	page_content_file_info
	File browsing support class. More...
class	restore_page_activity_structure_step
	Define all the restore steps that will be used by the restore_page_activity_task. More...
class	restore_page_activity_task
	page restore task that provides all the settings and steps to perform one complete restore of the activity More...

Functions
	mod_page_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, $userid=0)
	This function receives a calendar event and returns the action associated with it, or null if there is none.
	mod_page_get_path_from_pluginfile (string $filearea, array $args)
	Given an array with a file path, it returns the itemid and the filepath for the defined filearea.
	page_add_instance ($data, $mform=null)
	Add page instance.
	page_check_updates_since (cm_info $cm, $from, $filter=array())
	Check if the module has any update that affects the current user since a given time.
	page_delete_instance ($id)
	Delete page instance.
	page_dndupload_handle ($uploadinfo)
	Handle a file that has been uploaded.
	page_dndupload_register ()
	Register the ability to handle drag and drop file uploads.
	page_export_contents ($cm, $baseurl)
	Export page resource contents.
	page_get_coursemodule_info ($coursemodule)
	Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing.
	page_get_editor_options ($context)
	page_get_file_areas ($course, $cm, $context)
	Lists all browsable file areas.
	page_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
	File browsing support for page module content area.
	page_get_post_actions ()
	List the actions that correspond to a post of this module.
	page_get_view_actions ()
	List the actions that correspond to a view of this module.
	page_page_type_list ($pagetype, $parentcontext, $currentcontext)
	Return a list of page types.
	page_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
	Serves the page files.
	page_reset_userdata ($data)
	This function is used by the reset_course_userdata function in moodlelib.
	page_supports ($feature)
	List of features supported in Page module.
	page_update_instance ($data, $mform)
	Update page instance.
	page_view ($page, $course, $cm, $context)
	Mark the activity completed (if required) and trigger the course_module_viewed event.
	xmldb_page_install ()
	xmldb_page_upgrade ($oldversion)

Variables
	$capabilities
	$functions
	$logs
	$plugin = 2023100400
$plugin	component = 'mod_page'
$plugin	cron = 0
$plugin	version = 2023100900

Detailed Description

Function Documentation

mod_page_core_calendar_provide_event_action()

mod_page_core_calendar_provide_event_action	(	calendar_event	$event,
		core_calendar\action_factory	$factory,
			$userid = 0 )

This function receives a calendar event and returns the action associated with it, or null if there is none.

This is used by block_myoverview in order to display the event appropriately. If null is returned then the event is not displayed on the block.

Parameters

calendar_event	$event
core_calendar\action_factory	$factory

Return values

core_calendar\local\event\entities\action_interface|null

mod_page_get_path_from_pluginfile()

mod_page_get_path_from_pluginfile	(	string	$filearea,
		array	$args )

Given an array with a file path, it returns the itemid and the filepath for the defined filearea.

Parameters

string	$filearea	The filearea.
array	$args	The path (the part after the filearea and before the filename).

Return values

array

The itemid and the filepath inside the $args path, for the defined filearea.

page_add_instance()

page_add_instance	(		$data,
			$mform = null )

Add page instance.

Parameters

stdClass	$data
mod_page_mod_form	$mform

Return values

int	new page instance id

page_check_updates_since()

page_check_updates_since	(	cm_info	$cm,
			$from,
			$filter = array() )

Check if the module has any update that affects the current user since a given time.

Parameters

cm_info	$cm	course module data
int	$from	the time to check updates from
array	$filter	if we need to check only specific updates

Return values

stdClass

an object with the different type of areas indicating if they were updated or not

Since

Moodle 3.2

page_delete_instance()

page_delete_instance

(

$id

)

Delete page instance.

Parameters

int

$id

Return values

bool

true

page_dndupload_handle()

page_dndupload_handle

(

$uploadinfo

)

Handle a file that has been uploaded.

Parameters

object

$uploadinfo

details of the file / content that has been uploaded

Return values

int	instance id of the newly created mod

page_dndupload_register()

page_dndupload_register

(

)

Register the ability to handle drag and drop file uploads.

Return values

array

containing details of the files / types the mod can handle

page_export_contents()

page_export_contents	(		$cm,
			$baseurl )

Export page resource contents.

Return values

array

of file content

page_get_coursemodule_info()

page_get_coursemodule_info

(

$coursemodule

)

Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing.

See course_modinfo::get_array_of_activities()

Parameters

stdClass

$coursemodule

Return values

cached_cm_info

Info to customise main page display

page_get_file_areas()

page_get_file_areas	(		$course,
			$cm,
			$context )

Lists all browsable file areas.

Parameters

stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object

Return values

array

page_get_file_info()

page_get_file_info	(		$browser,
			$areas,
			$course,
			$cm,
			$context,
			$filearea,
			$itemid,
			$filepath,
			$filename )

File browsing support for page module content area.

Parameters

file_browser	$browser	file browser instance
stdClass	$areas	file areas
stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object
string	$filearea	file area
int	$itemid	item ID
string	$filepath	file path
string	$filename	file name

Return values

file_info

instance or null if not found

page_get_post_actions()

page_get_post_actions

(

)

List the actions that correspond to a post of this module.

This is used by the participation report.

Note: This is not used by new logging system. Event with crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING will be considered as post action.

Return values

array

page_get_view_actions()

page_get_view_actions

(

)

List the actions that correspond to a view of this module.

This is used by the participation report.

Note: This is not used by new logging system. Event with crud = 'r' and edulevel = LEVEL_PARTICIPATING will be considered as view action.

Return values

array

page_page_type_list()

page_page_type_list	(		$pagetype,
			$parentcontext,
			$currentcontext )

Return a list of page types.

Parameters

string	$pagetype	current page type
stdClass	$parentcontext	Block's parent context
stdClass	$currentcontext	Current context of block

page_pluginfile()

page_pluginfile	(		$course,
			$cm,
			$context,
			$filearea,
			$args,
			$forcedownload,
		array	$options = array() )

Serves the page files.

Parameters

stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object
string	$filearea	file area
array	$args	extra arguments
bool	$forcedownload	whether or not force download
array	$options	additional options affecting the file serving

Return values

bool	false if file not found, does not return if found - just send the file

page_reset_userdata()

page_reset_userdata

(

$data

)

This function is used by the reset_course_userdata function in moodlelib.

Parameters

$data

the data submitted from the reset course.

Return values

array

status array

page_supports()

page_supports

(

$feature

)

List of features supported in Page module.

Parameters

string

$feature

FEATURE_xx constant for requested feature

Return values

mixed

True if module supports feature, false if not, null if doesn't know or string for the module purpose.

page_update_instance()

page_update_instance	(		$data,
			$mform )

Update page instance.

Parameters

object	$data
object	$mform

Return values

bool

true

page_view()

page_view	(		$page,
			$course,
			$cm,
			$context )

Mark the activity completed (if required) and trigger the course_module_viewed event.

Parameters

stdClass	$page	page object
stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object

Since

Moodle 3.0

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    'mod/page:view' => array(
        'captype' => 'read',
        'contextlevel' => CONTEXT_MODULE,
        'archetypes' => array(
            'guest' => CAP_ALLOW,
            'user' => CAP_ALLOW,
        )
    ),
 
    'mod/page:addinstance' => array(
        'riskbitmask' => RISK_XSS,
 
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'editingteacher' => CAP_ALLOW,
            'manager' => CAP_ALLOW
        ),
        'clonepermissionsfrom' => 'moodle/course:manageactivities'
    ),
 
 
 
)

$functions

$functions

Initial value:

= array(
 
    'mod_page_view_page' => array(
        'classname'     => 'mod_page_external',
        'methodname'    => 'view_page',
        'description'   => 'Simulate the view.php web interface page: trigger events, completion, etc...',
        'type'          => 'write',
        'capabilities'  => 'mod/page:view',
        'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
    ),
 
    'mod_page_get_pages_by_courses' => array(
        'classname'     => 'mod_page_external',
        'methodname'    => 'get_pages_by_courses',
        'description'   => 'Returns a list of pages in a provided list of courses, if no list is provided all pages that the user
                            can view will be returned.',
        'type'          => 'read',
        'capabilities'  => 'mod/page:view',
        'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    ),
)

$logs

$logs

Initial value:

= array(
    array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),
    array('module'=>'page', 'action'=>'view all', 'mtable'=>'page', 'field'=>'name'),
    array('module'=>'page', 'action'=>'update', 'mtable'=>'page', 'field'=>'name'),
    array('module'=>'page', 'action'=>'add', 'mtable'=>'page', 'field'=>'name'),
)