lib/ezutils/classes/ezsys.php

Show:

inherited

Classes
- \eZSys

Table of Contents

\eZSys
jump to top

Package:

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) .

Details

Type: array

string
                 $EnvSeparator= ''

The list separator used for env variables (':' or ';')

Details

Type: string

string
                 $FileSeparator= ''

The directory separator used for files, '/' or '\'

Details

Type: string

string
                 $FileSystemType= ''

The type of filesystem, is either win32 or unix. This often used to determine OS specific paths.

Details

Type: string

string
                 $IndexFile= ''

The indef file name (eg: 'index.php')

Details

Type: string

string
                 $LineSeparator= ''

The line separator used in files, "\n" / "\n\r" / "\r"

Details

Type: string

string
                 $OSType= ''

The type of OS, is either win32, mac or unix.

Details

Type: string

array
                 $Params= 'null'

Holds server variables as read automatically or provided by unit tests Only used by init functionality as other calls will need to use live data direclty from globals.

Default valuenullDetails

Type: array

string
                 $RequestURI= ''

The uri which is used for parsing module/view information from, may differ from $_SERVER['REQUEST_URI']

Details

Type: string

string
                 $RootDir= ''

The absolute path to the root directory.

Details

Type: string

\stringt
                 $ShellEscapeCharacter= ''

The character to be used in shell escaping, this character is OS specific

Details

Type: \stringt

string
                 $SiteDir= ''

The system path to where all the code resides

Details

Type: string

string
                 $WWWDir= ''

The relative directory path of the vhless setup

Details

Type: string

null|\eZSys
                 $instance= 'null'

static

Holds eZSys instance

Default valuenullDetails

Type: null | \eZSys

Methods

__construct(
          array | null $serverParams
              =
              null
          )
        
        :
          void

Initializes the object with settings taken from the current script run.

Parameters

Name	Type	Description
$serverParams	array \| null	For unit testing use, see first few lines for content

__get(
           $propertyName
          )
        
        :
          mixed

Magic function to get access readonly properties (protected)

Parameters

Name	Type	Description
$propertyName

Returns

Type	Description
mixed

Throws

Exception	Description
\ezcBasePropertyNotFoundException

addAccessPath(
          array | string $path, string $name
              =
              'undefined', bool $siteaccess
              =
              true
          )
        
        :
          void

static

Appends 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.

Parameters

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

Parameters

Name	Type	Description
$attr

attributes(
          
          )
        
        :
          void

backupFilename(
          
          )
        
        :
          void

static

cacheDirectory(
          
          )
        
        :
          void

static

clearAccessPath(
           $siteaccess
              =
              true
          )
        
        :
          void

static

Clears the access path, used by {@link eZSys::indexFile()}

Parameters

Name	Type	Description
$siteaccess

createShellArgument(
           $argumentText,  $replaceList
          )
        
        :
          void

static

Parameters

Name	Type	Description
$argumentText
$replaceList

envSeparator(
          
          )
        
        :
          void

static

environmentVariable(
           $variableName,  $quiet
              =
              false
          )
        
        :
          void

static

Return the variable named \a $variableName in the global \c ENV variable.

If the variable is not present an error is shown and \c null is returned.

Parameters

Name	Type	Description
$variableName
$quiet

escapeShellArgument(
           $argument
          )
        
        :
          void

static

Parameters

Name	Type	Description
$argument

ezcrc32(
           $string
          )
        
        :
          void

static

Parameters

Name	Type	Description
$string

fileSeparator(
          
          )
        
        :
          void

static

filesystemType(
          
          )
        
        :
          void

static

getValidwwwDir(
          string $phpSelf, string $scriptFileName, string $index
          )
        
        :
          string | null | false

static

Generate wwwdir from phpSelf if valid accoring to scriptFileName and return null if invalid and false if there is no index in phpSelf

Parameters

Name	Type	Description
$phpSelf	string
$scriptFileName	string
$index	string

Returns

Type	Description
string \| null \| false	String in form 'path/path2' if valid, null if not and false if $index is not part of phpself

globBrace(
           $pattern,  $flags
              =
              0
          )
        
        :
          void

static

Parameters

Name	Type	Description
$pattern
$flags

hasAttribute(
           $attr
          )
        
        :
          void

Parameters

Name	Type	Description
$attr

hasEnvironmentVariable(
           $variableName
          )
        
        :
          void

static

Parameters

Name	Type	Description
$variableName

hostname(
          
          )
        
        :
          void

static

indexDir(
           $withAccessList
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$withAccessList

indexFile(
           $withAccessPath
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$withAccessPath

indexFileName(
          
          )
        
        :
          void

static

init(
          string $index
              =
              'index.php', bool $forceVirtualHost
              =
              null
          )
        
        :
          void

static

Initializes some variables according to some global PHP values.

This function should be called once in the index file with the parameters stated in the parameter list.

Parameters

Name	Type	Description
$index	string	The current index file, needed for virtual host mode detection.
$forceVirtualHost	bool	Virtual host mode is normally autodetected, but if not this can be forced by setting this to true.

instance(
          
          )
        
        :
          \eZSys

static

Returns a shared instance of the eZSys class

Returns

Type	Description
\eZSys

isDebugEnabled(
          
          )
        
        :
          bool

static

Return true if debugging of internals is enabled, this will display which server variables are read.

Set the option with setIsDebugEnabled().

Returns

Type	Description
bool

Details

Deprecated: Since 4.5, not used

isPHPVersionSufficient(
          array $requiredVersion
          )
        
        :
          bool

static

Return \c true if the PHP version is equal or higher than \a $requiredVersion.

Use: eZSys::isPHPVersionSufficient( array( 4, 1, 0 ) );

Parameters

Name	Type	Description
$requiredVersion	array	Must be an array with version number

Returns

Type	Description
bool

Details

Deprecated: Since 4.5

isSSLNow(
          
          )
        
        :
          void

static

isShellExecution(
          
          )
        
        :
          void

static

lineSeparator(
          
          )
        
        :
          void

static

magickQuotes(
          
          )
        
        :
          void

static

Returns true if magick quotes is enabled, but does nothing.

Details

Deprecated: since 4.5

mergeArgumentElements(
           $argumentElements
          )
        
        :
          void

static

Parameters

Name	Type	Description
$argumentElements

osName(
          
          )
        
        :
          void

static

osType(
          
          )
        
        :
          void

static

path(
           $quiet
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$quiet

phpVersion(
          
          )
        
        :
          array

static

Return the PHP version as an array with the version elements.

Returns

Type	Description
array

Details

Deprecated: Since 4.5

phpVersionText(
          
          )
        
        :
          string

static

The PHP version as text.

Returns

Type	Description
string

Details

Deprecated: Since 4.5, use PHP_VERSION

protocolSchema(
          
          )
        
        :
          void

static

removeMagicQuotes(
          
          )
        
        :
          void

static

Removes magic quotes

Details

Deprecated: Since 4.5, magic quotes setting has been deprecated in PHP 5.3

requestURI(
          
          )
        
        :
          void

static

rootDir(
          
          )
        
        :
          void

static

serverPort(
          
          )
        
        :
          void

static

serverProtocol(
          
          )
        
        :
          void

static

serverURL(
          
          )
        
        :
          void

static

serverVariable(
           $variableName,  $quiet
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$variableName
$quiet

setAccessPath(
          array $path
              =
              array(), string $name
              =
              'undefined', bool $siteaccess
              =
              true
          )
        
        :
          void

static

Set access path (parts of url that identifies siteaccess), used by {@link eZSys::indexFile()}

Parameters

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

static

Parameters

Name	Type	Description
$variableName
$variableValue

setInstance(
          \eZSys $instance
              =
              null
          )
        
        :
          void

static

Sets eZSys instance or clears it if left undefined.

Parameters

Name	Type	Description
$instance	\eZSys

setIsDebugEnabled(
          bool $debug
          )
        
        :
          void

static

Sets whether internal debugging is enabled or not.

Parameters

Name	Type	Description
$debug	bool

Details

Deprecated: Since 4.5, has not effect anymore

setServerVariable(
           $variableName,  $variableValue
          )
        
        :
          void

static

Parameters

Name	Type	Description
$variableName
$variableValue

simulateGlobBrace(
           $filenames
          )
        
        :
          void

static

Parameters

Name	Type	Description
$filenames

siteDir(
          
          )
        
        :
          void

static

splitArgumentIntoElements(
           $argumentText
          )
        
        :
          void

static

Parameters

Name	Type	Description
$argumentText

storageDirectory(
          
          )
        
        :
          void

static

varDirectory(
          
          )
        
        :
          void

static

wwwDir(
          
          )
        
        :
          void

static

lib/ezutils/classes/ezsys.php

\eZSysjump to top

Properties

Methods

\eZSys
jump to top