| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2017 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 542 lines (18 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ApiModel:: (11 methods):
getFile()
getFiles()
createFolder()
createFile()
updateFile()
delete()
copy()
move()
getUrl()
search()
isMediaFile()
| getFile($adapter, $path = '/', $options = []) X-Ref |
| Returns the requested file or folder information. More information can be found in AdapterInterface::getFile(). param: string $adapter The adapter param: string $path The path to the file or folder param: array $options The options return: \stdClass |
| getFiles($adapter, $path = '/', $options = []) X-Ref |
| Returns the folders and files for the given path. More information can be found in AdapterInterface::getFiles(). param: string $adapter The adapter param: string $path The folder param: array $options The options return: \stdClass[] |
| createFolder($adapter, $name, $path, $override) X-Ref |
| Creates a folder with the given name in the given path. More information can be found in AdapterInterface::createFolder(). param: string $adapter The adapter param: string $name The name param: string $path The folder param: boolean $override Should the folder being overridden when it exists return: string |
| createFile($adapter, $name, $path, $data, $override) X-Ref |
| Creates a file with the given name in the given path with the data. More information can be found in AdapterInterface::createFile(). param: string $adapter The adapter param: string $name The name param: string $path The folder param: string $data The data param: boolean $override Should the file being overridden when it exists return: string |
| updateFile($adapter, $name, $path, $data) X-Ref |
| Updates the file with the given name in the given path with the data. More information can be found in AdapterInterface::updateFile(). param: string $adapter The adapter param: string $name The name param: string $path The folder param: string $data The data return: void |
| delete($adapter, $path) X-Ref |
| Deletes the folder or file of the given path. More information can be found in AdapterInterface::delete(). param: string $adapter The adapter param: string $path The path to the file or folder return: void |
| copy($adapter, $sourcePath, $destinationPath, $force = false) X-Ref |
| Copies file or folder from source path to destination path If forced, existing files/folders would be overwritten param: string $adapter The adapter param: string $sourcePath Source path of the file or folder (relative) param: string $destinationPath Destination path(relative) param: bool $force Force to overwrite return: string |
| move($adapter, $sourcePath, $destinationPath, $force = false) X-Ref |
| Moves file or folder from source path to destination path If forced, existing files/folders would be overwritten param: string $adapter The adapter param: string $sourcePath Source path of the file or folder (relative) param: string $destinationPath Destination path(relative) param: bool $force Force to overwrite return: string |
| getUrl($adapter, $path) X-Ref |
| Returns a url for serve media files from adapter. Url must provide a valid image type to be displayed on Joomla! site. param: string $adapter The adapter param: string $path The relative path for the file return: string Permalink to the relative file |
| search($adapter, $needle, $path = '/', $recursive = true) X-Ref |
| Search for a pattern in a given path param: string $adapter The adapter to work on param: string $needle The search therm param: string $path The base path for the search param: bool $recursive Do a recursive search return: \stdClass[] |
| isMediaFile($path) X-Ref |
| Checks if the given path is an allowed media file. param: string $path The path to file return: boolean |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |