eZPublish(LegacyStack)  5.1
eZINI Class Reference

Reads and writes .ini style configuration files. More...

Public Member Functions

 appendOverrideDir ($dir, $globalDir=false, $identifier=false, $scope=null)
 Appends the override directory $dir to the override directory list. More...
 
 assign ($blockName, $varName, &$variable)
 
 eZINI ($fileName= 'site.ini', $rootDir= '', $useTextCodec=null, $useCache=null, $useLocalOverrides=null, $directAccess=false, $addArrayDefinition=false, $load=true)
 Initialization of eZINI object. More...
 
 filename ()
 
 findSettingPlacement ($path)
 Gives you the location of a ini file based on it's path, format is same as used internally for $identifer for override dirs- Eg: default / ext-siteaccess:<ext> / siteaccess / extension:<ext> / override / injected. More...
 
 getNamedArray ()
 Returns BlockValues, which is a nicely named Array. More...
 
 group ($blockName)
 Fetches a variable group and returns it as an associative array. More...
 
groupPlacements ()
 
 groups ()
 Fetches all defined groups and returns them as an associative array. More...
 
 hasGroup ($blockName)
 Checks if the group $blockName exists. More...
 
 hasSection ($sectionName)
 Checks if the group $blockName exists. More...
 
 hasVariable ($blockName, $varName)
 Checks if a variable is set. More...
 
 isSettingReadOnly ($fileName=false, $blockName=false, $settingName=false)
 
 isVariableModified ($blockName, $varName)
 
 load ($reset=true)
 Tries to load the ini file specified in the constructor or instance() function. More...
 
 loadCache ($reset=true, $placement=false)
 Will load a cached version of the ini file if it exists, if not it will parse the original file and create the cache file. More...
 
 loadPlacement ($reset=true)
 Tries to load the ini file placement specified in the constructor or instance() function. More...
 
 overrideDirs ($scope=null)
 Return the override directories witch raw override dir data, or within a scope if $scope is set, see eZINI::defaultOverrideDirs() for how the raw data looks like. More...
 
 prependOverrideDir ($dir, $globalDir=false, $identifier=false, $scope=null)
 Prepends the override directory $dir to the override directory list. More...
 
 readOnlySettingsCheck ()
 
 removeGroup ($blockName)
 
 removeOverrideDir ($identifier, $scope= 'extension')
 Removes an override dir by identifier See eZINI::defaultOverrideDirs() for how these parameters are used. More...
 
 removeSetting ($blockName, $settingName)
 
 reset ()
 
 resetCache ()
 
 resetOverrideDirs ()
 Reset the override directories with data from eZINI::defaultOverrideDirs(). More...
 
 rootDir ()
 
 save ($fileName=false, $suffix=false, $useOverride=false, $onlyModified=false, $useRootDir=true, $resetArrays=false, $encapsulateInPHP=true)
 
 setGroups ($groupArray)
 
 setOverrideDirs (array $newDirs, $scope=false)
 Set the override directories witch raw override dir data, or within a scope if $scope is set, see eZINI::defaultOverrideDirs() for how the raw data looks like. More...
 
 setReadOnlySettingsCheck ($readOnly=true)
 
 settingType ($settingValue)
 
 setVariable ($blockName, $variableName, $variableValue)
 
 setVariables ($variables)
 
 variable ($blockName, $varName)
 Reads a variable from the ini file. More...
 
 variableArray ($blockName, $varName)
 Reads a variable from the ini file or injected settings. More...
 
 variableMulti ($blockName, $varNames, $signatures=array())
 Reads multiple variables from the ini file. More...
 

Static Public Member Functions

static create ($fileName= 'site.ini', $rootDir= 'settings', $useTextCodec=null, $useCache=null, $useLocalOverrides=null)
 
static defaultOverrideDirs ()
 Default override directories as raw array data. More...
 
static exists ($fileName="site.ini", $rootDir="settings")
 
static fetchFromFile ($fileName, $useTextCodec=null)
 
static getSiteAccessIni ($siteAccess, $iniFile)
 Get ini file for a specific siteaccess (not incl extesnions or overrides) use eZSiteAccess::getIni() instead if you want to have full ini env. More...
 
static globalOverrideDirs ($scope=null)
 Return the global override directories witch raw override dir data, or within a scope if $scope is set, see eZINI::defaultOverrideDirs() for how the raw data looks like. More...
 
static injectSettings (array $settings)
 Injects settings at runtime so that they override the content of local .ini files and the corresponding overrides. More...
 
static instance ($fileName= 'site.ini', $rootDir= 'settings', $useTextCodec=null, $useCache=null, $useLocalOverrides=null, $directAccess=false, $addArrayDefinition=false)
 Returns a shared instance of the eZINI class pr $fileName, $rootDir and $useLocalOverrides param combinations. More...
 
static isCacheEnabled ()
 Returns whether INI cache is enabled globally, by default it is true. More...
 
static isDebugEnabled ()
 Returns whether debugging of internals is enabled. More...
 
static isLoaded ($fileName= 'site.ini', $rootDir= 'settings', $useLocalOverrides=null)
 Returns whether the mentioned ini file has been loaded. More...
 
static isNoCacheAdviced ()
 
static isTextCodecEnabled ()
 Returns whether textcodecs is to be used, this will use the eZTextCodec class in the eZI18N library for text conversion. More...
 
static parameterSet ($fileName= 'site.ini', $rootDir= 'settings', &$section, &$parameter)
 Check whether a specified parameter in a specified section is set in a specified file. More...
 
static resetAllGlobals ($resetGlobalOverrideDirs=true)
 Reset all eZINI instances as well override dirs ( optional ) More...
 
static resetAllInstances ($resetGlobalOverrideDirs=true)
 Reset all eZINI instances as well override dirs ( optional ) More...
 
static resetGlobalOverrideDirs ()
 Reset the global override directories with data from eZINI::defaultOverrideDirs(). More...
 
static resetGlobals ($fileName= 'site.ini', $rootDir= 'settings', $useLocalOverrides=null)
 Resets a specific instance of eZINI. More...
 
static resetInstance ($fileName= 'site.ini', $rootDir= 'settings', $useLocalOverrides=null)
 Resets a specific instance of eZINI. More...
 
static setIsCacheEnabled ($enabled)
 Sets whether caching is enabled for INI files or not. More...
 
static setIsDebugEnabled ($enabled)
 Sets whether internal debugging is enabled or not. More...
 
static setIsTextCodecEnabled ($enabled)
 Sets whether textcodec conversion is enabled or not. More...
 

Public Attributes

 $AddArrayDefinition
 If true empty element will be created in the beginning of array if it is defined in this ini file. More...
 
 $BlockValues
 Variable to store the ini file values. More...
 
 $BlockValuesPlacement
 Variable to store the setting placement (which file is the setting in). More...
 
 $CacheFile
 Stores the path and filename of the value cache file. More...
 
 $Charset
 The charset of the ini file. More...
 
 $Codec
 Variable to store the textcodec. More...
 
 $DirectAccess
 If true then all file loads are done directly on the filename. More...
 
 $FileName
 Stores the filename. More...
 
 $LocalOverrideDirArray
 Contains the override dirs, if in local mode. More...
 
 $ModifiedBlockValues
 Variable to store whether variables are modified or not. More...
 
 $PlacementCacheFile
 Stores the path and filename of the placement cache file. More...
 
 $ReadOnlySettingsCheck = true
 If true eZINI will check each setting (before saving) for correspondence of settings in site.ini[eZINISetting].ReadonlySettingList. More...
 
 $RootDir
 The root of all ini files. More...
 
 $UseCache
 true if cache should be used More...
 
 $UseLocalOverrides
 true if the overrides should only be changed locally More...
 
 $UseTextCodec
 Whether to use the text codec when reading the ini file or not. More...
 
const CONFIG_CACHE_DIR = 'var/cache/ini/'
 
const CONFIG_CACHE_REV = 2
 
const INJECTED_PATH = 'injected'
 

Protected Member Functions

 cacheFileName ($placement=false)
 
 saveCache ($cachedDir, $cachedFile, array $data, array $inputFiles, $iniFile)
 Stores the content of the INI object to the cache file $cachedFile. More...
 

Static Protected Member Functions

static overrideDirsByScope (array $dirs, $scope=null)
 Return the override directories witch raw override dir data, or within a scope if $scope is set, see eZINI::defaultOverrideDirs() for how the raw data looks like. More...
 
static selectOverrideScope ($scope, $identifier, $dir, $default)
 Function to handle bc with code from pre 4.4 that does not know about scopes. More...
 

Static Protected Attributes

static $cacheEnabled = true
 
static $checkFileMtime = null
 
static $debugEnabled = false
 
static $filePermission = null
 
static $GlobalOverrideDirArray = null
 Contains global override dirs. More...
 
static $injectedSettings = array()
 
static $instances = array()
 
static $textCodecEnabled = true
 

Private Member Functions

 findInputFiles (&$inputFiles, &$iniFile)
 
 parse ($inputFiles=false, $iniFile=false, $reset=true, $placement=false)
 
 parseFile ($file, $placement=false)
 

Detailed Description

Reads and writes .ini style configuration files.

The most common way of using it is.

$ini = eZINI::instance( "site.ini" );
// get a variable from the file.
$iniVar = $ini->variable( "BlockName", "Variable" );

The default ini file is site.ini but others can be passed to the instance() function among with some others. It will create one unique instance for each ini file and rootdir, this means that the next time instance() is used with the same parameters the same object will be returned and no new parsing is required.

The class will by default try to create a cache file in var/cache/ini, however to change this behaviour the static setIsCacheEnabled() function can be used, or use the $useCache parameter in instance() for setting this for one object only.

The class will also handle charset conversion using eZTextCodec, to turn this behaviour off use the static setIsTextCodecEnabled() function or set the $useTextCodec parameter in instance() for a per object basis setting.

Normally the eZINI class will not give out much information about what it's doing, it's only when errors occur that you'll see this. To enable internal debugging use the static setIsDebugEnabled() function. The class will then give information about which files are load, if cache files are used and when cache files are written.

Member Function Documentation

eZINI::appendOverrideDir (   $dir,
  $globalDir = false,
  $identifier = false,
  $scope = null 
)

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 eZINI::defaultOverrideDirs() for how these parameters are used.

Parameters
string$dir
bool$globalDir
string | false$identifierWill overwrite existing directory with same identifier if set
string | null$scope
Returns
bool True if new dir was appended, false if there was a $identifier match and a overwrite
eZINI::assign (   $blockName,
  $varName,
$variable 
)

Reads a variable from the ini file and puts it in the parameter $variable.

Note
$variable is not modified if the variable does not exist
eZINI::cacheFileName (   $placement = false)
protected

Generates cache name for loadCache

Referenced by loadCache().

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

Default override directories as raw array data.

Returns
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 $RootDir and (string|false) optional identifier as used by eZINI::prependOverrideDir() to match and replace values on.
static eZINI::exists (   $fileName = "site.ini",
  $rootDir = "settings" 
)
static
Returns
true if the INI file $fileName exists in the root dir $rootDir. $fileName defaults to site.ini and rootDir to settings.

Referenced by eZLocale\countryFile(), eZLocale\languageFile(), eZLocale\localeFile(), and parameterSet().

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

Initialization of eZINI object.

Enter description here ...

Parameters
string$fileName
string$rootDir
null | bool$useTextCodec
null | bool$useCache
null | bool$useLocalOverrides
bool$directAccess
bool$addArrayDefinition
bool$load
Since
4.5 Lets you disable automatic loading of ini values in cases where changes on instance will be done first.

Referenced by create(), fetchFromFile(), and instance().

static eZINI::fetchFromFile (   $fileName,
  $useTextCodec = null 
)
static

Fetches the ini file $fileName and returns the INI object for it.

Note
This will not use the override system or read cache files, this is a direct fetch from one file.

Referenced by eZFilePackageHandler\install().

eZINI::filename ( )
Returns
the filename.

Referenced by setVariable().

eZINI::findInputFiles ( $inputFiles,
$iniFile 
)
private

Looks trough all known settings and override folders to find relevant INI files. The result is a list with expanded paths to the files.

Returns
the expanded file list.

Referenced by loadCache(), and parse().

eZINI::findSettingPlacement (   $path)

Gives you the location of a ini file based on it's path, format is same as used internally for $identifer for override dirs- Eg: default / ext-siteaccess:<ext> / siteaccess / extension:<ext> / override / injected.

Since
5.0 returns 'injected' for injected settings
Parameters
string$path
Returns
string
eZINI::getNamedArray ( )

Returns BlockValues, which is a nicely named Array.

Returns
array
static eZINI::getSiteAccessIni (   $siteAccess,
  $iniFile 
)
static

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

Parameters
string$siteAccess
string$iniFile
Returns
eZINI
static eZINI::globalOverrideDirs (   $scope = null)
static

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

Parameters
string | false | null$scopeSee 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
array
eZINI::group (   $blockName)

Fetches a variable group and returns it as an associative array.

Since
5.0 takes injected settings into account
5.0 does not return the array by reference anymore
Parameters
string$blockName
Returns
array
& eZINI::groupPlacements ( )

Fetches all defined placements for every setting and returns them as an associative array

eZINI::groups ( )

Fetches all defined groups and returns them as an associative array.

Since
5.0 does not return the array by reference anymore
5.0 takes injected settings into account
Returns
array
eZINI::hasGroup (   $blockName)

Checks if the group $blockName exists.

Parameters
string$blockName
Returns
boolean
eZINI::hasSection (   $sectionName)

Checks if the group $blockName exists.

Since
5.0 also checks in the injected settings
Parameters
string$blockName
Returns
boolean

Referenced by hasGroup().

eZINI::hasVariable (   $blockName,
  $varName 
)

Checks if a variable is set.

Since
5.0 also checks in the injected settings
Parameters
string$blockName
string$varName
Returns
bool
static eZINI::injectSettings ( array  $settings)
static

Injects settings at runtime so that they override the content of local .ini files and the corresponding overrides.

Since
5.0
Parameters
array$settingshash of settings organized under filename, block and variable, for instance: $settings['site.ini']['DatabaseSettings']['Server'] = '127.0.0.1';

Referenced by ezpKernelWeb\__construct().

static eZINI::instance (   $fileName = 'site.ini',
  $rootDir = 'settings',
  $useTextCodec = null,
  $useCache = null,
  $useLocalOverrides = null,
  $directAccess = false,
  $addArrayDefinition = false 
)
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
string$fileName
string$rootDir
null | bool$useTextCodecDefault system setting if null (instance not used if not null!)
null | bool$useCacheDefault system setting if null (instance not used if not null!)
null | bool$useLocalOverridesDefault system setting if null
bool$directAccessDirect access to specific file instead of values from several (instance not used if true!)
bool$addArrayDefinition,\xrefitemdeprecated 40.
Returns
eZINI

Referenced by eZDFSFileHandlerDFSBackend\__construct(), ezpContentPublishingQueueProcessor\__construct(), ezpRestAuthenticationStyle\__construct(), ezpMvcConfiguration\__construct(), ezpKernelTreeMenu\__construct(), ezpRestDebug\__construct(), eZDFSFileHandlerMySQLiBackend\__construct(), ezpRestMvcController\__construct(), eZDFSFileHandler\__construct(), eZStaticCache\__construct(), ezpKernelWeb\__construct(), eZWebDAVContentBackend\__construct(), eZDFSFileHandlerMySQLiBackend\_connect(), eZUser\_loginUser(), eZModule\accessAllowed(), eZUser\accessArray(), eZExtension\activateExtensions(), eZExtension\activeExtensions(), eZModule\activeModuleRepositories(), eZInstallScriptPackageHandler\add(), eZExtensionPackageHandler\addExtension(), eZCodeTemplate\allCodeFiles(), eZInformationCollection\allowAnonymous(), eZMail\allowedCharsets(), eZNotificationEventType\allowedTypes(), eZWorkflowType\allowedTypes(), eZDataType\allowedTypes(), eZTemplateCompiler\alwaysGenerate(), eZImageAnalyzer\analyzerData(), eZUser\anonymousId(), eZWebDAVContentBackend\appendLogEntry(), eZContentCacheManager\appendRelatingNodeIDs(), eZPackage\applyStorageFilePermissions(), eZInformationCollection\attributeHideList(), eZUser\authenticationMatch(), eZContentObjectTreeNode\availableClassListJsArray(), eZNotificationEventFilter\availableHandlers(), eZExtension\baseDirectory(), eZDBInterface\begin(), eZContentBrowse\browse(), eZStaticCache\buildCacheDirPath(), eZSearchEngine\buildTempTablesForFullTextSearch(), eZTranslationCache\cacheDirectory(), eZSys\cacheDirectory(), eZURLWildcard\cacheInfo(), eZContentCache\cachePathInfo(), eZContentObject\canCreateClassList(), eZContentObjectTreeNode\canCreateClassList(), eZContentClass\canInstantiateClassList(), eZContentFunctionCollection\canInstantiateClassList(), Cezpdf\Cezpdf(), eZSiteAccess\change(), changeDBCharsetORACLE(), eZImageHandler\changeFilePermissions(), changeSiteAccessSetting(), eZPaymentCallbackChecker\checkAmount(), eZSSLZone\checkModuleView(), eZTipafriendRequest\checkReceiver(), checkTimeout(), eZDB\checkTransactionCounter(), eZUserLoginHandler\checkUser(), eZUser\checkUser(), eZUserType\classAttributeRemovableInformation(), eZDataType\classDisplayInformation(), eZContentClassPackageHandler\classDOMTree(), eZTipafriendRequest\cleanup(), eZContentCache\cleanup(), eZSubtreeCache\cleanupCacheDir(), eZBasket\cleanupCurrentBasket(), eZContentCacheManager\clearAllContentCache(), eZContentCacheManager\clearObjectViewCache(), eZContentCacheManager\clearObjectViewCacheArray(), eZContentCacheManager\clearObjectViewCacheIfNeeded(), eZContentCacheManager\clearTemplateBlockCache(), eZContentCacheManager\clearTemplateBlockCacheIfNeeded(), eZSys\clientIP(), eZDBInterface\commit(), eZTemplateCompiler\compilationDirectory(), eZTemplateCompiler\compilationFilename(), eZTemplateCompiler\compileTemplate(), eZUser\contentClassIDs(), eZContentClass\contentObjectName(), eZURLAliasML\convertToAlias(), eZFileHandler\copy(), eZVatRule\country(), eZLocale\countryFile(), eZExchangeRatesUpdateHandler\create(), eZPDFExport\create(), eZRSSExport\create(), eZLocale\create(), eZImageManager\createAliasFromINI(), eZDiffXMLTextEngine\createDifferenceObject(), eZContentObjectTreeNode\createExtendedAttributeFilterSQLStrings(), eZContentOperationCollection\createFeedForNode(), eZWebDAVContentBackend\createFolder(), eZImageShellHandler\createFromINI(), eZImageGDHandler\createFromINI(), eZContentObject\createGroupedDataMap(), eZTemplateDesignResource\createOverrideCache(), eZHTTPTool\createRedirectUrl(), ezpRestRouter\createRoutes(), eZSiteInstaller\createSiteAccess(), eZPackageCreationHandler\creatorList(), eZOrder\customerList(), eZMultiOption2Type\customObjectAttributeHTTPAction(), eZObjectRelationType\customObjectAttributeHTTPAction(), eZObjectRelationListType\customObjectAttributeHTTPAction(), databaseCleanup(), eZTemplateLocaleOperator\dateTimeTransformation(), eZCodeMapper\decodeCommand(), eZContentObject\defaultLanguage(), eZWebDAVContentBackend\deleteContent(), eZContentOperationCollection\deleteObject(), eZContentCacheManager\dependencyInfo(), eZTemplateDesignResource\designSetting(), ezpLanguageSwitcher\destinationUrl(), eZContentUpload\detectClassIdentifier(), eZContentUpload\detectLocations(), dfsCleanup(), eZDir\directoryPermission(), ezpKernelWeb\dispatchLoop(), eZStepSiteTemplates\display(), eZStepSiteDetails\display(), eZInformationCollection\displayHandling(), eZFilePassthroughHandler\dispositionType(), ezpRestRouter\doCreateRoutes(), ezpRestOauthTokenController\doHandleRequest(), eZObjectRelationListType\domString(), eZMatrix\domString(), ezpOauthUtility\doRefreshToken(), ezpOauthUtility\doRefreshTokenWithAuthorizationCode(), eZStepSiteTypes\downloadFile(), eZVatType\dynamicVatTypeName(), eZHTTPHeader\enabled(), eZSSLZone\enabled(), eZDefaultConfirmOrderHandler\execute(), eZSimpleShippingType\execute(), ezpMultivariateTestHandler\execute(), eZStaticCache\executeActions(), eZFunctionHandler\executeAlias(), eZCharTransform\executeCacheFile(), eZCodeMapper\executeCommandCode(), eZContentObjectEditHandler\executeHandlerFunction(), eZISBN13\extractISBNNumber(), eZCodeTemplate\eZCodeTemplate(), eZSys\ezcrc32(), eZDBInterface\eZDBInterface(), eZDisplayDebug(), eZFetchActiveSessionCount(), eZFetchActiveSessions(), eZImageManager\eZImageManager(), eZMail\eZMail(), eZMimeType\eZMimeType(), eZPaymentCallbackChecker\eZPaymentCallbackChecker(), eZPDF\eZPDF(), eZPostgreSQLDB\eZPostgreSQLDB(), eZSetupConfigVariable(), eZSetupConfigVariableArray(), eZSetupCriticalTests(), eZSetupImageConfigVariableArray(), eZSetupOptionalTests(), eZSetupTestDirectoryPermissions(), eZSetupTestFilePermissions(), eZSimplifiedXMLInput\eZSimplifiedXMLInput(), eZStepInstaller\eZStepInstaller(), eZStepSiteTypes\eZStepSiteTypes(), eZTemplate\eZTemplate(), eZTemplateImageOperator\eZTemplateImageOperator(), eZUpdateDebugSettings(), eZUpdateTextCodecSettings(), eZXHTMLXMLOutput\eZXHTMLXMLOutput(), eZXMLInputParser\eZXMLInputParser(), eZXMLOutputHandler\eZXMLOutputHandler(), eZXMLSchema\eZXMLSchema(), eZTemplate\factory(), eZAlphabetOperator\fetchAlphabet(), eZUser\fetchAnonymousCount(), eZAudit\fetchAuditEnabled(), eZAudit\fetchAuditNameSettings(), eZCountryType\fetchCountryList(), eZCache\fetchList(), eZNavigationPart\fetchList(), eZTSTranslator\fetchList(), eZUser\fetchLoggedInCount(), eZUser\fetchLoggedInList(), eZPackage\fetchMaintainerRoleIDList(), eZContentClass\fetchMatchGroupIDList(), eZContentObjectTreeNode\fetchNode(), eZWebDAVContentBackend\fetchNodeByTranslation(), eZPackageType\fetchObjectAttributeHTTPInput(), eZUserType\fetchObjectAttributeHTTPInput(), eZClassFunctionCollection\fetchOverrideTemplateList(), eZWebDAVContentBackend\fetchParentNodeByTranslation(), eZProductCategory\fetchProductCountByCategory(), eZLayoutFunctionCollection\fetchSitedesignList(), eZTemplateExecuteOperator\fetchTransform(), eZUser\fetchUserGroupClassNames(), eZRSSImport\fieldMap(), eZFilePackageHandler\fileExists(), eZFSFileHandler\fileStoreContents(), ezpRestAuthConfiguration\filter(), eZExtension\findExtensionType(), eZContentUpload\findHandler(), eZSiteAccess\findPathToSiteAccess(), eZURLAliasML\findUniqueText(), eZContentObject\fixReverseRelations(), eZCodeMapper\generateCommandCode(), eZRSSExport\generateFeed(), eZContentObjectPackageHandler\generateFetchAliasArray(), eZContentCacheManager\generateObjectViewCache(), eZContentObjectPackageHandler\generateOverrideSettingsArray(), eZNodeviewfunctions\generateViewCacheFile(), eZModule\getAllowedRedirectHosts(), ezpRestRequest\getBaseURI(), ezpRestRouter\getCachedRoutes(), eZHTTPTool\getDataByURL(), eZSearch\getEngine(), getExtensionsInfo(), ezpMobileDeviceDetectFilter\getFilter(), eZLDAPUser\getGroupNameByDN(), ezpMultivariateTest\getHandler(), eZExtension\getHandlerClass(), eZSession\getHandlerInstance(), eZSiteAccess\getIni(), eZLDAPUser\getNodeAssignmentsForGroupName(), ezpAttributeOperatorManager\getOutputFormatter(), eZDir\getPathFromFilename(), eZDefaultVATHandler\getProductCategory(), ezpRestIniRouteFilter\getSkipRoutes(), eZSSLZone\getSSLZones(), eZVATManager\getUserCountryAttributeName(), eZWebDAVContentBackend\getVirtualFolderCollection(), eZCharTransform\groupCommands(), eZUser\groups(), eZGeneralDigestHandler\handle(), eZContentUpload\handleLocalFile(), eZContentObjectPackageHandler\handleParameters(), eZSubTreeHandler\handlePublishEvent(), handleRelationTemplate(), eZContentUpload\handleUpload(), eZImageInterface\hasGD2(), eZUser\hashType(), eZHTTPHeader\headerOverrideArray(), eZSys\hostname(), eZLocale\httpLocaleCode(), eZi18nOperator\i18nTrans(), eZImageAliasHandler\imagePath(), eZImageAliasHandler\imagePathByNode(), eZContentCache\inCleanupThresholdRange(), eZSys\indexFile(), eZCollaborationViewHandler\ini(), eZCollaborationItemHandler\ini(), eZTemplate\ini(), eZStepCreateSites\init(), eZStepDatabaseInit\init(), eZPDFTable\initFrameMargins(), eZXHTMLXMLOutput\initHandlerEmbed(), ezpContentPublishingQueue\initHooks(), eZECBHandler\initialize(), eZContentObjectEditHandler\initialize(), eZScript\initialize(), eZModule\initialize(), eZSimpleTagsOperator\initializeIncludes(), eZIniSettingType\initializeObjectAttribute(), eZContentObjectPackageCreator\initializeObjectLimits(), eZStepCreateSites\initializePackage(), eZContentObjectPackageInstaller\initializeSiteAccess(), eZContentObjectPackageInstaller\initializeTopNodes(), eZURLOperator\iniTrans(), eZINIAddonPackageHandler\install(), eZExtensionPackageHandler\install(), eZContentObjectPackageHandler\installFetchAliases(), eZContentObjectPackageHandler\installOverrides(), eZContentObjectPackageHandler\installTemplates(), eZDbSchema\instance(), eZNotificationTransport\instance(), eZUserLoginHandler\instance(), eZDB\instance(), eZBinaryFileHandler\instance(), eZFileHandler\instance(), eZUser\instance(), eZLocale\instance(), eZTextCodec\internalCharset(), eZTemplateTreeCache\internalKey(), eZTemplateCompiler\isAccumulatorsEnabled(), eZTemplateTreeCache\isCacheEnabled(), eZTemplateCompiler\isCommentsEnabled(), eZTemplateCompiler\isCompilationEnabled(), eZContentObject\isComplexViewMode(), eZDebugSetting\isConditionTrue(), ezpRestDebug\isDebugEnabled(), eZTemplateCompiler\isDevelopmentModeEnabled(), ezpMultivariateTestHandler\isEnabled(), ezpMobileDeviceDetect\isEnabled(), ezpI18n\isEnabled(), eZTemplateCompiler\isExecutionEnabled(), isExtensionSiteaccess(), eZTemplateCompiler\isFallbackResourceCodeEnabled(), eZSSLZone\isKeepModeView(), ezpLanguageSwitcher\isLocaleAvailableAsFallback(), eZTemplate\isMethodDebugEnabled(), eZTemplateCompiler\isNodePlacementEnabled(), eZContentObject\isObjectRelationTyped(), ezpAttributeOperatorManager\isRegisteredFormatter(), isSettingReadOnly(), eZSys\isSSLNow(), eZTemplate\isTemplatesUsageStatisticsEnabled(), eZTemplateCompiler\isTimingPointsEnabled(), eZTemplateCompiler\isTreeEnabled(), eZUser\isTrusted(), ezpLanguageSwitcher\isUrlPointingToModule(), eZVATManager\isUserCountryRequired(), eZUser\isUserLoggedIn(), eZTemplate\isXHTMLCodeIncluded(), eZLocale\languageFile(), ezpRestDbConfig\lazyDbHelper(), eZUser\limitValueList(), eZMail\lineSeparator(), eZLintSchema\lintCheckSchema(), eZPaymentGatewayType\loadAndRegisterBuiltInGateways(), eZPaymentGatewayType\loadAndRegisterExtensionGateways(), eZNotificationEventType\loadAndRegisterType(), eZWorkflowType\loadAndRegisterType(), eZDataType\loadAndRegisterType(), eZShippingManager\loadBasketInfoHandler(), eZNotificationEventFilter\loadHandler(), eZContentObjectPackageCreator\loadObjectLimits(), eZDBSchemaInterface\loadSchemaTransformationRules(), eZShippingManager\loadShippingHandler(), eZCodeMapper\loadTransformationFiles(), eZTSTranslator\loadTranslationFile(), eZVATManager\loadVATHandler(), eZLocale\localeFile(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), eZPackage\maintainerRoleListForRoles(), eZSiteAccess\match(), eZContentObject\matchIngroupIDList(), eZCurrencyConverter\mathHandler(), eZContentBrowseRecent\maximumRecentItems(), eZUser\maxNumberOfFailedLogin(), eZRunCronjobs\maxScriptExecutionTime(), eZBinaryFile\metaData(), ezpLanguageSwitcherOperator\modify(), eZWordToImageOperator\modify(), eZModuleOperator\modify(), eZPDF\modify(), eZSimpleTagsOperator\modify(), eZTopMenuOperator\modify(), eZTemplateImageOperator\modify(), eZTemplateLocaleOperator\modify(), eZTemplateUnitOperator\modify(), eZTemplateStringOperator\modify(), eZURLOperator\modify(), eZTemplateAttributeOperator\namedParameterList(), eZContentBrowse\nodeAliasID(), eZContentUpload\nodeAliasID(), eZContentObjectAssignmentHandler\nodeID(), eZContentCacheManager\nodeListForObject(), eZIniSettingType\objectAttributeContent(), eZDataType\objectDisplayInformation(), eZContentUpload\objectFileInfo(), eZPHPCreator\open(), eZOperationHandler\operationIsAvailable(), eZTemplateUnitOperator\operatorTransform(), eZMail\outputCharset(), parameterSet(), eZContentObjectTreeNode\parentDepthLimitationList(), eZPDFParser\parseFile(), eZWordParser\parseFile(), eZHTTPTool\password(), eZUser\passwordCharacterTable(), eZContentObjectTreeNode\pathWithNames(), postInstallAdminSiteaccessINIUpdate(), postInstallUserSiteaccessINIUpdate(), eZUserLoginHandler\preCheck(), eZShopFunctions\preferredCurrencyCode(), eZSearchEngine\prepareWordIDArrays(), eZExtension\prependSiteAccess(), eZDebug\printReportInternal(), eZContentLanguage\prioritizedLanguages(), eZURLAliasFilterAppendNodeID\process(), ezpMobileDeviceRegexpFilter\process(), eZTemplateMenuFunction\process(), eZTemplateCacheFunction\process(), eZTemplateToolbarFunction\process(), eZURLAliasFilter\processFilters(), eZStepSiteTemplates\processPostData(), eZWebDAVContentBackend\propFind(), eZLDAPUser\publishNewUserGroup(), eZLDAPUser\publishUpdateUser(), ezpSessionHandlerDB\read(), eZImageAnalyzer\readAnalyzerSettingsFromINI(), eZImageManager\readConversionRuleSettingsFromINI(), eZImageManager\readImageAliasesFromINI(), eZImageManager\readImageHandlersFromINI(), eZImageManager\readMIMETypeQualitySettingFromINI(), eZImageManager\readMIMETypeSettingFromINI(), eZImageManager\readMIMETypeSettingsFromINI(), eZImageManager\readSupportedFormatsFromINI(), ezpMobileDeviceRegexpFilter\redirect(), ezpKernelWeb\redirect(), eZInformationCollection\redirectURL(), ezpEvent\registerEventListeners(), eZSession\registerFunctions(), eZContentOperationCollection\registerSearchObject(), eZProductCategory\removeByID(), removeRelatedCache(), eZContentObjectTreeNode\removeThis(), ezpContentXHTMLRenderer\render(), eZDBInterface\reportError(), eZPackage\repositoryPath(), ezpKernelWeb\requestInit(), eZUser\requireUniqueEmail(), resetINI(), ezpRestCacheStorageApcCluster\restore(), eZContentBrowse\result(), eZUser\roleIDList(), eZDBInterface\rollback(), eZTranslationCache\rootCacheDirectory(), eZCurrencyConverter\roundingPrecision(), eZCurrencyConverter\roundingTarget(), eZCurrencyConverter\roundingType(), eZScriptTrashPurge\run(), ezpKernelTreeMenu\run(), ezpKernelWeb\run(), ezpMvcConfiguration\runCustomFilters(), eZSiteAccess\saNameByLanguage(), eZSearchEngine\search(), eZMailNotificationTransport\send(), eZMailTransport\send(), eZUserOperationCollection\sendActivationEmail(), eZFileTransport\sendMail(), eZSMTPTransport\sendMail(), eZSendmailTransport\sendMail(), eZDefaultConfirmOrderHandler\sendOrderEmail(), eZInformationCollection\sendOutEmail(), eZContentOperationCollection\sendToPublishingQueue(), eZUserOperationCollection\sendUserNotification(), eZSys\serverURL(), eZUserLoginHandler\sessionCleanup(), ezpKernelTreeMenu\sessionInit(), ezpKernelWeb\sessionInit(), eZTranslatorManager\setActiveTranslation(), eZTemplateTreeCache\setCachedTree(), eZSession\setCookieParams(), eZRSSEditFunction\setItemDefaults(), ezpSessionHandlerPHP\setSaveHandler(), eZIniSettingType\setSiteAccessList(), ezpRestNoAuthStyle\setup(), eZContentObjectAssignmentHandler\setupAssignments(), ezpLanguageSwitcher\setupTranslationSAList(), eZURI\setURIString(), ezpRestAuthConfiguration\shallAuthenticate(), eZContentObjectTreeNode\showInvisibleNodes(), eZUser\site(), eZSiteAccess\siteAccessList(), eZStepInstaller\siteaccessURLs(), eZScript\startup(), eZPackage\stateList(), eZSys\storageDirectory(), eZHTTPFile\store(), eZPHPCreator\store(), eZStaticCache\storeCachedFile(), eZFSFileHandler\storeContents(), eZPackageType\storeObjectAttribute(), eZRSSEditFunction\storeRSSExport(), eZContentObjectTreeNode\subTreeCountByNodeID(), eZSSLZone\switchIfNeeded(), eZPackage\systemRepositoryInformation(), eZTemplateMenuFunction\templateNodeTransformation(), eZTemplateToolbarFunction\templateNodeTransformation(), eZTemplateCacheFunction\templateNodeTransformation(), eZTemplateCompiler\TemplatePrefix(), eZURLWildcard\translate(), eZURLAliasML\translate(), ezpI18n\translateText(), eZInformationCollection\typeForObject(), eZPackage\typeList(), eZExtensionPackageHandler\uninstall(), eZIniSettingType\unserializeContentClassAttribute(), eZBinaryFileType\unserializeContentObjectAttribute(), eZMediaType\unserializeContentObjectAttribute(), eZShopFunctions\updateAutoRates(), ezpRestDebug\updateDebugSettings(), eZScript\updateDebugSettings(), updateINI_1_1_0(), updateINI_1_2_0(), updateINI_1_4_0(), updateINIAccessType(), eZSiteInstaller\updateINIFiles(), eZContentObjectTreeNode\updateSubTreePath(), eZScript\updateTextCodecSettings(), eZContentUpload\upload(), eZContentObjectTreeNode\url(), eZContentObjectTreeNode\urlAlias(), eZContentClass\urlAliasName(), eZURLOperator\urlTransformation(), eZURLAliasML\urlTranslationEnabledByUri(), eZInformationCollection\userDataHandling(), eZHTTPTool\username(), eZIniSettingType\validateClassAttributeHTTPInput(), eZUser\validateLoginName(), eZIniSettingType\validateObjectAttributeHTTPInput(), eZUserType\validateObjectAttributeHTTPInput(), eZUser\validatePassword(), eZSys\varDirectory(), eZContentClass\versionHistoryLimit(), eZXMLInputParser\wordMatchSupport(), eZCharTransform\wordSeparator(), eZLog\write(), ezpSessionHandlerDB\write(), eZDebug\writeFile(), and eZLog\writeStorageLog().

static eZINI::isCacheEnabled ( )
static

Returns whether INI cache is enabled globally, by default it is true.

See Also
setIsCacheEnabled().
Returns
bool
static eZINI::isDebugEnabled ( )
static

Returns whether debugging of internals is enabled.

This will display which files are loaded an when cache files are created.

See Also
setIsDebugEnabled()
Returns
bool
static eZINI::isLoaded (   $fileName = 'site.ini',
  $rootDir = 'settings',
  $useLocalOverrides = null 
)
static

Returns whether the mentioned ini file has been loaded.

Parameters
string$fileName
string$rootDir
null | bool$useLocalOverridesdefault system setting if null
Returns
bool
static eZINI::isNoCacheAdviced ( )
static
Returns
true if cache is not adviced to be used.
Note
The no-cache-adviced flag might not be modified in time for site.ini and some other important files to be affected.

Referenced by eZINI().

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

Referenced by setGroups(), and setVariable().

static eZINI::isTextCodecEnabled ( )
static

Returns whether textcodecs is to be used, this will use the eZTextCodec class in the eZI18N library for text conversion.

See Also
setIsTextCodecEnabled()
Returns
bool
eZINI::isVariableModified (   $blockName,
  $varName 
)
Returns
true if the variable $varName in group $blockName has been modified.
eZINI::load (   $reset = true)

Tries to load the ini file specified in the constructor or instance() function.

If cache files should be used and a cache file is found it loads that instead.

Parameters
bool$resetReset ini values on instance

Referenced by eZINI().

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

Will load a cached version of the ini file if it exists, if not it will parse the original file and create the cache file.

protected

Please use eZINI::load() or eZINI::loadPlacement()

Parameters
bool$resetReset ini values on instance
bool$placementLoad cache for placment info, not the ini values themself.

Referenced by load(), and loadPlacement().

eZINI::loadPlacement (   $reset = true)

Tries to load the ini file placement specified in the constructor or instance() function.

If cache files should be used and a cache file is found it loads that instead.

Since
5.0 takes injected settings into account
Parameters
bool$resetReset ini values on instance

Referenced by groupPlacements().

eZINI::overrideDirs (   $scope = null)

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

Parameters
string | null | false$scopeSee 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
array

Referenced by cacheFileName(), and findInputFiles().

static eZINI::overrideDirsByScope ( array  $dirs,
  $scope = null 
)
staticprotected

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

Parameters
array$dirsDirectories directly from internal raw structure (see above).
string | null | false$scopeSee 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
array
static eZINI::parameterSet (   $fileName = 'site.ini',
  $rootDir = 'settings',
$section,
$parameter 
)
static

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

Deprecated:
Since 4.4
Parameters
stringfileName file name (optional)
stringrootDir directory (optional)
stringsection section name
stringparameter parameter name
Returns
bool True if the the parameter is set.

Referenced by eZIniSettingType\initializeObjectAttribute(), and eZIniSettingType\objectAttributeContent().

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

Parses either the override ini file or the standard file and then the append override file if it exists.

Referenced by load(), loadCache(), and loadPlacement().

eZINI::parseFile (   $file,
  $placement = false 
)
private

Will parse the INI file and store the variables in the variable $this->BlockValues

Referenced by parse().

eZINI::prependOverrideDir (   $dir,
  $globalDir = false,
  $identifier = false,
  $scope = null 
)

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

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

Parameters
string$dir
bool$globalDir
string | false$identifierWill overwrite existing directory with same identifier if set
string | null$scope
Returns
bool True if new dir was prepended, false if there was a $identifier match and a overwrite
eZINI::readOnlySettingsCheck ( )
Returns
ReadonlySettingsCheck variable.

Referenced by isSettingReadOnly().

eZINI::removeGroup (   $blockName)

Removes the group and all it's settings from the .ini file

Referenced by removeSetting().

eZINI::removeOverrideDir (   $identifier,
  $scope = 'extension' 
)

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

Parameters
string$identifierWill remove existing directory with identifier it it exists
string$scopeBy default 'extension'
Returns
bool True if new dir was appended, false if there was a $identifier match and a overwrite
eZINI::removeSetting (   $blockName,
  $settingName 
)
eZINI::reset ( )

Removes all read data from .ini files.

Referenced by loadCache(), and parse().

static eZINI::resetAllGlobals (   $resetGlobalOverrideDirs = true)
static

Reset all eZINI instances as well override dirs ( optional )

Deprecated:
since 4.5, use resetAllInstances() instead
Parameters
bool$resetOverrideDirsSpecify if you don't want to clear override dirs
See Also
resetAllInstances()
static eZINI::resetAllInstances (   $resetGlobalOverrideDirs = true)
static

Reset all eZINI instances as well override dirs ( optional )

Since
4.5
Parameters
bool$resetOverrideDirsSpecify if you don't want to clear override dirs

Referenced by ezpKernelWeb\__construct(), eZScript\initialize(), and eZSiteAccess\load().

eZINI::resetCache ( )

the cache file if it exists.

static eZINI::resetGlobalOverrideDirs ( )
static

Reset the global override directories with data from eZINI::defaultOverrideDirs().

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

Resets a specific instance of eZINI.

Deprecated:
since 4.5, use resetInstance() instead
Parameters
string$fileName
string$rootDir
null | bool$useLocalOverridesdefault system setting if null
See Also
resetInstance()
static eZINI::resetInstance (   $fileName = 'site.ini',
  $rootDir = 'settings',
  $useLocalOverrides = null 
)
static

Resets a specific instance of eZINI.

Since
4.5
Parameters
string$fileName
string$rootDir
null | bool$useLocalOverridesdefault system setting if null

Referenced by eZTranslatorManager\setActiveTranslation().

eZINI::resetOverrideDirs ( )

Reset the override directories with data from eZINI::defaultOverrideDirs().

eZINI::rootDir ( )
Returns
the root directory from where all .ini and override files are read.

This is set by the instance() or eZINI() functions.

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

Saves the file to disk. If filename is given the file is saved with that name if not the current name is used. If $useOverride is true then the file will be placed in the override directory, if $useOverride is "append" it will append ".append" to the filename.

eZINI::saveCache (   $cachedDir,
  $cachedFile,
array  $data,
array  $inputFiles,
  $iniFile 
)
protected

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

Parameters
string$cachedDirCache dir, usually "var/cache/ini/"
string$cachedFileName of cache file as returned by cacheFileName()
array$dataConfiguration data as an associative array structure
array$inputFilesList of input files used as basis for cache (for use in load cache to check mtime)
string$iniFileIni file path string returned by findInputFiles() for main ini file
Returns
bool

Referenced by loadCache().

static eZINI::selectOverrideScope (   $scope,
  $identifier,
  $dir,
  $default 
)
staticprotected

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

Since
4.4
Parameters
string | null$scope
string$identifier
string$dir
string$default
Returns
string
eZINI::setGroups (   $groupArray)

Sets all groups overwriting the current values

static eZINI::setIsCacheEnabled (   $enabled)
static

Sets whether caching is enabled for INI files or not.

This setting is global and can be overriden in the instance() function.

See Also
isCacheEnabled().
Parameters
bool$enabled
static eZINI::setIsDebugEnabled (   $enabled)
static

Sets whether internal debugging is enabled or not.

This setting is global and can be overriden in the instance() function.

See Also
isDebugEnabled().
Parameters
bool$enabled
static eZINI::setIsTextCodecEnabled (   $enabled)
static

Sets whether textcodec conversion is enabled or not.

See Also
isTextCodecEnabled().
Parameters
bool$enabled
eZINI::setOverrideDirs ( array  $newDirs,
  $scope = false 
)

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

Parameters
array$newDirs
string | false$scopeSee eZINI::defaultOverrideDirs() for possible scope values

Referenced by resetOverrideDirs().

eZINI::setReadOnlySettingsCheck (   $readOnly = true)

Sets ReadonlySettingsCheck variable.

eZINI::settingType (   $settingValue)
eZINI::setVariable (   $blockName,
  $variableName,
  $variableValue 
)

Sets an INI file variable.

$ini->setVariable( 'SiteSettings', 'SiteName', 'mysite' );
See Also
setVariables

Referenced by setVariables().

eZINI::setVariables (   $variables)

Sets multiple variables from the array $variables.

Parameters
$variablesContains an associative array with groups as first key, variable names as second key and variable values as values.
$ini->setVariables( array( 'SiteSettings' => array( 'SiteName' => 'mysite',
'SiteURL' => 'mysite.com' ) ) );
See Also
setVariable
eZINI::variable (   $blockName,
  $varName 
)

Reads a variable from the ini file.

Returns false, if the variable was not found.

Since
5.0 takes injected settings into account
Parameters
string$blockName
string$varName
Returns
mixed
eZINI::variableArray (   $blockName,
  $varName 
)

Reads a variable from the ini file or injected settings.

The variable will be returned as an array. ; is used as delimiter.

Parameters
string$blockName
string$varName
Returns
array
eZINI::variableMulti (   $blockName,
  $varNames,
  $signatures = array() 
)

Reads multiple variables from the ini file.

Returns false, if the block does not exist.

Since
5.0 takes injected settings into account
Parameters
string$blockName
string$varNames
array$signatures
Returns
false|array

Member Data Documentation

eZINI::$AddArrayDefinition

If true empty element will be created in the beginning of array if it is defined in this ini file.

eZINI::$BlockValues

Variable to store the ini file values.

Referenced by getNamedArray(), and groups().

eZINI::$BlockValuesPlacement

Variable to store the setting placement (which file is the setting in).

Referenced by groupPlacements().

eZINI::$cacheEnabled = true
staticprotected
eZINI::$CacheFile

Stores the path and filename of the value cache file.

eZINI::$Charset

The charset of the ini file.

Referenced by save().

eZINI::$checkFileMtime = null
staticprotected
eZINI::$Codec

Variable to store the textcodec.

eZINI::$debugEnabled = false
staticprotected
eZINI::$DirectAccess

If true then all file loads are done directly on the filename.

Referenced by cacheFileName().

eZINI::$FileName

Stores the filename.

Referenced by filename(), findInputFiles(), groups(), save(), variable(), variableArray(), and variableMulti().

eZINI::$filePermission = null
staticprotected
eZINI::$GlobalOverrideDirArray = null
staticprotected

Contains global override dirs.

eZINI::$injectedSettings = array()
staticprotected
eZINI::$instances = array()
staticprotected
eZINI::$LocalOverrideDirArray

Contains the override dirs, if in local mode.

Referenced by appendOverrideDir(), overrideDirs(), prependOverrideDir(), removeOverrideDir(), and setOverrideDirs().

eZINI::$ModifiedBlockValues

Variable to store whether variables are modified or not.

eZINI::$PlacementCacheFile

Stores the path and filename of the placement cache file.

eZINI::$ReadOnlySettingsCheck = true

If true eZINI will check each setting (before saving) for correspondence of settings in site.ini[eZINISetting].ReadonlySettingList.

Referenced by readOnlySettingsCheck().

eZINI::$RootDir

The root of all ini files.

Referenced by findInputFiles(), rootDir(), and save().

eZINI::$textCodecEnabled = true
staticprotected
eZINI::$UseCache

true if cache should be used

eZINI::$UseLocalOverrides

true if the overrides should only be changed locally

eZINI::$UseTextCodec

Whether to use the text codec when reading the ini file or not.

const eZINI::CONFIG_CACHE_DIR = 'var/cache/ini/'
const eZINI::CONFIG_CACHE_REV = 2

Referenced by loadCache(), and saveCache().

const eZINI::INJECTED_PATH = 'injected'

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