Class PimPluginSetup

Standard class for Plugin Manager (PIM)

Direct known subclasses

PimPluginSetupInstall, PimPluginSetupStatus, PimPluginSetupUninstall, PimPluginSetupUpdate

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 static`	# `setMode( string $mode )` Set method for installation / update mode Mode 1: Plugin is already extracted Mode 2: Plugin is uploaded Set method for installation / update mode Mode 1: Plugin is already extracted Mode 2: Plugin is uploaded Parameters `$mode` `string` $mode
`public`	# `setPageClass( cGuiPage $page )` Set method for cGuiPage class Set method for cGuiPage class Parameters `$page` `cGuiPage` $page
`protected`	# `_setUpdateSqlFileExist( boolean $value )` Set method to change updateSqlFileExist variable Set method to change updateSqlFileExist variable Parameters `$value` `boolean` $value
`protected static PimPluginArchiveExtractor`	# `_setPimPluginArchiveExtractor( string $tempArchiveNewPath, string $tempArchiveName )` Initialzing and set variable for PimPluginArchiveExtractor class Initialzing and set variable for PimPluginArchiveExtractor class Parameters `$tempArchiveNewPath` `string` $tempArchiveNewPath Path to Zip archive `$tempArchiveName` `string` $tempArchiveName Name of Zip archive Returns `PimPluginArchiveExtractor`
`private`	# `_setXml( string $xml )` Set temporary xml content to static variables Set temporary xml content to static variables Parameters `$xml` `string` $xml
`public integer`	# `setPluginId( integer $pluginId = 0 )` Set method for PluginId Set method for PluginId Parameters `$pluginId` `integer` $pluginId Returns `integer`
`public string`	# `setPluginName( string $pluginName = '' )` Set method for PluginName Set method for PluginName Parameters `$pluginName` `string` $pluginName Returns `string`
`public static integer`	# `getMode( )` Get method for installation / update mode Get method for installation / update mode Returns `integer`
`protected static integer`	# `_getPluginId( )` Get method for PluginId Get method for PluginId Returns `integer`
`protected static string`	# `_getPluginName( )` Get methos for PluginName Get methos for PluginName Returns `string`
`protected boolean`	# `_getUpdateSqlFileExist( )` Set method for updateSqlFileExist variable Set method for updateSqlFileExist variable Returns `boolean`
`public`	# `checkXml( )` checkXml Load plugin datas and run Xml checks checkXml Load plugin datas and run Xml checks
`public boolean`	# `checkDependencies( )` Check dependencies to other plugins (dependencies-Tag at plugin.xml) Global function for uninstall and status mode Install mode uses an own dependencies function Check dependencies to other plugins (dependencies-Tag at plugin.xml) Global function for uninstall and status mode Install mode uses an own dependencies function Returns `boolean`
`private`	# `checkZip( )` Check file type, Plugin Manager accepts only Zip archives Check file type, Plugin Manager accepts only Zip archives
`private boolean`	# `validXml( string $xml )` Validate Xml source Validate Xml source Parameters `$xml` `string` $xml Returns `boolean`
`protected static`	# `error( string $message = '' )` Error function with pim_error-Template Error function with pim_error-Template Parameters `$message` `string` $message
`protected static`	# `info( string $message = '' )` Info function, used displayOk CONTENIDO method Info function, used displayOk CONTENIDO method Parameters `$message` `string` $message

Constants summary
`string`	`PLUGIN_XML_FILENAME`	`"plugin.xml"`	#
`string`	`SQL_PREFIX`	`"!PREFIX!"`	#

Properties summary
`public static integer`	`$mode`	`0`	#
`protected static mixed`	`$_GuiPage`		#
`protected static mixed`	`$_PimPluginArchiveExtractor`		#
`private static boolean`	`$_updateSqlFileExist`	`false`	# Help variable. If this variable is true PIM does not run uninstall and install sql file. Standard value: false (update sql file does not exist) Help variable. If this variable is true PIM does not run uninstall and install sql file. Standard value: false (update sql file does not exist)
`public static mixed`	`$XmlGeneral`		#
`public static mixed`	`$XmlRequirements`		#
`public static mixed`	`$XmlDependencies`		#
`public static mixed`	`$XmlArea`		#
`public static mixed`	`$XmlActions`		#
`public static mixed`	`$XmlFrames`		#
`public static mixed`	`$XmlNavMain`		#
`public static mixed`	`$XmlNavSub`		#
`public static mixed`	`$XmlContentType`		#
`protected static integer`	`$_pluginId`	`0`	#
`protected static mixed`	`$_pluginName`		#

Packages

Classes

Class PimPluginSetup

Direct known subclasses

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Parameters