super-powers/src/a223b31e-ea1d-4cdf-92ae-5f9becffaff0/README.md

87 lines
2.5 KiB
Markdown
Raw Normal View History

2023-03-21 22:43:11 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# abstract class FileHelper (Details)
2024-05-26 15:39:49 +00:00
> namespace: **VastDevelopmentMethod\Joomla\Utilities**
2023-03-21 22:43:11 +00:00
```uml
@startuml
abstract FileHelper #Orange {
# static $curlError
+ {static} zip(string $workingDirectory, string $filepath) : bool
2024-01-27 07:08:12 +00:00
+ {static} getContent(string $path, mixed $none = '') : string
2023-03-21 22:43:11 +00:00
+ {static} write(string $path, string $data) : bool
2024-01-27 07:08:12 +00:00
+ {static} getPaths(string $folder, array $fileTypes = array('\.php') : array|null
2023-03-21 22:43:11 +00:00
+ {static} getPath(string $type = 'path', string $target = 'filepath', ...) : string
+ {static} exists(string $path) : bool
}
note right of FileHelper::zip
The zipper method
since: 3.0.9
return: bool
end note
note right of FileHelper::getContent
get the content of a file
since: 3.0.9
return: string
end note
note right of FileHelper::write
Write a file to the server
since: 3.0.9
return: bool
end note
note right of FileHelper::getPaths
get all the file paths in folder and sub folders
since: 3.0.9
2024-01-27 07:08:12 +00:00
return: array|null
2023-03-21 22:43:11 +00:00
end note
note right of FileHelper::getPath
Get the file path or url
since: 3.0.9
return: string
arguments:
string $type = 'path'
string $target = 'filepath'
string $fileType = null
string $key = ''
string $default = ''
bool $createIfNotSet = true
end note
note right of FileHelper::exists
Check if file exist
since: 3.0.9
return: bool
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)