jcb-compiler/src/8a63e87b-b39b-4a15-8044-9b2a2f4fb61c/README.md

127 lines
3.3 KiB
Markdown
Raw Normal View History

2023-03-21 22:52:57 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Component (Details)
> namespace: **VDM\Joomla\Componentbuilder\Compiler\Service**
```uml
@startuml
class Component #Gold {
2024-01-27 07:09:33 +00:00
# $targetVersion
2023-03-21 22:52:57 +00:00
+ register(Container $container) : void
2024-01-27 07:09:33 +00:00
+ getCompilerComponent(Container $container) : CompilerComponent
+ getJ3Settings(Container $container) : J3Settings
+ getJ4Settings(Container $container) : J4Settings
2024-03-14 12:29:20 +00:00
+ getJ5Settings(Container $container) : J5Settings
2023-03-21 22:52:57 +00:00
+ getDashboard(Container $container) : Dashboard
+ getPlaceholder(Container $container) : Placeholder
+ getData(Container $container) : Data
+ getStructure(Container $container) : Structure
+ getStructuresingle(Container $container) : Structuresingle
+ getStructuremultiple(Container $container) : Structuremultiple
2024-01-27 07:09:33 +00:00
+ getSettings(Container $container) : Settings
2023-03-21 22:52:57 +00:00
}
note right of Component::register
Registers the service provider with a DI container.
since: 3.2.0
return: void
end note
2024-01-27 07:09:33 +00:00
note left of Component::getCompilerComponent
Get The Component Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: CompilerComponent
end note
2024-01-27 07:09:33 +00:00
note right of Component::getJ3Settings
Get The Settings Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
2024-01-27 07:09:33 +00:00
return: J3Settings
end note
note left of Component::getJ4Settings
Get The Settings Class.
since: 3.2.0
return: J4Settings
2023-03-21 22:52:57 +00:00
end note
2024-03-14 12:29:20 +00:00
note right of Component::getJ5Settings
Get The Settings Class.
since: 3.2.0
return: J5Settings
end note
note left of Component::getDashboard
2024-01-27 07:09:33 +00:00
Get The Dashboard Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: Dashboard
end note
2024-03-14 12:29:20 +00:00
note right of Component::getPlaceholder
2024-01-27 07:09:33 +00:00
Get The Placeholder Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: Placeholder
end note
2024-03-14 12:29:20 +00:00
note left of Component::getData
2024-01-27 07:09:33 +00:00
Get The Data Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: Data
end note
2024-03-14 12:29:20 +00:00
note right of Component::getStructure
2024-01-27 07:09:33 +00:00
Get The Structure Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: Structure
end note
2024-03-14 12:29:20 +00:00
note left of Component::getStructuresingle
2024-01-27 07:09:33 +00:00
Get The Structuresingle Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: Structuresingle
end note
2024-03-14 12:29:20 +00:00
note right of Component::getStructuremultiple
2024-01-27 07:09:33 +00:00
Get The Structuremultiple Class.
2023-03-21 22:52:57 +00:00
since: 3.2.0
return: Structuremultiple
end note
2024-01-27 07:09:33 +00:00
2024-03-14 12:29:20 +00:00
note left of Component::getSettings
2024-01-27 07:09:33 +00:00
Get The Settings Class.
since: 3.2.0
return: Settings
end note
2023-03-21 22:52:57 +00:00
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)