ComponentRecord

Object representing a component extension record

since

3.7.0

package

Application

Methods

__construct

Class constructor

__construct(array data = array()) : mixed
since

3.7.0

Arguments

data

arrayThe component record data to load

Response

mixed

__get

Method to get certain otherwise inaccessible properties from the form field object.

__get(string name) : mixed
deprecated
since

3.7.0

deprecated

5.0 Access the item parameters through the getParams() method

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(string name, mixed value) : void
deprecated
since

3.7.0

deprecated

5.0 Set the item parameters through the setParams() method

Arguments

name

stringThe property name for which to set the value.

value

mixedThe value of the property.

getParams

Returns the menu item parameters

getParams() : \Joomla\Registry\Registry
since

3.7.0

Response

\Joomla\Registry\Registry

setParams

Sets the menu item parameters

setParams(\Joomla\Registry\Registry|string params) : void
since

3.7.0

Arguments

params

\Joomla\Registry\Registry|stringThe data to be stored as the parameters

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)

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