eZPublish  4.4
eZStepInstaller Class Reference

The class EZStepInstaller provide a framework for eZStep installer classes. More...

+ Inheritance diagram for eZStepInstaller:

Public Member Functions

 availableSitePackages ()
 
 checkDatabaseRequirements ($dbCharset=false, $overrideDBParameters=array())
 
 chosenSitePackage ()
 
 chosenSiteType ()
 
 databaseErrorInfo ($errorInfo)
 
 display ()
 
 extraData ($dataIdentifier)
 
 extraDataList ()
 
 extraSiteData ($siteIdentifier, $dataIdentifier)
 
 eZStepInstaller ($tpl, $http, $ini, &$persistenceList, $identifier, $name)
 
 findAppropriateCharset ($primaryLanguage, $allLanguages, $canUseUnicode)
 
 findAppropriateCharsetsList ($primaryLanguage, $allLanguages, $canUseUnicode)
 
 hasKickstartData ()
 
 init ()
 
 isKickstartAllowed ()
 
 kickstartContinueNextStep ()
 
 kickstartData ()
 
 processPostData ()
 
 selectSiteType ($sitePackageName)
 
 setAllowKickstart ($allow)
 
 siteaccessURLs ()
 
 storeExtraSiteData ($siteIdentifier, $dataIdentifier, $value)
 
 storePersistenceData ()
 
 storeSiteType ($siteType)
 

Public Attributes

 $Http
 
 $Identifier
 
 $Ini
 
 $INI
 Kickstart INI file, if one is found. More...
 
 $KickstartData
 The kickstart data as an associative array or false if no data available. More...
 
 $Name
 
 $PersistenceList
 
 $Tpl
 
const DB_DATA_APPEND = 1
 
const DB_DATA_CHOOSE = 4
 
const DB_DATA_KEEP = 3
 
const DB_DATA_REMOVE = 2
 
const DB_ERROR_ALREADY_CHOSEN = 10
 
const DB_ERROR_CHARSET_DIFFERS = 8
 
const DB_ERROR_CONNECTION_FAILED = 3
 
const DB_ERROR_EMPTY_PASSWORD = 1
 
const DB_ERROR_NO_DATABASES = 5
 
const DB_ERROR_NO_DIGEST_PROC = 6
 
const DB_ERROR_NONMATCH_PASSWORD = 2
 
const DB_ERROR_NOT_EMPTY = 4
 
const DB_ERROR_VERSION_INVALID = 7
 

Detailed Description

The class EZStepInstaller provide a framework for eZStep installer classes.

Member Function Documentation

eZStepInstaller::availableSitePackages ( )
eZStepInstaller::checkDatabaseRequirements (   $dbCharset = false,
  $overrideDBParameters = array() 
)
eZStepInstaller::databaseErrorInfo (   $errorInfo)
eZStepInstaller::display ( )

Display information and forms needed to pass this step.

Returns
result to use in template
eZStepInstaller::extraData (   $dataIdentifier)
eZStepInstaller::extraDataList ( )

Referenced by chosenSiteType(), and storeSiteType().

eZStepInstaller::extraSiteData (   $siteIdentifier,
  $dataIdentifier 
)
eZStepInstaller::findAppropriateCharset (   $primaryLanguage,
  $allLanguages,
  $canUseUnicode 
)
eZStepInstaller::findAppropriateCharsetsList (   $primaryLanguage,
  $allLanguages,
  $canUseUnicode 
)
eZStepInstaller::init ( )

Performs test needed by this class.

This class may access class variables to store data needed for viewing if output failed

Returns
true if all tests passed and continue with next default step, number of next step if all tests passed and next step is "hard coded", false if tests failed
eZStepInstaller::isKickstartAllowed ( )
Returns
true if kickstart functionality can be used.

Referenced by hasKickstartData().

eZStepInstaller::processPostData ( )

Processespost data from this class.

Returns
true if post data accepted, or false if post data is rejected.
eZStepInstaller::selectSiteType (   $sitePackageName)
eZStepInstaller::setAllowKickstart (   $allow)

Sets whether kickstart data can be checked or not.

Referenced by eZStepCreateSites\init().

eZStepInstaller::siteaccessURLs ( )
Returns
Urls to access user and admin siteaccesses

Referenced by eZStepFinal\display(), and eZStepCreateSites\initializePackage().

eZStepInstaller::storeExtraSiteData (   $siteIdentifier,
  $dataIdentifier,
  $value 
)
eZStepInstaller::storePersistenceData ( )

Member Data Documentation

eZStepInstaller::$Http
eZStepInstaller::$Identifier

Referenced by isKickstartAllowed().

eZStepInstaller::$Ini
eZStepInstaller::$INI

Kickstart INI file, if one is found.

eZStepInstaller::$KickstartData

The kickstart data as an associative array or false if no data available.

Referenced by kickstartData().

eZStepInstaller::$Name
eZStepInstaller::$PersistenceList
eZStepInstaller::$Tpl
const eZStepInstaller::DB_DATA_APPEND = 1
const eZStepInstaller::DB_DATA_CHOOSE = 4
const eZStepInstaller::DB_DATA_KEEP = 3
const eZStepInstaller::DB_DATA_REMOVE = 2
const eZStepInstaller::DB_ERROR_ALREADY_CHOSEN = 10
const eZStepInstaller::DB_ERROR_CHARSET_DIFFERS = 8
const eZStepInstaller::DB_ERROR_CONNECTION_FAILED = 3
const eZStepInstaller::DB_ERROR_EMPTY_PASSWORD = 1
const eZStepInstaller::DB_ERROR_NO_DATABASES = 5
const eZStepInstaller::DB_ERROR_NO_DIGEST_PROC = 6
const eZStepInstaller::DB_ERROR_NONMATCH_PASSWORD = 2
const eZStepInstaller::DB_ERROR_NOT_EMPTY = 4
const eZStepInstaller::DB_ERROR_VERSION_INVALID = 7

The documentation for this class was generated from the following file: