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
   5
   6 === 3.1 ===
   7
   8 * The following functions, previously used (exclusively) by upgrade steps are not available
   9   anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
  10     - repository_picasa_admin_upgrade_notification()
  11     - repository_googledocs_admin_upgrade_notification()
  12     - repository_boxnet_admin_upgrade_notification()
  13     - repository_alfresco_admin_security_key_notice()
  14 * The prepare_file() function will now return a file in a per-request directory which will
  15   be automatically cleaned at the end of the request.
  16   No modifications should be required as a result of this change.
  17
  18 === 2.8 ===
  19
  20 * Repositories working with Moodle files must replace serialize() with json_encode() in the
  21   attribute 'source' returned by get_listing(). If repository overrides file_is_accessible(),
  22   get_file_reference() or get_file_source_info() they need to be changed too. See MDL-45616.
  23
  24 === 2.6 ===
  25
  26 * get_option() now always return null when the first parameter ($config) is not empty, and
  27   no value was found for this $config. Previously this could sometimes return an empty array().
  28
  29 * The function repository_attach_id() was removed, it was never used and was not useful.
  30
  31 * New functions send_relative_file() and supports_relative_file() to allow sending relative linked
  32   files - see filesystem repository for example.
  33
  34 * DB fields files.referencelifetime, files.referencelastsync and files_reference.lifetime
  35   are deleted. The last synchronization time is stored only in files_reference.lastsync
  36   and lifetime is not stored in DB any more, each repository must decide for itself
  37   when to synchronize the file in function repository::sync_reference().
  38
  39 * The following methods in class repository are deprecated: sync_external_file(),
  40   get_file_by_reference(), get_reference_file_lifetime(), sync_individual_file() and
  41   reset_caches(). Instead there is one method repository::sync_reference() - this simplifies
  42   the repositories API and reduces the number of DB queries.
  43
  44 * Deprecated const GETFILE_TIMEOUT, SYNCFILE_TIMEOUT and SYNCIMAGE_TIMEOUT and replaced them with
  45   config variables repositorygetfiletimeout, repositorysyncfiletimeout and repositorysyncimagetimeout.
  46
  47 === 2.5 ===
  48
  49 * repository::append_suffix() has been deprecated, use repository::get_unused_filename() if you need
  50   to get a file name which has not yet been used in the draft area.
  51
  52 * contains_private_data() is a new method to determine if a user 'logged in as' another user
  53   can access the content of the repository. The default is to return True (no access).
  54
  55 * get_typename() returns the type of repository: dropbox, googledocs, etc...
  56
  57 * can_be_edited_by_user() encapsulates all the tests to make sure that the current user
  58   has the rights to edit the instance of this repository.
  59
  60 * repository::get_instances() (used by filepicker and texteditor to populate the
  61   list of available repositories) now calls repository constructor specifying the
  62   context where repository will be used.
  63   When checking permissions inside repository class use:
  64   $this->instance->contextid - to find the context where repository was created;
  65   $this->context - to find the current context where repository is used.
  66   This also means that the same repository instance may now have different names when
  67   called from different contexts.
  68   Avoid calling repository::get_instance(), use repository::get_repository_by_id() instead.
  69
  70 === 2.4 ===
  71
  72 * copy_to_area() can receive a new parameter called $areamaxbytes which controls the maximum
  73   size of the area the files will be stored in.
  74
  75 * the repositories using the upload() method should implement a check for $areamaxbytes,
  76   see repository/upload/lib.php upload() and process_upload() for an example on how handling it.
  77
  78 === 2.3 ===
  79
  80 * instance_config_form() must now be declared static for php5.4 compatibility.
  81
  82 * get_listing() and search() file metadata details are now now more prominently
  83   displayed in the interface. Dates and timestamos are now able to be sorted on in
  84   the filepicker interface so plugin authors are asked to ensure:
  85     - Dates are defined as UNIX timestamps
  86     - Filesize is an integer in bytes
  87
  88 * It is recomended to define function get_file_source_info() to provide more rich
  89   infromation about the source of a file.
  90
  91 * The API was extended to allow repositories can now support external references, please
  92   see http://docs.moodle.org/dev/Repository_API for further details.