e47ba3be344f4d59de5d956226e83ddc19acb1fc
[moodle.git] / repository / upgrade.txt
1 This files describes API changes in /repository/ repository system,
2 information provided here is intended especially for developers. Full
3 details of the repository API are available on Moodle docs:
4 http://docs.moodle.org/dev/Repository_API
6 === 2.8 ===
8 * Repositories working with Moodle files must replace serialize() with json_encode() in the
9   attribute 'source' returned by get_listing(). If repository overrides file_is_accessible(),
10   get_file_reference() or get_file_source_info() they need to be changed too. See MDL-45616.
12 === 2.6 ===
14 * get_option() now always return null when the first parameter ($config) is not empty, and
15   no value was found for this $config. Previously this could sometimes return an empty array().
17 * The function repository_attach_id() was removed, it was never used and was not useful.
19 * New functions send_relative_file() and supports_relative_file() to allow sending relative linked
20   files - see filesystem repository for example.
22 * DB fields files.referencelifetime, files.referencelastsync and files_reference.lifetime
23   are deleted. The last synchronization time is stored only in files_reference.lastsync
24   and lifetime is not stored in DB any more, each repository must decide for itself
25   when to synchronize the file in function repository::sync_reference().
27 * The following methods in class repository are deprecated: sync_external_file(),
28   get_file_by_reference(), get_reference_file_lifetime(), sync_individual_file() and
29   reset_caches(). Instead there is one method repository::sync_reference() - this simplifies
30   the repositories API and reduces the number of DB queries.
32 * Deprecated const GETFILE_TIMEOUT, SYNCFILE_TIMEOUT and SYNCIMAGE_TIMEOUT and replaced them with
33   config variables repositorygetfiletimeout, repositorysyncfiletimeout and repositorysyncimagetimeout.
35 === 2.5 ===
37 * repository::append_suffix() has been deprecated, use repository::get_unused_filename() if you need
38   to get a file name which has not yet been used in the draft area.
40 * contains_private_data() is a new method to determine if a user 'logged in as' another user
41   can access the content of the repository. The default is to return True (no access).
43 * get_typename() returns the type of repository: dropbox, googledocs, etc...
45 * can_be_edited_by_user() encapsulates all the tests to make sure that the current user
46   has the rights to edit the instance of this repository.
48 * repository::get_instances() (used by filepicker and texteditor to populate the
49   list of available repositories) now calls repository constructor specifying the
50   context where repository will be used.
51   When checking permissions inside repository class use:
52   $this->instance->contextid - to find the context where repository was created;
53   $this->context - to find the current context where repository is used.
54   This also means that the same repository instance may now have different names when
55   called from different contexts.
56   Avoid calling repository::get_instance(), use repository::get_repository_by_id() instead.
58 === 2.4 ===
60 * copy_to_area() can receive a new parameter called $areamaxbytes which controls the maximum
61   size of the area the files will be stored in.
63 * the repositories using the upload() method should implement a check for $areamaxbytes,
64   see repository/upload/lib.php upload() and process_upload() for an example on how handling it.
66 === 2.3 ===
68 * instance_config_form() must now be declared static for php5.4 compatibility.
70 * get_listing() and search() file metadata details are now now more prominently
71   displayed in the interface. Dates and timestamos are now able to be sorted on in
72   the filepicker interface so plugin authors are asked to ensure:
73     - Dates are defined as UNIX timestamps
74     - Filesize is an integer in bytes
76 * It is recomended to define function get_file_source_info() to provide more rich
77   infromation about the source of a file.
79 * The API was extended to allow repositories can now support external references, please
80   see http://docs.moodle.org/dev/Repository_API for further details.