This plugin is used to access local files. More...

Inheritance diagram for repository_local:

Public Member Functions
	cache_file_by_reference ($reference, $storedfile)
	Cache file from external repository by reference repository::get_file_reference() repository::get_file() Invoked at MOODLE/repository/repository_ajax.php.

	callback ()
	For oauth like external authentication, when external repository direct user back to moodle, this function will be called to set up token and token_secret.

	can_be_edited_by_user ()
	Can the instance be edited by the current user?

	check_capability ()
	Checks if user has a capability to view the current repository.

	check_login ()
	To check whether the user is logged in.

	contains_private_data ()
	Is this repository accessing private data?

	convert_references_to_local ()
	Find all external files in this repo and import them.

	copy_to_area ($source, $filerecord, $maxbytes=-1, $areamaxbytes=FILE_AREA_MAX_BYTES_UNLIMITED)
	This function is used to copy a moodle file to draft area.

	cron ()
	Defines operations that happen occasionally on cron.

	default_returntype ()
	Tells how the file can be picked from this repository.

	delete ($downloadcontents=false)
	delete a repository instance

	file_is_accessible ($source)
	Repository method to make sure that user can access particular file.

	filter ($value)
	Filter file listing to display specific types.

	get_file ($url, $filename='')
	Downloads a file from external repository and saves it in temp dir.

	get_file_reference ($source)
	Prepare file reference information.

	get_file_size ($source)
	Return size of a file in bytes.

	get_file_source_info ($source)
	Return the source information.

	get_link ($url)
	Return file URL, for most plugins, the parameter is the original url, but some plugins use a file id, so we need this function to convert file id to original url.

	get_listing ($encodedpath='', $page='')
	Get file listing.

	get_meta ()
	Provide repository instance information for Ajax.

	get_name ()
	Return the name of this instance, can be overridden.

	get_option ($config='')
	Get settings for repository instance.

	get_reference_details ($reference, $filestatus=0)
	Return human readable reference information.

	get_short_filename ($str, $maxlength)
	Create a shorten filename.

	get_typename ()
	Returns the type name of the repository.

	global_search ()
	is it possible to do glboal search?

	has_moodle_files ()
	Does this repository used to browse moodle files?

	hide ($hide='toggle')
	Hide/Show a repository.

	import_external_file_contents (stored_file $file, $maxbytes=0)
	Downloads the file from external repository and saves it in moodle filepool.

	is_visible ()
	Return is the instance is visible (is the type visible ? is the context enable ?)

	logout ()
	Logout from repository instance By default, this function will return a login form.

	prepare_file ($filename)
	Get a unique file path in which to save the file.

	prepare_to_cache ()
	Prepares the repository to be cached.

	print_login ()
	Show the login screen, if required.

	print_search ()
	Show the search screen, if required.

	reference_file_selected ($reference, $context, $component, $filearea, $itemid)
	reference_file_selected

	remove_files ()
	Find all external files linked to this repository and delete them.

	search ($q, $page=1)
	Search through all the files.

	send_file ($storedfile, $lifetime=null, $filter=0, $forcedownload=false, array $options=null)
	Repository method to serve the referenced file.

	send_relative_file (stored_file $mainfile, $relativepath)
	Gets a file relative to this file in the repository and sends it to the browser.

	set_option ($options=array())
	Save settings for repository instance $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));.

	supported_filetypes ()
	What kind of files will be in this repository?

	supported_returntypes ()
	Tells how the file can be picked from this repository.

	supports_relative_file ()
	helper function to check if the repository supports send_relative_file.

	sync_reference (stored_file $file)
	Performs synchronisation of an external file if the previous one has expired.

	uses_post_requests ()
	Helper function to indicate if this repository uses post requests for uploading files.

Static Public Member Functions
static	antivir_scan_file ($thefile, $filename, $deleteinfected)
	Scan file, throws exception in case of infected file.

static	append_suffix ($filename)
	Append a suffix to filename.

static	build_source_field ($source)
	Build draft file's source field.

static	build_tree ($fileinfo, $search, $dynamicmode, &$list)
	Builds a tree of files This function is then called recursively.

static	create ($type, $userid, $context, $params, $readonly=0)
	Create an instance for this plug-in.

static	delete_all_for_context ($contextid, $downloadcontents=true)
	Delete all the instances associated to a context.

static	delete_tempfile_from_draft ($draftitemid, $filepath, $filename)
	Delete a temp file from draft area.

static	display_instances_list ($context, $typename=null)
	Display a repository instance list (with edit/delete/create links)

static	draftfile_exists ($itemid, $filepath, $filename)
	Check if file already exists in draft area.

static	get_editable_types ($context=null)
	Return all types that you a user can create/edit and which are also visible Note: Mostly used in order to know if at least one editable type can be set.

static	get_instance ($id)
	Get single repository instance for administrative actions.

static	get_instance_option_names ()
	Return names of the instance options.

static	get_instances ($args=array())
	Return repository instances.

static	get_moodle_file ($reference)
	Parses the moodle file reference and returns an instance of stored_file.

static	get_repository_by_id ($repositoryid, $context, $options=array())
	Get repository instance using repository id.

static	get_secret_key ()
	Generate a secret key to be used for passing sensitive information around.

static	get_type_by_id ($id)
	Get the repository type by a given repository type id.

static	get_type_by_typename ($typename)
	Get a repository type object by a given type name.

static	get_type_option_names ()
	Return names of the general options.

static	get_types ($visible=null)
	Return all repository types ordered by sortorder field first repository type in returnedarray[0], second repository type in returnedarray[1], ...

static	get_unused_filename ($itemid, $filepath, $filename)
	Get an unused filename from the current draft area.

static	instance_config_form ($mform)
	Edit/Create Instance Settings Moodle form.

static	instance_form_validation ($mform, $data, $errors)
	Validate repository plugin instance form.

static	move_to_filepool ($thefile, $record)
	Move file from download folder to file pool using FILE API.

static	overwrite_existing_draftfile ($itemid, $filepath, $filename, $newfilepath, $newfilename)
	Overwrite an existing file.

static	plugin_init ()
	function which is run when the type is created (moodle administrator add the plugin)

static	prepare_listing ($listing)
	Prepares list of files before passing it to AJAX, makes sure data is in the correct format and stores formatted values.

static	reset_caches ()
	Function repository\reset_caches() is deprecated, cache is handled by MUC now.

static	static_function ($plugin, $function)
	Call a static function.

static	sync_external_file ($file, $resetsynchistory=false)
	Function repository\sync_external_file() is deprecated.

static	type_config_form ($mform, $classname='repository')
	Edit/Create Admin Settings Moodle form.

static	type_form_validation ($mform, $data, $errors)
	Validate Admin Settings Moodle form.

static	update_draftfile ($draftid, $filepath, $filename, $updatedata)
	Updates a file in draft filearea.

static	wake_from_cache ($data)
	Restores the repository from cache.

Public Attributes
context	$context
	current context

bool	$disabled = false
	force disable repository instance

int	$id
	repository instance id

stdClass	$instance
	repository instance database record

string	$name
	instance name.

array	$options
	repository options

bool	$readonly
	Whether or not the repository instance is editable.

int	$returntypes
	return types

bool	$super_called
	true if the super construct is called, otherwise false.

const	GETFILE_TIMEOUT = 30
	Timeout in seconds for downloading the external file into moodle.

const	SYNCFILE_TIMEOUT = 1
	Timeout in seconds for syncronising the external file size.

const	SYNCIMAGE_TIMEOUT = 3
	Timeout in seconds for downloading an image file from external repository during syncronisation.

Static Protected Member Functions
static	prepare_breadcrumb ($breadcrumb)
	Prepare the breadcrumb.

static	prepare_list ($list)
	Prepare the file/folder listing.

Protected Attributes
string	$typename
	Type of repository (webdav, google_docs, dropbox, ...).

Detailed Description

This plugin is used to access local files.

Since: Moodle 2.0

Copyright: 2010 Dongsheng Cai

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later repository_local class is used to browse moodle files

Since: Moodle 2.0

Copyright: 2012 Marina Glancy; 2009 Dongsheng Cai

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ antivir_scan_file()

static repository::antivir_scan_file	(	$thefile,
		$filename,
		$deleteinfected )

staticinherited

Scan file, throws exception in case of infected file.

Please note that the scanning engine must be able to access the file, permissions of the file are not modified here!

Deprecated: since Moodle 3.0

Parameters

string	$thefile
string	$filename	name of the file
bool	$deleteinfected

◆ append_suffix()

static repository::append_suffix ( $filename )

staticinherited

Append a suffix to filename.

Parameters

string $filename

Return values

string

Deprecated: since 2.5

◆ build_source_field()

static repository::build_source_field ( $source )

staticinherited

Build draft file's source field.

file_restore_source_field_from_draft_file() XXX: This is a hack for file manager (MDL-28666) For newly created draft files we have to construct source filed in php serialized data format. File manager needs to know the original file information before copying to draft area, so we append these information in mdl_files.source field

Parameters

string $source

Return values

string serialised source field

◆ build_tree()

static repository::build_tree	(		$fileinfo,
			$search,
			$dynamicmode,
		&	$list )

staticinherited

Builds a tree of files This function is then called recursively.

Todo: take $search into account, and respect a threshold for dynamic loading

Parameters

file_info	$fileinfo	an object returned by file_browser\get_file_info()
string	$search	searched string
bool	$dynamicmode	no recursive call is done when in dynamic mode
array	$list	the array containing the files under the passed $fileinfo

Return values

int	the number of files found

◆ cache_file_by_reference()

repository::cache_file_by_reference	(		$reference,
			$storedfile )

inherited

Cache file from external repository by reference repository::get_file_reference() repository::get_file() Invoked at MOODLE/repository/repository_ajax.php.

Parameters

string	$reference	this reference is generated by repository\get_file_reference()
stored_file	$storedfile	created file reference

Reimplemented in repository_dropbox.

◆ callback()

repository::callback ( )

inherited

For oauth like external authentication, when external repository direct user back to moodle, this function will be called to set up token and token_secret.

Reimplemented in repository_dropbox, repository_flickr, repository_nextcloud, and repository_onedrive.

◆ can_be_edited_by_user()

repository::can_be_edited_by_user ( )

finalinherited

Can the instance be edited by the current user?

The property $readonly must not be used within this method because it only controls if the options from self\get_instance_option_names() can be edited.

Return values

bool	true if the user can edit the instance.

Since: Moodle 2.5

◆ check_capability()

repository::check_capability ( )

finalinherited

Checks if user has a capability to view the current repository.

Return values

bool	true when the user can, otherwise throws an exception.

Exceptions

repository_exception when the user does not meet the requirements.

◆ check_login()

repository::check_login ( )

inherited

To check whether the user is logged in.

Return values

bool

Reimplemented in repository_dropbox, repository_filesystem, repository_flickr, repository_flickr_public, repository_merlot, repository_nextcloud, repository_onedrive, repository_s3, repository_url, repository_webdav, repository_wikimedia, and repository_youtube.

◆ contains_private_data()

repository_local::contains_private_data ( )

Is this repository accessing private data?

Return values

bool

Reimplemented from repository.

◆ copy_to_area()

repository::copy_to_area	(	$source,
		$filerecord,
		$maxbytes = -1,
		$areamaxbytes = FILE_AREA_MAX_BYTES_UNLIMITED )

inherited

This function is used to copy a moodle file to draft area.

It DOES NOT check if the user is allowed to access this file because the actual file can be located in the area where user does not have access to but there is an alias to this file in the area where user CAN access it. file_is_accessible should be called for alias location before calling this function.

Parameters

string	$source	The metainfo of file, it is base64 encoded php serialized data
stdClass \| array	$filerecord	contains itemid, filepath, filename and optionally other attributes of the new file
int	$maxbytes	maximum allowed size of file, -1 if unlimited. If size of file exceeds the limit, the file_exception is thrown.
int	$areamaxbytes	the maximum size of the area. A file_exception is thrown if the new file will reach the limit.

Return values

array The information about the created file

◆ create()

static repository::create	(	$type,
		$userid,
		$context,
		$params,
		$readonly = 0 )

staticinherited

Create an instance for this plug-in.

Parameters

string	$type	the type of the repository
int	$userid	the user id
stdClass	$context	the context
array	$params	the options for this instance
int	$readonly	whether to create it readonly or not (defaults to not)

Return values

mixed

Reimplemented in repository_filesystem, and repository_nextcloud.

◆ cron()

repository::cron ( )

inherited

Defines operations that happen occasionally on cron.

Return values

bool

Reimplemented in repository_dropbox.

◆ default_returntype()

repository::default_returntype ( )

inherited

Tells how the file can be picked from this repository.

Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE

Return values

int

Reimplemented in repository_contentbank, repository_nextcloud, and repository_onedrive.

◆ delete()

repository::delete ( $downloadcontents = false )

finalinherited

delete a repository instance

Parameters

bool $downloadcontents

Return values

bool

◆ delete_all_for_context()

static repository::delete_all_for_context	(		$contextid,
			$downloadcontents = true )

staticfinalinherited

Delete all the instances associated to a context.

This method is intended to be a callback when deleting a course or a user to delete all the instances associated to their context. The usual way to delete a single instance is to use self::delete().

Parameters

int	$contextid	context ID.
boolean	$downloadcontents	true to convert references to hard copies.

Return values

void

◆ delete_tempfile_from_draft()

static repository::delete_tempfile_from_draft	(	$draftitemid,
		$filepath,
		$filename )

staticinherited

Delete a temp file from draft area.

Parameters

int	$draftitemid
string	$filepath
string	$filename

Return values

bool

◆ display_instances_list()

static repository::display_instances_list	(		$context,
			$typename = null )

staticinherited

Display a repository instance list (with edit/delete/create links)

Parameters

stdClass	$context	the context for which we display the instance
string	$typename	if set, we display only one type of instance

◆ draftfile_exists()

static repository::draftfile_exists	(	$itemid,
		$filepath,
		$filename )

staticinherited

Check if file already exists in draft area.

Parameters

int	$itemid	of the draft area.
string	$filepath	path to the file.
string	$filename	file name.

Return values

bool

◆ file_is_accessible()

repository::file_is_accessible ( $source )

inherited

Repository method to make sure that user can access particular file.

This is checked when user tries to pick the file from repository to deal with potential parameter substitutions is request

Parameters

string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)

Return values

bool	whether the file is accessible by current user

Reimplemented in repository_contentbank, and repository_recent.

◆ filter()

repository::filter ( $value )

inherited

Filter file listing to display specific types.

Parameters

array $value

Return values

bool

◆ get_editable_types()

static repository::get_editable_types ( $context = null )

staticinherited

Return all types that you a user can create/edit and which are also visible Note: Mostly used in order to know if at least one editable type can be set.

Parameters

stdClass $context the context for which we want the editable types

Return values

array types

◆ get_file()

repository::get_file	(		$url,
			$filename = '' )

inherited

Downloads a file from external repository and saves it in temp dir.

Function get_file() must be implemented by repositories that support returntypes FILE_INTERNAL or FILE_REFERENCE. It is invoked to pick up the file and copy it to moodle. This function is not called for moodle repositories, the function repository::copy_to_area() is used instead.

This function can be overridden by subclass if the files.reference field contains not just URL or if request should be done differently.

See also: curl

Exceptions

file_exception when error occured

Parameters

string	$url	the content of files.reference field, in this implementaion it is asssumed that it contains the string with URL of the file
string	$filename	filename (without path) to save the downloaded file in the temporary directory, if omitted or file already exists the new filename will be generated

Return values

array with elements: path: internal location of the file url: URL to the source (from parameters)

Reimplemented in repository_dropbox, repository_equella, repository_filesystem, repository_flickr, repository_flickr_public, repository_nextcloud, repository_onedrive, repository_s3, and repository_webdav.

◆ get_file_reference()

repository::get_file_reference ( $source )

inherited

Prepare file reference information.

Parameters

string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)

Return values

string file reference, ready to be stored

Reimplemented in repository_dropbox, repository_equella, repository_nextcloud, and repository_onedrive.

◆ get_file_size()

repository::get_file_size ( $source )

inherited

Return size of a file in bytes.

Parameters

string $source encoded and serialized data of file

Return values

int	file size in bytes

Deprecated: since Moodle 4.3

◆ get_file_source_info()

repository::get_file_source_info ( $source )

inherited

Return the source information.

The result of the function is stored in files.source field. It may be analysed when the source file is lost or repository may use it to display human-readable location of reference original.

This method is called when file is picked for the first time only. When file (either copy or a reference) is already in moodle and it is being picked again to another file area (also as a copy or as a reference), the value of files.source is copied.

Parameters

string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)

Return values

string|null

Reimplemented in repository_dropbox, repository_equella, repository_filesystem, repository_flickr, repository_flickr_public, repository_s3, repository_url, and repository_wikimedia.

◆ get_instance()

static repository::get_instance ( $id )

staticinherited

Get single repository instance for administrative actions.

Do not use this function to access repository contents, because it does not set the current context

See also: repository\get_repository_by_id()

Parameters

integer $id repository instance id

Return values

repository

◆ get_instance_option_names()

static repository::get_instance_option_names ( )

staticinherited

Return names of the instance options.

By default: no instance option name

Return values

array

Reimplemented in repository_equella, repository_filesystem, repository_flickr_public, repository_nextcloud, and repository_webdav.

◆ get_instances()

static repository::get_instances ( $args = array() )

staticinherited

Return repository instances.

Parameters

array $args Array containing the following keys: currentcontext : instance of context (default system context) context : array of instances of context (default empty array) onlyvisible : bool (default true) type : string return instances of this type only accepted_types : string|array return instances that contain files of those types (*, web_image, .pdf, ...) return_types : int combination of FILE_INTERNAL & FILE_EXTERNAL & FILE_REFERENCE & FILE_CONTROLLED_LINK. 0 means every type. The default is FILE_INTERNAL | FILE_EXTERNAL. userid : int if specified, instances belonging to other users will not be returned

Return values

array repository instances

◆ get_link()

repository::get_link ( $url )

inherited

Return file URL, for most plugins, the parameter is the original url, but some plugins use a file id, so we need this function to convert file id to original url.

Parameters

string $url the url of file

Return values

string

Reimplemented in repository_coursefiles, repository_dropbox, repository_flickr, repository_flickr_public, and repository_nextcloud.

◆ get_listing()

repository_local::get_listing	(		$encodedpath = '',
			$page = '' )

Get file listing.

Parameters

string	$encodedpath
string	$page	no paging is used in repository_local

Return values

mixed

Reimplemented from repository.

◆ get_meta()

repository::get_meta ( )

finalinherited

Provide repository instance information for Ajax.

Return values

stdClass

◆ get_moodle_file()

static repository::get_moodle_file ( $reference )

staticinherited

Parses the moodle file reference and returns an instance of stored_file.

Parameters

string $reference reference to the moodle internal file as retruned by repository::get_file_reference() or file_storage::pack_reference()

Return values

stored_file|null

◆ get_name()

repository::get_name ( )

inherited

Return the name of this instance, can be overridden.

Return values

string

Reimplemented in repository_coursefiles.

◆ get_option()

repository::get_option ( $config = '' )

inherited

Get settings for repository instance.

Parameters

string $config a specific option to get.

Return values

mixed returns an array of options. If $config is not empty, then it returns that option, or null if the option does not exist.

Reimplemented in repository_dropbox, repository_flickr, repository_flickr_public, and repository_youtube.

◆ get_reference_details()

repository::get_reference_details	(		$reference,
			$filestatus = 0 )

inherited

Return human readable reference information.

Parameters

string	$reference	value of DB field files_reference.reference
int	$filestatus	status of the file, 0 - ok, 666 - source missing

Return values

string

Reimplemented in repository_dropbox, repository_equella, repository_filesystem, repository_nextcloud, and repository_onedrive.

◆ get_repository_by_id()

static repository::get_repository_by_id	(	$repositoryid,
		$context,
		$options = array() )

staticinherited

Get repository instance using repository id.

Note that this function does not check permission to access repository contents

Exceptions

repository_exception

Parameters

int	$repositoryid	repository instance ID
context \| int	$context	context instance or context ID where this repository will be used
array	$options	additional repository options

Return values

repository

◆ get_secret_key()

static repository::get_secret_key ( )

staticfinalinherited

Generate a secret key to be used for passing sensitive information around.

Return values

string repository secret key.

◆ get_short_filename()

repository::get_short_filename	(		$str,
			$maxlength )

inherited

Create a shorten filename.

Parameters

string	$str	filename
int	$maxlength	max file name length

Return values

string short filename

◆ get_type_by_id()

static repository::get_type_by_id ( $id )

staticinherited

Get the repository type by a given repository type id.

Parameters

int $id the type id

Return values

object

◆ get_type_by_typename()

static repository::get_type_by_typename ( $typename )

staticinherited

Get a repository type object by a given type name.

Parameters

string $typename the repository type name

Return values

repository_type|bool

◆ get_type_option_names()

static repository::get_type_option_names ( )

staticinherited

Return names of the general options.

By default: no general option name

Return values

array

Reimplemented in repository_coursefiles, repository_dropbox, repository_flickr, repository_flickr_public, repository_merlot, repository_nextcloud, repository_onedrive, repository_recent, repository_s3, and repository_youtube.

◆ get_typename()

repository::get_typename ( )

inherited

Returns the type name of the repository.

Return values

string type name of the repository.

Since: Moodle 2.5

◆ get_types()

static repository::get_types ( $visible = null )

staticinherited

Return all repository types ordered by sortorder field first repository type in returnedarray[0], second repository type in returnedarray[1], ...

Parameters

bool $visible can return types by visiblity, return all types if null

Return values

array Repository types

◆ get_unused_filename()

static repository::get_unused_filename	(	$itemid,
		$filepath,
		$filename )

staticinherited

Get an unused filename from the current draft area.

Will check if the file ends with ([0-9]) and increase the number.

Parameters

int	$itemid	draft item ID.
string	$filepath	path to the file.
string	$filename	name of the file.

Return values

string an unused file name.

◆ global_search()

repository::global_search ( )

inherited

is it possible to do glboal search?

Return values

bool

Reimplemented in repository_filesystem, repository_flickr, repository_flickr_public, repository_merlot, repository_s3, repository_webdav, repository_wikimedia, and repository_youtube.

◆ has_moodle_files()

repository_local::has_moodle_files ( )

Does this repository used to browse moodle files?

Return values

boolean

Reimplemented from repository.

◆ hide()

repository::hide ( $hide = 'toggle' )

finalinherited

Hide/Show a repository.

Parameters

string $hide

Return values

bool

◆ import_external_file_contents()

repository::import_external_file_contents	(	stored_file	$file,
			$maxbytes = 0 )

inherited

Downloads the file from external repository and saves it in moodle filepool.

This function is different from repository::sync_reference() because it has bigger request timeout and always downloads the content.

This function is invoked when we try to unlink the file from the source and convert a reference into a true copy.

Exceptions

exception when file could not be imported

Parameters

stored_file	$file
int	$maxbytes	throw an exception if file size is bigger than $maxbytes (0 means no limit)

◆ instance_config_form()

static repository::instance_config_form ( $mform )

staticinherited

Edit/Create Instance Settings Moodle form.

Parameters

moodleform $mform Moodle form (passed by reference)

Reimplemented in repository_equella, repository_filesystem, repository_flickr_public, repository_nextcloud, and repository_webdav.

◆ instance_form_validation()

static repository::instance_form_validation	(	$mform,
		$data,
		$errors )

staticinherited

Validate repository plugin instance form.

Parameters

moodleform	$mform	moodle form
array	$data	form data
array	$errors	errors

Return values

array errors

Reimplemented in repository_filesystem.

◆ is_visible()

repository::is_visible ( )

inherited

Return is the instance is visible (is the type visible ? is the context enable ?)

Return values

bool

Reimplemented in repository_coursefiles.

◆ logout()

repository::logout ( )

inherited

Logout from repository instance By default, this function will return a login form.

Return values

string

Reimplemented in repository_dropbox, repository_filesystem, repository_flickr, repository_flickr_public, repository_nextcloud, repository_onedrive, and repository_wikimedia.

◆ move_to_filepool()

static repository::move_to_filepool	(		$thefile,
			$record )

staticinherited

Move file from download folder to file pool using FILE API.

Todo: MDL-28637

Parameters

string	$thefile	file path in download folder
stdClass	$record

Return values

array containing the following keys: icon file id url

◆ overwrite_existing_draftfile()

static repository::overwrite_existing_draftfile	(	$itemid,
		$filepath,
		$filename,
		$newfilepath,
		$newfilename )

staticinherited

Overwrite an existing file.

Parameters

int	$itemid
string	$filepath
string	$filename
string	$newfilepath
string	$newfilename

Return values

bool

◆ plugin_init()

static repository::plugin_init ( )

staticinherited

function which is run when the type is created (moodle administrator add the plugin)

Return values

bool	success or fail?

Reimplemented in repository_flickr_public.

◆ prepare_breadcrumb()

static repository::prepare_breadcrumb ( $breadcrumb )

staticprotectedinherited

Prepare the breadcrumb.

Parameters

array $breadcrumb contains each element of the breadcrumb.

Return values

array of breadcrumb elements.

Since: Moodle 2.3.3

◆ prepare_file()

repository::prepare_file ( $filename )

inherited

Get a unique file path in which to save the file.

The filename returned will be removed at the end of the request and should not be relied upon to exist in subsequent requests.

Parameters

string $filename file name

Return values

file path

◆ prepare_list()

static repository::prepare_list ( $list )

staticprotectedinherited

Prepare the file/folder listing.

Parameters

array $list of files and folders.

Return values

array of files and folders.

Since: Moodle 2.3.3

◆ prepare_listing()

static repository::prepare_listing ( $listing )

staticinherited

Prepares list of files before passing it to AJAX, makes sure data is in the correct format and stores formatted values.

Parameters

array | stdClass $listing result of get_listing() or search() or file_get_drafarea_files()

Return values

stdClass

◆ prepare_to_cache()

repository::prepare_to_cache ( )

inherited

Prepares the repository to be cached.

Implements method from cacheable_object interface.

Return values

array

Implements cacheable_object.

◆ print_login()

repository::print_login ( )

inherited

Show the login screen, if required.

Return values

string

Reimplemented in repository_areafiles, repository_coursefiles, repository_dropbox, repository_filesystem, repository_flickr, repository_flickr_public, repository_merlot, repository_nextcloud, repository_onedrive, repository_recent, repository_upload, repository_url, repository_user, and repository_wikimedia.

◆ print_search()

repository::print_search ( )

inherited

Show the search screen, if required.

Return values

string

Reimplemented in repository_flickr_public.

◆ reference_file_selected()

repository::reference_file_selected	(	$reference,
		$context,
		$component,
		$filearea,
		$itemid )

inherited

reference_file_selected

This function is called when a controlled link file is selected in a file picker and the form is saved. The expected behaviour for repositories supporting controlled links is to

copy the file to the moodle system account
put it in a folder that reflects the context it is being used
make sure the sharing permissions are correct (read-only with the link)
return a new reference string pointing to the newly copied file.

Parameters

string	$reference	this reference is generated by repository\get_file_reference()
context	$context	the target context for this new file.
string	$component	the target component for this new file.
string	$filearea	the target filearea for this new file.
string	$itemid	the target itemid for this new file.

Return values

string updated reference (final one before it's saved to db).

Reimplemented in repository_nextcloud, and repository_onedrive.

◆ reset_caches()

static repository::reset_caches ( )

staticinherited

Function repository\reset_caches() is deprecated, cache is handled by MUC now.

Deprecated: since Moodle 2.6 MDL-42016 - please do not use this function any more.

◆ search()

repository_local::search	(		$q,
			$page = 1 )

Search through all the files.

This method will do a raw search through the database, then will try to match with files that a user can access. A maximum of 50 files will be returned at a time, excluding possible duplicates found along the way.

Queries are done in chunk of 100 files to prevent too many records to be fetched at once. When too many files are not included, or a maximum of 10 queries are performed we consider that this was the last page.

Parameters

String	$q	The query string.
integer	$page	The page number.

Return values

array of results.

Reimplemented from repository.

◆ send_file()

repository::send_file	(		$storedfile,
			$lifetime = null,
			$filter = 0,
			$forcedownload = false,
		array	$options = null )

inherited

Repository method to serve the referenced file.

See also: send_stored_file

Parameters

stored_file	$storedfile	the file that contains the reference
int	$lifetime	Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
int	$filter	0 (default)=no filtering, 1=all files, 2=html files only
bool	$forcedownload	If true (default false), forces download of file rather than view in browser/plugin
array	$options	additional options affecting the file serving

Reimplemented in repository_dropbox, repository_equella, repository_filesystem, repository_nextcloud, and repository_onedrive.

◆ send_relative_file()

repository::send_relative_file	(	stored_file	$mainfile,
			$relativepath )

inherited

Gets a file relative to this file in the repository and sends it to the browser.

Used to allow relative file linking within a repository without creating file records for linked files

Repositories that overwrite this must be very careful - see filesystem repository for example.

Parameters

stored_file	$mainfile	The main file we are trying to access relative files for.
string	$relativepath	the relative path to the file we are trying to access.

Reimplemented in repository_filesystem.

◆ set_option()

repository::set_option ( $options = array() )

inherited

Save settings for repository instance $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));.

Parameters

array $options settings

Return values

bool

Reimplemented in repository_dropbox, repository_filesystem, repository_flickr, repository_flickr_public, repository_nextcloud, and repository_youtube.

◆ static_function()

static repository::static_function	(		$plugin,
			$function )

staticinherited

Call a static function.

Any additional arguments than plugin and function will be passed through.

Parameters

string	$plugin	repository plugin name
string	$function	function name

Return values

mixed

◆ supported_filetypes()

repository::supported_filetypes ( )

inherited

What kind of files will be in this repository?

Return values

array return '*' means this repository support any files, otherwise return mimetypes of files, it can be an array

Reimplemented in repository_dropbox, repository_flickr, repository_flickr_public, repository_merlot, repository_onedrive, repository_url, and repository_youtube.

◆ supported_returntypes()

repository_local::supported_returntypes ( )

Tells how the file can be picked from this repository.

Return values

int

Reimplemented from repository.

◆ supports_relative_file()

repository::supports_relative_file ( )

inherited

helper function to check if the repository supports send_relative_file.

Return values

true|false

Reimplemented in repository_filesystem.

◆ sync_external_file()

static repository::sync_external_file	(		$file,
			$resetsynchistory = false )

staticinherited

Function repository\sync_external_file() is deprecated.

Use repository\sync_reference instead

Deprecated: since Moodle 2.6 MDL-42016 - please do not use this function any more.

See also: repository\sync_reference()

◆ sync_reference()

repository::sync_reference ( stored_file $file )

inherited

Performs synchronisation of an external file if the previous one has expired.

This function must be implemented for external repositories supporting FILE_REFERENCE, it is called for existing aliases when their filesize, contenthash or timemodified are requested. It is not called for internal repositories (see repository::has_moodle_files()), references to internal files are updated immediately when source is modified.

Referenced files may optionally keep their content in Moodle filepool (for thumbnail generation or to be able to serve cached copy). In this case both contenthash and filesize need to be synchronized. Otherwise repositories should use contenthash of empty file and correct filesize in bytes.

Note that this function may be run for EACH file that needs to be synchronised at the moment. If anything is being downloaded or requested from external sources there should be a small timeout. The synchronisation is performed to update the size of the file and/or to update image and re-generated image preview. There is nothing fatal if syncronisation fails but it is fatal if syncronisation takes too long and hangs the script generating a page.

Note: If you wish to call $file->get_filesize(), $file->get_contenthash() or $file->get_timemodified() make sure that recursion does not happen.

Called from stored_file::sync_external_file()

@uses stored_file\set_missingsource() @uses stored_file\set_synchronized()

Parameters

stored_file $file

Return values

bool	false when file does not need synchronisation, true if it was synchronised

Reimplemented in repository_dropbox, repository_equella, repository_filesystem, and repository_nextcloud.

◆ type_config_form()

static repository::type_config_form	(		$mform,
			$classname = 'repository' )

staticinherited

Edit/Create Admin Settings Moodle form.

Parameters

MoodleQuickForm	$mform	Moodle form (passed by reference)
string	$classname	repository class name

Reimplemented in repository_dropbox, repository_flickr, repository_flickr_public, repository_merlot, repository_onedrive, repository_recent, repository_s3, and repository_youtube.

◆ type_form_validation()

static repository::type_form_validation	(	$mform,
		$data,
		$errors )

staticinherited

Validate Admin Settings Moodle form.

Parameters

moodleform	$mform	Moodle form (passed by reference)
array	$data	array of ("fieldname"=>value) of submitted data
array	$errors	array of ("fieldname"=>errormessage) of errors

Return values

array array of errors

◆ update_draftfile()

static repository::update_draftfile	(	$draftid,
		$filepath,
		$filename,
		$updatedata )

staticinherited

Updates a file in draft filearea.

This function can only update fields filepath, filename, author, license. If anything (except filepath) is updated, timemodified is set to current time. If filename or filepath is updated the file unconnects from it's origin and therefore all references to it will be converted to copies when filearea is saved.

Parameters

int	$draftid
string	$filepath	path to the directory containing the file, or full path in case of directory
string	$filename	name of the file, or '.' in case of directory
array	$updatedata	array of fields to change (only filename, filepath, license and/or author can be updated)

Exceptions

moodle_exception if for any reason file can not be updated (file does not exist, target already exists, etc.)

◆ uses_post_requests()

repository::uses_post_requests ( )

inherited

Helper function to indicate if this repository uses post requests for uploading files.

Deprecated: since Moodle 3.2, 3.1.1, 3.0.5

Return values

bool

◆ wake_from_cache()

static repository::wake_from_cache ( $data )

staticinherited

Restores the repository from cache.

Implements method from cacheable_object interface.

Return values

array

Implements cacheable_object.

Member Data Documentation

◆ $typename

string repository::$typename

protectedinherited

Type of repository (webdav, google_docs, dropbox, ...).

Read from $this->get_typename().

◆ GETFILE_TIMEOUT

const repository::GETFILE_TIMEOUT = 30

inherited

Timeout in seconds for downloading the external file into moodle.

Deprecated: since Moodle 2.7, please use $CFG->repositorygetfiletimeout instead

◆ SYNCFILE_TIMEOUT

const repository::SYNCFILE_TIMEOUT = 1

inherited

Timeout in seconds for syncronising the external file size.

Deprecated: since Moodle 2.7, please use $CFG->repositorysyncfiletimeout instead

◆ SYNCIMAGE_TIMEOUT

const repository::SYNCIMAGE_TIMEOUT = 3

inherited

Timeout in seconds for downloading an image file from external repository during syncronisation.

Deprecated: since Moodle 2.7, please use $CFG->repositorysyncimagetimeout instead

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

repository/local/lib.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ antivir_scan_file()

◆ append_suffix()

◆ build_source_field()

◆ build_tree()

◆ cache_file_by_reference()

◆ callback()

◆ can_be_edited_by_user()

◆ check_capability()

◆ check_login()

◆ contains_private_data()

◆ copy_to_area()

◆ create()

◆ cron()

◆ default_returntype()

◆ delete()

◆ delete_all_for_context()

◆ delete_tempfile_from_draft()

◆ display_instances_list()

◆ draftfile_exists()

◆ file_is_accessible()

◆ filter()

◆ get_editable_types()

◆ get_file()

◆ get_file_reference()

◆ get_file_size()

◆ get_file_source_info()

◆ get_instance()

◆ get_instance_option_names()

◆ get_instances()

◆ get_link()

◆ get_listing()

◆ get_meta()

◆ get_moodle_file()

◆ get_name()

◆ get_option()

◆ get_reference_details()

◆ get_repository_by_id()

◆ get_secret_key()

◆ get_short_filename()

◆ get_type_by_id()

◆ get_type_by_typename()

◆ get_type_option_names()

◆ get_typename()

◆ get_types()

◆ get_unused_filename()

◆ global_search()

◆ has_moodle_files()

◆ hide()

◆ import_external_file_contents()

◆ instance_config_form()

◆ instance_form_validation()

◆ is_visible()

◆ logout()

◆ move_to_filepool()

◆ overwrite_existing_draftfile()

◆ plugin_init()

◆ prepare_breadcrumb()

◆ prepare_file()

◆ prepare_list()

◆ prepare_listing()

◆ prepare_to_cache()

◆ print_login()

◆ print_search()

◆ reference_file_selected()

◆ reset_caches()

◆ search()

◆ send_file()

◆ send_relative_file()

◆ set_option()

◆ static_function()

◆ supported_filetypes()

◆ supported_returntypes()

◆ supports_relative_file()