super-powers/src/7e822c03-1b20-41d1-9427-f5b8d5836af7/README.md

111 lines
3.8 KiB
Markdown
Raw Permalink Normal View History

2023-10-04 18:23:30 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
2023-10-10 09:39:09 +00:00
# abstract class Registry (Details)
2024-06-21 12:01:19 +00:00
> namespace: **VDM\Joomla\Abstraction**
2023-10-10 09:39:09 +00:00
> extends: **ActiveRegistry**
2024-07-16 12:12:10 +00:00
2023-10-04 18:23:30 +00:00
```uml
@startuml
2023-10-10 09:39:09 +00:00
abstract Registry #Orange {
2023-10-04 18:23:30 +00:00
# ?string $separator
2024-06-25 12:09:34 +00:00
+ set(string $path, mixed $value) : self
+ add(string $path, mixed $value, ...) : self
2023-10-04 18:23:30 +00:00
+ get(string $path, mixed $default = null) : mixed
2024-06-25 12:09:34 +00:00
+ remove(string $path) : self
2023-10-04 18:23:30 +00:00
+ exists(string $path) : bool
2024-06-25 12:09:34 +00:00
+ setSeparator(?string $value) : self
2023-10-04 18:23:30 +00:00
# getActiveKeys(string $path) : ?array
}
2023-10-10 09:39:09 +00:00
note right of Registry::set
Sets a value into the registry using multiple keys.
2023-10-04 18:23:30 +00:00
since: 3.2.0
2024-06-25 12:09:34 +00:00
return: self
2023-10-04 18:23:30 +00:00
end note
2023-10-10 09:39:09 +00:00
note right of Registry::add
Adds content into the registry. If a key exists,
2023-10-04 18:23:30 +00:00
it either appends or concatenates based on $asArray switch.
2024-01-27 07:08:12 +00:00
Default is $addAsArray = false (if null) in base class.
Override in child class allowed set class property $addAsArray = true.
2023-10-04 18:23:30 +00:00
since: 3.2.0
2024-06-25 12:09:34 +00:00
return: self
2023-10-04 18:23:30 +00:00
arguments:
string $path
mixed $value
2024-01-27 07:08:12 +00:00
?bool $asArray = null
2023-10-04 18:23:30 +00:00
end note
2023-10-10 09:39:09 +00:00
note right of Registry::get
Retrieves a value (or sub-array) from the registry using multiple keys.
2023-10-04 18:23:30 +00:00
since: 3.2.0
return: mixed
end note
2023-10-10 09:39:09 +00:00
note right of Registry::remove
Removes a value (or sub-array) from the registry using multiple keys.
2023-10-04 18:23:30 +00:00
since: 3.2.0
2024-06-25 12:09:34 +00:00
return: self
2023-10-04 18:23:30 +00:00
end note
2023-10-10 09:39:09 +00:00
note right of Registry::exists
Checks the existence of a particular location in the registry using multiple keys.
2023-10-04 18:23:30 +00:00
since: 3.2.0
return: bool
end note
2023-10-10 09:39:09 +00:00
note right of Registry::setSeparator
2023-10-04 18:23:30 +00:00
Sets a separator value
since: 3.2.0
2024-06-25 12:09:34 +00:00
return: self
2023-10-04 18:23:30 +00:00
end note
2023-10-10 09:39:09 +00:00
note right of Registry::getActiveKeys
2023-10-04 18:23:30 +00:00
Get that the active keys from a path
since: 3.2.0
return: ?array
end note
@enduml
```
2024-07-16 12:12:10 +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---7e822c03_1b20_41d1_9427_f5b8d5836af7---Power
```
> remember to replace the `---` with `___` to activate this Power in your code
2023-10-04 18:23:30 +00:00
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)