Ibuildings - Docs For Class atkmlsplitter

Docs For Class atkmlsplitter

Home

Documentation home

Atk index

Docs For Class atkmlsplitter [ package: atk ]

Class: atkmlsplitter

Source Location: /utils/class.atkmlsplitter.inc

Class atkmlsplitter

Class Overview

This class is responsible for managing multilanguage nodes which have multiple records per occurance.

It updates/saves or merges multiple records. This is used by multilingual atkNodes. It should generally not be necessary to use this class directly.

Located in /utils/class.atkmlsplitter.inc [line 31]

Wiki documentation

Author(s):

Martin Roest <martin@ibuildings.nl>

Information Tags:

Methods

[ Top ]

Method Summary

array	addLngRecords()	Add language records
void	addMlCondition()	Adds language condition
void	atkMlSplitter()	Constructor
void	combineMlRecordSet()	merges multiple multilanguage records to one record with fields containing arrays needed by mlattributes
atkOutput	&getInstance()	Retrieve the mlsplitter instance
array	getLanguages()	Get supported languages
array	getMlNodes()	this is used to find 1:1 relations with multilanguage support we need these relation because the recordlist will have them included when editting a record we have to combine these records
bool	hasLngRecord()	Has language record?
void	mergeMlRecords()	Merge multilanguage records
int	searchRecordDefaultLanguage()	Search the recordset for the default language
bool	updateLngField()	Update the language field
void	updateMlRecords()	add/update multiple language records because nodes are cached and we have to make some attribute modifications you can't pass the node as a reference!!

[ Top ]

Methods

addLngRecords [line 307]

array addLngRecords(

&$node, 
&$recordset, atkNode
$node, array
$recordset 
)

Add language records

Parameters:

atkNode	$node:
array	$recordset:
	&$node:
	&$recordset:

API Tags:

Return:

Array with records to add

[ Top ]

addMlCondition [line 220]

void addMlCondition(

&$query, 
&$node, string
$mode, string
$joinalias, atkQuery
$query, atkNode
$node 
)

Adds language condition

Parameters:

atkQuery	$query:
atkNode	$node:
string	$mode:
string	$joinalias:
	&$query:
	&$node:

[ Top ]

atkMlSplitter [line 37]

void atkMlSplitter(
)

Constructor

[ Top ]

combineMlRecordSet [line 241]

void combineMlRecordSet(

&$node, 
&$recordset, atkQuery
$query, atkNode
$node, array
$recordset 
)

merges multiple multilanguage records to one record with fields containing arrays needed by mlattributes

Parameters:

atkNode	$node:
array	$recordset:
atkQuery	$query:
	&$node:
	&$recordset:

[ Top ]

getInstance [line 46]

atkOutput &getInstance(
)

Retrieve the mlsplitter instance

API Tags:

Return:

The instance.

[ Top ]

getLanguages [line 63]

array getLanguages(

&$node, atkNode
$node 
)

Get supported languages

Parameters:

atkNode	$node:
	&$node:

API Tags:

Return:

Array with supported languages

[ Top ]

getMlNodes [line 261]

array getMlNodes(

&$node, atkNode
$node 
)

this is used to find 1:1 relations with multilanguage support we need these relation because the recordlist will have them included when editting a record we have to combine these records

Parameters:

atkNode	$node:
	&$node:

API Tags:

Return:

Array with relationnames

[ Top ]

hasLngRecord [line 288]

bool hasLngRecord(

&$node, 
&$recordset, string
$lng, 
&$index, atkNode
$node, array
$recordset, int
$index 
)

Has language record?

Parameters:

atkNode	$node:
array	$recordset:
string	$lng:
int	$index:
	&$node:
	&$recordset:
	&$index:

[ Top ]

mergeMlRecords [line 337]

void mergeMlRecords(

&$node, 
&$recordset, atkNode
$node, array
$recordset 
)

Merge multilanguage records

Parameters:

atkNode	$node:
array	$recordset:
	&$node:
	&$recordset:

[ Top ]

searchRecordDefaultLanguage [line 371]

int searchRecordDefaultLanguage(
array
$recordset, string
$defaultlanguage 
)

Search the recordset for the default language

Parameters:

array	$recordset:
string	$defaultlanguage:

API Tags:

Return:

The position in the recordset array where the defaultlanguage is found

[ Top ]

updateLngField [line 81]

bool updateLngField(

&$node, 
&$record, atkNode
$node, array
$record 
)

Update the language field

Parameters:

atkNode	$node:
array	$record:
	&$node:
	&$record:

[ Top ]

updateMlRecords [line 99]

void updateMlRecords(
atkNode
$node, array
$record, [string
$mode = "add"], [
$excludes = ''], [
$includes = ''] 
)

add/update multiple language records because nodes are cached and we have to make some attribute modifications you can't pass the node as a reference!!

Parameters:

atkNode	$node:
array	$record:
string	$mode:
	$excludes:
	$includes:

[ Top ]