jcb-compiler/src/d42e1fac-3c05-4a22-8878-2abd43019811/README.md

110 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2024-01-27 07:09:33 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
2024-03-14 12:29:20 +00:00
# final class InstallScript (Details)
2024-01-27 07:09:33 +00:00
> namespace: **VDM\Joomla\Componentbuilder\Compiler\Extension\JoomlaFour**
2024-07-16 12:08:25 +00:00
2024-01-27 07:09:33 +00:00
```uml
@startuml
2024-03-14 12:29:20 +00:00
class InstallScript << (F,LightGreen) >> #RoyalBlue {
2024-01-27 07:09:33 +00:00
# object $extension
# array $methods
# array $types
# array $construct
# array $install
# array $update
# array $uninstall
# bool $preflightActive
# bool $postflightActive
+ get(object $extension) : string
2024-03-14 12:29:20 +00:00
# rest() : void
2024-01-27 07:09:33 +00:00
# build() : string
# head() : string
# construct() : string
# main(string $name) : string
# flight(string $name) : string
}
note right of InstallScript::get
get install script
since: 3.2.0
return: string
end note
2024-03-14 12:29:20 +00:00
note right of InstallScript::rest
Reset all bucket at the start of each build
since: 3.2.0
return: void
end note
2024-01-27 07:09:33 +00:00
note right of InstallScript::build
build the install class
since: 3.2.0
return: string
end note
note right of InstallScript::head
get install script head
since: 3.2.0
return: string
end note
note right of InstallScript::construct
get constructor
since: 3.2.0
return: string
end note
note right of InstallScript::main
build main methods
since: 3.2.0
return: string
end note
note right of InstallScript::flight
build flight methods
since: 3.2.0
return: string
end note
@enduml
```
2024-07-16 12:08:25 +00:00
The Power feature in JCB allows you to write PHP classes and their implementations, making it easy to include them in your Joomla project. JCB handles linking, autoloading, namespacing, and folder structure creation for you.
By using the SPK (Super Power Key) in your custom code (replacing the class name in your code with the SPK), JCB will automatically pull the power from the repository into your project. This makes it available in your JCB instance, allowing you to edit it and include the class in your generated Joomla component.
JCB uses placeholders like [[[`NamespacePrefix`]]] and [[[`ComponentNamespace`]]] in namespacing to prevent collisions and improve reusability across different JCB systems. You can also set the **JCB powers path** globally or per component under the **Dynamic Integration** tab, providing flexibility and easy maintainability.
To add this specific Power to your project in JCB:
> simply use this SPK
```
Super---d42e1fac_3c05_4a22_8878_2abd43019811---Power
```
> remember to replace the `---` with `___` to activate this Power in your code
2024-01-27 07:09:33 +00:00
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)