eZPublish  3.9
eZIniSettingType Class Reference

A content datatype for setting ini file settings. More...

+ Inheritance diagram for eZIniSettingType:
+ Collaboration diagram for eZIniSettingType:

Public Member Functions

 diff ($old, $new, $options=false)
 
 eZIniSettingType ()
 
 fetchClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fetchObjectAttributeHTTPInput (&$http, $base, &$contentObjectAttribute)
 
 fromString (&$contentObjectAttribute, $string)
 
 hasObjectAttributeContent (&$contentObjectAttribute)
 
 initializeClassAttribute (&$classAttribute)
 
 initializeObjectAttribute (&$objectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
objectAttributeContent (&$contentObjectAttribute)
 
 onPublish (&$contentObjectAttribute, &$contentObject, &$publishedNodes)
 
 serializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 serializeContentObjectAttribute (&$package, &$objectAttribute)
 
 title (&$contentObjectAttribute)
 
 toString ($contentObjectAttribute)
 
 unserializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 validateObjectAttributeHTTPInput (&$http, $base, &$contentObjectAttribute)
 
- Public Member Functions inherited from eZDataType
 allowedTypes ()
 
attribute ($attr)
 
 attributes ()
 
classAttributeContent (&$classAttribute)
 
 classAttributeRemovableInformation (&$classAttribute, $includeAll=true)
 
classDisplayInformation (&$classAttribute, $mergeInfo=false)
 
 cloneClassAttribute (&$oldClassAttribute, &$newClassAttribute)
 
 contentActionList (&$classAttribute)
 
 createContentObjectAttributeDOMNode ($objectAttribute)
 Create empty content object attribute DOM node. More...
 
 customClassAttributeHTTPAction (&$http, $action, &$classAttribute)
 
 customObjectAttributeHTTPAction (&$http, $action, &$objectAttribute)
 
 customSorting ()
 
 customSortingSQL ($params)
 
 deleteStoredClassAttribute (&$classAttribute, $version=null)
 
 deleteStoredObjectAttribute (&$objectAttribute, $version=null)
 
 diff ($old, $new, $options=false)
 
editTemplate (&$contentobjectAttribute)
 
 eZDataType ($dataTypeString, $name, $properties=array())
 
 fetchActionValue ($action, $actionName, &$value)
 
 fetchClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fetchCollectionAttributeHTTPInput (&$collection, &$collectionAttribute, &$http, $base, &$objectAttribute)
 
 fetchObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 fixRelatedObjectItem (&$contentObjectAttribute, $objectID, $mode)
 
 fixupClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fixupCollectionAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 fixupObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 fromString (&$objectAttribute, $string)
 
 handleCustomObjectHTTPActions (&$http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 handleDownload (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 hasAttribute ($attr)
 
 hasInformationCollection ()
 
 hasObjectAttributeContent (&$contentObjectAttribute)
 
 hasStoredFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
informationTemplate (&$contentobjectAttribute)
 
 initializeClassAttribute (&$classAttribute)
 
 initializeObjectAttribute (&$objectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 insertHTTPFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, &$httpFile, $mimeData, &$result)
 
 insertRegularFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, $filePath, &$result)
 
 insertSimpleString (&$object, $objectVersion, $objectLanguage, &$objectAttribute, $string, &$result)
 
 isA ()
 
 isClassAttributeRemovable (&$classAttribute)
 
 isHTTPFileInsertionSupported ()
 
 isIndexable ()
 
 isInformationCollector ()
 
 isRegularFileInsertionSupported ()
 
 isSimpleStringInsertionSupported ()
 
 loadAndRegisterAllTypes ()
 
 loadAndRegisterType ($type)
 
 metaData ()
 
objectAttributeContent (&$objectAttribute)
 
 objectDisplayInformation (&$objectAttribute, $mergeInfo=false)
 
 onPublish (&$contentObjectAttribute, &$contentObject, &$publishedNodes)
 
 postInitializeObjectAttribute (&$objectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 postStore (&$objectAttribute)
 
 postUnserializeContentObjectAttribute (&$package, &$objectAttribute)
 
 preStoreClassAttribute (&$classAttribute, $version)
 
 preStoreDefinedClassAttribute (&$classAttribute)
 
 productOptionInformation (&$objectAttribute, $optionID, &$productItem)
 
 removeRelatedObjectItem (&$contentObjectAttribute, $objectID)
 
 repairContentObjectAttribute (&$contentObjectAttribute)
 
resultTemplate (&$collectionAttribute)
 
 serializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 serializeContentObjectAttribute (&$package, &$objectAttribute)
 
 sortKey (&$objectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute (&$classAttribute, $version)
 
 storeDefinedClassAttribute (&$classAttribute)
 
 storedFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 storeObjectAttribute (&$objectAttribute)
 
 templateList ()
 
 title (&$objectAttribute, $name=null)
 
 toString ($objectAttribute)
 
 unserializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 validateCollectionAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 validateObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
viewTemplate (&$contentobjectAttribute)
 

Private Member Functions

iniFile (&$contentClassAttribute)
 
iniParameterName (&$contentClassAttribute)
 
iniSection (&$contentClassAttribute)
 
 parseArrayInput ($inputText, &$outputArray, $makeEmptyArray=false)
 

Static Private Member Functions

 setSiteAccessList (&$contentClassAttribute)
 

Additional Inherited Members

- Static Public Member Functions inherited from eZDataType
 create ($dataTypeString)
 
 register ($dataTypeString, $className)
 
registeredDataTypes ()
 

Detailed Description

A content datatype for setting ini file settings.

Enable editing and versioning of ini files from the admin interface

Member Function Documentation

eZIniSettingType::diff (   $old,
  $new,
  $options = false 
)
eZIniSettingType::eZIniSettingType ( )

Initializes with a string id and a description.

eZIniSettingType::fetchClassAttributeHTTPInput ( $http,
  $base,
$classAttribute 
)
eZIniSettingType::fetchObjectAttributeHTTPInput ( $http,
  $base,
$contentObjectAttribute 
)
eZIniSettingType::fromString ( $contentObjectAttribute,
  $string 
)
eZIniSettingType::hasObjectAttributeContent ( $contentObjectAttribute)
& eZIniSettingType::iniFile ( $contentClassAttribute)
private

Get ini settings file

Parameters
ContentClass Attribute

Referenced by validateObjectAttributeHTTPInput().

& eZIniSettingType::iniParameterName ( $contentClassAttribute)
private

Get Ini section parameter name

Parameters
ContentClass Attribute

Referenced by validateObjectAttributeHTTPInput().

& eZIniSettingType::iniSection ( $contentClassAttribute)
private

Get Ini file section name

Parameters
ContentClass Attribute

Referenced by validateObjectAttributeHTTPInput().

eZIniSettingType::initializeClassAttribute ( $classAttribute)
eZIniSettingType::initializeObjectAttribute ( $objectAttribute,
  $currentVersion,
$originalContentObjectAttribute 
)
& eZIniSettingType::objectAttributeContent ( $contentObjectAttribute)
eZIniSettingType::onPublish ( $contentObjectAttribute,
$contentObject,
$publishedNodes 
)
eZIniSettingType::parseArrayInput (   $inputText,
$outputArray,
  $makeEmptyArray = false 
)
private

Parse array input text into array with korrect keys.

Parameters
inputtext
arrayto store parsed file to
Returns
true if parsed successfully, false if illegal syntax

Referenced by objectAttributeContent(), onPublish(), and validateObjectAttributeHTTPInput().

eZIniSettingType::serializeContentClassAttribute ( $classAttribute,
$attributeNode,
$attributeParametersNode 
)
eZIniSettingType::serializeContentObjectAttribute ( $package,
$objectAttribute 
)
eZIniSettingType::setSiteAccessList ( $contentClassAttribute)
staticprivate

Set site access list, including override option

Parameters
contentClassAttributeto set site access list and override options

Referenced by fetchClassAttributeHTTPInput(), and initializeClassAttribute().

eZIniSettingType::title ( $contentObjectAttribute)
eZIniSettingType::toString (   $contentObjectAttribute)
eZIniSettingType::unserializeContentClassAttribute ( $classAttribute,
$attributeNode,
$attributeParametersNode 
)

Use Override to do ini alterations if the specified site access does not exist

eZIniSettingType::unserializeContentObjectAttribute ( $package,
$objectAttribute,
  $attributeNode 
)
eZIniSettingType::validateClassAttributeHTTPInput ( $http,
  $base,
$classAttribute 
)
eZIniSettingType::validateObjectAttributeHTTPInput ( $http,
  $base,
$contentObjectAttribute 
)

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