lib/ezutils/classes/ezsys.php
Classes
\eZSys
Constants
Properties
array
$AccessPath= ''
The access path of the current site view, associated array of associated arrays.
On first level key is 'siteaccess' and 'path' to distinguish between siteaccess and general path. On second level you have (string)'name' and (array)'url', where url is the path and name is the name of the source (used to match siteaccess in {@link eZSys::indexFile()} for RemoveSiteAccessIfDefaultAccess matching) .
- Type
- array
string
$EnvSeparator= ''
The list separator used for env variables (':' or ';')
- Type
- string
string
$FileSeparator= ''
The directory separator used for files, '/' or '\'
- Type
- string
string
$FileSystemType= ''
The type of filesystem, is either win32 or unix. This often used to determine OS specific paths.
- Type
- string
string
$IndexFile= ''
The indef file name (eg: 'index.php')
- Type
- string
string
$LineSeparator= ''
The line separator used in files, "\n" / "\n\r" / "\r"
- Type
- string
string
$OSType= ''
The type of OS, is either win32, mac or unix.
- Type
- string
string
$RequestURI= ''
The uri which is used for parsing module/view information from, may differ from $_SERVER['REQUEST_URI']
- Type
- string
string
$RootDir= ''
The absolute path to the root directory.
- Type
- string
\stringt
$ShellEscapeCharacter= ''
The character to be used in shell escaping, this character is OS specific
- Type
- \stringt
string
$SiteDir= ''
The system path to where all the code resides
- Type
- string
string
$WWWDir= ''
The relative directory path of the vhless setup
- Type
- string
Methods
__get(
$propertyName
)
:
mixedMagic function to get access readonly properties (protected)
| Name | Type | Description |
|---|---|---|
| $propertyName |
| Type | Description |
|---|---|
| mixed |
| Exception | Description |
|---|---|
| \ezcBasePropertyNotFoundException |
addAccessPath(
array | string $path, string $name
=
'undefined', bool $siteaccess
=
true
)
:
voidAppends the access path (parts of url that identifies siteaccess), used by {@link eZSys::indexFile()} NOTE: Does not make sense to use for siteaccess, as you would want to clear current path and set new one normally, so preferably use {@link eZSys::setAccessPath()} in this case.
| Name | Type | Description |
|---|---|---|
| $path | array | string | |
| $name | string | An identifer of the name of the path provided {@link $AccessPath} |
| $siteaccess | bool | Hints if path is siteaccess related or not, needed in case subsequesnt code suddenly changes siteaccess and needs to clear siteaccess scope |
attribute(
$attr
)
:
void| Name | Type | Description |
|---|---|---|
| $attr |
attributes(
)
:
voidbackupFilename(
)
:
voidcacheDirectory(
)
:
voidclearAccessPath(
$siteaccess
=
true
)
:
voidClears the access path, used by {@link eZSys::indexFile()}
| Name | Type | Description |
|---|---|---|
| $siteaccess |
createShellArgument(
$argumentText, $replaceList
)
:
void| Name | Type | Description |
|---|---|---|
| $argumentText | ||
| $replaceList |
eZSys(
)
:
voidenvSeparator(
)
:
voidenvironmentVariable(
$variableName, $quiet
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $variableName | ||
| $quiet |
escapeShellArgument(
$argument
)
:
void| Name | Type | Description |
|---|---|---|
| $argument |
ezcrc32(
$string
)
:
void| Name | Type | Description |
|---|---|---|
| $string |
fileSeparator(
)
:
voidfilesystemType(
)
:
voidglobBrace(
$pattern, $flags
=
0
)
:
void| Name | Type | Description |
|---|---|---|
| $pattern | ||
| $flags |
hasAttribute(
$attr
)
:
void| Name | Type | Description |
|---|---|---|
| $attr |
hasEnvironmentVariable(
$variableName
)
:
void| Name | Type | Description |
|---|---|---|
| $variableName |
hostname(
)
:
voidindexDir(
$withAccessList
=
true
)
:
void| Name | Type | Description |
|---|---|---|
| $withAccessList |
indexFile(
$withAccessPath
=
true
)
:
void| Name | Type | Description |
|---|---|---|
| $withAccessPath |
indexFileName(
)
:
voidinit(
$index
=
"index.php", $force_VirtualHost
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $index | ||
| $force_VirtualHost |
instance(
)
:
\eZSysReturns a shared instance of the eZSys class
| Type | Description |
|---|---|
| \eZSys |
isDebugEnabled(
)
:
voidisPHPVersionSufficient(
$requiredVersion
)
:
void| Name | Type | Description |
|---|---|---|
| $requiredVersion |
isSSLNow(
)
:
voidisShellExecution(
)
:
voidlineSeparator(
)
:
voidmagickQuotes(
)
:
voidmergeArgumentElements(
$argumentElements
)
:
void| Name | Type | Description |
|---|---|---|
| $argumentElements |
osName(
)
:
voidosType(
)
:
voidpath(
$quiet
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $quiet |
phpVersion(
)
:
voidphpVersionText(
)
:
voidprotocolSchema(
)
:
voidremoveMagicQuotes(
)
:
voidrequestURI(
)
:
voidrootDir(
)
:
voidserverPort(
)
:
voidserverProtocol(
)
:
voidserverURL(
)
:
voidserverVariable(
$variableName, $quiet
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $variableName | ||
| $quiet |
setAccessPath(
array $path
=
array(), string $name
=
'undefined', bool $siteaccess
=
true
)
:
voidSet access path (parts of url that identifies siteaccess), used by {@link eZSys::indexFile()}
| Name | Type | Description |
|---|---|---|
| $path | array | |
| $name | string | An identifer of the name of the path provided {@link $AccessPath} |
| $siteaccess | bool | Hints if path is siteaccess related or not, needed in case subsequesnt code suddenly changes siteaccess and needs to clear siteaccess scope |
setEnvironmentVariable(
$variableName, $variableValue
)
:
void| Name | Type | Description |
|---|---|---|
| $variableName | ||
| $variableValue |
setIsDebugEnabled(
$debug
)
:
void| Name | Type | Description |
|---|---|---|
| $debug |
setServerVariable(
$variableName, $variableValue
)
:
void| Name | Type | Description |
|---|---|---|
| $variableName | ||
| $variableValue |
simulateGlobBrace(
$filenames
)
:
void| Name | Type | Description |
|---|---|---|
| $filenames |
siteDir(
)
:
voidsplitArgumentIntoElements(
$argumentText
)
:
void| Name | Type | Description |
|---|---|---|
| $argumentText |
storageDirectory(
)
:
voidvarDirectory(
)
:
voidwwwDir(
)
:
void