Class

eZStepInstaller

class eZStepInstaller

Constants

DB_ERROR_EMPTY_PASSWORD

DB_ERROR_NONMATCH_PASSWORD

DB_ERROR_CONNECTION_FAILED

DB_ERROR_NOT_EMPTY

DB_ERROR_NO_DATABASES

DB_ERROR_NO_DIGEST_PROC

DB_ERROR_VERSION_INVALID

DB_ERROR_CHARSET_DIFFERS

DB_ERROR_ALREADY_CHOSEN

DB_DATA_APPEND

DB_DATA_REMOVE

DB_DATA_KEEP

DB_DATA_CHOOSE

Properties

$Tpl
$Http
$Ini
$PersistenceList
$Identifier
$Name
$INI
$KickstartData

Methods

__construct(eZTemplate $tpl, eZHTTPTool $http, eZINI $ini, array $persistenceList, string $identifier, string $name)

Default constructor for eZ Publish installer classes

bool processPostData()

Processespost data from this class.

init()

array display()

Virtual (abstract)

bool|string findAppropriateCharset(eZLocale $primaryLanguage, eZLocale[]|null $allLanguages, bool $canUseUnicode)

array findAppropriateCharsetsList(eZLocale $primaryLanguage, eZLocale[]|null $allLanguages, bool $canUseUnicode)

array availableSitePackages()

array extraDataList()

bool chosenSitePackage()

array chosenSiteType()

bool selectSiteType(string $sitePackageName)

storeSiteType(array $siteType)

storePersistenceData()

storeExtraSiteData($siteIdentifier, $dataIdentifier, $value)

bool extraData(string $dataIdentifier)

bool extraSiteData(string $siteIdentifier, string $dataIdentifier)

array checkDatabaseRequirements(string|bool $dbCharset = false, array $overrideDBParameters = array())

array|bool databaseErrorInfo(array $errorInfo)

bool hasKickstartData()

array|bool kickstartData()

bool isKickstartAllowed()

bool kickstartContinueNextStep()

setAllowKickstart($allow)

array siteaccessURLs()

Details

at line 43
public __construct(eZTemplate $tpl, eZHTTPTool $http, eZINI $ini, array $persistenceList, string $identifier, string $name)

Default constructor for eZ Publish installer classes

Parameters

eZTemplate $tpl
eZHTTPTool $http
eZINI $ini
array $persistenceList
string $identifier
string $name

at line 78
public bool processPostData()

Processespost data from this class.

Abstract (virtual) method for step classes to use.

Return Value

bool True if post data accepted, or false if post data is rejected.

at line 92
public init()

at line 104
public array display()

Virtual (abstract)

Display information and forms needed to pass this step. return result to use in template.

Return Value

array

at line 116
public bool|string findAppropriateCharset(eZLocale $primaryLanguage, eZLocale[]|null $allLanguages, bool $canUseUnicode)

Parameters

eZLocale $primaryLanguage
eZLocale[]|null $allLanguages
bool $canUseUnicode

Return Value

bool|string

at line 174
public array findAppropriateCharsetsList(eZLocale $primaryLanguage, eZLocale[]|null $allLanguages, bool $canUseUnicode)

Parameters

eZLocale $primaryLanguage
eZLocale[]|null $allLanguages
bool $canUseUnicode

Return Value

array

at line 226
public array availableSitePackages()

Return Value

array

at line 236
public array extraDataList()

Return Value

array

at line 246
public bool chosenSitePackage()

Return Value

bool

at line 259
public array chosenSiteType()

Return Value

array

at line 282
public bool selectSiteType(string $sitePackageName)

Parameters

string $sitePackageName

Return Value

bool

at line 297
public storeSiteType(array $siteType)

Parameters

array $siteType

at line 316
public storePersistenceData()

at line 324
public storeExtraSiteData($siteIdentifier, $dataIdentifier, $value)

Parameters

$siteIdentifier
$dataIdentifier
$value

at line 335
public bool extraData(string $dataIdentifier)

Parameters

string $dataIdentifier

Return Value

bool

at line 347
public bool extraSiteData(string $siteIdentifier, string $dataIdentifier)

Parameters

string $siteIdentifier
string $dataIdentifier

Return Value

bool

at line 359
public array checkDatabaseRequirements(string|bool $dbCharset = false, array $overrideDBParameters = array())

Parameters

string|bool $dbCharset Default charset used if false
array $overrideDBParameters

Return Value

array

at line 526
public array|bool databaseErrorInfo(array $errorInfo)

Parameters

array $errorInfo

Return Value

array|bool

at line 626
public bool hasKickstartData()

Return Value

bool True if the step has kickstart data available.

at line 636
public array|bool kickstartData()

Return Value

array|bool All kickstart data as an associative array or false if no data available

at line 644
public bool isKickstartAllowed()

Return Value

bool True if kickstart functionality can be used.

at line 660
public bool kickstartContinueNextStep()

Return Value

bool True if the kickstart functionality should continue to the next step.

at line 671
public setAllowKickstart($allow)

Parameters

$allow

at line 679
public array siteaccessURLs()

Return Value

array Urls to access user and admin siteaccesses