Inheritance diagram for core_contentbank\contenttype:

Public Member Functions
	__construct (\context $context=null)
	Content type constructor.

	can_access ()
	Returns user has access capability for the main content bank and the content itself (base on is_access_allowed from plugin).

	can_copy (content $content)
	Returns whether or not the user has permission to copy the content.

	can_delete (content $content)
	Check if the user can delete this content.

	can_download (content $content)
	Returns whether or not the user has permission to download the content.

	can_edit (?content $content=null)
	Returns whether or not the user has permission to use the editor.

	can_manage (content $content)
	Check if the user can managed this content.

	can_upload ()
	Returns the user has permission to upload new content.

	create_content (\stdClass $record=null)
	Fills content_bank table with appropiate information.

	delete_content (content $content)
	Delete this content from the content_bank.

	get_contenttype_name ()
	Returns the contenttype name of this content.

	get_contenttype_types ()
	Returns the list of different types of the given content type.

	get_download_url (content $content)
	Returns the URL to download the content.

	get_icon (content $content)
	Returns the HTML code to render the icon for content bank contents.

	get_manageable_extensions ()
	Return an array of extensions the plugins could manage.

	get_plugin_name ()
	Returns the plugin name of the current instance.

	get_view_content (content $content)
	Returns the HTML content to add to view.php visualizer.

	get_view_url (content $content)
	Returns the URL where the content will be visualized.

	is_feature_supported (string $feature)
	Returns the plugin supports the feature.

	move_content (content $content, context $context)
	Move content to another context.

	rename_content (content $content, string $name)
	Rename this content from the content_bank.

	replace_content (stored_file $file, content $content)
	Replace a content using an uploaded file.

	upload_content (stored_file $file, stdClass $record=null)
	Create a new content from an uploaded file.

Public Attributes
string const	CAN_COPY = 'copy'
	Constant representing whether the plugin implements copy feature.

string const	CAN_DOWNLOAD = 'download'
	Constant representing whether the plugin implements download feature.

string const	CAN_EDIT = 'edit'
	Constant representing whether the plugin implements edition feature.

string const	CAN_UPLOAD = 'upload'
	Constant representing whether the plugin implements uploading feature.

Protected Member Functions
	get_implemented_features ()
	Return an array of implemented features by the plugins.

	is_access_allowed ()
	Returns user has access capability for the content itself.

	is_copy_allowed (content $content)
	Returns plugin allows copying.

	is_delete_allowed (content $content)
	Returns if content allows deleting.

	is_download_allowed (content $content)
	Returns plugin allows downloading.

	is_edit_allowed (?content $content)
	Returns plugin allows edition.

	is_manage_allowed (content $content)
	Returns if content allows managing.

	is_upload_allowed ()
	Returns plugin allows uploading.

Protected Attributes
context	$context = null
	This contenttype's context.

Constructor & Destructor Documentation

◆ __construct()

core_contentbank\contenttype::__construct ( \context $context = null )

Content type constructor.

Parameters

context $context Optional context to check (default null)

Member Function Documentation

◆ can_access()

core_contentbank\contenttype::can_access ( )

final

Returns user has access capability for the main content bank and the content itself (base on is_access_allowed from plugin).

Return values

bool	True if content could be accessed. False otherwise.

◆ can_copy()

core_contentbank\contenttype::can_copy ( content $content )

final

Returns whether or not the user has permission to copy the content.

Since: Moodle 4.3

Parameters

content $content The content to be copied.

Return values

bool	True if the user can copy the content. False otherwise.

◆ can_delete()

core_contentbank\contenttype::can_delete ( content $content )

final

Check if the user can delete this content.

Parameters

content $content The content to be deleted.

Return values

bool	True if content could be uploaded. False otherwise.

◆ can_download()

core_contentbank\contenttype::can_download ( content $content )

final

Returns whether or not the user has permission to download the content.

Since: Moodle 3.10

Parameters

content $content The content to be downloaded.

Return values

bool	True if the user can download the content. False otherwise.

◆ can_edit()

core_contentbank\contenttype::can_edit ( ?content $content = null )

final

Returns whether or not the user has permission to use the editor.

This function will be called with the content to be edited as parameter, or null when is checking permission to create a new content using the editor.

Parameters

content $content The content to be edited or null when creating a new content.

Return values

bool	True if the user can edit content. False otherwise.

◆ can_manage()

core_contentbank\contenttype::can_manage ( content $content )

final

Check if the user can managed this content.

Parameters

content $content The content to be managed.

Return values

bool	True if content could be managed. False otherwise.

◆ can_upload()

core_contentbank\contenttype::can_upload ( )

final

Returns the user has permission to upload new content.

Return values

bool	True if content could be uploaded. False otherwise.

◆ create_content()

core_contentbank\contenttype::create_content ( \stdClass $record = null )

Fills content_bank table with appropiate information.

Exceptions

dml_exception A DML specific exception is thrown for any creation error.

Parameters

stdClass $record An optional content record compatible object (default null)

Return values

content Object with content bank information.

◆ delete_content()

core_contentbank\contenttype::delete_content ( content $content )

Delete this content from the content_bank.

This method can be overwritten by the plugins if they need to delete specific information.

Parameters

content $content The content to delete.

Return values

boolean true if the content has been deleted; false otherwise.

◆ get_contenttype_name()

core_contentbank\contenttype::get_contenttype_name ( )

Returns the contenttype name of this content.

Return values

string Content type of the current instance

◆ get_contenttype_types()

core_contentbank\contenttype::get_contenttype_types ( )

abstract

Returns the list of different types of the given content type.

A content type can have one or more options for creating content. This method will report all of them or only the content type itself if it has no other options.

Return values

array

An object for each type:

string typename: descriptive name of the type.
string typeeditorparams: params required by this content type editor.
url typeicon: this type icon.

Reimplemented in contenttype_h5p\contenttype.

◆ get_download_url()

core_contentbank\contenttype::get_download_url ( content $content )

Returns the URL to download the content.

Since: Moodle 3.10

Parameters

content $content The content to be downloaded.

Return values

string URL with the content to download.

◆ get_icon()

core_contentbank\contenttype::get_icon ( content $content )

Returns the HTML code to render the icon for content bank contents.

Parameters

content $content The content to be displayed.

Return values

string HTML code to render the icon

◆ get_implemented_features()

core_contentbank\contenttype::get_implemented_features ( )

abstractprotected

Return an array of implemented features by the plugins.

Return values

array

Reimplemented in contenttype_h5p\contenttype.

◆ get_manageable_extensions()

core_contentbank\contenttype::get_manageable_extensions ( )

abstract

Return an array of extensions the plugins could manage.

Return values

array

Reimplemented in contenttype_h5p\contenttype.

◆ get_plugin_name()

core_contentbank\contenttype::get_plugin_name ( )

Returns the plugin name of the current instance.

Return values

string Plugin name of the current instance

◆ get_view_content()

core_contentbank\contenttype::get_view_content ( content $content )

Returns the HTML content to add to view.php visualizer.

Parameters

content $content The content to be displayed.

Return values

string HTML code to include in view.php.

◆ get_view_url()

core_contentbank\contenttype::get_view_url ( content $content )

Returns the URL where the content will be visualized.

Parameters

content $content The content to be displayed.

Return values

string URL where to visualize the given content.

◆ is_access_allowed()

core_contentbank\contenttype::is_access_allowed ( )

protected

Returns user has access capability for the content itself.

Return values

bool	True if content could be accessed. False otherwise.

Reimplemented in contenttype_h5p\contenttype.

◆ is_copy_allowed()

core_contentbank\contenttype::is_copy_allowed ( content $content )

protected

Returns plugin allows copying.

Since: Moodle 4.3

Parameters

content $content The content to be copied.

Return values

bool	True if plugin allows copying. False otherwise.

◆ is_delete_allowed()

core_contentbank\contenttype::is_delete_allowed ( content $content )

protected

Returns if content allows deleting.

Parameters

content $content The content to be deleted.

Return values

bool	True if content allows uploading. False otherwise.

◆ is_download_allowed()

core_contentbank\contenttype::is_download_allowed ( content $content )

protected

Returns plugin allows downloading.

Since: Moodle 3.10

Parameters

content $content The content to be downloaed.

Return values

bool	True if plugin allows downloading. False otherwise.

◆ is_edit_allowed()

core_contentbank\contenttype::is_edit_allowed ( ?content $content )

protected

Returns plugin allows edition.

Parameters

content $content The content to be edited.

Return values

bool	True if plugin allows edition. False otherwise.

◆ is_feature_supported()

core_contentbank\contenttype::is_feature_supported ( string $feature )

final

Returns the plugin supports the feature.

Parameters

string $feature Feature code e.g CAN_UPLOAD

Return values

bool	True if content could be uploaded. False otherwise.

◆ is_manage_allowed()

core_contentbank\contenttype::is_manage_allowed ( content $content )

protected

Returns if content allows managing.

Parameters

content $content The content to be managed.

Return values

bool	True if content allows uploading. False otherwise.

◆ is_upload_allowed()

core_contentbank\contenttype::is_upload_allowed ( )

protected

Returns plugin allows uploading.

Return values

bool	True if plugin allows uploading. False otherwise.

◆ move_content()

core_contentbank\contenttype::move_content	(	content	$content,
		context	$context )

Move content to another context.

This method can be overwritten by the plugins if they need to change some other specific information.

Parameters

content	$content	The content to rename.
context	$context	The new context.

Return values

boolean true if the content has been renamed; false otherwise.

◆ rename_content()

core_contentbank\contenttype::rename_content	(	content	$content,
		string	$name )

Rename this content from the content_bank.

This method can be overwritten by the plugins if they need to change some other specific information.

Parameters

content	$content	The content to rename.
string	$name	The name of the content.

Return values

boolean true if the content has been renamed; false otherwise.

◆ replace_content()

core_contentbank\contenttype::replace_content	(	stored_file	$file,
		content	$content )

Replace a content using an uploaded file.

Exceptions

file_exception	If file operations fail
dml_exception	if the content creation fails

Parameters

stored_file	$file	the uploaded file
content	$content	the original content record

Return values

content Object with the updated content bank information.

◆ upload_content()

core_contentbank\contenttype::upload_content	(	stored_file	$file,
		stdClass	$record = null )

Create a new content from an uploaded file.

Exceptions

file_exception	If file operations fail
dml_exception	if the content creation fails

Parameters

stored_file	$file	the uploaded file
stdClass \| null	$record	an optional content record

Return values

content Object with content bank information.

Member Data Documentation

◆ CAN_COPY

string const core_contentbank\contenttype::CAN_COPY = 'copy'

Constant representing whether the plugin implements copy feature.

Since: Moodle 4.3

◆ CAN_DOWNLOAD

string const core_contentbank\contenttype::CAN_DOWNLOAD = 'download'

Constant representing whether the plugin implements download feature.

Since: Moodle 3.10

The documentation for this class was generated from the following file:

contentbank/classes/contenttype.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ can_access()

◆ can_copy()

◆ can_delete()

◆ can_download()

◆ can_edit()

◆ can_manage()

◆ can_upload()

◆ create_content()

◆ delete_content()

◆ get_contenttype_name()

◆ get_contenttype_types()

◆ get_download_url()

◆ get_icon()

◆ get_implemented_features()

◆ get_manageable_extensions()

◆ get_plugin_name()

◆ get_view_content()

◆ get_view_url()

◆ is_access_allowed()

◆ is_copy_allowed()

◆ is_delete_allowed()

◆ is_download_allowed()

◆ is_edit_allowed()

◆ is_feature_supported()

◆ is_manage_allowed()

◆ is_upload_allowed()

◆ move_content()

◆ rename_content()

◆ replace_content()

◆ upload_content()

Member Data Documentation

◆ CAN_COPY

◆ CAN_DOWNLOAD