Overview

Packages

  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Datatype
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
  • 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

Classes

  • cUpgradeJob_0001
  • cUpgradeJob_0002
  • cUpgradeJob_0003
  • cUpgradeJob_0004
  • cUpgradeJob_0005
  • cUpgradeJob_0006
  • cUpgradeJob_0007
  • cUpgradeJob_0008
  • cUpgradeJob_0009
  • cUpgradeJob_0010
  • cUpgradeJob_0011
  • cUpgradeJob_0012
  • cUpgradeJob_0013
  • cUpgradeJobAbstract
  • cUpgradeJobMain
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class cUpgradeJobAbstract

Abstract upgrade job class.

Direct known subclasses

cUpgradeJob_0001, cUpgradeJob_0002, cUpgradeJob_0011, cUpgradeJob_0012, cUpgradeJob_0013, cUpgradeJobMain, cUpgradeJob_0003, cUpgradeJob_0004, cUpgradeJob_0005, cUpgradeJob_0006, cUpgradeJob_0007, cUpgradeJob_0008, cUpgradeJob_0009, cUpgradeJob_0010
Abstract
Package: Setup\UpgradeJob
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Murat Purc <murat@purc.de>
Located at upgrade_jobs/class.upgrade.job.abstract.php
Methods summary
public
# __construct( cDb $db, array $cfg, array $cfgClient, string $version )

Constructor, sets some properties

Constructor, sets some properties

Parameters

$db
cDb
$db
$cfg
array
$cfg Main configuration array
$cfgClient
array
$cfgClient Clients configuration array
$version
string
$version The CONTENIDO version which is upgraded
final public
# execute( )

This function will perform the version check and execute the job if it succeeds.

This function will perform the version check and execute the job if it succeeds.

Do not override this.

abstract public
# _execute( )

Main function for each upgrade job. Each upgrade job has to implement this!

Main function for each upgrade job. Each upgrade job has to implement this!

protected cApiClient[]
# _getAllClients( )

Returns list of all available clients

Returns list of all available clients

Returns

cApiClient[]
protected cApiLanguage[]
# _getAllLanguages( )

Returns list of all available languages

Returns list of all available languages

Returns

cApiLanguage[]
protected
# _logError( string $errorMsg )

Logs passed setup error, wrapper for logSetupFailure() function

Logs passed setup error, wrapper for logSetupFailure() function

Parameters

$errorMsg
string
$errorMsg
Properties summary
protected cDb $_oDb
#
protected array $_aCfg
#
protected string $_setupType
#
protected string $_version
#
protected static cApiClient[] $_clients
#
protected static cApiLanguage[] $_languages
#
protected static string $_rootPath
#
protected static string $_rootHttpPath
#
public string $maxVersion "0"
#

This must be set. 0 means this upgrade job will be executed every time. Anyhting else should be a valid CONTENIDO version. Only if the upgraded version is older than this string the job will be executed.

This must be set. 0 means this upgrade job will be executed every time. Anyhting else should be a valid CONTENIDO version. Only if the upgraded version is older than this string the job will be executed.

Setting this to '4.8.18' would mean that any version lower than 4.8.18 will get the upgrade job.

CMS CONTENIDO 4.9.3 API documentation generated by ApiGen 2.8.0