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