block_html

Namespaces
namespace	block_html\privacy
namespace	block_html\search

Classes
class	backup_html_block_task
	Specialised backup task for the html block (requires encode_content_links in some configdata attrs) More...
class	block_html
class	block_html\privacy\provider
	Privacy Subsystem implementation for block_html. More...
class	block_html\search\content
	Search area for block_html blocks. More...
class	block_html_edit_form
	Form for editing HTML block instances. More...
class	moodle1_block_html_handler
	Block conversion handler for html. More...
class	restore_html_block_decode_content
	Specialised restore_decode_content provider that unserializes the configdata field, to serve the configdata->text content to the restore_decode_processor packaging it back to its serialized form after process. More...
class	restore_html_block_task
	Specialised restore task for the html block (requires encode_content_links in some configdata attrs) More...

Functions
	block_html_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.
	block_html_global_db_replace ($search, $replace)
	Perform global search replace such as when migrating site to new URL.
	block_html_pluginfile ($course, $birecord_or_cm, $context, $filearea, $args, $forcedownload, array $options=array())
	xmldb_block_html_upgrade ($oldversion)
	Upgrade code for the HTML block.

Variables
	$capabilities
	$plugin = 2023100400
$plugin	component = 'block_html'
$plugin	version = 2023100900

Detailed Description

Function Documentation

block_html_get_path_from_pluginfile()

block_html_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.

block_html_global_db_replace()

block_html_global_db_replace	(		$search,
			$replace )

Perform global search replace such as when migrating site to new URL.

Parameters

$search
$replace

Return values

void

block_html_pluginfile()

block_html_pluginfile	(		$course,
			$birecord_or_cm,
			$context,
			$filearea,
			$args,
			$forcedownload,
		array	$options = array() )

Parameters

stdClass	$course	course object
stdClass	$birecord_or_cm	block instance record
context	$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

Todo

MDL-36050 improve capability check on stick blocks, so we can check user capability before sending images.

xmldb_block_html_upgrade()

xmldb_block_html_upgrade

(

$oldversion

)

Upgrade code for the HTML block.

Parameters

int

$oldversion

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
 
    'block/html:myaddinstance' => array(
        'captype' => 'write',
        'contextlevel' => CONTEXT_SYSTEM,
        'archetypes' => array(
            'user' => CAP_ALLOW
        ),
 
        'clonepermissionsfrom' => 'moodle/my:manageblocks'
    ),
 
    'block/html:addinstance' => array(
        'riskbitmask' => RISK_SPAM | RISK_XSS,
 
        'captype' => 'write',
        'contextlevel' => CONTEXT_BLOCK,
        'archetypes' => array(
            'editingteacher' => CAP_ALLOW,
            'manager' => CAP_ALLOW
        ),
 
        'clonepermissionsfrom' => 'moodle/site:manageblocks'
    ),
)