ModuleLibraryJoin Class Reference

Inheritance diagram for ModuleLibraryJoin:

Public Member Functions
	__construct (&$module, $params=array())
&	get_newObject ($id=0)
	get_item1ListForItem2 ($id)
	get_item2ListForItem1 ($id)
	get_item1ListForItem2List ($ids)
	get_item2ListForItem1List ($ids)
	save_item1ListForItem2 ($id, $list)
	save_item2ListForItem1 ($id, $list)
	_save_itemJoinedList ($target, $list, $given, $id)
Public Member Functions inherited from ModuleLibrary
	__construct ($id, &$module, $wf_version=false)
	ModuleLibrary ($id, &$module, $wf_version=false)
	init_library ()
	initialise ()
	get ($language=true)
	get_fromHeader ($prefix='')
	save ()
	delete ()
	reset ()
	install ()
	uninstall ()
	is_installed ()
	is_marked ()
	get_databaseItems ()
	save_databaseItems ()
	delete_databaseItems ()
	reset_databaseItems ()
	install_databaseItems ()
	uninstall_databaseItems ()
	check_databaseInstallation ()
	get_objectList_databaseItemsSQLQuery ($where='', $limit=-1, $count=-1, $order='id', $sens='')
	update_databaseSpecificItems ($updatedItems)
	get_databaseLocalisedItems ()
	save_databaseLocalisedItems ()
	delete_databaseLocalisedItems ()
	reset_databaseLocalisedItems ()
	install_databaseLocalisedItems ()
	get_objectList_databaseLocalisedItemsSQLQuery ($ids)
	get_allDatabaseItems ($language)
	get_objectList_allDatabaseItemsSQLQuery ($language, $where='', $limit=-1, $count=-1, $order='id', $sens='')
	get_textItems ($language=null)
	save_textItems ()
	delete_textItems ()
	reset_textItems ()
	install_textItems ()
	get_fileItems ($language=null)
	save_fileItems ()
	delete_fileItems ()
	reset_fileItems ()
	install_fileItems ()
	get_tempItems ()
	get_fromArray ($data, $match=null, $onlyAvailable=false)
	get_fromItems ()
	check_data ()
	load_fromSession ($name='ObjectData', $onlyAvailable=false)
	save_toSession ($name='ObjectData')
	delete_fromSession ($name='ObjectData')
	get_fileURL ($file, $full=true, $default='')
	load_file ($file)
	get_varFileURL ($file, $full=true, $default='')
	load_varFile ($file)
	get_translation ($str, $args=null)
	build_SQLCondition ($params)
	get_objectList ($language=false, $where='', $limit=-1, $count=-1, $order='id', $sens='')
	get_objectIdList ($language=false, $where='', $orderBy='', $orderWay='asc')
	get_nameList ($element='name', $where='', $language='', $orderBy='', $orderWay='asc')
	get_objectCount ($where='', $language=false)
	get_uniqueItemList ($element='name', $where='', $structured=false)
	execute_DBQuery ($sql='', $line=-1, $file='', $resName=null)
	execute_DBMultiQueries ($sql='', $line=-1, $file='', $resName=null)
	get_DBQueryGeneratedId ($resName=null)
	get_DBQueryDataLine ($resName=null)
	get_DBQueryNumDataLine ($resName=null)
	get_DBQueryError ($resName=null)
	get_DBQueryAffectedRows ($resName=null)
	escape_string ($string)
	get_DBInsertExtra ()
	create_DBTable ($name, $fields, $charset='utf8')

Private Member Functions
	_get_itemJoinedList ($target, $given, $id)
	_get_itemJoinedLists ($target, $given, $ids)

Private Attributes
	$_initParams
	Initial parameters. More...

Additional Inherited Members
Public Attributes inherited from ModuleLibrary
	$object_type = 'ModuleLibrary'
	Object type. More...
	$_libName
	Object name. More...
	$_libParent
	Parent module. More...
	$_libItems = array()
	Object item list. More...
	$_libItemTypes = array('db' => array(), 'dbl' => array(), 'text' => array(), 'file' => array(), 'temp' => array())
	Object item list by type. More...
	$_libSQLTable
	Object table name in database. More...
	$_libSQLLocaleTable
	$_libDesc
	Library description. More...
	$_libError
	Last error. More...
	$_libIsInstalled = null
	$id
	Object instance id. More...
	$vars = array()
	Object item values. More...
Protected Member Functions inherited from ModuleLibrary
	add_newItem ($name, $itemtype, $info0, $info1, $info2, $default=null, $localised=false)
	insert_multiObjectsDatabaseItems ($keys, $values)
	check_SQLCondition ($where, $localeOnly=false)
	build_SQLOrderByStatement ($order, $way='')
Protected Attributes inherited from ModuleLibrary
	$_libParentFile
	Object library file. More...
	$_libDBConnector
	Database connection. More...

Detailed Description

ModuleLibraryJoin class.

Constructor & Destructor Documentation

__construct()

ModuleLibraryJoin::__construct	(	&	$module,
			$params = array()
	)

Class constructor.

Parameters

Module	$module
array	$params

Returns

void

Member Function Documentation

get_newObject()

& ModuleLibraryJoin::get_newObject

(

$id = 0

)

Return a new object.

Parameters

integer

$id

Returns

Object

Reimplemented from ModuleLibrary.

get_item1ListForItem2()

ModuleLibraryJoin::get_item1ListForItem2

(

$id

)

Return item1 id list for given item2

Parameters

integer

$id

Returns

array

get_item2ListForItem1()

ModuleLibraryJoin::get_item2ListForItem1

(

$id

)

Return item2 id list for given item1.

Parameters

integer

$id

Returns

array

get_item1ListForItem2List()

ModuleLibraryJoin::get_item1ListForItem2List

(

$ids

)

Return item1 id list for given item2 id list.

Parameters

array

$ids

Returns

array

get_item2ListForItem1List()

ModuleLibraryJoin::get_item2ListForItem1List

(

$ids

)

Return item2 id list for given item1 id list.

Parameters

array

$ids

Returns

array

save_item1ListForItem2()

ModuleLibraryJoin::save_item1ListForItem2	(		$id,
			$list
	)

Save item1 id list for given item2.

Parameters

integer	$id
array	$list

Returns

boolean success

save_item2ListForItem1()

ModuleLibraryJoin::save_item2ListForItem1	(		$id,
			$list
	)

Save item2 id list for given item1.

Parameters

integer	$id
array	$list

Returns

boolean success

_get_itemJoinedList()

ModuleLibraryJoin::_get_itemJoinedList (   $target,   $given,   $id  )

private

Return item joined list.

Parameters

string	$target
string	$given
integer	$id

Returns

array

_get_itemJoinedLists()

ModuleLibraryJoin::_get_itemJoinedLists (   $target,   $given,   $ids  )

private

Return item joined lists.

Parameters

string	$target
string	$given
array	$ids

Returns

array

_save_itemJoinedList()

ModuleLibraryJoin::_save_itemJoinedList	(		$target,
			$list,
			$given,
			$id
	)

Save item joined list.

Parameters

string	$target
array	$list
string	$given
integer	$id

Returns

boolean success

Member Data Documentation

$_initParams

array ModuleLibraryJoin::$_initParams

private

Initial value:

= array(
        'item1' => 'item1',
        'item2' => 'item2',
    )

Initial parameters.

---

The documentation for this class was generated from the following file:

• CaMykS/engine/lib/object/ModuleLibraryJoin.php.inc