core_repository

Namespaces
namespace	core_repository\privacy

Classes
class	core_repository\privacy\provider
	Privacy Subsystem for core_repository implementing metadata and plugin providers. More...
class	repository
	This is the base class of the repository class. More...
class	repository_exception
	Exception class for repository api. More...
class	repository_instance_form
	This is a class used to define a repository instance form. More...
class	repository_type
	This class is used to manage repository plugins. More...
class	repository_type_form
	This is a class used to define a repository type setting form. More...

Functions
	create_event_draft_file_deleted (context $context, stored_file $storedfile)
	Convenience function to create draft_file_deleted log event.
	initialise_filepicker ($args)
	Generate all options needed by filepicker.
	repository_delete_selected_files ($context, string $component, string $filearea, $itemid, array $files)
	Convenience function to handle deletion of files.
	repository_download_selected_files ($context, string $component, string $filearea, $itemid, array $files)
	Convenience function to handle deletion of files.

Variables
const	FILE_CONTROLLED_LINK 8
const	FILE_EXTERNAL 1
const	FILE_INTERNAL 2
const	FILE_REFERENCE 4
const	RENAME_SUFFIX '_2'

Detailed Description

Function Documentation

create_event_draft_file_deleted()

create_event_draft_file_deleted	(	context	$context,
		stored_file	$storedfile )

Convenience function to create draft_file_deleted log event.

Parameters

context	$context	The context where delete is called.
stored_file	$storedfile	the file to be logged.

initialise_filepicker()

initialise_filepicker

(

$args

)

Generate all options needed by filepicker.

Parameters

stdClass

$args

including following keys context accepted_types return_types

Return values

stdClass

the list of repository instances, including meta infomation, containing the following keys externallink repositories accepted_types

repository_delete_selected_files()

repository_delete_selected_files	(		$context,
		string	$component,
		string	$filearea,
			$itemid,
		array	$files )

Convenience function to handle deletion of files.

Parameters

object	$context	The context where the delete is called
string	$component	component
string	$filearea	filearea
int	$itemid	the item id
array	$files	Array of files object with each item having filename/filepath as values

Return values

array#$return

Array of strings matching up to the parent directory of the deleted files

Exceptions

coding_exception

repository_download_selected_files()

repository_download_selected_files	(		$context,
		string	$component,
		string	$filearea,
			$itemid,
		array	$files )

Convenience function to handle deletion of files.

Parameters

object	$context	The context where the delete is called
string	$component	component
string	$filearea	filearea
int	$itemid	the item id
array	$files	Array of files object with each item having filename/filepath as values

Return values

false|stdClass#$return

Object containing URL of zip archive and a file path

Exceptions

coding_exception