namespace: VDM\Joomla\Interfaces extends: Activeregistryinterface
@startuml
interface Registryinterface #Lavender {
+ __get(string $name) : mixed
+ __set(string $name, mixed $value) : void
+ __isset(string $name) : bool
+ __unset(string $name) : void
+ __clone() : void
+ __toString() : string
+ loadString(string $data, string $format = 'JSON', ...) : self
+ loadObject(object $object) : self
+ loadArray(array $array) : self
+ loadFile(string $path, string $format = 'json') : self
+ set(string $path, mixed $value) : self
+ add(string $path, mixed $value, ...) : self
+ get(string $path, mixed $default = null) : mixed
+ remove(string $path) : self
+ exists(string $path) : bool
+ jsonSerialize() : mixed
+ count() : int
+ offsetExists(mixed $offset) : bool
+ offsetGet(mixed $offset) : mixed
+ offsetSet(mixed $offset, mixed $value) : void
+ offsetUnset(mixed $offset) : void
+ getIterator() : \Traversable
+ toArray() : array
+ toObject() : object
+ toString(string $format = 'JSON', array $options = []) : string
+ flatten(?string $separator = null, bool $full = false) : array
+ def(string $path, mixed $default) : mixed
+ merge(Registryinterface $source) : self
+ clear() : self
+ extract(string $path, mixed $default = null, ...) : self
+ append(string $path, mixed $value) : self
+ getName() : ?string
+ setName(?string $name) : self
+ setSeparator(?string $value) : self
+ getSeparator() : ?string
}
note right of Registryinterface::__get
Magic method to get a value from the registry.
Allows for accessing registry data using object property syntax.
since: 5.0.4
return: mixed
end note
note left of Registryinterface::__set
Magic method to set a value in the registry.
Allows for setting registry data using object property syntax.
since: 5.0.4
return: void
end note
note right of Registryinterface::__isset
Magic method to check if a property is set in the registry.
Allows for using isset() on registry properties.
since: 5.0.4
return: bool
end note
note left of Registryinterface::__unset
Magic method to unset a property in the registry.
Allows for using unset() on registry properties.
since: 5.0.4
return: void
end note
note right of Registryinterface::__clone
Magic method to clone the registry.
Performs a deep copy of the registry data.
since: 5.0.4
return: void
end note
note left of Registryinterface::__toString
Magic method to convert the registry to a string.
Returns the registry data in JSON format.
since: 5.0.4
return: string
end note
note right of Registryinterface::loadString
Loads data into the registry from a string using Joomla's format classes.
since: 5.0.4
return: self
arguments:
string $data
string $format = 'JSON'
array $options = []
end note
note left of Registryinterface::loadObject
Loads data into the registry from an object.
since: 5.0.4
return: self
end note
note right of Registryinterface::loadArray
Loads data into the registry from an array.
The loaded data will be merged into the registry's existing data.
since: 5.0.4
return: self
end note
note left of Registryinterface::loadFile
Loads data into the registry from a file.
since: 5.0.4
return: self
end note
note right of Registryinterface::set
Sets a value into the registry using multiple keys.
since: 3.2.0
return: self
end note
note left of Registryinterface::add
Adds content into the registry. If a key exists,
it either appends or concatenates based on $asArray switch.
Default is $addAsArray = false (if null) in base class.
Override in child class allowed set class property $addAsArray = true.
since: 3.2.0
return: self
arguments:
string $path
mixed $value
?bool $asArray = null
end note
note right of Registryinterface::get
Retrieves a value (or sub-array) from the registry using multiple keys.
since: 3.2.0
return: mixed
end note
note left of Registryinterface::remove
Removes a value (or sub-array) from the registry using multiple keys.
since: 3.2.0
return: self
end note
note right of Registryinterface::exists
Checks the existence of a particular location in the registry using multiple keys.
since: 3.2.0
return: bool
end note
note left of Registryinterface::jsonSerialize
Specify data which should be serialized to JSON.
which is a value of any type other than a resource.
since: 5.0.4
return: mixed
end note
note right of Registryinterface::count
Count elements of the registry.
since: 5.0.4
return: int
end note
note left of Registryinterface::offsetExists
Whether a given offset exists in the registry.
since: 5.0.4
return: bool
end note
note right of Registryinterface::offsetGet
Retrieve the value at a given offset.
since: 5.0.4
return: mixed
end note
note left of Registryinterface::offsetSet
Set the value at a given offset.
since: 5.0.4
return: void
end note
note right of Registryinterface::offsetUnset
Unset the value at a given offset.
since: 5.0.4
return: void
end note
note left of Registryinterface::getIterator
Retrieve an external iterator for the registry.
since: 5.0.4
return: \Traversable
end note
note right of Registryinterface::toArray
Get the registry data as an associative array.
since: 5.0.4
return: array
end note
note left of Registryinterface::toObject
Get the registry data as an object.
since: 5.0.4
return: object
end note
note right of Registryinterface::toString
Converts the registry data to a string in the specified format.
since: 5.0.4
return: string
end note
note left of Registryinterface::flatten
Flattens the registry data into a one-dimensional array.
since: 5.0.4
return: array
end note
note right of Registryinterface::def
Sets a default value if not already set.
since: 5.0.4
return: mixed
end note
note left of Registryinterface::merge
Merges another registry into this one.
The data from the source registry will be merged into this registry,
overwriting any existing values with the same keys.
since: 5.0.4
return: self
end note
note right of Registryinterface::clear
Clears all data from the registry.
since: 5.0.4
return: self
end note
note left of Registryinterface::extract
Extracts a subset of the registry data based on a given path.
since: 5.0.4
return: self
arguments:
string $path
mixed $default = null
?string $separator = null
end note
note right of Registryinterface::append
Appends content into the registry.
If a key exists, the value will be appended to the existing value.
since: 5.0.4
return: self
end note
note left of Registryinterface::getName
Gets the name of the registry.
since: 5.0.4
return: ?string
end note
note right of Registryinterface::setName
Sets the name of the registry.
since: 5.0.4
return: self
end note
note left of Registryinterface::setSeparator
Sets a separator value
since: 3.2.0
return: self
end note
note right of Registryinterface::getSeparator
Gets the current path separator used in registry paths.
since: 5.0.4
return: ?string
end note
@enduml
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 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 maintainability.
To add this specific Power to your project in JCB:
Simply use this SPK:
Super---64e291c2_11f1_423d_a44d_837cc12cc017---Power
Remember to replace the
---with___to activate this Power in your code.
Used in Joomla Component Builder - Source - Mirror - Download
