class Property implements PropertyInterface

Property descriptior

Constants

TEXT

NUMBER

CUSTOM

BOOLEAN_TYPE

LIST

PHP_CLASS

PASSWORD

URL

TEXT_AREA

GROUP

Properties

protected string $name Property name
protected string|null $id Property id
protected mixed|null $value Property value
protected array $items Dropdown items
protected string|null $group Group name
protected mixed|null $default Default value
protected string|null $title Property title
protected integer $type Property type
protected string|null $description Property description
protected boolean $required Property required atribute
protected string|null $help Property help
protected boolean $readonly Readonly attribute
protected boolean $hidden Hidden attribute
protected string|null $displayType Display type

Methods

__construct(string $name, array|null $data = null)

Constructor

bool
getReadonly()

Get readonly attribute

bool
isReadonly()

Get readonly attribute

bool
isGroup()

Return true if property is group

bool
isHidden()

Get hidden attribute

value(mixed|null $value)

Set property value

items(array $items)

Set property items

type(string|integer $type)

Set property type

displayType(string|null $displayType)

Set display type

readonly(bool $readonly)

Set readonly attribute

hidden(bool $hidden)

Set hidden attribute

bool
getHidden()

Get hidden property

title(string|null $title)

Set property title

required(bool $required)

Set property required attribute

default(mixed|null $default)

Set property default

description(string|null $description)

Set property description

help(string|null $help)

Set property help

name(string|null $name)

Set property name

id(string|null $id)

Set property id

group(string $name)

Set property group

int|null
getTypeId(string|int $type)

Get type id

string
getName()

Return property name.

string|null
getId()

Get property id.

array
getItems()

Return property items.

bool
getRequired()

Return property required attribute.

string|null
getGroup()

Return property group.

mixed|null
getValue()

Return property value.

mixed|null
getDefault()

Get property default value.

string|null
getTitle()

Return property display name.

string|null
getDescription()

Get property description

int|null
getType()

Get property type

string
getTypeText()

Get property type as text

string|null
getHelp()

Get property help

array
toArray()

Convert to array

void
applyData(array $data)

Set property object params

static Property|null
createFromText(string $text)

Create property obj from text

static Property|null
create(array $data)

Create property obj from array

Details

at line 152
__construct(string $name, array|null $data = null)

Constructor

Parameters

string $name
array|null $data

at line 165
bool getReadonly()

Get readonly attribute

Return Value

bool

at line 175
bool isReadonly()

Get readonly attribute

Return Value

bool

at line 185
bool isGroup()

Return true if property is group

Return Value

bool

at line 195
bool isHidden()

Get hidden attribute

Return Value

bool

at line 206
Property value(mixed|null $value)

Set property value

Parameters

mixed|null $value

Return Value

Property

at line 219
Property items(array $items)

Set property items

Parameters

array $items

Return Value

Property

at line 232
Property type(string|integer $type)

Set property type

Parameters

string|integer $type

Return Value

Property

at line 245
Property displayType(string|null $displayType)

Set display type

Parameters

string|null $displayType

Return Value

Property

at line 257
Property readonly(bool $readonly)

Set readonly attribute

Parameters

bool $readonly

Return Value

Property

at line 269
Property hidden(bool $hidden)

Set hidden attribute

Parameters

bool $hidden

Return Value

Property

at line 280
bool getHidden()

Get hidden property

Return Value

bool

at line 291
Property title(string|null $title)

Set property title

Parameters

string|null $title

Return Value

Property

at line 303
Property required(bool $required)

Set property required attribute

Parameters

bool $required

Return Value

Property

at line 315
Property default(mixed|null $default)

Set property default

Parameters

mixed|null $default

Return Value

Property

at line 327
Property description(string|null $description)

Set property description

Parameters

string|null $description

Return Value

Property

at line 339
Property help(string|null $help)

Set property help

Parameters

string|null $help

Return Value

Property

at line 351
Property name(string|null $name)

Set property name

Parameters

string|null $name

Return Value

Property

at line 363
Property id(string|null $id)

Set property id

Parameters

string|null $id

Return Value

Property

at line 375
Property group(string $name)

Set property group

Parameters

string $name

Return Value

Property

at line 387
int|null getTypeId(string|int $type)

Get type id

Parameters

string|int $type

Return Value

int|null

at line 398
string getName()

Return property name.

Return Value

string

at line 408
string|null getId()

Get property id.

Return Value

string|null

at line 418
array getItems()

Return property items.

Return Value

array

at line 428
bool getRequired()

Return property required attribute.

Return Value

bool

at line 438
string|null getGroup()

Return property group.

Return Value

string|null

at line 448
mixed|null getValue()

Return property value.

Return Value

mixed|null

at line 458
mixed|null getDefault()

Get property default value.

Return Value

mixed|null

at line 468
string|null getTitle()

Return property display name.

Return Value

string|null

at line 478
string|null getDescription()

Get property description

Return Value

string|null

at line 488
int|null getType()

Get property type

Return Value

int|null

at line 498
string getTypeText()

Get property type as text

Return Value

string

at line 509
string|null getHelp()

Get property help

Return Value

string|null

at line 519
array toArray()

Convert to array

Return Value

array

at line 545
void applyData(array $data)

Set property object params

Parameters

array $data

Return Value

void

at line 558
static Property|null createFromText(string $text)

Create property obj from text

Parameters

string $text

Return Value

Property|null

at line 576
static Property|null create(array $data)

Create property obj from array

Parameters

array $data

Return Value

Property|null