Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_imscp

Topics

 backup
 
 
 external
 
 
 files
 
 
 log
 
 
 test
 
 

Namespaces

namespace  mod_imscp\analytics\indicator
 Activity base class.
 
namespace  mod_imscp\event
 The mod_imscp instance list viewed event.
 
namespace  mod_imscp\privacy
 Privacy Subsystem implementation for mod_imscp.
 
namespace  mod_imscp\search
 Search area for mod_imscp activities.
 

Classes

class  backup_imscp_activity_structure_step
 Define the complete imscp structure for backup, with file and id annotations. More...
 
class  imscp_file_info
 File browsing support class. More...
 
class  mod_imscp\analytics\indicator\activity_base
 Activity base class. More...
 
class  mod_imscp\analytics\indicator\cognitive_depth
 Cognitive depth indicator - imscp. More...
 
class  mod_imscp\analytics\indicator\social_breadth
 Social breadth indicator - imscp. More...
 
class  mod_imscp\event\course_module_instance_list_viewed
 The mod_imscp instance list viewed event class. More...
 
class  mod_imscp\event\course_module_viewed
 The mod_imscp course module viewed event class. More...
 
class  mod_imscp\privacy\provider
 Privacy Subsystem for mod_imscp implementing null_provider. More...
 
class  mod_imscp\search\activity
 Search area for mod_imscp activities. More...
 
class  mod_imscp_mod_form
 IMS CP configuration form. More...
 
class  moodle1_mod_imscp_handler
 imscp conversion handler. More...
 
class  restore_imscp_activity_structure_step
 Define all the restore steps that will be used by the restore_imscp_activity_task. More...
 
class  restore_imscp_activity_task
 Provides the settings and steps to perform one complete restore of the activity. More...
 

Functions

 imscp_htmllize_item ($item, $imscp, $cm)
 Internal function - creates htmls structure suitable for YUI tree.
 
 imscp_libxml_disable_entity_loader (bool $value)
 Wrapper for function libxml_disable_entity_loader() deprecated in PHP 8.
 
 imscp_parse_manifestfile ($manifestfilecontents, $imscp, $context)
 Parse the contents of a IMS package's manifest file.
 
 imscp_parse_structure ($imscp, $context)
 Parse an IMS content package's manifest file to determine its structure.
 
 imscp_print_content ($imscp, $cm, $course)
 Print IMSCP content to page.
 
 imscp_recursive_href ($manifestfilename, $imscp, $context)
 
 imscp_recursive_item ($xmlitem, $level, $resources)
 
 xmldb_imscp_install ()
 Stub for database installation.
 
 xmldb_imscp_upgrade ($oldversion)
 Stub for database upgrade.
 

Variables

 $capabilities
 
 $plugin = 2023100400
 
$plugin component = 'mod_imscp'
 
$plugin cron = 0
 
$plugin version = 2023100900
 

Detailed Description

Function Documentation

◆ imscp_libxml_disable_entity_loader()

imscp_libxml_disable_entity_loader ( bool $value)

Wrapper for function libxml_disable_entity_loader() deprecated in PHP 8.

Method was deprecated in PHP 8 and it shows deprecation message. However it is still required in the previous versions on PHP. While Moodle supports both PHP 7 and 8 we need to keep it.

See also
https://php.watch/versions/8.0/libxml_disable_entity_loader-deprecation
Parameters
bool$value
Return values
bool
Deprecated
since Moodle 4.3

◆ imscp_parse_manifestfile()

imscp_parse_manifestfile ( $manifestfilecontents,
$imscp,
$context )

Parse the contents of a IMS package's manifest file.

Parameters
string$manifestfilecontentsthe contents of the manifest file
Return values
array

◆ imscp_parse_structure()

imscp_parse_structure ( $imscp,
$context )

Parse an IMS content package's manifest file to determine its structure.

Parameters
object$imscp
object$context
Return values
array

◆ imscp_print_content()

imscp_print_content ( $imscp,
$cm,
$course )

Print IMSCP content to page.

Parameters
stdClass$imscpmodule instance.
stdClass$cmcourse module.
stdClass$courserecord.

◆ xmldb_imscp_upgrade()

xmldb_imscp_upgrade ( $oldversion)

Stub for database upgrade.

Parameters
int$oldversion

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'mod/imscp:view' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'guest' => CAP_ALLOW,
'user' => CAP_ALLOW,
)
),
'mod/imscp:addinstance' => array(
'riskbitmask' => RISK_XSS,
'captype' => 'write',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => array(
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
),
'clonepermissionsfrom' => 'moodle/course:manageactivities'
),
)
const CONTEXT_COURSE
Course context level - one instances for each course.
Definition accesslib.php:128
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition accesslib.php:115
const RISK_XSS
Capability allows user to add scripted content - see
Definition accesslib.php:143
const CONTEXT_MODULE
Course module context level - one instance for each course module.
Definition accesslib.php:130