jcb-compiler/src/6f20369a-8536-4870-a1a3-cda254c939c8/README.md

96 lines
2.5 KiB
Markdown
Raw Normal View History

2023-03-21 22:52:57 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Paths (Details)
> namespace: **VDM\Joomla\Componentbuilder\Compiler\Utilities**
2023-10-10 09:39:16 +00:00
> extends: **Registry**
2023-03-21 22:52:57 +00:00
```uml
@startuml
class Paths #Gold {
# Config $config
# Component $component
2023-10-10 09:39:16 +00:00
+ __construct(Config $config = null, Component $component = null)
2023-03-21 22:52:57 +00:00
+ __get(string $key) : string
- setTemplatePath() : void
- setComponentSalesName() : void
- setComponentBackupName() : void
- setComponentFolderName() : void
- setComponentPath() : void
- setTemplatePathCustom() : void
}
note right of Paths::__construct
Constructor
since: 3.2.0
end note
note left of Paths::__get
getting any valid paths
since: 3.2.0
return: string
end note
2023-10-10 09:39:16 +00:00
note right of Paths::setTemplatePath
2023-03-21 22:52:57 +00:00
Set the template path
since: 3.2.0
return: void
end note
2023-10-10 09:39:16 +00:00
note left of Paths::setComponentSalesName
2023-03-21 22:52:57 +00:00
Set component sales name
since: 3.2.0
return: void
end note
2023-10-10 09:39:16 +00:00
note right of Paths::setComponentBackupName
2023-03-21 22:52:57 +00:00
Set component backup name
since: 3.2.0
return: void
end note
2023-10-10 09:39:16 +00:00
note left of Paths::setComponentFolderName
2023-03-21 22:52:57 +00:00
Set component folder name
since: 3.2.0
return: void
end note
2023-10-10 09:39:16 +00:00
note right of Paths::setComponentPath
2023-03-21 22:52:57 +00:00
Set component path
since: 3.2.0
return: void
end note
2023-10-10 09:39:16 +00:00
note left of Paths::setTemplatePathCustom
2023-03-21 22:52:57 +00:00
set the template path for custom TODO: just use custom_folder_path in config
since: 3.2.0
return: void
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)