Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
repository_boxnet Class Reference

repository_boxnet class implements box.net client More...

Inheritance diagram for repository_boxnet:
repository cacheable_object

Public Member Functions

 __construct ($repositoryid, $context=SYSCONTEXTID, $options=array())
 Constructor. More...
 
 cache_file_by_reference ($reference, $storedfile)
 Cache file from external repository by reference } * repository::get_file() Invoked at MOODLE/repository/repository_ajax.php. More...
 
 callback ()
 Catch the request token.
 
 can_be_edited_by_user ()
 Can the instance be edited by the current user? More...
 
 check_capability ()
 Checks if user has a capability to view the current repository. More...
 
 check_login ()
 check if user logged More...
 
 contains_private_data ()
 Is this repository accessing private data? More...
 
 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. More...
 
 cron ()
 Defines operations that happen occasionally on cron. More...
 
 default_returntype ()
 Tells how the file can be picked from this repository. More...
 
 delete ($downloadcontents=false)
 delete a repository instance More...
 
 file_is_accessible ($source)
 Repository method to make sure that user can access particular file. More...
 
 filter (&$value)
 Filter file listing to display specific types. More...
 
 get_file ($ref, $filename='')
 Downloads a repository file and saves to a path. More...
 
 get_file_reference ($source)
 Prepare file reference information. More...
 
 get_file_size ($source)
 Return size of a file in bytes. More...
 
 get_file_source_info ($source)
 Return the source information. More...
 
 get_link ($reference)
 Get a link to the file. More...
 
 get_listing ($fullpath='', $page='')
 Get file listing. More...
 
 get_meta ()
 Provide repository instance information for Ajax. More...
 
 get_name ()
 Return the name of this instance, can be overridden. More...
 
 get_option ($config='')
 Get settings for repository instance. More...
 
 get_reference_details ($reference, $filestatus=0)
 Return human readable reference information stored_file::get_reference(). More...
 
 get_short_filename ($str, $maxlength)
 Create a shorten filename. More...
 
 get_typename ()
 Returns the type name of the repository. More...
 
 global_search ()
 is it possible to do glboal search? More...
 
 has_moodle_files ()
 Does this repository used to browse moodle files? More...
 
 hide ($hide='toggle')
 Hide/Show a repository. More...
 
 import_external_file_contents (stored_file $file, $maxbytes=0)
 Downloads the file from external repository and saves it in moodle filepool. More...
 
 is_visible ()
 Return is the instance is visible (is the type visible ? is the context enable ?) More...
 
 logout ()
 reset auth token More...
 
 prepare_file ($filename)
 Get a unique file path in which to save the file. More...
 
 prepare_to_cache ()
 Prepares the repository to be cached. More...
 
 print_login ()
 Return login form. More...
 
 print_search ()
 Show the search screen, if required. More...
 
 reference_file_selected ($reference, $context, $component, $filearea, $itemid)
 reference_file_selected More...
 
 remove_files ()
 Find all external files linked to this repository and delete them.
 
 search ($search_text, $page=0)
 Search files from box.net. More...
 
 send_file ($storedfile, $lifetime=null, $filter=0, $forcedownload=false, array $options=null)
 Repository method to serve the referenced file. More...
 
 send_relative_file (stored_file $mainfile, $relativepath)
 Gets a file relative to this file in the repository and sends it to the browser. More...
 
 set_option ($options=array())
 Save settings for repository instance $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));. More...
 
 supported_filetypes ()
 What kind of files will be in this repository? More...
 
 supported_returntypes ()
 Box.net supports copied and links. More...
 
 supports_relative_file ()
 helper function to check if the repository supports send_relative_file. More...
 
 sync_reference (stored_file $file)
 Synchronize the references. More...
 
 uses_post_requests ()
 Helper function to indicate if this repository uses post requests for uploading files. More...
 

Static Public Member Functions

static antivir_scan_file ($thefile, $filename, $deleteinfected)
 Scan file, throws exception in case of infected file. More...
 
static append_suffix ($filename)
 Append a suffix to filename. More...
 
static build_source_field ($source)
 Build draft file's source field. More...
 
static build_tree ($fileinfo, $search, $dynamicmode, &$list)
 Builds a tree of files This function is then called recursively. More...
 
static convert_to_valid_reference ($reference)
 Convert a reference to the new reference style. More...
 
static create ($type, $userid, $context, $params, $readonly=0)
 Create an instance for this plug-in. More...
 
static delete_all_for_context ($contextid, $downloadcontents=true)
 Delete all the instances associated to a context. More...
 
static delete_tempfile_from_draft ($draftitemid, $filepath, $filename)
 Delete a temp file from draft area. More...
 
static display_instances_list ($context, $typename=null)
 Display a repository instance list (with edit/delete/create links) More...
 
static draftfile_exists ($itemid, $filepath, $filename)
 Check if file already exists in draft area. More...
 
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. More...
 
static get_instance ($id)
 Get single repository instance for administrative actions. More...
 
static get_instance_option_names ()
 Return names of the instance options. More...
 
static get_instances ($args=array())
 Return repository instances. More...
 
static get_moodle_file ($reference)
 Parses the moodle file reference and returns an instance of stored_file. More...
 
static get_repository_by_id ($repositoryid, $context, $options=array())
 Get repository instance using repository id. More...
 
static get_secret_key ()
 Generate a secret key to be used for passing sensitive information around. More...
 
static get_type_by_id ($id)
 Get the repository type by a given repository type id. More...
 
static get_type_by_typename ($typename)
 Get a repository type object by a given type name. More...
 
static get_type_option_names ()
 Names of the plugin settings. More...
 
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], ... More...
 
static get_unused_filename ($itemid, $filepath, $filename)
 Get an unused filename from the current draft area. More...
 
static instance_config_form ($mform)
 Edit/Create Instance Settings Moodle form. More...
 
static instance_form_validation ($mform, $data, $errors)
 Validate repository plugin instance form. More...
 
static move_to_filepool ($thefile, $record)
 Move file from download folder to file pool using FILE API. More...
 
static overwrite_existing_draftfile ($itemid, $filepath, $filename, $newfilepath, $newfilename)
 Overwrite an existing file. More...
 
static plugin_init ()
 function which is run when the type is created (moodle administrator add the plugin) More...
 
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. More...
 
static reset_caches ()
 Function repository::reset_caches() is deprecated, cache is handled by MUC now. More...
 
static static_function ($plugin, $function)
 Call a static function. More...
 
static sync_external_file ($file, $resetsynchistory=false)
 Function repository::sync_external_file() is deprecated. More...
 
static type_config_form ($mform, $classname='repository')
 Add Plugin settings input to Moodle form. More...
 
static type_form_validation ($mform, $data, $errors)
 Validate Admin Settings Moodle form. More...
 
static update_draftfile ($draftid, $filepath, $filename, $updatedata)
 Updates a file in draft filearea. More...
 
static wake_from_cache ($data)
 Restores the repository from cache. More...
 

Public Attributes

stdClass $context
 current context
 
bool $disabled = false
 force disable repository instance
 
int $id
 repository instance id
 
stdClass $instance
 repository instance database record
 
array $options
 repository options
 
bool $readonly
 Whether or not the repository instance is editable.
 
int $returntypes
 return types
 
const GETFILE_TIMEOUT = 30
 Timeout in seconds for downloading the external file into moodle. More...
 
const MANAGE_URL = 'https://app.box.com/files'
 @const MANAGE_URL Manage URL.
 
const SESSION_PREFIX = 'repository_boxnet'
 @const SESSION_PREFIX Key used to store information in the session.
 
const SYNCFILE_TIMEOUT = 1
 Timeout in seconds for syncronising the external file size. More...
 
const SYNCIMAGE_TIMEOUT = 3
 Timeout in seconds for downloading an image file from external repository during syncronisation. More...
 

Protected Member Functions

 build_breadcrumb ($fullpath)
 Construct a breadcrumb from a path. More...
 
 build_part ($type, $value, $name='')
 Build a part of the path. More...
 
 split_part ($part)
 Extract information from a part of path. More...
 

Static Protected Member Functions

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

Protected Attributes

string $accesstoken
 Access token.
 
object $boxnetclient
 Box.net object.
 
string $clientid
 Client ID.
 
string $clientsecret
 Client secret.
 
string $typename
 Type of repository (webdav, google_docs, dropbox, ...). More...
 

Detailed Description

repository_boxnet class implements box.net client

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

Constructor & Destructor Documentation

◆ __construct()

repository_boxnet::__construct (   $repositoryid,
  $context = SYSCONTEXTID,
  $options = array() 
)

Constructor.

Parameters
int$repositoryid
stdClass$context
array$options

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$filenamename 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_breadcrumb()

repository_boxnet::build_breadcrumb (   $fullpath)
protected

Construct a breadcrumb from a path.

Parameters
string$fullpathPath containing multiple parts separated by slashes.
Return values
arrayArray expected to be generated in self::get_listing().

◆ build_part()

repository_boxnet::build_part (   $type,
  $value,
  $name = '' 
)
protected

Build a part of the path.

This is used to construct the path that the user is currently browsing. It must contain a 'type', and a 'value'. Then it can also contain a 'name' which is very useful to prevent extra queries to get the name only.

See self::split_part to extra the information from a part.

Parameters
string$typeType of part, typically 'folder' or 'search'.
string$valueThe value of the part, eg. a folder ID or search terms.
string$nameThe name of the part.
Return values
stringtype:value or type:value|name

◆ 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
stringserialised 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$fileinfoan object returned by file_browser::get_file_info()
string$searchsearched string
bool$dynamicmodeno recursive call is done when in dynamic mode
array$listthe array containing the files under the passed $fileinfo
Return values
intthe 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() Invoked at MOODLE/repository/repository_ajax.php.

Parameters
string$referencethis reference is generated by repository::get_file_reference()
stored_file$storedfilecreated file reference

Reimplemented in repository_dropbox.

◆ 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
booltrue 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
booltrue when the user can, otherwise throws an exception.
Exceptions
repository_exceptionwhen the user does not meet the requirements.

◆ check_login()

repository_boxnet::check_login ( )

check if user logged

Return values
boolean

Reimplemented from repository.

◆ contains_private_data()

repository::contains_private_data ( )
inherited

Is this repository accessing private data?

This function should return true for the repositories which access external private data from a user. This is the case for repositories such as Dropbox, Google Docs or Box.net which authenticate the user and then store the auth token.

Of course, many repositories store 'private data', but we only want to set contains_private_data() to repositories which are external to Moodle and shouldn't be accessed to by the users having the capability to 'login as' someone else. For instance, the repository 'Private files' is not considered as private because it's part of Moodle.

You should not set contains_private_data() to true on repositories which allow different types of instances as the levels other than 'user' are, by definition, not private. Also the user instances will be protected when they need to.

Return values
booleanTrue when the repository accesses private external data.
Since
Moodle 2.5

Reimplemented in repository_youtube, repository_wikimedia, repository_webdav, repository_user, repository_url, repository_upload, repository_s3, repository_recent, repository_merlot, repository_local, repository_flickr_public, repository_filesystem, repository_equella, and repository_coursefiles.

◆ convert_to_valid_reference()

static repository_boxnet::convert_to_valid_reference (   $reference)
static

Convert a reference to the new reference style.

While converting Box.net to APIv2 we introduced a new format for file references, see self::get_file_reference(). This function ensures that the format is always the same regardless of the whether the reference was from APIv1 or v2.

Parameters
mixed$referenceFile reference.
Return values
stdClassValid file reference.

◆ 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$sourceThe metainfo of file, it is base64 encoded php serialized data
stdClass | array$filerecordcontains itemid, filepath, filename and optionally other attributes of the new file
int$maxbytesmaximum allowed size of file, -1 if unlimited. If size of file exceeds the limit, the file_exception is thrown.
int$areamaxbytesthe maximum size of the area. A file_exception is thrown if the new file will reach the limit.
Return values
arrayThe 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$typethe type of the repository
int$useridthe user id
stdClass$contextthe context
array$paramsthe options for this instance
int$readonlywhether to create it readonly or not (defaults to not)
Return values
mixed

Reimplemented in repository_nextcloud, and repository_filesystem.

◆ 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_onedrive, repository_nextcloud, and repository_googledocs.

◆ 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$contextidcontext ID.
boolean$downloadcontentstrue 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$contextthe context for which we display the instance
string$typenameif 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$itemidof the draft area.
string$filepathpath to the file.
string$filenamefile 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$sourcesource of the file, returned by repository as 'source' and received back from user (not cleaned)
Return values
boolwhether the file is accessible by current user

Reimplemented in 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$contextthe context for which we want the editable types
Return values
arraytypes

◆ get_file()

repository_boxnet::get_file (   $ref,
  $filename = '' 
)

Downloads a repository file and saves to a path.

Parameters
string$refreference to the file
string$filenameto save file as
Return values
array

Reimplemented from repository.

◆ get_file_reference()

repository_boxnet::get_file_reference (   $source)

Prepare file reference information.

Parameters
string$source
Return values
stringfile referece

Reimplemented from repository.

◆ get_file_size()

repository::get_file_size (   $source)
inherited

Return size of a file in bytes.

Parameters
string$sourceencoded and serialized data of file
Return values
intfile size in bytes

◆ get_file_source_info()

repository_boxnet::get_file_source_info (   $source)

Return the source information.

Parameters
string$sourceNot the reference, just the source.
Return values
string|null

Reimplemented from repository.

◆ 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$idrepository 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_webdav, repository_nextcloud, repository_flickr_public, repository_filesystem, and repository_equella.

◆ get_instances()

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

Return repository instances.

Parameters
array$argsArray 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
arrayrepository instances

◆ get_link()

repository_boxnet::get_link (   $reference)

Get a link to the file.

This returns the URL of the web view of the file. To generate this link the file must be shared.

Parameters
stdClass$referenceReference.
Return values
stringURL.

Reimplemented from repository.

◆ get_listing()

repository_boxnet::get_listing (   $fullpath = '',
  $page = '' 
)

Get file listing.

Parameters
string$path
string$page
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$referencereference to the moodle internal file as retruned by } 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$configa specific option to get.
Return values
mixedreturns 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_youtube, repository_flickr_public, repository_flickr, and repository_dropbox.

◆ get_reference_details()

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

Return human readable reference information stored_file::get_reference().

Parameters
string$reference
int$filestatusstatus of the file, 0 - ok, 666 - source missing
Return values
string

Reimplemented from repository.

◆ 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$repositoryidrepository instance ID
context | int$contextcontext instance or context ID where this repository will be used
array$optionsadditional 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
stringrepository secret key.

◆ get_short_filename()

repository::get_short_filename (   $str,
  $maxlength 
)
inherited

Create a shorten filename.

Parameters
string$strfilename
int$maxlengthmax file name length
Return values
stringshort 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$idthe 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$typenamethe repository type name
Return values
repository_type|bool

◆ get_type_option_names()

static repository_boxnet::get_type_option_names ( )
static

Names of the plugin settings.

Return values
array

Reimplemented from repository.

◆ get_typename()

repository::get_typename ( )
inherited

Returns the type name of the repository.

Return values
stringtype 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$visiblecan return types by visiblity, return all types if null
Return values
arrayRepository 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$itemiddraft item ID.
string$filepathpath to the file.
string$filenamename of the file.
Return values
stringan unused file name.

◆ global_search()

repository::global_search ( )
inherited

◆ has_moodle_files()

repository::has_moodle_files ( )
inherited

Does this repository used to browse moodle files?

Return values
bool

Reimplemented in repository_user, repository_recent, repository_local, and repository_coursefiles.

◆ 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
exceptionwhen file could not be imported
Parameters
stored_file$file
int$maxbytesthrow 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$mformMoodle form (passed by reference)

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

◆ instance_form_validation()

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

Validate repository plugin instance form.

Parameters
moodleform$mformmoodle form
array$dataform data
array$errorserrors
Return values
arrayerrors

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_boxnet::logout ( )

reset auth token

Return values
string

Reimplemented from repository.

◆ 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$thefilefile path in download folder
stdClass$record
Return values
arraycontaining 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
boolsuccess or fail?

Reimplemented in repository_flickr_public.

◆ prepare_breadcrumb()

static repository::prepare_breadcrumb (   $breadcrumb)
staticprotectedinherited

Prepare the breadcrumb.

Parameters
array$breadcrumbcontains each element of the breadcrumb.
Return values
arrayof 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$filenamefile name
Return values
filepath

◆ prepare_list()

static repository::prepare_list (   $list)
staticprotectedinherited

Prepare the file/folder listing.

Parameters
array$listof files and folders.
Return values
arrayof 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$listingresult of get_listing() or search() or file_get_drafarea_files()
Return values
array

◆ 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_boxnet::print_login ( )

Return login form.

Return values
array

Reimplemented from repository.

◆ 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$referencethis reference is generated by repository::get_file_reference()
context$contextthe target context for this new file.
string$componentthe target component for this new file.
string$fileareathe target filearea for this new file.
string$itemidthe target itemid for this new file.
Return values
stringupdated reference (final one before it's saved to db).

Reimplemented in repository_onedrive, repository_nextcloud, and repository_googledocs.

◆ 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_boxnet::search (   $search_text,
  $page = 0 
)

Search files from box.net.

Parameters
string$search_text
Return values
mixed

Reimplemented from repository.

◆ send_file()

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

Repository method to serve the referenced file.

Parameters
stored_file$storedfilethe file that contains the reference
int$lifetimeNumber of seconds before the file should expire from caches (null means $CFG->filelifetime)
int$filter0 (default)=no filtering, 1=all files, 2=html files only
bool$forcedownloadIf true (default false), forces download of file rather than view in browser/plugin
array$optionsadditional options affecting the file serving

Reimplemented from repository.

◆ 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$mainfileThe main file we are trying to access relative files for.
string$relativepaththe 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$optionssettings
Return values
bool

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

◆ split_part()

repository_boxnet::split_part (   $part)
protected

Extract information from a part of path.

Parameters
string$partvalue generated from self::build_parth().
Return values
arraycontaining type, value and name.

◆ 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$pluginrepository plugin name
string$functionfunction name
Return values
mixed

◆ supported_filetypes()

repository::supported_filetypes ( )
inherited

What kind of files will be in this repository?

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

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

◆ supported_returntypes()

repository_boxnet::supported_returntypes ( )

Box.net supports copied and links.

Theoretically this API is ready for references, though it only works for Box.net Business accounts, but it is not enabled because we are not supporting it.

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_boxnet::sync_reference ( stored_file  $file)

Synchronize the references.

Parameters
stored_file$fileStored file.
Return values
boolean

Reimplemented from repository.

◆ type_config_form()

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

Add Plugin settings input to Moodle form.

Parameters
moodleform$mform
string$classname

Reimplemented from repository.

◆ type_form_validation()

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

Validate Admin Settings Moodle form.

Parameters
moodleform$mformMoodle form (passed by reference)
array$dataarray of ("fieldname"=>value) of submitted data
array$errorsarray of ("fieldname"=>errormessage) of errors
Return values
arrayarray 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$filepathpath to the directory containing the file, or full path in case of directory
string$filenamename of the file, or '.' in case of directory
array$updatedataarray of fields to change (only filename, filepath, license and/or author can be updated)
Exceptions
moodle_exceptionif 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: