eZPublishCommunityProject(LegacyStack)  2013.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, $name=null)
 
 toString ($contentObjectAttribute)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
- Public Member Functions inherited from eZDataType
 attribute ($attr)
 
 attributes ()
 
 batchInitializeObjectAttributeData ($classAttribute)
 
 classAttributeContent ($classAttribute)
 
 classAttributeRemovableInformation ($classAttribute, $includeAll=true)
 
 classDisplayInformation ($classAttribute, $mergeInfo=false)
 
 cloneClassAttribute ($oldClassAttribute, $newClassAttribute)
 
 contentActionList ($classAttribute)
 Return content action(s) which can be performed on object containing the current datatype. More...
 
 createContentObjectAttributeDOMNode ($objectAttribute)
 Create empty content object attribute DOM node. More...
 
 customClassAttributeHTTPAction ($http, $action, $classAttribute)
 
 customObjectAttributeHTTPAction ($http, $action, $objectAttribute, $parameters)
 
 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)
 
 getDBAExtensionFilePath ()
 
 getDBAFileName ()
 
 getDBAFilePath ($checkExtensions=true)
 
 handleCustomObjectHTTPActions ($http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 handleDownload ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 hasAttribute ($attr)
 
 hasInformationCollection ()
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 hasStoredFileInformation ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 importDBDataFromDBAFile ($dbaFilePath=false)
 
 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 ()
 
 isAddToBasketValidationRequired ()
 
 isClassAttributeRemovable ($classAttribute)
 
 isHTTPFileInsertionSupported ()
 
 isIndexable ()
 
 isInformationCollector ()
 
 isRegularFileInsertionSupported ()
 
 isSimpleStringInsertionSupported ()
 
 isTranslatable ()
 Indicates if datatype supports being translated. More...
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($objectAttribute)
 
 objectDisplayInformation ($objectAttribute, $mergeInfo=false)
 
 onPublish ($contentObjectAttribute, $contentObject, $publishedNodes)
 
 postInitializeObjectAttribute ($objectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 postStore ($objectAttribute)
 
 postUnserializeContentObjectAttribute ($package, $objectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 preStoreDefinedClassAttribute ($classAttribute)
 
 preStoreModifiedClassAttribute ($classAttribute)
 
 preStoreVersionedClassAttribute ($classAttribute, $version)
 Hook function which is called before an content class attribute is stored. More...
 
 productOptionInformation ($objectAttribute, $optionID, $productItem)
 
 removeRelatedObjectItem ($contentObjectAttribute, $objectID)
 
 repairContentObjectAttribute ($contentObjectAttribute)
 
 restoreTrashedObjectAttribute ($objectAttribute)
 Restores the content object attribute $objectAttribute from trash Default implementation does nothing. More...
 
 resultTemplate (&$collectionAttribute)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 serializeContentObjectAttribute ($package, $objectAttribute)
 
 sortKey ($objectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute ($classAttribute, $version)
 
 storeDefinedClassAttribute ($classAttribute)
 
 storedFileInformation ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 storeModifiedClassAttribute ($classAttribute)
 
 storeObjectAttribute ($objectAttribute)
 
 storeVersionedClassAttribute ($classAttribute, $version)
 
 supportsBatchInitializeObjectAttribute ()
 
 templateList ()
 
 title ($objectAttribute, $name=null)
 
 toString ($objectAttribute)
 
 trashStoredObjectAttribute ($objectAttribute, $version=null)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
 
 validateAddToBasket ($objectAttribute, $data, &$errors)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateCollectionAttributeHTTPInput ($http, $base, $objectAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $objectAttribute)
 
 viewTemplate ($contentobjectAttribute)
 

Public Attributes

const CLASS_FILE = '_ezinisetting_file_'
 
const CLASS_FILE_FIELD = 'data_text1'
 
const CLASS_INI_INSTANCE = '_ezinisetting_ini_instance_'
 
const CLASS_INI_INSTANCE_FIELD = 'data_text4'
 
const CLASS_PARAMETER = '_ezinisetting_parameter_'
 
const CLASS_PARAMETER_FIELD = 'data_text3'
 
const CLASS_SECTION = '_ezinisetting_section_'
 
const CLASS_SECTION_FIELD = 'data_text2'
 
const CLASS_TYPE = '_ezinisetting_type_'
 
const CLASS_TYPE_ARRAY = 6
 
const CLASS_TYPE_FIELD = 'data_int1'
 
const DATA_TYPE_STRING = 'ezinisetting'
 
const SITE_ACCESS_LIST_FIELD = 'data_text5'
 
- Public Attributes inherited from eZDataType
 $DataTypeString
 The datatype string ID, used for uniquely identifying a datatype. More...
 
 $Name
 The descriptive name of the datatype, usually used for displaying to the user. More...
 

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
static allowedTypes ()
 
static create ($dataTypeString)
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($type)
 
static register ($dataTypeString, $className)
 
static 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,
  $name = null 
)
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 
)

Member Data Documentation

const eZIniSettingType::CLASS_FILE = '_ezinisetting_file_'
const eZIniSettingType::CLASS_FILE_FIELD = 'data_text1'
const eZIniSettingType::CLASS_INI_INSTANCE = '_ezinisetting_ini_instance_'
const eZIniSettingType::CLASS_INI_INSTANCE_FIELD = 'data_text4'
const eZIniSettingType::CLASS_PARAMETER = '_ezinisetting_parameter_'
const eZIniSettingType::CLASS_PARAMETER_FIELD = 'data_text3'
const eZIniSettingType::CLASS_SECTION = '_ezinisetting_section_'
const eZIniSettingType::CLASS_SECTION_FIELD = 'data_text2'
const eZIniSettingType::CLASS_TYPE = '_ezinisetting_type_'
const eZIniSettingType::CLASS_TYPE_ARRAY = 6
const eZIniSettingType::CLASS_TYPE_FIELD = 'data_int1'
const eZIniSettingType::DATA_TYPE_STRING = 'ezinisetting'
const eZIniSettingType::SITE_ACCESS_LIST_FIELD = 'data_text5'

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