fdaed9f9f2f414b4a6c85931c59dd4e9fb5707a6
[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.6 ===
8 * get_option() now always return null when the first parameter ($config) is not empty, and
9   no value was found for this $config. Previously this could sometimes return an empty array().
11 === 2.5 ===
13 * repository::append_suffix() has been deprecated, use repository::get_unused_filename() if you need
14   to get a file name which has not yet been used in the draft area.
16 * contains_private_data() is a new method to determine if a user 'logged in as' another user
17   can access the content of the repository. The default is to return True (no access).
19 * get_typename() returns the type of repository: dropbox, googledocs, etc...
21 * can_be_edited_by_user() encapsulates all the tests to make sure that the current user
22   has the rights to edit the instance of this repository.
24 * repository::get_instances() (used by filepicker and texteditor to populate the
25   list of available repositories) now calls repository constructor specifying the
26   context where repository will be used.
27   When checking permissions inside repository class use:
28   $this->instance->contextid - to find the context where repository was created;
29   $this->context - to find the current context where repository is used.
30   This also means that the same repository instance may now have different names when
31   called from different contexts.
32   Avoid calling repository::get_instance(), use repository::get_repository_by_id() instead.
34 === 2.4 ===
36 * copy_to_area() can receive a new parameter called $areamaxbytes which controls the maximum
37   size of the area the files will be stored in.
39 * the repositories using the upload() method should implement a check for $areamaxbytes,
40   see repository/upload/lib.php upload() and process_upload() for an example on how handling it.
42 === 2.3 ===
44 * instance_config_form() must now be declared static for php5.4 compatibility.
46 * get_listing() and search() file metadata details are now now more prominently
47   displayed in the interface. Dates and timestamos are now able to be sorted on in
48   the filepicker interface so plugin authors are asked to ensure:
49     - Dates are defined as UNIX timestamps
50     - Filesize is an integer in bytes
52 * It is recomended to define function get_file_source_info() to provide more rich
53   infromation about the source of a file.
55 * The API was extended to allow repositories can now support external references, please
56   see http://docs.moodle.org/dev/Repository_API for further details.