Docs For Class atkMetaPolicy

array	$m_attrs	Node attributes.
atkMetaCompiler	$m_compiler	The meta compiler which is being used by the policy.
array\|null	$m_excludes	Excluded attributes.
atkMetaGrammar	$m_grammar	The meta grammar which is being used by the policy.
mixed	$m_handler	The meta handler which is begin used by the policy. A function name or handler array (class/object and method name). If set to null we will check if the meta node contains a method called meta and will call this instead.
array\|null	$m_includes	Included attributes.
array	$m_metaData	Table meta data.
atkMetaNode	$m_node	The node which is being constructed by the policy.
string	$m_nodeDatabase	Node database name.
string	$m_nodeDescriptor	Node descriptor.
string	$m_nodeFilter	Node filter.
int	$m_nodeFlags	Node flags.
string	$m_nodeIndex	Node index column.
string	$m_nodeOrder	Node (default) order.
string	$m_nodeSecurityAlias	Node security alias.
string	$m_nodeSecurityMap	Node security map.
string	$m_nodeSequence	Node sequence name.
string	$m_nodeTable	Node table name.

[ Top ]

Method Summary

static int	bitOr()	Utility method to bit-or two integers.
static int	cmpAttributes()	Compares two attributes based on their order.
static atkMetaPolicy	create()	Returns an instance of the meta policy using the given class. If no class is specified the default meta policy is used determined using the $config_meta_policy variable.
atkMetaPolicy	__construct()	Constructor.
atkMetaAttributeModifier	add()	Add / replace (custom) attribute.
void	addDefaultFlags()	Add default flag(s) to all attributes, except the specifed attribute or list of attributes.
atkMetaAttributeModifier	addFieldSet()	Add fieldset.
void	addFlag()	Add flag(s) for the given attribute or list of attributes.
void	addFlags()	Add flag(s) for the given attribute or list of attributes.
void	addForceInsert()	Enable force insert for the given attribute or list of attributes.
void	addForceUpdate()	Enable force update for the given attribute or list of attributes.
void	apply()	Build / setup node using the collected attributes.
void	exists()	Does the given attribute exist?
atkMetaAttributeModifier	get()	Returns the attribute modifier for the given attributes. The modifier allows you to add flags, set tabs etc. through a fluent interface.
atkMetaAttributeModifier	getAll()	Returns an attribute modifier for all attributes.The modifier allows you to add flags, set tabs etc. through a fluent interface.
array	getAttributeNames()	Returns the attribute names.
array	&getAttributes()	Returns a reference to the attributes array.
atkMetaCompiler	getCompiler()	Returns the meta compiler.
array	getExcludes()	Returns the currently set excludes (if applicable).
atkMetaGrammar	getGrammar()	Returns the meta grammar.
mixed	getHandler()	Returns the meta handler.
array	getIncludes()	Returns the currently set includes (if applicable).
array	getMetaData()	Returns the meta data for this policy's table.
atkNode	getNode()	Returns the node for this policy.
string	getNodeDatabase()	Returns the node database.
string	getNodeDescriptor()	Returns the node descriptor.
string	getNodeFilter()	Returns the node filter.
int	getNodeFlags()	Returns the node flags.
string	getNodeIndex()	Returns the index column.
string	getNodeOrder()	Returns the (default) node order.
string	getNodeSecurityAlias()	Returns the node security alias.
array	getNodeSecurityMap()	Returns the additional node security map
string	getNodeSequence()	Returns the node sequence.
string	getNodeTable()	Returns the node table.
atkMetaAttributeModifier	hasMany()	One-to-many / many-to-many relation support. You can call the hasMany method to indicate that this node has a one-to-many or a many-to-many relationship with another node. The meta policy will then try to guess, amongst other things, which fields should be used for this relation.
atkMetaAttributeModifier	hasOne()	Many-to-one / one-to-one relation support. You can call the hasOne method to indicate that this node has a many-to-one or a one-to-one relation with another node. The meta policy will then try to guess, amongst other things, which fields should be used for this relation.
void	importAttribute()	Import attribute of the given type, we do this as soon as attributes are added to the meta node or the type has been changed so that the flags for the attribute are available.
void	remove()	Remove attribute.
void	removeFlag()	Remove flag(s) from the given attribute or list of attributes.
void	removeFlags()	Remove flag(s) from the given attribute or list of attributes.
void	removeForceInsert()	Disable force insert for the given attribute or list of attributes.
void	removeForceUpdate()	Disable force update for the given attribute or list of attributes.
void	setColumn()	Set the column for the given attribute or list of attributes.
void	setCompiler()	Sets the meta compiler.
void	setDefaultValue()	Set the default value for the given attribute(s).
void	setExcludes()	Set excludes.
void	setFlag()	Set flag(s) for the given attribute or list of attributes.
void	setFlags()	Set flag(s) for the given attribute or list of attributes.
void	setGrammar()	Sets the meta grammar.
void	setHandler()	Sets the meta handler.
void	setIncludes()	Set includes. Implicitly sets the order!
void	setNode()	Sets the node for this policy.
void	setNodeDescriptor()	Sets the node descriptor.
void	setNodeFilter()	Sets the node filter.
void	setNodeFlags()	Sets the node flags
void	setNodeIndex()	Sets the node index column.
void	setNodeOrder()	Sets the (default) node order.
void	setNodeSecurityAlias()	Sets the node security alias.
void	setNodeSecurityMap()	Sets the node additional security map.
void	setNodeSequence()	Sets the node sequence name.
void	setOrder()	Sets the attribute order. All attributes not mentioned will be moved to the bottom using their current order.
void	setSection()	Set the sections/tabs for the given attribute or list of attributes.
void	setSections()	Set the sections/tabs for the given attribute or list of attributes.
void	setTab()	Set the sections/tabs for the given attribute or list of attributes.
void	setTabs()	Set the sections/tabs for the given attribute or list of attributes.
void	setType()	Sets the attribute type. All extra arguments after the two standard arguments will be threated as parameters for the attribute. If you need to pass arguments by reference you can better use the setTypeAndParams method.
void	setTypeAndParams()	Sets the attribute type and parameters.
void	sortAttributes()	Sort the attributes based on their order.
String	text()	Translate using the node's module and type.
string	_cache()	Write compiled meta node code to cache.
mixed	_call()	Calls a method of this object with the given parameters.
string	_compile()	Compile policy.
string	_detectNodeSequence()	Detect node sequence name.
string	_detectNodeTable()	Detect node table name.
string	_findDestination()	Find destination node for the given meta relation.
string	_findSourceAttribute()	Find source attribute for a many-to-one relation that point to the given destination node.
mixed	_getDefaultValue()	Get auto-detected default value for the given attribute.
array	_getDestinationAttributeVariants()	Returns a list of possible attribute name variants for relations which reference this node or the given destination node.
int	_getFlags()	Returns the auto-detected flags for the given attribute.
int	_getMaxOrder()	Returns the current maximum order in the attribute list.
int	_getOrder()	Get auto-detected order for the given attribute.
array	_getTypeAndParams()	Get attribute type and params for the given attribute/column.
void	_init()	Initialize attributes using policy.
void	_initAttribute()	Intialize attribute for node using the given column meta data.
void	_meta()	Modify meta policy, by default the meta method of the node is called.
void	_setMetaData()	Sets the meta data for this policy's table.
void	_setNodeDatabase()	Sets the node database.
void	_setNodeTable()	Sets the node table name.

[ Top ]

Properties

array $m_attrs = array() [line 161]

Node attributes.

API Tags:

Access:

protected

[ Top ]

atkMetaCompiler $m_compiler = null [line 54]

The meta compiler which is being used by the policy.

API Tags:

Access:

protected

[ Top ]

array|null $m_excludes = null [line 154]

Excluded attributes.

API Tags:

Access:

protected

[ Top ]

atkMetaGrammar $m_grammar = null [line 47]

The meta grammar which is being used by the policy.

API Tags:

Access:

protected

[ Top ]

mixed $m_handler = null [line 63]

The meta handler which is begin used by the policy. A function name or handler array (class/object and method name). If set to null we will check if the meta node contains a method called meta and will call this instead.

API Tags:

Access:

protected

[ Top ]

array|null $m_includes = null [line 147]

Included attributes.

API Tags:

Access:

protected

[ Top ]

array $m_metaData = null [line 70]

Table meta data.

API Tags:

Access:

protected

[ Top ]

atkMetaNode $m_node = null [line 40]

The node which is being constructed by the policy.

API Tags:

Access:

protected

[ Top ]

string $m_nodeDatabase = null [line 77]

Node database name.

API Tags:

Access:

protected

[ Top ]

string $m_nodeDescriptor = null [line 105]

Node descriptor.

API Tags:

Access:

protected

[ Top ]

string $m_nodeFilter = null [line 126]

Node filter.

API Tags:

Access:

protected

[ Top ]

int $m_nodeFlags = null [line 98]

Node flags.

API Tags:

Access:

protected

[ Top ]

string $m_nodeIndex = null [line 119]

Node index column.

API Tags:

Access:

protected

[ Top ]

string $m_nodeOrder = null [line 112]

Node (default) order.

API Tags:

Access:

protected

[ Top ]

string $m_nodeSecurityAlias = null [line 133]

Node security alias.

API Tags:

Access:

protected

[ Top ]

string $m_nodeSecurityMap = null [line 140]

Node security map.

API Tags:

Access:

protected

[ Top ]

string $m_nodeSequence = null [line 91]

Node sequence name.

API Tags:

Access:

protected

[ Top ]

string $m_nodeTable = null [line 84]

Node table name.

API Tags:

Access:

protected

[ Top ]

Methods

static method bitOr [line 1767]

static int bitOr(
int
$a, int
$b 
)

Utility method to bit-or two integers.

Parameters:

int	$a:	integer a
int	$b:	integer b

API Tags:

Return:	result of bit-or
Access:	public

[ Top ]

static method cmpAttributes [line 794]

static int cmpAttributes(
array
$a, array
$b 
)

Compares two attributes based on their order.

Parameters:

array	$a:	attribute
array	$b:	attribute

API Tags:

Return:	order (a == b ? 0 : (a < b ? -1 : 1))
Access:	public

[ Top ]

static method create [line 173]

static atkMetaPolicy create(
atkMetaNode
$node, [string
$class = null] 
)

Returns an instance of the meta policy using the given class. If no class is specified the default meta policy is used determined using the $config_meta_policy variable.

Parameters:

atkMetaNode	$node:	policy node
string	$class:	full ATK policy class path

API Tags:

Return:	meta policy
Access:	public

[ Top ]

Constructor __construct [line 188]

atkMetaPolicy __construct(
atkMetaNode
$node 
)

Constructor.

Parameters:

atkMetaNode

$node:

policy node

API Tags:

Access:

public

[ Top ]

add [line 1636]

atkMetaAttributeModifier add(
string|array
$name, [string
$type = 'atkattribute'], [array
$params = array()], [int
$flags = 0], [string|array
$sections = NULL], [int
$order = NULL], [mixed
$default = self::NO_DEFAULT_VALUE] 
)

Add / replace (custom) attribute.

Parameters:

string\|array	$name:	attribute name or list of attributes
string	$type:	attribute type
array	$params:	attribute parameters, excluding flags (optional)
int	$flags:	attribute flags (optional)
string\|array	$sections:	sections/tabs to display the attribute on
int	$order:	order of the attribute
mixed	$default:	default value

API Tags:

Access:

public

[ Top ]

addDefaultFlags [line 960]

void addDefaultFlags(
array|string
$exclude_attrs, [int
$flags = 0] 
)

Add default flag(s) to all attributes, except the specifed attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

Parameters:

array\|string	$exclude_attrs:	list of attribute names or single attribute name to exclude
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

addFieldSet [line 1688]

atkMetaAttributeModifier addFieldSet(
string
$name, string
$template, [int
$flags = 0], [string|array
$sections = NULL], [int
$order = NULL] 
)

Add fieldset.

To include an attribute label use [attribute.label] inside your template. To include an attribute edit/display field use [attribute.field] inside your template.

Parameters:

string	$name:	name
string	$template:	template string
int	$flags:	attribute flags
string\|array	$sections:	sections/tabs to display the attribute on
int	$order:	order of the attribute

API Tags:

Access:

public

[ Top ]

addFlag [line 921]

void addFlag(
array|string
$attrs, int
$flags 
)

Add flag(s) for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

addFlags [line 936]

void addFlags(
array|string
$attrs, int
$flags 
)

Add flag(s) for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

addForceInsert [line 1026]

void addForceInsert(
string|array
$attrs 
)

Enable force insert for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

addForceUpdate [line 1060]

void addForceUpdate(
string|array
$attrs 
)

Enable force update for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

apply [line 1981]

void apply(
)

Build / setup node using the collected attributes.

API Tags:

Access:

public

[ Top ]

exists [line 1713]

void exists(
string
$name 
)

Does the given attribute exist?

Parameters:

string

$name:

attribute name

API Tags:

Access:

public

[ Top ]

get [line 706]

atkMetaAttributeModifier get(
string|array
$attrs 
)

Returns the attribute modifier for the given attributes. The modifier allows you to add flags, set tabs etc. through a fluent interface.

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

getAll [line 719]

atkMetaAttributeModifier getAll(
)

Returns an attribute modifier for all attributes.The modifier allows you to add flags, set tabs etc. through a fluent interface.

API Tags:

Access:

public

[ Top ]

getAttributeNames [line 1735]

array getAttributeNames(
)

Returns the attribute names.

API Tags:

Return:	string attribute names
Access:	public

[ Top ]

getAttributes [line 1725]

array &getAttributes(
)

Returns a reference to the attributes array.

Be very careful when using this array, modifying it might void your warranty!

API Tags:

Return:	reference to the attributes array
Access:	public

[ Top ]

getCompiler [line 238]

atkMetaCompiler getCompiler(
)

Returns the meta compiler.

API Tags:

Return:	the meta compiler
Access:	public

[ Top ]

getExcludes [line 761]

array getExcludes(
)

Returns the currently set excludes (if applicable).

API Tags:

Return:	excludes list
Access:	public

[ Top ]

getGrammar [line 218]

atkMetaGrammar getGrammar(
)

Returns the meta grammar.

API Tags:

Return:	the meta grammar
Access:	public

[ Top ]

getHandler [line 258]

mixed getHandler(
)

Returns the meta handler.

API Tags:

Return:	the meta handler
Access:	public

[ Top ]

getIncludes [line 729]

array getIncludes(
)

Returns the currently set includes (if applicable).

API Tags:

Return:	includes list
Access:	public

[ Top ]

getMetaData [line 278]

array getMetaData(
)

Returns the meta data for this policy's table.

API Tags:

Return:	meta data
Access:	public

[ Top ]

getNode [line 198]

atkNode getNode(
)

Returns the node for this policy.

API Tags:

Return:	policy node
Access:	public

[ Top ]

getNodeDatabase [line 298]

string getNodeDatabase(
)

Returns the node database.

API Tags:

Return:	database name
Access:	public

[ Top ]

getNodeDescriptor [line 382]

string getNodeDescriptor(
)

Returns the node descriptor.

API Tags:

Return:	descriptor
Access:	public

[ Top ]

getNodeFilter [line 442]

string getNodeFilter(
)

Returns the node filter.

API Tags:

Return:	filter
Access:	public

[ Top ]

getNodeFlags [line 362]

int getNodeFlags(
)

Returns the node flags.

API Tags:

Return:	node flags
Access:	public

[ Top ]

getNodeIndex [line 422]

string getNodeIndex(
)

Returns the index column.

API Tags:

Return:	index column
Access:	public

[ Top ]

getNodeOrder [line 402]

string getNodeOrder(
)

Returns the (default) node order.

API Tags:

Return:	node order
Access:	public

[ Top ]

getNodeSecurityAlias [line 462]

string getNodeSecurityAlias(
)

Returns the node security alias.

API Tags:

Return:	security alias
Access:	public

[ Top ]

getNodeSecurityMap [line 482]

array getNodeSecurityMap(
)

Returns the additional node security map

API Tags:

Return:	security map
Access:	public

[ Top ]

getNodeSequence [line 342]

string getNodeSequence(
)

Returns the node sequence.

API Tags:

Return:	sequence name
Access:	public

[ Top ]

getNodeTable [line 320]

string getNodeTable(
)

Returns the node table.

API Tags:

Return:	table name
Access:	public

[ Top ]

hasMany [line 1435]

atkMetaAttributeModifier hasMany(
string
$accessor, [string|array
$templateOrOptions = array()], [array
$options = array()], [int
$flags = 0] 
)

One-to-many / many-to-many relation support. You can call the hasMany method to indicate that this node has a one-to-many or a many-to-many relationship with another node. The meta policy will then try to guess, amongst other things, which fields should be used for this relation.

This method uses a smart name guessing scheme for the (optional intermediate) and destination node. If you enter the plural form of the (singular) node name it will still be able to find the node. You can ommit the module name prefix if the destination node resides in the same module as the source node. Ofcourse you can also just use the real module/node name combination.

The options list may contain several parameters to make more complex relations work. The supported parameters are as follows:

dest(-ination) destination attribute name
filter destination filter
through intermediary node name (for many-to-many relations)
local if ATK can't determine the key in the intermediary node automatically, use local to tell it which key points to the source node.
remote if ATK can't determine the key in the intermediary node use remote to tell it which key points to the destination node.
type type of many-to-many relation (shuttle, select, eshuttle, bool(ean) or list, defaults to shuttle)
cols/columns number of columns (many-to-many bool relations only)
rows number of rows (many-to-many list relations only)
name name for this relation (by default getNodeType($accessor))

Parameters:

string	$accessor:	accessor name (complete description is given above)
string\|array	$templateOrOptions:	template or list of options (complete description is given above)
array	$options:	list op options (complete description is given above)
int	$flags:	the flags for the relation

API Tags:

Access:

public

[ Top ]

hasOne [line 1572]

atkMetaAttributeModifier hasOne(
string
$accessor, [string|array
$templateOrOptions = array()], [array
$options = array()], [int
$flags = 0] 
)

Many-to-one / one-to-one relation support. You can call the hasOne method to indicate that this node has a many-to-one or a one-to-one relation with another node. The meta policy will then try to guess, amongst other things, which fields should be used for this relation.

To determine if a many-to-one or a one-to-one relation should be used the system will check if the source node contains an attribute for storing the relation. If so the system will use a many-to-one relation, else a one-to-one relation will be used.

This method uses a smart name guessing scheme for the destination node. If you enter the singular form of the (plural) node name it will still be able to find the node. You can ommit the module name prefix if the destination node resides in the same module as the source node. Ofcourse you can also just use the real module/node name combination.

The options list may contain several parameters to make more complex relations work. The supported parameters are as follows:

source source attribute name (should only be used for many-to-one relations and will act as an indicator for whatever this is a many-to-one relation or not)
dest(-ination) destination attribute name (should only be used for one-to-one relations and will act as an indicator for whatever this is a one-to-one relation or not)
filter destination filter
large boolean indicating if there will be lots and lots of records in case of a many-to-one relation, same as the AF_LARGE flag (defaults to false)

Parameters:

string	$accessor:	accessor name (complete description is given above)
string\|array	$templateOrOptions:	template or list of options (complete description is given above)
array	$options:	list op options (complete description is given above)
int	$flags:	the flags for the relation

API Tags:

Access:

public

[ Top ]

importAttribute [line 682]

void importAttribute(
string
$type 
)

Import attribute of the given type, we do this as soon as attributes are added to the meta node or the type has been changed so that the flags for the attribute are available.

Parameters:

string

$type:

attribute type

API Tags:

Access:

public

[ Top ]

remove [line 1698]

void remove(
string|array
$name 
)

Remove attribute.

Parameters:

string|array

$name:

attribute name

API Tags:

Access:

public

[ Top ]

removeFlag [line 988]

void removeFlag(
array|string
$attrs, int
$flags 
)

Remove flag(s) from the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

removeFlags [line 1003]

void removeFlags(
array|string
$attrs, int
$flags 
)

Remove flag(s) from the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

removeForceInsert [line 1043]

void removeForceInsert(
string|array
$attrs 
)

Disable force insert for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

removeForceUpdate [line 1077]

void removeForceUpdate(
string|array
$attrs 
)

Disable force update for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

setColumn [line 1166]

void setColumn(
array|string
$attrs, array|string
$column 
)

Set the column for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the section name(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
array\|string	$column:	colum name

API Tags:

Access:

public

[ Top ]

setCompiler [line 248]

void setCompiler(
atkMetaCompiler
$compiler 
)

Sets the meta compiler.

Parameters:

atkMetaCompiler

$compiler:

the meta compiler

API Tags:

Access:

public

[ Top ]

setDefaultValue [line 850]

void setDefaultValue(
array|string
$attrs, mixed
$value 
)

Set the default value for the given attribute(s).

This method can also be called with multiple attribute string arguments as long as the last argument contains the default value.

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
mixed	$value:	default value

API Tags:

Access:

public

[ Top ]

setExcludes [line 777]

void setExcludes(
string|array
$attrs 
)

Set excludes.

NOTE: Attributes manually added through the policy will always be included unless they are explicitly removed using the remove method!

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

setFlag [line 878]

void setFlag(
array|string
$attrs, int
$flags 
)

Set flag(s) for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

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

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

setFlags [line 896]

void setFlags(
array|string
$attrs, int
$flags 
)

Set flag(s) for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the flag(s).

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

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
int	$flags:	flag(s)

API Tags:

Access:

public

[ Top ]

setGrammar [line 228]

void setGrammar(
atkMetaGrammar
$grammar 
)

Sets the meta grammar.

Parameters:

atkMetaGrammar

$grammar:

the meta grammar

API Tags:

Access:

public

[ Top ]

setHandler [line 268]

void setHandler(
mixed
$handler 
)

Sets the meta handler.

Parameters:

mixed

$handler:

the meta compiler

API Tags:

Access:

public

[ Top ]

setIncludes [line 745]

void setIncludes(
string|array
$attrs 
)

Set includes. Implicitly sets the order!

NOTE: Attributes manually added through the policy will always be included unless they are explicitly removed using the remove method!

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

setNode [line 208]

void setNode(
atkMetaNode
$node 
)

Sets the node for this policy.

Parameters:

atkNode

$node:

policy node

API Tags:

Access:

public

[ Top ]

setNodeDescriptor [line 392]

void setNodeDescriptor(
string
$descriptor 
)

Sets the node descriptor.

Parameters:

string

$descriptor:

descriptor

API Tags:

Access:

public

[ Top ]

setNodeFilter [line 452]

void setNodeFilter(
string
$filter 
)

Sets the node filter.

Parameters:

string

$filter:

filter

API Tags:

Access:

public

[ Top ]

setNodeFlags [line 372]

void setNodeFlags(
int
$flags 
)

Sets the node flags

Parameters:

int

$flags:

node flags

API Tags:

Access:

public

[ Top ]

setNodeIndex [line 432]

void setNodeIndex(
string
$column 
)

Sets the node index column.

Parameters:

string

$column:

index column

API Tags:

Access:

public

[ Top ]

setNodeOrder [line 412]

void setNodeOrder(
string
$order 
)

Sets the (default) node order.

Parameters:

string

$order:

node order

API Tags:

Access:

public

[ Top ]

setNodeSecurityAlias [line 472]

void setNodeSecurityAlias(
string
$alias 
)

Sets the node security alias.

Parameters:

string

$alias:

security alias

API Tags:

Access:

public

[ Top ]

setNodeSecurityMap [line 492]

void setNodeSecurityMap(
array
$map 
)

Sets the node additional security map.

Parameters:

array

$map:

security map array

API Tags:

Access:

public

[ Top ]

setNodeSequence [line 352]

void setNodeSequence(
string
$sequence 
)

Sets the node sequence name.

Parameters:

string

$sequence:

sequence name

API Tags:

Access:

public

[ Top ]

setOrder [line 826]

void setOrder(
string|array
$attrs 
)

Sets the attribute order. All attributes not mentioned will be moved to the bottom using their current order.

This method can also be called with multiple attribute string arguments.

Parameters:

string|array

$attrs:

attribute name(s)

API Tags:

Access:

public

[ Top ]

setSection [line 1136]

void setSection(
array|string
$attrs, array|string
$sections 
)

Set the sections/tabs for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the section name(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
array\|string	$sections:	section name(s)

API Tags:

Access:

public

[ Top ]

setSections [line 1151]

void setSections(
array|string
$attrs, array|string
$sections 
)

Set the sections/tabs for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the section name(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
array\|string	$sections:	section name(s)

API Tags:

Access:

public

[ Top ]

setTab [line 1096]

void setTab(
array|string
$attrs, array|string
$tabs 
)

Set the sections/tabs for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the section name(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
array\|string	$tabs:	tab name(s)

[ Top ]

setTabs [line 1111]

void setTabs(
array|string
$attrs, array|string
$tabs 
)

Set the sections/tabs for the given attribute or list of attributes.

This method can also be called with multiple attribute string arguments as long as the last argument contains the section name(s).

Parameters:

array\|string	$attrs:	list of attribute names or single attribute name
array\|string	$tabs:	tab name(s)

API Tags:

Access:

public

[ Top ]

setType [line 1192]

void setType(
string|array
$attr, string
$type, mixed
2 
)

Sets the attribute type. All extra arguments after the two standard arguments will be threated as parameters for the attribute. If you need to pass arguments by reference you can better use the setTypeAndParams method.

Parameters:

string\|array	$attr:	the attribute name or a list of attributes
string	$type:	full ATK attribute class (e.g. atk.attributes.atkboolattribute)
mixed	2:	... all other arguments will be threated as parameters

API Tags:

Access:

public

[ Top ]

setTypeAndParams [line 1206]

void setTypeAndParams(
string|array
$attr, string
$type, [array
$params = array()] 
)

Sets the attribute type and parameters.

Parameters:

string\|array	$attr:	the attribute name or a list of attributes
string	$type:	full ATK attribute class (e.g. atk.attributes.atkboolattribute)
array	$params:	parameters for the attribute (optional)

API Tags:

Access:

public

[ Top ]

sortAttributes [line 813]

void sortAttributes(
)

Sort the attributes based on their order.

API Tags:

Access:

protected

[ Top ]

text [line 1754]

String text(
mixed
$string, [String
$module = NULL], [String
$language = ''], [String
$firstFallback = ""], [boolean
$nodeDefaultText = false] 
)

Translate using the node's module and type.

Parameters:

mixed	$string:	string or array of strings containing the name(s) of the string to return when an array of strings is passed, the second will be the fallback if the first one isn't found, and so forth
String	$module:	module in which the language file should be looked for, defaults to core module with fallback to ATK
String	$language:	ISO 639-1 language code, defaults to config variable
String	$firstFallback:	the first module to check as part of the fallback
boolean	$nodeDefaultText:	if true, then it doesn't return a default text when it can't find a translation

API Tags:

Return:	the string from the languagefile
Access:	public

[ Top ]

_cache [line 1970]

string _cache(
string
$code 
)

Write compiled meta node code to cache.

Parameters:

string

$code:

compiled code

API Tags:

Return:	file path
Access:	protected

[ Top ]

_call [line 670]

mixed _call(
string
$method, array
$params 
)

Calls a method of this object with the given parameters.

Parameters:

string	$method:	the method name
array	$params:	the method parameters

API Tags:

Return:	result
Access:	protected

[ Top ]

_compile [line 1958]

string _compile(
)

Compile policy.

API Tags:

Return:	code compiled code
Access:	protected

[ Top ]

_detectNodeSequence [line 1816]

string _detectNodeSequence(
)

Detect node sequence name.

API Tags:

Return:	sequence name
Access:	protected

[ Top ]

_detectNodeTable [line 1777]

string _detectNodeTable(
)

Detect node table name.

API Tags:

Return:	table name
Access:	protected

[ Top ]

_findDestination [line 1246]

string _findDestination(
string
$accessor, bool
$toMany 
)

Find destination node for the given meta relation.

Parameters:

string	$accessor:	accessor name
bool	$toMany:	accessor name might be in plural form?

API Tags:

Return:	destination node name for the given relation
Access:	protected

[ Top ]

_findSourceAttribute [line 1367]

string _findSourceAttribute(
string
$destination 
)

Find source attribute for a many-to-one relation that point to the given destination node.

Parameters:

string

$destination:

destination node type

API Tags:

Return:	source attribute name
Access:	protected

[ Top ]

_getDefaultValue [line 643]

mixed _getDefaultValue(
string
$name, array
$meta 
)

Get auto-detected default value for the given attribute.

Parameters:

string	$name:	column/attribute name
array	$meta:	column meta data

API Tags:

Return:	default value
Access:	protected

[ Top ]

_getDestinationAttributeVariants [line 1295]

array _getDestinationAttributeVariants(
[string
$destination = null] 
)

Returns a list of possible attribute name variants for relations which reference this node or the given destination node.

Parameters:

string

$destination:

destination node

API Tags:

Return:	list of attribute variants
Access:	protected

[ Top ]

_getFlags [line 600]

int _getFlags(
string
$name, array
$meta 
)

Returns the auto-detected flags for the given attribute.

Parameters:

string	$name:	attribute/column name
array	$meta:	column meta data

API Tags:

Return:	flags
Access:	protected

[ Top ]

_getMaxOrder [line 1223]

int _getMaxOrder(
)

Returns the current maximum order in the attribute list.

API Tags:

Return:	max order
Access:	protected

[ Top ]

_getOrder [line 629]

int _getOrder(
string
$name, array
$meta 
)

Get auto-detected order for the given attribute.

Parameters:

string	$name:	column/attribute name
array	$meta:	column meta data

API Tags:

Return:	order
Access:	protected

[ Top ]

_getTypeAndParams [line 508]

array _getTypeAndParams(
string
$name, array
$meta 
)

Get attribute type and params for the given attribute/column.

Returns an array which looks like the following: array("type" => ..., "params" => array(...))

Parameters:

string	$name:	attribute/column name
array	$meta:	column meta data

API Tags:

Return:	type and params
Access:	protected

[ Top ]

_init [line 1860]

void _init(
)

Initialize attributes using policy.

API Tags:

Access:

protected

[ Top ]

_initAttribute [line 1843]

void _initAttribute(
string
$name, array
$meta 
)

Intialize attribute for node using the given column meta data.

Parameters:

string	$name:	column name
array	$meta:	column meta data

API Tags:

Access:

protected

[ Top ]

_meta [line 1929]

void _meta(
)

Modify meta policy, by default the meta method of the node is called.

API Tags:

Access:

protected

[ Top ]

_setMetaData [line 288]

void _setMetaData(
array
$metaData 
)

Sets the meta data for this policy's table.

Parameters:

array

$metaData:

meta data

API Tags:

Access:

protected

[ Top ]

_setNodeDatabase [line 310]

void _setNodeDatabase(
string
$database 
)

Sets the node database.

Only for internal use, because it's too late to set this from inside the meta method.

Parameters:

string

$database:

database name

API Tags:

Access:

protected

[ Top ]

_setNodeTable [line 332]

void _setNodeTable(
string
$table 
)

Sets the node table name.

Only for internal use, because it's too late to set this from inside the meta method.

Parameters:

string

$table:

table name

API Tags:

Access:

protected

[ Top ]

Constants

NO_DEFAULT_VALUE = '!@NO_DEFAULT_VALUE@!' [line 33]

No default value.

[ Top ]