Class

eZStepSiteTypes

class eZStepSiteTypes extends 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
$IndexURL
$XMLIndexURL
$Error
$ErrorMsg
$FileOpenErrorMsg
$Message

Methods

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

Constructor

bool processPostData()

Process POST data.

init()

array display()

Virtual (abstract)

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

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

from eZStepInstaller
array availableSitePackages()

from eZStepInstaller
array extraDataList()

from eZStepInstaller
bool chosenSitePackage()

from eZStepInstaller
array chosenSiteType()

from eZStepInstaller
bool selectSiteType(string $sitePackageName)

from eZStepInstaller
storeSiteType(array $siteType)

from eZStepInstaller
storePersistenceData()

from eZStepInstaller
storeExtraSiteData($siteIdentifier, $dataIdentifier, $value)

from eZStepInstaller
bool extraData(string $dataIdentifier)

from eZStepInstaller
bool extraSiteData(string $siteIdentifier, string $dataIdentifier)

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

from eZStepInstaller
array|bool databaseErrorInfo(array $errorInfo)

from eZStepInstaller
bool hasKickstartData()

from eZStepInstaller
array|bool kickstartData()

from eZStepInstaller
bool isKickstartAllowed()

from eZStepInstaller
bool kickstartContinueNextStep()

from eZStepInstaller
setAllowKickstart($allow)

from eZStepInstaller
array siteaccessURLs()

from eZStepInstaller
downloadFile($url, $outDir, $forcedFileName = false)

Downloads file.

downloadAndImportPackage($packageName, $packageUrl, $forceDownload = false)

Downloads and imports package.

downloadDependantPackages($sitePackage)

uploadPackage()

Upload local package.

createSitePackagesList($remoteSitePackages, $importedSitePackages, $dependenciesStatus)

\private

fetchAvailableSitePackages()

Fetches list of site packages already available locally.

fetchAvailablePackages($type = false)

Fetches list of packages already available locally.

retrieveRemotePackagesList($onlySitePackages = false)

Retrieve list of packages available to download.

retrieveRemoteSitePackagesList()

Retrieve list of site packages available to download.

fopen($fileName, $mode)

Wrapper for standard fopen() doing error checking.

tempDir()

Returns temporary directory used to download files to.

Details

at line 27
public __construct(eZTemplate $tpl, eZHTTPTool $http, eZINI $ini, array $persistenceList)

Constructor

Parameters

eZTemplate $tpl
eZHTTPTool $http
eZINI $ini
array $persistenceList

at line 342
public bool processPostData()

Process POST data.

\reimp

Return Value

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

at line 392
public init()

at line 549
public array display()

Virtual (abstract)

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

Return Value

array

in eZStepInstaller 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

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

Parameters

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

Return Value

array

in eZStepInstaller at line 226
public array availableSitePackages()

Return Value

array

in eZStepInstaller at line 236
public array extraDataList()

Return Value

array

in eZStepInstaller at line 246
public bool chosenSitePackage()

Return Value

bool

in eZStepInstaller at line 259
public array chosenSiteType()

Return Value

array

in eZStepInstaller at line 282
public bool selectSiteType(string $sitePackageName)

Parameters

string $sitePackageName

Return Value

bool

in eZStepInstaller at line 297
public storeSiteType(array $siteType)

Parameters

array $siteType

in eZStepInstaller at line 316
public storePersistenceData()

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

Parameters

$siteIdentifier
$dataIdentifier
$value

in eZStepInstaller at line 335
public bool extraData(string $dataIdentifier)

Parameters

string $dataIdentifier

Return Value

bool

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

Parameters

string $siteIdentifier
string $dataIdentifier

Return Value

bool

in eZStepInstaller 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

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

Parameters

array $errorInfo

Return Value

array|bool

in eZStepInstaller at line 626
public bool hasKickstartData()

Return Value

bool True if the step has kickstart data available.

in eZStepInstaller at line 636
public array|bool kickstartData()

Return Value

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

in eZStepInstaller at line 644
public bool isKickstartAllowed()

Return Value

bool True if kickstart functionality can be used.

in eZStepInstaller at line 660
public bool kickstartContinueNextStep()

Return Value

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

in eZStepInstaller at line 671
public setAllowKickstart($allow)

Parameters

$allow

in eZStepInstaller at line 679
public array siteaccessURLs()

Return Value

array Urls to access user and admin siteaccesses

at line 61
public downloadFile($url, $outDir, $forcedFileName = false)

Downloads file.

Sets $this->ErrorMsg in case of an error.

\private \param $url URL. \param $outDir Directory where to put downloaded file to. \param $forcedFileName Force saving downloaded file under this name. \return false on error, path to downloaded package otherwise.

Parameters

$url
$outDir
$forcedFileName

at line 154
public downloadAndImportPackage($packageName, $packageUrl, $forceDownload = false)

Downloads and imports package.

Sets $this->ErrorMsg in case of an error.

\param $forceDownload download even if this package already exists. \private \return false on error, package object otherwise.

Parameters

$packageName
$packageUrl
$forceDownload

at line 212
public downloadDependantPackages($sitePackage)

Parameters

$sitePackage

at line 291
public uploadPackage()

Upload local package.

\private

at line 487
public createSitePackagesList($remoteSitePackages, $importedSitePackages, $dependenciesStatus)

\private

Parameters

$remoteSitePackages
$importedSitePackages
$dependenciesStatus

at line 607
public fetchAvailableSitePackages()

Fetches list of site packages already available locally.

\private

at line 619
public fetchAvailablePackages($type = false)

Fetches list of packages already available locally.

\private

Parameters

$type

at line 643
public retrieveRemotePackagesList($onlySitePackages = false)

Retrieve list of packages available to download.

Example of return value: array( 'packages' => array( '' => array( "name" =>... , "version" =>... , "summary" => ... "url" =>... ), '' => array( "name" =>... , "version" =>... , "summary" => ... "url" =>... ) ) );

Parameters

$onlySitePackages

at line 720
public retrieveRemoteSitePackagesList()

Retrieve list of site packages available to download.

\private

at line 731
public fopen($fileName, $mode)

Wrapper for standard fopen() doing error checking.

\private \static

Parameters

$fileName
$mode

at line 749
public tempDir()

Returns temporary directory used to download files to.

\static