[ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
Copyright: | (C) 2016 Open Source Matters, Inc. |
License: | GNU General Public License version 2 or later; see LICENSE.txt |
File Size: | 215 lines (6 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
AdapterInterface:: (12 methods):
getFile()
getFiles()
getResource()
createFolder()
createFile()
updateFile()
delete()
move()
copy()
getUrl()
getAdapterName()
search()
Interface: AdapterInterface - X-Ref
Media file adapter interface.getFile(string $path = '/') X-Ref |
Returns the requested file or folder. The returned object has the following properties available: - type: The type can be file or dir - name: The name of the file - path: The relative path to the root - extension: The file extension - size: The size of the file - create_date: The date created - modified_date: The date modified - mime_type: The mime type - width: The width, when available - height: The height, when available If the path doesn't exist a FileNotFoundException is thrown. param: string $path The path to the file or folder return: \stdClass |
getFiles(string $path = '/') X-Ref |
Returns the folders and files for the given path. The returned objects have the following properties available: - type: The type can be file or dir - name: The name of the file - path: The relative path to the root - extension: The file extension - size: The size of the file - create_date: The date created - modified_date: The date modified - mime_type: The mime type - width: The width, when available - height: The height, when available If the path doesn't exist a FileNotFoundException is thrown. param: string $path The folder return: \stdClass[] |
getResource(string $path) X-Ref |
Returns a resource for the given path. param: string $path The path return: resource |
createFolder(string $name, string $path) X-Ref |
Creates a folder with the given name in the given path. It returns the new folder name. This allows the implementation classes to normalise the file name. param: string $name The name param: string $path The folder return: string |
createFile(string $name, string $path, $data) X-Ref |
Creates a file with the given name in the given path with the data. It returns the new file name. This allows the implementation classes to normalise the file name. param: string $name The name param: string $path The folder param: string $data The data return: string |
updateFile(string $name, string $path, $data) X-Ref |
Updates the file with the given name in the given path with the data. param: string $name The name param: string $path The folder param: string $data The data return: void |
delete(string $path) X-Ref |
Deletes the folder or file of the given path. param: string $path The path to the file or folder return: void |
move(string $sourcePath, string $destinationPath, bool $force = false) X-Ref |
Moves a file or folder from source to destination. It returns the new destination path. This allows the implementation classes to normalise the file name. param: string $sourcePath The source path param: string $destinationPath The destination path param: bool $force Force to overwrite return: string |
copy(string $sourcePath, string $destinationPath, bool $force = false) X-Ref |
Copies a file or folder from source to destination. It returns the new destination path. This allows the implementation classes to normalise the file name. param: string $sourcePath The source path param: string $destinationPath The destination path param: bool $force Force to overwrite return: string |
getUrl(string $path) X-Ref |
Returns a public url for the given path. This function can be used by the cloud adapter to publish the media file and create a permanent publicly accessible url. param: string $path The path to file return: string |
getAdapterName() X-Ref |
Returns the name of the adapter. It will be shown in the Media Manager return: string |
search(string $path, string $needle, bool $recursive = false) X-Ref |
Search for a pattern in a given path param: string $path The base path for the search param: string $needle The path to file param: bool $recursive Do a recursive search return: \stdClass[] |
Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |