Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • PimPlugin
  • PimPluginArchiveExtractor
  • PimPluginCollection
  • PimPluginRelations
  • PimPluginRelationsCollection
  • PimPluginSetup
  • PimPluginSetupInstall
  • PimPluginSetupStatus
  • PimPluginSetupUninstall
  • PimPluginSetupUpdate
  • PimPluginViewDependencies
  • PimPluginViewNavSub
  • Overview
  • Package
  • Class
  • Todo
  • Download

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
public
# setPageClass( cGuiPage $page )

Set method for cGuiPage class

Set method for cGuiPage class

Parameters

$page
protected
# _setUpdateSqlFileExist( boolean $value )

Set method to change updateSqlFileExist variable

Set method to change updateSqlFileExist variable

Parameters

$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
Path to Zip archive
$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
public integer
# setPluginId( integer $pluginId = 0 )

Set method for PluginId

Set method for PluginId

Parameters

$pluginId

Returns

integer
public string
# setPluginName( string $pluginName = '' )

Set method for PluginName

Set method for PluginName

Parameters

$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

Returns

boolean
protected static
# error( string $message = '' )

Error function with pim_error-Template

Error function with pim_error-Template

Parameters

$message
protected static
# info( string $message = '' )

Info function

Info function

Parameters

$message
Constants summary
string PLUGIN_XML_FILENAME
# "plugin.xml"
string SQL_PREFIX
# "!PREFIX!"
Properties summary
public static integer $mode
# 0
protected static $_GuiPage
#
protected static $_PimPluginArchiveExtractor
#
private static boolean $_updateSqlFileExist

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)
# false
public static $XmlGeneral
#
public static $XmlRequirements
#
public static $XmlDependencies
#
public static $XmlArea
#
public static $XmlActions
#
public static $XmlFrames
#
public static $XmlNavMain
#
public static $XmlNavSub
#
public static $XmlContentType
#
protected static integer $_pluginId
# 0
protected static $_pluginName
#
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen