eZPublish  3.8
eZStepSiteTypes Class Reference

The class eZStepSiteTypes does. More...

+ Inheritance diagram for eZStepSiteTypes:
+ Collaboration diagram for eZStepSiteTypes:

Public Member Functions

display ()
 
 eZStepSiteTypes (&$tpl, &$http, &$ini, &$persistenceList)
 
 init ()
 
 processPostData ()
 Process POST data. More...
 
 retrieveRemotePackagesList ($onlySitePackages=false)
 Retrieve list of packages available to download. More...
 
- Public Member Functions inherited from eZStepInstaller
 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)
 
 storeExtraSiteData ($siteIdentifier, $dataIdentifier, $value)
 
 storePersistenceData ()
 
 storeSiteType ($siteType)
 

Static Public Member Functions

 tempDir ()
 Returns temporary directory used to download files to. More...
 

Public Attributes

 $Error = 0
 
 $ErrorMsg = false
 
 $FileOpenErrorMsg = false
 
 $IndexURL
 
 $Message = false
 
 $XMLIndexURL
 
- Public Attributes inherited from eZStepInstaller
 $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
 

Private Member Functions

 createSitePackagesList ($remoteSitePackages, $importedSitePackages, $dependenciesStatus)
 
 downloadAndImportPackage ($packageName, $packageUrl, $forceDownload=false)
 Downloads and imports package. More...
 
 downloadDependantPackages ($sitePackage)
 
 downloadFile ($url, $outDir, $forcedFileName=false)
 Downloads file. More...
 
 fetchAvailablePackages ($type=false)
 Fetches list of packages already available locally. More...
 
 fetchAvailableSitePackages ()
 Fetches list of site packages already available locally. More...
 
 retrieveRemoteSitePackagesList ()
 Retrieve list of site packages available to download. More...
 
 uploadPackage ()
 Upload local package. More...
 

Static Private Member Functions

 fopen ($fileName, $mode)
 Wrapper for standard fopen() doing error checking. More...
 

Detailed Description

The class eZStepSiteTypes does.

Member Function Documentation

eZStepSiteTypes::createSitePackagesList (   $remoteSitePackages,
  $importedSitePackages,
  $dependenciesStatus 
)
private

Referenced by display().

& eZStepSiteTypes::display ( )
eZStepSiteTypes::downloadAndImportPackage (   $packageName,
  $packageUrl,
  $forceDownload = false 
)
private

Downloads and imports package.

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

Parameters
$forceDownloaddownload even if this package already exists.
Returns
false on error, package object otherwise.

Referenced by downloadDependantPackages(), and processPostData().

eZStepSiteTypes::downloadDependantPackages (   $sitePackage)
private

Download packages required by the given package.

Referenced by processPostData().

eZStepSiteTypes::downloadFile (   $url,
  $outDir,
  $forcedFileName = false 
)
private

Downloads file.

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

Parameters
$urlURL.
$outDirDirectory where to put downloaded file to.
$forcedFileNameForce saving downloaded file under this name.
Returns
false on error, path to downloaded package otherwise.

Referenced by downloadAndImportPackage(), and retrieveRemotePackagesList().

eZStepSiteTypes::eZStepSiteTypes ( $tpl,
$http,
$ini,
$persistenceList 
)

Constructor

eZStepSiteTypes::fetchAvailablePackages (   $type = false)
private

Fetches list of packages already available locally.

eZStepSiteTypes::fetchAvailableSitePackages ( )
private

Fetches list of site packages already available locally.

Referenced by display().

eZStepSiteTypes::fopen (   $fileName,
  $mode 
)
staticprivate

Wrapper for standard fopen() doing error checking.

Referenced by downloadFile().

eZStepSiteTypes::init ( )
eZStepSiteTypes::processPostData ( )

Process POST data.

eZStepSiteTypes::retrieveRemotePackagesList (   $onlySitePackages = false)

Retrieve list of packages available to download.

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

Referenced by downloadDependantPackages(), and retrieveRemoteSitePackagesList().

eZStepSiteTypes::retrieveRemoteSitePackagesList ( )
private

Retrieve list of site packages available to download.

Referenced by display().

eZStepSiteTypes::tempDir ( )
static

Returns temporary directory used to download files to.

Referenced by downloadAndImportPackage(), and retrieveRemotePackagesList().

eZStepSiteTypes::uploadPackage ( )
private

Upload local package.

Referenced by processPostData().

Member Data Documentation

eZStepSiteTypes::$Error = 0
eZStepSiteTypes::$ErrorMsg = false
eZStepSiteTypes::$FileOpenErrorMsg = false

Referenced by downloadFile().

eZStepSiteTypes::$IndexURL
eZStepSiteTypes::$Message = false
eZStepSiteTypes::$XMLIndexURL

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