Components
Table of Contents
- delete() : bool
- Delete component and uninstall by name.
- disable() : bool
- Disable the component.
- enable() : bool
- Activate the component.
- enableOrDisable() : bool
- Activate or Disable component.
- getAll() : array<string|int, mixed>
- Get all components name.
- getConponentConfigByName() : bool
- Get the component json file configuration.
- install() : bool
- Install the component.
- isSupported() : bool
- Determine whether the component is supported with current version of alphaz.
- moveToTrash() : void
- Move to trash component by name.
- remove() : bool
- Remove component by name.
- restoreFromTrash() : void
- Restore from trash component by name.
- uninstall() : bool
- Uninstall the component.
Methods
delete()
Delete component and uninstall by name.
public
delete((string) $name) : bool
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
bool —disable()
Disable the component.
public
disable((string) $name) : bool
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
bool —enable()
Activate the component.
public
enable((string) $name) : bool
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
bool —enableOrDisable()
Activate or Disable component.
public
enableOrDisable((string) $name, (bool) $status) : bool
Parameters
- $name : (string)
-
Name of component.
- $status : (bool)
-
Valid status.
Tags
Return values
bool —getAll()
Get all components name.
public
getAll() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getConponentConfigByName()
Get the component json file configuration.
public
getConponentConfigByName((string) $name) : bool
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
bool —install()
Install the component.
public
install((string) $archive, (string) $name) : bool
Parameters
- $archive : (string)
-
Valid component zip archive in Data folder.
- $name : (string)
-
Name of component.
Tags
Return values
bool —isSupported()
Determine whether the component is supported with current version of alphaz.
public
isSupported((string) $zVersion, (string) $comparator) : bool
Parameters
- $zVersion : (string)
-
alphaz version number from component config file.
- $comparator : (string)
-
Operator that used to compare version.
Tags
Return values
bool —moveToTrash()
Move to trash component by name.
public
moveToTrash((string) $name) : void
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
void —remove()
Remove component by name.
public
remove((string) $name) : bool
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
bool —restoreFromTrash()
Restore from trash component by name.
public
restoreFromTrash((string) $name) : void
Parameters
- $name : (string)
-
Name of component.
Tags
Return values
void —uninstall()
Uninstall the component.
public
uninstall((string) $name) : bool
Parameters
- $name : (string)
-
Name of component.