/lib/files/storage/wrapper/wrapper.php
PHP | 427 lines | 125 code | 43 blank | 259 comment | 0 complexity | 10d11435fd8fa184cc6991a1b342b93a MD5 | raw file
Possible License(s): AGPL-3.0, AGPL-1.0, MPL-2.0-no-copyleft-exception
- <?php
- /**
- * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
- * This file is licensed under the Affero General Public License version 3 or
- * later.
- * See the COPYING-README file.
- */
- namespace OC\Files\Storage\Wrapper;
- class Wrapper implements \OC\Files\Storage\Storage {
- /**
- * @var \OC\Files\Storage\Storage $storage
- */
- protected $storage;
- /**
- * @param array $parameters
- */
- public function __construct($parameters) {
- $this->storage = $parameters['storage'];
- }
- /**
- * @return \OC\Files\Storage\Storage
- */
- public function getWrapperStorage() {
- return $this->storage;
- }
- /**
- * Get the identifier for the storage,
- * the returned id should be the same for every storage object that is created with the same parameters
- * and two storage objects with the same id should refer to two storages that display the same files.
- *
- * @return string
- */
- public function getId() {
- return $this->storage->getId();
- }
- /**
- * see http://php.net/manual/en/function.mkdir.php
- *
- * @param string $path
- * @return bool
- */
- public function mkdir($path) {
- return $this->storage->mkdir($path);
- }
- /**
- * see http://php.net/manual/en/function.rmdir.php
- *
- * @param string $path
- * @return bool
- */
- public function rmdir($path) {
- return $this->storage->rmdir($path);
- }
- /**
- * see http://php.net/manual/en/function.opendir.php
- *
- * @param string $path
- * @return resource
- */
- public function opendir($path) {
- return $this->storage->opendir($path);
- }
- /**
- * see http://php.net/manual/en/function.is_dir.php
- *
- * @param string $path
- * @return bool
- */
- public function is_dir($path) {
- return $this->storage->is_dir($path);
- }
- /**
- * see http://php.net/manual/en/function.is_file.php
- *
- * @param string $path
- * @return bool
- */
- public function is_file($path) {
- return $this->storage->is_file($path);
- }
- /**
- * see http://php.net/manual/en/function.stat.php
- * only the following keys are required in the result: size and mtime
- *
- * @param string $path
- * @return array
- */
- public function stat($path) {
- return $this->storage->stat($path);
- }
- /**
- * see http://php.net/manual/en/function.filetype.php
- *
- * @param string $path
- * @return bool
- */
- public function filetype($path) {
- return $this->storage->filetype($path);
- }
- /**
- * see http://php.net/manual/en/function.filesize.php
- * The result for filesize when called on a folder is required to be 0
- *
- * @param string $path
- * @return int
- */
- public function filesize($path) {
- return $this->storage->filesize($path);
- }
- /**
- * check if a file can be created in $path
- *
- * @param string $path
- * @return bool
- */
- public function isCreatable($path) {
- return $this->storage->isCreatable($path);
- }
- /**
- * check if a file can be read
- *
- * @param string $path
- * @return bool
- */
- public function isReadable($path) {
- return $this->storage->isReadable($path);
- }
- /**
- * check if a file can be written to
- *
- * @param string $path
- * @return bool
- */
- public function isUpdatable($path) {
- return $this->storage->isUpdatable($path);
- }
- /**
- * check if a file can be deleted
- *
- * @param string $path
- * @return bool
- */
- public function isDeletable($path) {
- return $this->storage->isDeletable($path);
- }
- /**
- * check if a file can be shared
- *
- * @param string $path
- * @return bool
- */
- public function isSharable($path) {
- return $this->storage->isSharable($path);
- }
- /**
- * get the full permissions of a path.
- * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
- *
- * @param string $path
- * @return int
- */
- public function getPermissions($path) {
- return $this->storage->getPermissions($path);
- }
- /**
- * see http://php.net/manual/en/function.file_exists.php
- *
- * @param string $path
- * @return bool
- */
- public function file_exists($path) {
- return $this->storage->file_exists($path);
- }
- /**
- * see http://php.net/manual/en/function.filemtime.php
- *
- * @param string $path
- * @return int
- */
- public function filemtime($path) {
- return $this->storage->filemtime($path);
- }
- /**
- * see http://php.net/manual/en/function.file_get_contents.php
- *
- * @param string $path
- * @return string
- */
- public function file_get_contents($path) {
- return $this->storage->file_get_contents($path);
- }
- /**
- * see http://php.net/manual/en/function.file_put_contents.php
- *
- * @param string $path
- * @param string $data
- * @return bool
- */
- public function file_put_contents($path, $data) {
- return $this->storage->file_put_contents($path, $data);
- }
- /**
- * see http://php.net/manual/en/function.unlink.php
- *
- * @param string $path
- * @return bool
- */
- public function unlink($path) {
- return $this->storage->unlink($path);
- }
- /**
- * see http://php.net/manual/en/function.rename.php
- *
- * @param string $path1
- * @param string $path2
- * @return bool
- */
- public function rename($path1, $path2) {
- return $this->storage->rename($path1, $path2);
- }
- /**
- * see http://php.net/manual/en/function.copy.php
- *
- * @param string $path1
- * @param string $path2
- * @return bool
- */
- public function copy($path1, $path2) {
- return $this->storage->copy($path1, $path2);
- }
- /**
- * see http://php.net/manual/en/function.fopen.php
- *
- * @param string $path
- * @param string $mode
- * @return resource
- */
- public function fopen($path, $mode) {
- return $this->storage->fopen($path, $mode);
- }
- /**
- * get the mimetype for a file or folder
- * The mimetype for a folder is required to be "httpd/unix-directory"
- *
- * @param string $path
- * @return string
- */
- public function getMimeType($path) {
- return $this->storage->getMimeType($path);
- }
- /**
- * see http://php.net/manual/en/function.hash.php
- *
- * @param string $type
- * @param string $path
- * @param bool $raw
- * @return string
- */
- public function hash($type, $path, $raw = false) {
- return $this->storage->hash($type, $path, $raw);
- }
- /**
- * see http://php.net/manual/en/function.free_space.php
- *
- * @param string $path
- * @return int
- */
- public function free_space($path) {
- return $this->storage->free_space($path);
- }
- /**
- * search for occurrences of $query in file names
- *
- * @param string $query
- * @return array
- */
- public function search($query) {
- return $this->storage->search($query);
- }
- /**
- * see http://php.net/manual/en/function.touch.php
- * If the backend does not support the operation, false should be returned
- *
- * @param string $path
- * @param int $mtime
- * @return bool
- */
- public function touch($path, $mtime = null) {
- return $this->storage->touch($path, $mtime);
- }
- /**
- * get the path to a local version of the file.
- * The local version of the file can be temporary and doesn't have to be persistent across requests
- *
- * @param string $path
- * @return string
- */
- public function getLocalFile($path) {
- return $this->storage->getLocalFile($path);
- }
- /**
- * get the path to a local version of the folder.
- * The local version of the folder can be temporary and doesn't have to be persistent across requests
- *
- * @param string $path
- * @return string
- */
- public function getLocalFolder($path) {
- return $this->storage->getLocalFolder($path);
- }
- /**
- * check if a file or folder has been updated since $time
- *
- * @param string $path
- * @param int $time
- * @return bool
- *
- * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
- * returning true for other changes in the folder is optional
- */
- public function hasUpdated($path, $time) {
- return $this->storage->hasUpdated($path, $time);
- }
- /**
- * get a cache instance for the storage
- *
- * @param string $path
- * @return \OC\Files\Cache\Cache
- */
- public function getCache($path = '') {
- return $this->storage->getCache($path);
- }
- /**
- * get a scanner instance for the storage
- *
- * @param string $path
- * @return \OC\Files\Cache\Scanner
- */
- public function getScanner($path = '') {
- return $this->storage->getScanner($path);
- }
- /**
- * get the user id of the owner of a file or folder
- *
- * @param string $path
- * @return string
- */
- public function getOwner($path) {
- return $this->storage->getOwner($path);
- }
- /**
- * get a permissions cache instance for the cache
- *
- * @param string $path
- * @return \OC\Files\Cache\Permissions
- */
- public function getPermissionsCache($path = '') {
- return $this->storage->getPermissions($path);
- }
- /**
- * get a watcher instance for the cache
- *
- * @param string $path
- * @return \OC\Files\Cache\Watcher
- */
- public function getWatcher($path = '') {
- return $this->storage->getWatcher($path);
- }
- /**
- * @return \OC\Files\Cache\Storage
- */
- public function getStorageCache() {
- return $this->storage->getStorageCache();
- }
- /**
- * get the ETag for a file or folder
- *
- * @param string $path
- * @return string
- */
- public function getETag($path) {
- return $this->storage->getETag($path);
- }
- }