super-powers/src/640b5352-fb09-425f-a26e-cd4.../README.md

99 lines
2.9 KiB
Markdown
Raw Normal View History

2023-07-04 06:26:08 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# abstract class Helper (Details)
> namespace: **VDM\Joomla\Utilities\Component**
```uml
@startuml
abstract Helper #Orange {
+ {static} getParams(?string $option = null) : Registry
+ {static} getOption(string $default = 'empty') : ?string
+ {static} getCode(?string $option = null, ?string $default = null) : ?string
+ {static} get(string $option = null, string $default = null) : ?string
2024-01-27 07:08:12 +00:00
+ {static} getNamespace(?string $option = null) : ?string
+ {static} getManifest(?string $option = null) : ?object
2023-07-04 06:26:08 +00:00
+ {static} methodExists(string $method, string $option = null) : bool
+ {static} _(string $method, array $arguments = [], ...) : mixed
}
note right of Helper::getParams
Gets the parameter object for the component
since: 3.0.11
return: Registry
end note
2024-01-27 07:08:12 +00:00
note left of Helper::getOption
2023-07-04 06:26:08 +00:00
Gets the component option
since: 3.0.11
return: ?string
end note
note right of Helper::getCode
Gets the component code name
since: 3.0.11
return: ?string
end note
2024-01-27 07:08:12 +00:00
note left of Helper::get
2023-07-04 06:26:08 +00:00
Gets the component abstract helper class
since: 3.0.11
return: ?string
end note
2024-01-27 07:08:12 +00:00
note right of Helper::getNamespace
Gets the component namespace if set
since: 3.0.11
return: ?string
end note
note left of Helper::getManifest
Gets the component abstract helper class
since: 3.0.11
return: ?object
end note
2023-07-04 06:26:08 +00:00
note right of Helper::methodExists
Check if the helper class of this component has a method
since: 3.0.11
return: bool
end note
2024-01-27 07:08:12 +00:00
note left of Helper::_
2023-07-04 06:26:08 +00:00
Check if the helper class of this component has a method, and call it with the arguments
since: 3.2.0
return: mixed
arguments:
string $method
array $arguments = []
?string $option = null
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)