Tool_InstallerParams Class Reference

Inheritance diagram for Tool_InstallerParams:

Public Member Functions
	__construct ($id, &$module)
	initialise ()
	get_fromItems ()
	initialise_hiddenValues ()
	get_adminThemeList ()
	get_siteThemeList ()
	get_templateList ()
	get_SSLModeList ()
	get_mobileModeList ()
	get_availableLanguages ()
Public Member Functions inherited from ModuleLibrary
	__construct ($id, &$module, $wf_version=false)
	ModuleLibrary ($id, &$module, $wf_version=false)
	init_library ()
	get ($language=true)
	get_fromHeader ($prefix='')
	save ()
	delete ()
	reset ()
	install ()
	uninstall ()
	is_installed ()
	is_marked ()
&	get_newObject ($id=0)
	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)
	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
	load_availableThemes ()
	load_availableTemplates ()

Private Attributes
	$themes
	Available theme list. More...
	$templates
	Available template list. 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

Tool_InstallerParams class.

Constructor & Destructor Documentation

__construct()

Tool_InstallerParams::__construct	(		$id,
		&	$module
	)

Class constructor.

Parameters

integer	$id
Module	$module

Returns

void

Member Function Documentation

initialise()

Tool_InstallerParams::initialise

(

)

Initialise object.

Returns

boolean success

Reimplemented from ModuleLibrary.

get_fromItems()

Tool_InstallerParams::get_fromItems

(

)

Return values from items.

Returns

void

Reimplemented from ModuleLibrary.

initialise_hiddenValues()

Tool_InstallerParams::initialise_hiddenValues

(

)

Initialise hidden values.

Returns

boolean success

get_adminThemeList()

Tool_InstallerParams::get_adminThemeList

(

)

Return admin theme list.

Returns

array

get_siteThemeList()

Tool_InstallerParams::get_siteThemeList

(

)

Return site theme list.

Returns

array

get_templateList()

Tool_InstallerParams::get_templateList

(

)

Return template list.

Returns

array

get_SSLModeList()

Tool_InstallerParams::get_SSLModeList

(

)

Return SSL mode value list.

Returns

array

get_mobileModeList()

Tool_InstallerParams::get_mobileModeList

(

)

Return mobile mode value list.

Returns

array

get_availableLanguages()

Tool_InstallerParams::get_availableLanguages

(

)

Return available languages (with icon).

Returns

array

load_availableThemes()

Tool_InstallerParams::load_availableThemes ( )

private

Load available themes.

Returns

void

load_availableTemplates()

Tool_InstallerParams::load_availableTemplates ( )

private

Load available templates.

Returns

void

Member Data Documentation

$themes

Tool_InstallerParams::$themes

private

Available theme list.

var array $themes

$templates

Tool_InstallerParams::$templates

private

Available template list.

var array $templates

---

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

• CaMykS/plugin/module/Tool_Installer/lib/Tool_InstallerParams.php.inc