Docs For Class atkMetaAttributeModifier

atkMetaAttributeModifier	addFlag()	Add flag(s) .
atkMetaAttributeModifier	addFlags()	Add flag(s) .
atkMetaAttributeModifier	__construct()	Cosntructor.
atkMetaAttributeModifier	enableForceInsert()	Enable/disable force insert.
atkMetaAttributeModifier	enableForceUpdate()	Enable/disable force update.
array	getAttributes()	Returns the attribute names.
atkMetaPolicy	getPolicy()	Returns the meta policy.
void	insert()	Insert.
atkMetaAttributeModifier	insertAfter()	Insert attribute(s) after the given attribute.
atkMetaAttributeModifier	insertAtBottom()	Insert attribute(s) at the bottom.
atkMetaAttributeModifier	insertAtTop()	Insert attribute(s) at the top.
atkMetaAttributeModifier	insertBefore()	Insert attribute(s) before the given attribute.
atkMetaAttributeModifier	removeFlag()	Remove flag(s).
atkMetaAttributeModifier	removeFlags()	Remove flag(s).
atkMetaAttributeModifier	setColumn()	Set the column.
atkMetaAttributeModifier	setDefaultValue()	Set the default value.
atkMetaAttributeModifier	setExcluded()	Add or remove attributes to/from the excludes list.
atkMetaAttributeModifier	setFlag()	Set flag(s).
atkMetaAttributeModifier	setFlags()	Set flag(s).
atkMetaAttributeModifier	setIncluded()	Add or remove attributes to/from the includes list.
atkMetaAttributeModifier	setSection()	Set the sections/tabs.
atkMetaAttributeModifier	setTab()	Set the sections/tabs.
atkMetaAttributeModifier	setType()	Sets the type. All extra arguments after the type argument will be treated as parameters for the attribute(s).
atkMetaAttributeModifier	setTypeAndParams()	Sets the type and parameters.

[ Top ]

Properties

array $m_attrs [line 46]

Attribute names.

API Tags:

Access:

private

[ Top ]

atkMetaPolicy $m_policy [line 39]

Meta policy.

API Tags:

Access:

private

[ Top ]

Methods

addFlag [line 179]

atkMetaAttributeModifier addFlag(
int
$flags 
)

Add flag(s) .

Parameters:

int

$flags:

flag(s)

API Tags:

Access:

public

[ Top ]

addFlags [line 191]

atkMetaAttributeModifier addFlags(
int
$flags 
)

Add flag(s) .

Parameters:

int

$flags:

flag(s)

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 54]

atkMetaAttributeModifier __construct(
atkMetaPolicy
$policy, array
$attrs 
)

Cosntructor.

Parameters:

atkMetaPolicy	$policy:	meta policy
array	$attrs:	attribute names

API Tags:

Access:

public

[ Top ]

enableForceInsert [line 229]

atkMetaAttributeModifier enableForceInsert(
[boolean
$enable = true] 
)

Enable/disable force insert.

Parameters:

boolean

$enable:

enable?

API Tags:

Access:

public

[ Top ]

enableForceUpdate [line 250]

atkMetaAttributeModifier enableForceUpdate(
[boolean
$enable = true] 
)

Enable/disable force update.

Parameters:

boolean

$enable:

enable?

API Tags:

Access:

public

[ Top ]

getAttributes [line 75]

array getAttributes(
)

Returns the attribute names.

API Tags:

Access:

protected

[ Top ]

getPolicy [line 65]

atkMetaPolicy getPolicy(
)

Returns the meta policy.

API Tags:

Access:

protected

[ Top ]

insert [line 342]

void insert(
int
$position, [string
$attr = null] 
)

Insert.

Parameters:

int	$position:	position
string	$attr:	relative to attribute (optional)

API Tags:

Access:

protected

[ Top ]

insertAfter [line 389]

atkMetaAttributeModifier insertAfter(
string
$attr 
)

Insert attribute(s) after the given attribute.

Parameters:

string

$attr:

attribute name

API Tags:

Access:

public

[ Top ]

insertAtBottom [line 409]

atkMetaAttributeModifier insertAtBottom(
)

Insert attribute(s) at the bottom.

API Tags:

Access:

public

[ Top ]

insertAtTop [line 399]

atkMetaAttributeModifier insertAtTop(
)

Insert attribute(s) at the top.

API Tags:

Access:

public

[ Top ]

insertBefore [line 377]

atkMetaAttributeModifier insertBefore(
string
$attr 
)

Insert attribute(s) before the given attribute.

Parameters:

string

$attr:

attribute name

API Tags:

Access:

public

[ Top ]

removeFlag [line 204]

atkMetaAttributeModifier removeFlag(
int
$flags 
)

Remove flag(s).

Parameters:

int

$flags:

flag(s)

API Tags:

Access:

public

[ Top ]

removeFlags [line 216]

atkMetaAttributeModifier removeFlags(
int
$flags 
)

Remove flag(s).

Parameters:

int

$flags:

flag(s)

API Tags:

Access:

public

[ Top ]

setColumn [line 297]

atkMetaAttributeModifier setColumn(
array|string
$column 
)

Set the column.

Parameters:

array|string

$column:

colum name

API Tags:

Access:

public

[ Top ]

setDefaultValue [line 135]

atkMetaAttributeModifier setDefaultValue(
mixed
$value 
)

Set the default value.

Parameters:

mixed

$value:

default value

API Tags:

Access:

public

[ Top ]

setExcluded [line 114]

atkMetaAttributeModifier setExcluded(
boolean
$exclude 
)

Add or remove attributes to/from the excludes list.

Parameters:

boolean

$exclude:

exclude?

API Tags:

Access:

public

[ Top ]

setFlag [line 151]

atkMetaAttributeModifier setFlag(
int
$flags 
)

Set flag(s).

NOTE: this method will overwrite all currently set flags, including automatically detected flags!

Parameters:

int

$flags:

flag(s)

API Tags:

Access:

public

[ Top ]

setFlags [line 166]

atkMetaAttributeModifier setFlags(
int
$flags 
)

Set flag(s).

NOTE: this method will overwrite all currently set flags, including automatically detected flags!

Parameters:

int

$flags:

flag(s)

API Tags:

Access:

public

[ Top ]

setIncluded [line 89]

atkMetaAttributeModifier setIncluded(
[boolean
$include = true] 
)

Add or remove attributes to/from the includes list.

The order of the attributes doesn't change!

Parameters:

boolean

$include:

include?

API Tags:

Access:

public

[ Top ]

setSection [line 284]

atkMetaAttributeModifier setSection(
array|string
$sections 
)

Set the sections/tabs.

Parameters:

array|string

$sections:

section name(s)

API Tags:

Access:

public

[ Top ]

setTab [line 271]

atkMetaAttributeModifier setTab(
array|string
$tabs 
)

Set the sections/tabs.

Parameters:

array|string

$tabs:

tab name(s)

API Tags:

Access:

public

[ Top ]

setType [line 314]

atkMetaAttributeModifier setType(
string
$type, mixed
1 
)

Sets the type. All extra arguments after the type argument will be treated as parameters for the attribute(s).

If you need to pass arguments by reference you can better use the setTypeAndParams method.

Parameters:

string	$type:	full ATK attribute class (e.g. atk.attributes.atkboolattribute)
mixed	1:	... all other arguments will be treated as parameters

API Tags:

Access:

public

[ Top ]

setTypeAndParams [line 330]

atkMetaAttributeModifier setTypeAndParams(
string
$type, [array
$params = array()] 
)

Sets the type and parameters.

Parameters:

string	$type:	full ATK attribute class (e.g. atk.attributes.atkboolattribute)
array	$params:	parameters for the attribute (optional)

API Tags:

Access:

public

[ Top ]

Constants

AFTER = 2 [line 30]

[ Top ]

BEFORE = 1 [line 29]

[ Top ]

BOTTOM = 4 [line 32]

[ Top ]

TOP = 3 [line 31]

[ Top ]