Docs For Class atkMetaCompiler

static int	compareAttributes()	Compare the order of two attributes.
static atkMetaCompiler	get()	Returns an instance of the meta compiler with the given class. If no class is specified the default meta compiler is used determined using the $config_meta_compiler variable.
string	compile()	Compile meta policy. Returns the node code for the given meta policy.
void	_compileAttribute()	Compiles the attribute with the given name using the given data.
string	_compileAttributes()	Compile attributes.
string	_compileBase()	Compile node base.
string	_getAttributeFlagsString()	Generates an attributes flags string for a given flags value.
string	_getFlagsString()	Generates an flags string for a given flags value.
string	_getNodeFlagsString()	Generates a node flags string for a given flags value.
bool	_isIncluded()	Checks if a certain attribute should be included or not. Checks both the include and exclude lists. If the attribute is not part of the table itself it will always be included (e.g. manually added relations etc.)

[ Top ]

Properties

static array $instances [line 33]

Compiler instances.

[ Top ]

Methods

static method compareAttributes [line 228]

static int compareAttributes(
array
$attr1, array
$attr2 
)

Compare the order of two attributes.

Parameters:

array	$attr1:	attribute data
array	$attr2:	attribute data

API Tags:

Return:	comparision value
Access:	public

[ Top ]

static method get [line 44]

static atkMetaCompiler get(
[string
$class = null] 
)

Returns an instance of the meta compiler with the given class. If no class is specified the default meta compiler is used determined using the $config_meta_compiler variable.

Parameters:

string

$class:

full ATK compiler class path

API Tags:

Return:	meta compiler
Access:	public

[ Top ]

compile [line 320]

string compile(
atkMetaPolicy
$policy 
)

Compile meta policy. Returns the node code for the given meta policy.

Parameters:

atkMetaPolicy

$policy:

meta policy

API Tags:

Return:	meta policy
Access:	public

[ Top ]

_compileAttribute [line 160]

void _compileAttribute(
atkMetaPolicy
$policy, string
$name, array
$data, string
3 
)

Compiles the attribute with the given name using the given data.

Parameters:

atkMetaPolicy	$policy:	meta policy
string	$name:	attribute name
array	$data:	attribute compile data
string	3:	attribute code

API Tags:

Access:

protected

[ Top ]

_compileAttributes [line 242]

string _compileAttributes(
atkMetaPolicy
$policy 
)

Compile attributes.

Parameters:

atkMetaPolicy

$policy:

meta policy

API Tags:

Return:	code
Access:	protected

[ Top ]

_compileBase [line 276]

string _compileBase(
atkMetaPolicy
$policy 
)

Compile node base.

Parameters:

atkMetaPolicy

$policy:

meta policy

API Tags:

Return:	code
Access:	protected

[ Top ]

_getAttributeFlagsString [line 111]

string _getAttributeFlagsString(
int
$flags 
)

Generates an attributes flags string for a given flags value.

Parameters:

int

$flags:

flags

API Tags:

Return:	flags string
Access:	protected

[ Top ]

_getFlagsString [line 69]

string _getFlagsString(
int
$flags, string
$prefix, [array
$specificExcludes = array()], [array
$constExcludes = array()] 
)

Generates an flags string for a given flags value.

Parameters:

int	$flags:	flags
string	$prefix:	flags prefix
array	$specificExcludes:	values of customizable flags which can differ for subclasses
array	$constExcludes:	constant names of constants that should be excluded

API Tags:

Return:	flags string
Access:	protected

[ Top ]

_getNodeFlagsString [line 123]

string _getNodeFlagsString(
int
$flags 
)

Generates a node flags string for a given flags value.

Parameters:

int

$flags:

flags

API Tags:

Return:	flags string
Access:	protected

[ Top ]

_isIncluded [line 138]

bool _isIncluded(
atkMetaPolicy
$policy, string
$name 
)

Checks if a certain attribute should be included or not. Checks both the include and exclude lists. If the attribute is not part of the table itself it will always be included (e.g. manually added relations etc.)

Parameters:

atkMetaPolicy	$policy:	meta policy
string	$name:	attribute name

API Tags:

Return:	attribute included?
Access:	protected

[ Top ]