kernel/classes/ezpackage.php

Show:

inherited

Classes
- \eZPackage

Table of Contents

File containing the eZPackage class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\eZPackage
jump to top

Package: kernel

File containing the eZPackage class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

 
                VERSION
                = '3.5.2'

 
                DEVELOPMENT
                = false

 
                USE_CACHE
                = true

 
                CACHE_CODE_DATE
                = 1069339607

 
                STATUS_ALREADY_EXISTS
                = 1

 
                STATUS_INVALID_NAME
                = 2

 
                NON_INTERACTIVE
                = -1

Properties


                 $Parameters= ''

Details

Type: n/a


                 $isInstalled= 'false'

Default valuefalseDetails

Type: n/a

Methods

appendChange(
           $person,  $email,  $changes,  $release
              =
              false,  $timestamp
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$person
$email
$changes
$release
$timestamp

appendDependency(
           $dependencySection,  $parameters
          )
        
        :
          void

Parameters

Name	Type	Description
$dependencySection
$parameters

appendDocument(
           $name,  $mimeType
              =
              false,  $os
              =
              false,  $audience
              =
              false,  $create
              =
              false,  $data
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$mimeType
$os
$audience
$create
$data

appendFile(
           $file,  $type,  $role,  $design,  $filePath,  $collection,  $subDirectory
              =
              null,  $md5
              =
              null,  $copyFile
              =
              false,  $modified
              =
              null,  $fileType
              =
              false,  $roleValue
              =
              false,  $variableName
              =
              false,  $packagePath
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$file
$type
$role
$design
$filePath
$collection
$subDirectory
$md5
$copyFile
$modified
$fileType
$roleValue
$variableName
$packagePath

appendGroup(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

appendInstall(
           $type,  $name,  $os
              =
              false,  $isInstall
              =
              true,  $filename
              =
              false,  $subdirectory
              =
              false,  $parameters
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$type
$name
$os
$isInstall
$filename
$subdirectory
$parameters

appendMaintainer(
           $name,  $email,  $role
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$email
$role

appendProvides(
           $type,  $name,  $value,  $parameters
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$type
$name
$value
$parameters

appendSimpleFile(
           $key,  $filepath
          )
        
        :
          void

Parameters

Name	Type	Description
$key
$filepath

applyStorageFilePermissions(
           $filename
          )
        
        :
          void

static

Parameters

Name	Type	Description
$filename

attribute(
           $attributeName
          )
        
        :
          void

Parameters

Name	Type	Description
$attributeName

attributes(
          
          )
        
        :
          void

cacheDirectory(
          
          )
        
        :
          void

static

canExport(
          
          )
        
        :
          void

canImport(
          
          )
        
        :
          void

canInstall(
          
          )
        
        :
          void

canRead(
          
          )
        
        :
          void

canUsePackagePolicyFunction(
           $functionName
          )
        
        :
          void

Parameters

Name	Type	Description
$functionName

canUsePolicyFunction(
           $functionName
          )
        
        :
          void

static

Parameters

Name	Type	Description
$functionName

create(
           $name,  $parameters
              =
              array(),  $repositoryPath
              =
              false,  $repositoryID
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$name
$parameters
$repositoryPath
$repositoryID

createDependencyText(
           $cli,  $dependencyItem,  $dependencySection
          )
        
        :
          void

Parameters

Name	Type	Description
$cli
$dependencyItem
$dependencySection

createDependencyTree(
           $dependenciesNode,  $dependencyType,  $list
          )
        
        :
          void

Parameters

Name	Type	Description
$dependenciesNode
$dependencyType
$list

createInstallTree(
           $installNode,  $dom,  $list,  $installType
          )
        
        :
          void

Parameters

Name	Type	Description
$installNode
$dom
$list
$installType

currentRepositoryInformation(
          
          )
        
        :
          void

currentRepositoryPath(
          
          )
        
        :
          void

defaultLanguageMap(
          
          )
        
        :
          void

definitionFilename(
          
          )
        
        :
          void

static

dependencyItems(
           $dependencySection,  $parameters
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$dependencySection
$parameters

dependencyOperatorText(
           $dependencyItem
          )
        
        :
          void

Parameters

Name	Type	Description
$dependencyItem

documentDirectory(
          
          )
        
        :
          void

static

domStructure(
          
          )
        
        :
          void

eZPackage(
           $parameters
              =
              array(),  $repositoryPath
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$parameters
$repositoryPath

exportName(
          
          )
        
        :
          void

exportToArchive(
           $archivePath
          )
        
        :
          void

Parameters

Name	Type	Description
$archivePath

fetch(
           $packageName,  $packagePath
              =
              false,  $repositoryID
              =
              false,  $dbAvailable
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$packageName
$packagePath
$repositoryID
$dbAvailable

fetchDOMFromFile(
           $filename
          )
        
        :
          void

static

Parameters

Name	Type	Description
$filename

fetchDependentPackages(
           $dependencyType,  $failedList
          )
        
        :
          void

Parameters

Name	Type	Description
$dependencyType
$failedList

fetchFromCache(
           $packagePath,  $packageModification,  $cacheExpired
          )
        
        :
          void

static

Parameters

Name	Type	Description
$packagePath
$packageModification
$cacheExpired

fetchFromFile(
           $filename
          )
        
        :
          void

static

Parameters

Name	Type	Description
$filename

fetchMaintainerRoleIDList(
           $packageType
              =
              false,  $checkRoles
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$packageType
$checkRoles

fetchMaintainerRoleList(
           $packageType
              =
              false,  $checkRoles
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$packageType
$checkRoles

fetchPackages(
           $parameters
              =
              array(),  $filterArray
              =
              array()
          )
        
        :
          void

static

Parameters

Name	Type	Description
$parameters
$filterArray

fileCount(
          
          )
        
        :
          void

fileItemPath(
           $fileItem,  $collectionName,  $path
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fileItem
$collectionName
$path

fileList(
           $collectionName
          )
        
        :
          void

Parameters

Name	Type	Description
$collectionName

fileStorePath(
           $fileItem,  $collectionName,  $path
              =
              false,  $installVariables
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$fileItem
$collectionName
$path
$installVariables

filesDirectory(
          
          )
        
        :
          void

static

getInstallState(
          
          )
        
        :
          void

getVersion(
          
          )
        
        :
          void

Returns package version.

Combines package version number and release number.

\static \return Package version (string).

groupDependencyItemsByType(
           $dependencyItems
          )
        
        :
          void

Parameters

Name	Type	Description
$dependencyItems

hasAttribute(
           $attributeName
          )
        
        :
          void

Parameters

Name	Type	Description
$attributeName

import(
          string $archiveName, string $packageName, bool $dbAvailable
              =
              true, bool $repositoryID
              =
              false
          )
        
        :
          \eZPackage

static

Imports a package from a gzip compressed tarball file

Parameters

Name	Type	Description
$archiveName	string	Path to the archive file
$packageName	string	Package name
$dbAvailable	bool
$repositoryID	bool

Returns

Type	Description
\eZPackage	The eZPackage object if successfull, or one of the STATUS_* class constants if an error occurs

install(
          array $installParameters
          )
        
        :
          bool

Installs all items in the package

Parameters

Name	Type	Description
$installParameters	array

Returns

Type	Description
bool	true if all items installed correctly, false otherwise

installItem(
           $item,  $installParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$item
$installParameters

installItemsList(
           $type
              =
              false,  $os
              =
              false,  $name
              =
              false,  $isInstall
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$type
$os
$name
$isInstall

isInstalled(
          
          )
        
        :
          void

isValidName(
          string $packageName, string $transformedPackageName
              =
              null
          )
        
        :
          boolean

static

Checks if a package name is valid

Parameters

Name	Type	Description
$packageName	string	the package name
$transformedPackageName	string	the package name, transformed to be valid

Returns

Type	Description
boolean	true if the package name is valid, false if not

languageInfo(
           $withLanguageNames
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$withLanguageNames

languageInfoFromPackageList(
           $packageNameList,  $withLanguageNames
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$packageNameList
$withLanguageNames

maintainerRoleListForRoles(
          
          )
        
        :
          void

static

maintainerRoleName(
           $roleID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$roleID

md5sum(
           $file
          )
        
        :
          void

static

Parameters

Name	Type	Description
$file

packageHandler(
           $handlerName
          )
        
        :
          void

static

Parameters

Name	Type	Description
$handlerName

packageRepositories(
           $parameters
              =
              array()
          )
        
        :
          void

static

Parameters

Name	Type	Description
$parameters

parseDOMTree(
           $dom
          )
        
        :
          void

Parameters

Name	Type	Description
$dom

parseDependencyTree(
           $dependenciesList,  $dependencySection
          )
        
        :
          void

Parameters

Name	Type	Description
$dependenciesList
$dependencySection

parseInstallTree(
           $installList,  $isInstall
          )
        
        :
          void

Parameters

Name	Type	Description
$installList
$isInstall

remove(
          
          )
        
        :
          void

Removes the package directory and all it's subfiles/directories.

removeFiles(
           $path
          )
        
        :
          void

static

Parameters

Name	Type	Description
$path

repositoryInformation(
           $repositoryID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$repositoryID

repositoryPath(
          
          )
        
        :
          void

static

setAttribute(
           $attributeName,  $attributeValue
          )
        
        :
          void

Parameters

Name	Type	Description
$attributeName
$attributeValue

setCurrentRepositoryInformation(
           $information
          )
        
        :
          void

Parameters

Name	Type	Description
$information

setInstalled(
           $installed
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$installed

setPackager(
           $timestamp
              =
              false,  $host
              =
              false,  $packager
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$timestamp
$host
$packager

setParameters(
           $parameters
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$parameters

setRelease(
           $version
              =
              false,  $release
              =
              false,  $timestamp
              =
              false,  $licence
              =
              false,  $state
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$release
$timestamp
$licence
$state

settingsDirectory(
          
          )
        
        :
          void

static

simpleFilePath(
           $fileKey
          )
        
        :
          void

Parameters

Name	Type	Description
$fileKey

simpleFilesDirectory(
          
          )
        
        :
          void

static

stateList(
          
          )
        
        :
          void

static

storeCache(
           $directory
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$directory

storeDOM(
           $filename,  $dom
          )
        
        :
          void

static

Parameters

Name	Type	Description
$filename
$dom

storePackageFile(
           $path,  $storeCache
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$path
$storeCache

storeString(
           $filename,  $data
          )
        
        :
          void

static

Parameters

Name	Type	Description
$filename
$data

storeToFile(
           $filename
          )
        
        :
          void

Parameters

Name	Type	Description
$filename

suffix(
          
          )
        
        :
          void

static

systemRepositoryInformation(
          
          )
        
        :
          void

static

temporaryExportPath(
          
          )
        
        :
          void

static

temporaryImportPath(
          
          )
        
        :
          void

static

thumbnailList(
           $collectionName
          )
        
        :
          void

Parameters

Name	Type	Description
$collectionName

toString(
          
          )
        
        :
          void

typeList(
          
          )
        
        :
          void

static

uninstall(
           $uninstallParameters
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$uninstallParameters

uninstallItem(
           $item,  $uninstallParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$item
$uninstallParameters

useCache(
          
          )
        
        :
          void

static

kernel/classes/ezpackage.php

\eZPackagejump to top

Constants

Properties

Methods

\eZPackage
jump to top