ComponentRecord
Object representing a component extension record
| since |
3.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Class constructor
__construct(mixed||string|int data = []) :
| since |
3.7.0 |
|---|
Arguments
- data
array<string|int, mixed>The component record data to load
Response
mixed
__get
Method to get certain otherwise inaccessible properties from the form field object.
__get( name) :
| since |
3.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0
Access the item parameters through the |
Arguments
- name
stringThe property name for which to get the value.
Response
mixedThe property value or null.
__set
Method to set certain otherwise inaccessible properties of the form field object.
__set( name, value) :
| since |
3.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0
Set the item parameters through the |
Arguments
- name
stringThe property name for which to set the value.- value
mixedThe value of the property.
Response
void
getParams
Returns the menu item parameters
getParams() : \Joomla\Registry\Registry
| since |
3.7.0 |
|---|
Response
Registry
setParams
Sets the menu item parameters
setParams(\Joomla\Registry\Registry|string params) :
| since |
3.7.0 |
|---|
Arguments
- params
Registry|stringThe data to be stored as the parameters
Response
void
Properties
id
Primary key
| since |
3.7.0 |
|---|
Type(s)
int
option
The component name
| since |
3.7.0 |
|---|
Type(s)
int
params
The component parameters
| since |
3.7.0 |
|---|---|
| note |
This field is protected to require reading this field to proxy through the getter to convert the params to a Registry instance |
Type(s)
string|Registry
namespace
The extension namespace
| since |
4.0.0 |
|---|
Type(s)
string
enabled
Indicates if this component is enabled
| since |
3.7.0 |
|---|
Type(s)
int