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 cGuiPage`	# `setPageClass( cGuiPage $page )` Set method for cGuiPage class Set method for cGuiPage class Parameters `$page` `cGuiPage` $page Returns `cGuiPage`
`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( SimpleXMLElement $xml )` Set temporary xml content to static variables Set temporary xml content to static variables Parameters `$xml` `SimpleXMLElement` $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 Throws `cException`
`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` Throws `cInvalidArgumentException`
`private`	# `checkZip( )` Check file type, Plugin Manager accepts only Zip archives Check file type, Plugin Manager accepts only Zip archives Throws `cException`
`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 Throws `cException` `cInvalidArgumentException`
`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"`	# File name of Xml configuration file for plugins File name of Xml configuration file for plugins
`string`	`SQL_PREFIX`	`"!PREFIX!"`	# Specific sql prefix Specific sql prefix

Properties summary
`public static integer`	`$mode`	`0`	# Initializing variables Variable for installation / update mode: Extracted or uploaded file? Initializing variables Variable for installation / update mode: Extracted or uploaded file?
`protected static cGuiPage`	`$_GuiPage`		#
`protected static PimPluginArchiveExtractor`	`$_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 SimpleXMLElement`	`$XmlGeneral`		# Xml variables General informations of plugin Xml variables General informations of plugin
`public static SimpleXMLElement`	`$XmlRequirements`		# Plugin requirements Plugin requirements
`public static SimpleXMLElement`	`$XmlDependencies`		# Plugin dependencies Plugin dependencies
`public static SimpleXMLElement`	`$XmlArea`		# CONTENIDO areas: _area CONTENIDO areas: _area
`public static SimpleXMLElement`	`$XmlActions`		# CONTENIDO actions: _actions CONTENIDO actions: _actions
`public static SimpleXMLElement`	`$XmlFrames`		# CONTENIDO frames: _frame_files and _files CONTENIDO frames: _frame_files and _files
`public static SimpleXMLElement`	`$XmlNavMain`		# CONTENIDO main navigations: _nav_main CONTENIDO main navigations: _nav_main
`public static SimpleXMLElement`	`$XmlNavSub`		# CONTENIDO sub navigations: _nav_sub CONTENIDO sub navigations: _nav_sub
`public static SimpleXMLElement`	`$XmlContentType`		# CONTENIDO content types: _type CONTENIDO content types: _type
`protected static integer`	`$_pluginId`	`0`	# Id of selected/new plugin Id of selected/new plugin
`protected static string`	`$_pluginName`		# Name of selected plugin Name of selected plugin

Packages

Classes

Class PimPluginSetup

Direct known subclasses

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Throws

Returns

Throws

Throws

Parameters

Returns

Parameters

Throws

Parameters