lib/ezutils/classes/ezini.php

Show:

inherited

Classes
- \eZINI

Table of Contents

\eZINI
jump to top

Package:

Constants

bool 
                DEBUG_INTERNALS
                = false

Constant to signal ini debug mode for ini development

: bool

string 
                CONFIG_CACHE_DIR
                = 'var/cache/ini/'

Constant path to directory for configuration cache

: string

int 
                CONFIG_CACHE_REV
                = 2

Constant integer to check against configuration cache format revision

: int

Properties


                 $AddArrayDefinition= ''

Details

Type: n/a


                 $BlockValues= ''

Details

Type: n/a


                 $BlockValuesPlacement= ''

Details

Type: n/a


                 $CacheFile= ''

Details

Type: n/a


                 $Charset= ''

Details

Type: n/a


                 $Codec= ''

Details

Type: n/a


                 $DirectAccess= ''

Details

Type: n/a


                 $FileName= ''

Details

Type: n/a


                 $GlobalOverrideDirArray= 'null'

static

Default valuenullDetails

Type: n/a


                 $LocalOverrideDirArray= ''

Details

Type: n/a


                 $ModifiedBlockValues= ''

Details

Type: n/a


                 $PlacementCacheFile= ''

Details

Type: n/a


                 $ReadOnlySettingsCheck= 'true'

Default valuetrueDetails

Type: n/a


                 $RootDir= ''

Details

Type: n/a


                 $UseCache= ''

Details

Type: n/a


                 $UseLocalOverrides= ''

Details

Type: n/a


                 $UseTextCodec= ''

Details

Type: n/a


                 $checkFileMtime= 'null'

static

Default valuenullDetails

Type: n/a


                 $filePermission= 'null'

static

Default valuenullDetails

Type: n/a

Methods

appendOverrideDir(
          string $dir, bool $globalDir
              =
              false, string | false $identifier
              =
              false, string | null $scope
              =
              null
          )
        
        :
          bool

Appends the override directory $dir to the override directory list.

Appends override dir to 'override' scope if scope is not defined, meaning above anything else. See {@link eZINI::defaultOverrideDirs()} for how these parameters are used.

Parameters

Name	Type	Description
$dir	string
$globalDir	bool
$identifier	string \| false	Will overwrite existing directory with same identifier if set
$scope	string \| null

Returns

Type	Description
bool	True if new dir was appended, false if there was a $identifier match and a overwrite

assign(
           $blockName,  $varName,  $variable
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$varName
$variable

cacheFileName(
           $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$placement

create(
           $fileName
              =
              'site.ini',  $rootDir
              =
              'settings',  $useTextCodec
              =
              null,  $useCache
              =
              null,  $useLocalOverrides
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$fileName
$rootDir
$useTextCodec
$useCache
$useLocalOverrides

defaultOverrideDirs(
          
          )
        
        :
          array

static

Default override directories as raw array data

Returns

Type	Description
array	An associated array of associated arrays of arrays.. First level keys are the scope and values are arrays Second level keys are identifier (numberic if not defined by caller) and value is arrays Third level contains (string) override dir, (bool) global flag if false then relative to {@link $RootDir} and (string\|false) optional identifier as used by {@link eZINI::prependOverrideDir()} to match and replace values on.

Type

Description

array

An associated array of associated arrays of arrays.. First level keys are the scope and values are arrays Second level keys are identifier (numberic if not defined by caller) and value is arrays Third level contains (string) override dir, (bool) global flag if false then relative to {@link $RootDir} and (string|false) optional identifier as used by {@link eZINI::prependOverrideDir()} to match and replace values on.

eZINI(
           $fileName
              =
              'site.ini',  $rootDir
              =
              '',  $useTextCodec
              =
              null,  $useCache
              =
              null,  $useLocalOverrides
              =
              null,  $directAccess
              =
              false,  $addArrayDefinition
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fileName
$rootDir
$useTextCodec
$useCache
$useLocalOverrides
$directAccess
$addArrayDefinition

exists(
           $fileName
              =
              "site.ini",  $rootDir
              =
              "settings"
          )
        
        :
          void

static

Parameters

Name	Type	Description
$fileName
$rootDir

fetchFromFile(
           $fileName,  $useTextCodec
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$fileName
$useTextCodec

filename(
          
          )
        
        :
          void

findInputFiles(
           $inputFiles,  $iniFile
          )
        
        :
          void

Parameters

Name	Type	Description
$inputFiles
$iniFile

findSettingPlacement(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

getNamedArray(
          
          )
        
        :
          void

getSiteAccessIni(
          string $siteAccess, string $iniFile
          )
        
        :
          \eZINI

static

Get ini file for a specific siteaccess (not incl extesnions or overrides) use {@link eZSiteAccess::getIni()} instead if you want to have full ini env.

Parameters

Name	Type	Description
$siteAccess	string
$iniFile	string

Returns

Type	Description
\eZINI

globalOverrideDirs(
          string | false | null $scope
              =
              null
          )
        
        :
          array

static

Return the global override directories witch raw override dir data, or within a scope if $scope is set, see {@link eZINI::defaultOverrideDirs()} for how the raw data looks like.

Parameters

Name	Type	Description
$scope	string \| false \| null	See {@link eZINI::defaultOverrideDirs()} for possible scope values If false then you'll get raw override dir structure, null (default) is a simplified variant withouth scopes that is easy to iterate over.

Returns

Type	Description
array

group(
           $blockName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName

groupPlacements(
          
          )
        
        :
          void

groups(
          
          )
        
        :
          void

hasGroup(
           $blockName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName

hasSection(
           $sectionName
          )
        
        :
          void

Parameters

Name	Type	Description
$sectionName

hasVariable(
           $blockName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$varName

instance(
          \$fileName $fileName
              =
              'site.ini', \$rootDir $rootDir
              =
              'settings', \$useTextCodec $useTextCodec
              =
              null, \$useCache $useCache
              =
              null, \$useLocalOverrides $useLocalOverrides
              =
              null, \$directAccess $directAccess
              =
              false, \$addArrayDefinition $addArrayDefinition
              =
              false
          )
        
        :
          \eZINI

static

Returns a shared instance of the eZINI class pr $fileName, $rootDir and $useLocalOverrides param combinations.

If $useLocalOverrides is set to true you will get a copy of the current overrides, but changes to the override settings will not be global. Direct access is for accessing the filename directly in the specified path. .append and .append.php is automaticly added to filename note: Use create() if you need to get a unique copy which you can alter.

Parameters

Name	Type	Description
$fileName	\$fileName	string
$rootDir	\$rootDir	string
$useTextCodec	\$useTextCodec	null\|bool default system setting if null
$useCache	\$useCache	null\|bool default system setting if null
$useLocalOverrides	\$useLocalOverrides	null\|bool default system setting if null
$directAccess	\$directAccess	bool
$addArrayDefinition	\$addArrayDefinition	bool

Returns

Type	Description
\eZINI

isCacheEnabled(
          
          )
        
        :
          void

static

isDebugEnabled(
          
          )
        
        :
          void

static

isLoaded(
           $fileName
              =
              'site.ini',  $rootDir
              =
              'settings',  $useLocalOverrides
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$fileName
$rootDir
$useLocalOverrides

isNoCacheAdviced(
          
          )
        
        :
          void

isSettingReadOnly(
           $fileName
              =
              false,  $blockName
              =
              false,  $settingName
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fileName
$blockName
$settingName

isTextCodecEnabled(
          
          )
        
        :
          void

static

isVariableModified(
           $blockName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$varName

load(
           $reset
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$reset

loadCache(
           $reset
              =
              true,  $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$reset
$placement

loadPlacement(
           $reset
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$reset

overrideDirs(
          string | null | false $scope
              =
              null
          )
        
        :
          array

Return the override directories witch raw override dir data, or within a scope if $scope is set, see {@link eZINI::defaultOverrideDirs()} for how the raw data looks like.

Parameters

Name	Type	Description
$scope	string \| null \| false	See {@link eZINI::defaultOverrideDirs()} for possible scope values If false then you'll get raw override dir structure, null (default) is a simplified variant withouth scopes that is easy to iterate over.

Returns

Type	Description
array

overrideDirsByScope(
          array $dirs, string | null | false $scope
              =
              null
          )
        
        :
          array

static

Return the override directories witch raw override dir data, or within a scope if $scope is set, see {@link eZINI::defaultOverrideDirs()} for how the raw data looks like.

Parameters

Name	Type	Description
$dirs	array	Directories directly from internal raw structure (see above).
$scope	string \| null \| false	See {@link eZINI::defaultOverrideDirs()} for possible scope values If false then you'll get raw override dir structure, null (default) is a simplified variant withouth scopes that is easy to iterate over.

Returns

Type	Description
array

parameterSet(
          string $fileName
              =
              'site.ini', string $rootDir
              =
              'settings', string $section, string $parameter
          )
        
        :
          bool

static

Check whether a specified parameter in a specified section is set in a specified file

Parameters

Name	Type	Description
$fileName	string	fileName file name (optional)
$rootDir	string	rootDir directory (optional)
$section	string	section section name
$parameter	string	parameter parameter name

Returns

Type	Description
bool	True if the the parameter is set.

Details

Deprecated: Since 4.4

parse(
           $inputFiles
              =
              false,  $iniFile
              =
              false,  $reset
              =
              true,  $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$inputFiles
$iniFile
$reset
$placement

parseFile(
           $file,  $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$file
$placement

prependOverrideDir(
          string $dir, bool $globalDir
              =
              false, string | false $identifier
              =
              false, string | null $scope
              =
              null
          )
        
        :
          bool

Prepends the override directory $dir to the override directory list.

Prepends override dir to 'extension' scope by default, bellow siteaccess and override settings. See {@link eZINI::defaultOverrideDirs()} for how these parameters are used.

Parameters

Name	Type	Description
$dir	string
$globalDir	bool
$identifier	string \| false	Will overwrite existing directory with same identifier if set
$scope	string \| null

Returns

Type	Description
bool	True if new dir was prepended, false if there was a $identifier match and a overwrite

readOnlySettingsCheck(
          
          )
        
        :
          void

removeGroup(
           $blockName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName

removeOverrideDir(
          string $identifier, string $scope
              =
              'extension'
          )
        
        :
          bool

Removes an override dir by identifier See {@link eZINI::defaultOverrideDirs()} for how these parameters are used.

Parameters

Name	Type	Description
$identifier	string	Will remove existing directory with identifier it it exists
$scope	string	By default 'extension'

Returns

Type	Description
bool	True if new dir was appended, false if there was a $identifier match and a overwrite

removeSetting(
           $blockName,  $settingName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$settingName

resetAllGlobals(
           $resetGlobalOverrideDirs
              =
              true
          )
        
        :
          void

static

Reset all eZINI instances as well override dirs ( optional )

Parameters

Name	Type	Description
$resetGlobalOverrideDirs

resetCache(
          
          )
        
        :
          void

resetGlobalOverrideDirs(
          
          )
        
        :
          void

static

Reset the global override directories with data from {@link eZINI::defaultOverrideDirs()}

resetGlobals(
           $fileName
              =
              'site.ini',  $rootDir
              =
              'settings',  $useLocalOverrides
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$fileName
$rootDir
$useLocalOverrides

resetOverrideDirs(
          
          )
        
        :
          void

Reset the override directories with data from {@link eZINI::defaultOverrideDirs()}

rootDir(
          
          )
        
        :
          void

save(
           $fileName
              =
              false,  $suffix
              =
              false,  $useOverride
              =
              false,  $onlyModified
              =
              false,  $useRootDir
              =
              true,  $resetArrays
              =
              false,  $encapsulateInPHP
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$fileName
$suffix
$useOverride
$onlyModified
$useRootDir
$resetArrays
$encapsulateInPHP

saveCache(
          string $cachedDir, string $cachedFile, array $data, array $inputFiles, string $iniFile
          )
        
        :
          bool

Stores the content of the INI object to the cache file \a $cachedFile.

Parameters

Name	Type	Description
$cachedDir	string	Cache dir, usually "var/cache/ini/"
$cachedFile	string	Name of cache file as returned by cacheFileName()
$data	array	Configuration data as an associative array structure
$inputFiles	array	List of input files used as basis for cache (for use in load cache to check mtime)
$iniFile	string	Ini file path string returned by findInputFiles() for main ini file

Returns

Type	Description
bool

selectOverrideScope(
          string | null $scope, string $identifier, string $dir, string $default
          )
        
        :
          string

static

Function to handle bc with code from pre 4.4 that does not know about scopes

Parameters

Name	Type	Description
$scope	string \| null
$identifier	string
$dir	string
$default	string

Returns

Type	Description
string

Details

Since: 4.4

setGroups(
           $groupArray
          )
        
        :
          void

Parameters

Name	Type	Description
$groupArray

setIsCacheEnabled(
           $cache
          )
        
        :
          void

static

Parameters

Name	Type	Description
$cache

setIsDebugEnabled(
           $debug
          )
        
        :
          void

static

Parameters

Name	Type	Description
$debug

setIsTextCodecEnabled(
           $codec
          )
        
        :
          void

static

Parameters

Name	Type	Description
$codec

setOverrideDirs(
          array $newDirs, string | false $scope
              =
              false
          )
        
        :
          void

Set the override directories witch raw override dir data, or within a scope if $scope is set, see {@link eZINI::defaultOverrideDirs()} for how the raw data looks like.

Parameters

Name	Type	Description
$newDirs	array
$scope	string \| false	See {@link eZINI::defaultOverrideDirs()} for possible scope values

setReadOnlySettingsCheck(
           $readOnly
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$readOnly

setVariable(
           $blockName,  $variableName,  $variableValue
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$variableName
$variableValue

setVariables(
           $variables
          )
        
        :
          void

Parameters

Name	Type	Description
$variables

settingType(
           $settingValue
          )
        
        :
          void

Parameters

Name	Type	Description
$settingValue

variable(
           $blockName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$varName

variableArray(
           $blockName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$varName

variableMulti(
           $blockName,  $varNames,  $signatures
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$blockName
$varNames
$signatures

lib/ezutils/classes/ezini.php

\eZINIjump to top

Constants

Properties

Methods

\eZINI
jump to top