Class PimPluginSetup

Abstract class for contenido setup operations When creating install, uninstall, update you must extend this class.

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.php

Methods summary
`public`	# `addArchiveObject( mixed $extractor )`
`public boolean`	# `checkValidXml( )` Checks xml file to valid Checks xml file to valid Returns `boolean` Throws `cException`
`public`	# `checkRequirements( )` Checks plugin specific requirements Checks plugin specific requirements
`private`	# `getRequirementsError( errorMessage $errorMessage )` Get error template for requirements (checkRequirements()) Get error template for requirements (checkRequirements()) Parameters `$errorMessage` `errorMessage` Specific error message string
`public content`	# `getTempXml( )` Get method for $tempXml Get method for $tempXml Returns `content` of $tempXml
`public true`	# `getValid( )` Get method for $valid Get method for $valid Returns `true` or fales value of $valid
`public id`	# `getPluginId( )` Get method for $pluginId Get method for $pluginId Returns `id` of selected plugin
`public`	# `getIsUpdate( )` Get method for "is update?" ($isUpdate) Get method for "is update?" ($isUpdate) 0 = No (Standard) 1 = Yes TODO: Optimize this function (CON-1358)
`public`	# `setIsUpdate( integer $value )` Set method for "is update?" ($isUpdate) Set method for "is update?" ($isUpdate) 0 = No (Standard) 1 = Yes TODO: Optimize this function (CON-1358) Parameters `$value` `integer` $value
`public`	# `setTempXml( mixed $value )` Set method for $tempXml Set method for $tempXml Parameters `$value` `mixed` $value xml content
`public`	# `setIsExtracted( mixed $value )` Set method for $isExtracted Set method for $isExtracted Parameters `$value` `mixed` $value true or false value
`public`	# `setExtractedPath( mixed $value )` Set method for $extractedPath Set method for $extractedPath Parameters `$value` `mixed` $value path to extracted files
`public`	# `setPluginId( mixed $value )` Set method for $pluginId Set method for $pluginId Parameters `$value` `mixed` $value id of selected plugin
`public`	# `install( mixed $tempXml )` Install a new plugin Install a new plugin Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddArea( mixed $tempXml )` Add entries at _area Add entries at _area Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddActions( mixed $tempXml )` Add entries at _actions Add entries at _actions Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddFrames( mixed $tempXml )` Add entries at _files and _frame_files Add entries at _files and _frame_files Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddNavMain( mixed $tempXml )` Add entries at _nav_main Add entries at _nav_main Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddNavSub( mixed $tempXml )` Add entries at _nav_sub Add entries at _nav_sub Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddSpecificSql( )` Add specific sql queries Add specific sql queries
`protected`	# `_installAddContentTypes( mixed $tempXml )` Add content types (_type) Add content types (_type) Parameters `$tempXml` `mixed` $tempXml temporary plugin definitions
`protected`	# `_installAddModules( mixed $tempXml )` Add modules Add modules
`public`	# `uninstall( mixed $pluginId, mixed $page = null, mixed $sql = true )` Uninstall a plugin Uninstall a plugin TODO: Optimize sql method for update plugins (CON-1358) Parameters `$pluginId` `mixed` $pluginId id of uninstall plugid `$page` `mixed` $page page class for success message `$sql` `mixed` $sql true or false
`protected`	# `_uninstallFullDeleteSpecificSql( mixed $foldername )` Delete specific sql entries or tables, full uninstall mode Delete specific sql entries or tables, full uninstall mode Parameters `$foldername` `mixed` $foldername foldername of installed plugin
`protected`	# `_uninstallUpdateDeleteSpecificSql( mixed $foldername )` Delete specific sql entries or tables, update uninstall mode Delete specific sql entries or tables, update uninstall mode TODO: Optimize this function (CON-1358) Parameters `$foldername` `mixed` $foldername foldername of installed plugin
`public`	# `uninstallDir( mixed $foldername, mixed $page = null )` Delete a installed plugin directory Delete a installed plugin directory Parameters `$foldername` `mixed` $foldername name of extracted plugin `$page` `mixed` $page page class for success or error message
`public`	# `changeActiveStatus( integer $pluginId, mixed $page = null )` Enable / disable plugins (active status) Enable / disable plugins (active status) Parameters `$pluginId` `integer` $pluginId `$page` `mixed` $page page class for success or error message
`protected true`	# `_setNavSubOnlineStatus( integer $idnavs, integer $online )` Set the online status of nav_sub Set the online status of nav_sub Parameters `$idnavs` `integer` $idnavs Id of nav_sub menu (is equivalent to idnavs `$online` `integer` $online 0 = offline, 1 = online Returns `true`
`public`	# `checkSamePlugin( integer $pluginId = '0' )` Check uuId for update routine Check uuId for update routine Parameters `$pluginId` `integer` $pluginId id of installed plugid
`public`	# `checkZip( )` Check file type, Plugin Manager accepts only Zip archives Check file type, Plugin Manager accepts only Zip archives
`protected`	# `errorArea( string $area )` Error message function for not existing areas Error message function for not existing areas Parameters `$area` `string` $area name of not existing area

Properties summary
`protected string`	`$sqlPrefix`	`"!PREFIX!"`	#
`protected boolean`	`$valid`	`false`	#
`protected mixed`	`$tempXml`		#
`protected boolean`	`$isExtracted`	`false`	#
`protected mixed`	`$extractedPath`		#
`protected integer`	`$pluginId`	`0`	#
`protected array`	`$allAreas`	`array()`	#
`protected integer`	`$isUpdate`	`0`	#
`protected mixed`	`$_extractor`		#

Packages

Classes

Functions

Class PimPluginSetup

Returns

Throws

Parameters

Returns

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters