Class PimPluginSetupInstall

Install class for new plugins, extends PimPluginSetup

PimPluginSetupInstall

Package: PluginManager
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: frederic.schneider
Located at plugins/pim/classes/setup/class.pimpluginsetup.install.php

Methods summary
`private string`	# `_setPluginFoldername( string $foldername )` Set variable for plugin foldername Set variable for plugin foldername Parameters `$foldername` `string` $foldername Returns `string`
`private PimPluginCollection`	# `_setPimPluginCollection( )` Initializing and set variable for PimPluginCollection class Initializing and set variable for PimPluginCollection class Returns `PimPluginCollection`
`private PimPluginRelationsCollection`	# `_setPimPluginRelationsCollection( )` Initializing and set variable for PimPluginRelationsCollection class Initializing and set variable for PimPluginRelationsCollection class Returns `PimPluginRelationsCollection`
`private cApiAreaCollection`	# `_setApiAreaCollection( )` Initializing and set variable for cApiAreaCollection Initializing and set variable for cApiAreaCollection Returns `cApiAreaCollection`
`private cApiActionCollection`	# `_setApiActionCollection( )` Initializing and set variable for cApiActionCollection Initializing and set variable for cApiActionCollection Returns `cApiActionCollection`
`private cApiFileCollection`	# `_setApiFileCollection( )` Initializing and set variable for cApiAFileCollection Initializing and set variable for cApiAFileCollection Returns `cApiFileCollection`
`private cApiFrameFileCollection`	# `_setApiFrameFileCollection( )` Initializing and set variable for cApiFrameFileCollection Initializing and set variable for cApiFrameFileCollection Returns `cApiFrameFileCollection`
`private cApiNavMainCollection`	# `_setApiNavMainCollection( )` Initializing and set variable for cApiNavMainFileCollection Initializing and set variable for cApiNavMainFileCollection Returns `cApiNavMainCollection`
`private cApiNavSubCollection`	# `_setApiNavSubCollection( )` Initializing and set variable for cApiNavSubCollection Initializing and set variable for cApiNavSubCollection Returns `cApiNavSubCollection`
`private cApiTypeCollection`	# `_setApiTypeCollection( )` Initializing and set variable for cApiTypeCollection Initializing and set variable for cApiTypeCollection Returns `cApiTypeCollection`
`protected string`	# `_getPluginFoldername( )` Get method for foldername of installed plugin Get method for foldername of installed plugin Returns `string`
`protected array`	# `_getInstalledAreas( )` Get method for installed areas Get method for installed areas Returns `array`
`protected boolean\|integer`	# `_getNavMainId( string $navm = '' )` Get id of nav_main entry Get id of nav_main entry Parameters `$navm` `string` $navm Returns `boolean\|integer` Throws `cDbException` `cException`
`public`	# `__construct( )` Construct function Construct function
`public`	# `install( )` Installation method Installation method Throws `cException`
`private`	# `_installCheckUuid( )` Check uuId: You can install a plugin only for one time Check uuId: You can install a plugin only for one time Throws `cException`
`private`	# `_installCheckRequirements( )` This function checks requirements for one plugin This function checks requirements for one plugin Throws `cException`
`private`	# `_installCheckDependencies( )` Check dependencies to other plugins (dependencies-Tag at plugin.xml) Check dependencies to other plugins (dependencies-Tag at plugin.xml) Throws `cException` `cInvalidArgumentException`
`private`	# `_installAddPlugin( )` Add entries at _plugins Add entries at _plugins Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installFillAreas( )` Get all area names from database Get all area names from database Throws `cDbException` `cException`
`private`	# `_installAddAreas( )` Add entries at _area Add entries at _area Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installAddActions( )` Add entries at _actions Add entries at _actions Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installAddFrames( )` Add entries at _frame_files and _files Add entries at _frame_files and _files Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installAddNavMain( )` Add entries at _nav_main Add entries at _nav_main Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installAddNavSub( )` Add entries at _nav_sub Add entries at _nav_sub Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installAddSpecificSql( )` Add specific sql queries Add specific sql queries Throws `cDbException` `cInvalidArgumentException`
`private`	# `_installAddContentTypes( )` Add content types (_type) Add content types (_type) Throws `cDbException` `cException` `cInvalidArgumentException`
`private boolean`	# `_installAddModules( )` Add modules Add modules Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`private`	# `_installAddDir( )` Add plugin dir Add plugin dir Throws `cInvalidArgumentException`

Methods inherited from PimPluginSetup
`_getPluginId(), _getPluginName(), _getUpdateSqlFileExist(), _setPimPluginArchiveExtractor(), _setUpdateSqlFileExist(), checkDependencies(), checkXml(), error(), getMode(), info(), setMode(), setPageClass(), setPluginId(), setPluginName()`

Constants inherited from PimPluginSetup
`PLUGIN_XML_FILENAME, SQL_PREFIX`

Properties summary
`private mixed`	`$PluginFoldername`		#
`private array`	`$PluginInstalledAreas`	`array()`	#
`protected PimPluginCollection`	`$_PimPluginCollection`		#
`protected PimPluginRelationsCollection`	`$_PimPluginRelationsCollection`		#
`protected cApiAreaCollection`	`$_ApiAreaCollection`		#
`protected cApiActionCollection`	`$_ApiActionCollection`		#
`protected cApiFileCollection`	`$_ApiFileCollection`		#
`protected cApiFrameFileCollection`	`$_ApiFrameFileCollection`		#
`protected cApiNavMainCollection`	`$_ApiNavMainCollection`		#
`protected cApiNavSubCollection`	`$_ApiNavSubCollection`		#
`protected cApiTypeCollection`	`$_ApiTypeCollection`		#

Properties inherited from PimPluginSetup
`$XmlActions, $XmlArea, $XmlContentType, $XmlDependencies, $XmlFrames, $XmlGeneral, $XmlNavMain, $XmlNavSub, $XmlRequirements, $_GuiPage, $_PimPluginArchiveExtractor, $_pluginId, $_pluginName, $mode`

Packages

Classes

Class PimPluginSetupInstall

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Returns

Throws

Throws