kernel/classes/ezdatatype.php

Show:

inherited

Classes
- \eZDataType

Table of Contents

File containing the eZDataType class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\eZDataType
jump to top

Package: kernel

File containing the eZDataType class.

Children: \eZPriceType; \eZMultiOptionType; \eZProductCategoryType; \eZPackageType; \eZRangeOptionType; \eZUserType; \eZIntegerType; \eZSelectionType; \eZStringType; \eZBinaryFileType; \eZMatrixType; \eZBooleanType; \eZAuthorType; \eZSubtreeSubscriptionType; \eZMultiOption2Type; \eZMediaType; \eZFloatType; \eZXMLTextType; \eZKeywordType; \eZOptionType; \eZObjectRelationListType; \eZTimeType; \eZMultiPriceType; \eZEnumType; \eZURLType; \eZTextType; \eZIdentifierType; \eZDateTimeType; \eZISBNType; \eZImageType; \eZEmailType; \eZObjectRelationType; \eZIniSettingType; \eZDateType; \eZCountryType
Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Properties


                 $DataTypeString= ''

Details

Type: n/a


                 $Name= ''

Details

Type: n/a

Methods

allowedTypes(
          
          )
        
        :
          void

static

attribute(
           $attr
          )
        
        :
          void

Parameters

Name	Type	Description
$attr

attributes(
          
          )
        
        :
          void

batchInitializeObjectAttributeData(
           $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute

classAttributeContent(
           $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute

classAttributeRemovableInformation(
           $classAttribute,  $includeAll
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$includeAll

classDisplayInformation(
           $classAttribute,  $mergeInfo
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$mergeInfo

cleanDBDataBeforeImport(
          
          )
        
        :
          void

cloneClassAttribute(
           $oldClassAttribute,  $newClassAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$oldClassAttribute
$newClassAttribute

contentActionList(
          \eZContentClassAttribute $classAttribute
          )
        
        :
          array

Return content action(s) which can be performed on object containing the current datatype. Return format is array of arrays with key 'name' and 'action'. 'action' can be mapped to url in datatype.ini

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute

Returns

Type	Description
array

create(
           $dataTypeString
          )
        
        :
          void

static

Parameters

Name	Type	Description
$dataTypeString

createContentObjectAttributeDOMNode(
           $objectAttribute
          )
        
        :
          void

Create empty content object attribute DOM node.

The result is intended to be used in a datatype's serializeContentObjectAttribute() method.

\return "Empty" DOM node

Parameters

Name	Type	Description
$objectAttribute

customClassAttributeHTTPAction(
           $http,  $action,  $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$action
$classAttribute

customObjectAttributeHTTPAction(
           $http,  $action,  $objectAttribute,  $parameters
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$action
$objectAttribute
$parameters

customSorting(
          
          )
        
        :
          void

customSortingSQL(
           $params
          )
        
        :
          void

Parameters

Name	Type	Description
$params

deleteStoredClassAttribute(
           $classAttribute,  $version
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$version

deleteStoredObjectAttribute(
           $objectAttribute,  $version
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$version

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

Parameters

Name	Type	Description
$old
$new
$options

eZDataType(
           $dataTypeString,  $name,  $properties
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$dataTypeString
$name
$properties

editTemplate(
           $contentobjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$contentobjectAttribute

fetchActionValue(
           $action,  $actionName,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$action
$actionName
$value

fetchClassAttributeHTTPInput(
           $http,  $base,  $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$classAttribute

fetchCollectionAttributeHTTPInput(
           $collection,  $collectionAttribute,  $http,  $base,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$collection
$collectionAttribute
$http
$base
$objectAttribute

fetchObjectAttributeHTTPInput(
           $http,  $base,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$objectAttribute

fixRelatedObjectItem(
           $contentObjectAttribute,  $objectID,  $mode
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute
$objectID
$mode

fixupClassAttributeHTTPInput(
           $http,  $base,  $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$classAttribute

fixupCollectionAttributeHTTPInput(
           $http,  $base,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$objectAttribute

fixupObjectAttributeHTTPInput(
           $http,  $base,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$objectAttribute

fromString(
           $objectAttribute,  $string
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$string

getDBAExtensionFilePath(
          
          )
        
        :
          void

getDBAFileName(
          
          )
        
        :
          void

getDBAFilePath(
           $checkExtensions
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$checkExtensions

handleCustomObjectHTTPActions(
           $http,  $attributeDataBaseName,  $customActionAttributeArray,  $customActionParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

handleDownload(
           $object,  $objectVersion,  $objectLanguage,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$object
$objectVersion
$objectLanguage
$objectAttribute

hasAttribute(
           $attr
          )
        
        :
          void

Parameters

Name	Type	Description
$attr

hasInformationCollection(
          
          )
        
        :
          void

hasObjectAttributeContent(
           $contentObjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute

hasStoredFileInformation(
           $object,  $objectVersion,  $objectLanguage,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$object
$objectVersion
$objectLanguage
$objectAttribute

importDBDataFromDBAFile(
           $dbaFilePath
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$dbaFilePath

informationTemplate(
           $contentobjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$contentobjectAttribute

initializeClassAttribute(
           $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute

initializeObjectAttribute(
           $objectAttribute,  $currentVersion,  $originalContentObjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$currentVersion
$originalContentObjectAttribute

insertHTTPFile(
           $object,  $objectVersion,  $objectLanguage,  $objectAttribute,  $httpFile,  $mimeData,  $result
          )
        
        :
          void

Parameters

Name	Type	Description
$object
$objectVersion
$objectLanguage
$objectAttribute
$httpFile
$mimeData
$result

insertRegularFile(
           $object,  $objectVersion,  $objectLanguage,  $objectAttribute,  $filePath,  $result
          )
        
        :
          void

Parameters

Name	Type	Description
$object
$objectVersion
$objectLanguage
$objectAttribute
$filePath
$result

insertSimpleString(
           $object,  $objectVersion,  $objectLanguage,  $objectAttribute,  $string,  $result
          )
        
        :
          void

Parameters

Name	Type	Description
$object
$objectVersion
$objectLanguage
$objectAttribute
$string
$result

isAddToBasketValidationRequired(
          
          )
        
        :
          void

isClassAttributeRemovable(
           $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute

isHTTPFileInsertionSupported(
          
          )
        
        :
          void

isIndexable(
          
          )
        
        :
          void

isInformationCollector(
          
          )
        
        :
          void

isRegularFileInsertionSupported(
          
          )
        
        :
          void

isSimpleStringInsertionSupported(
          
          )
        
        :
          void

isTranslatable(
          
          )
        
        :
          bool

Indicates if datatype supports being translated

Returns

Type	Description
bool

loadAndRegisterAllTypes(
          
          )
        
        :
          void

static

loadAndRegisterType(
           $type
          )
        
        :
          void

static

Parameters

Name	Type	Description
$type

metaData(
           $contentObjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute

objectAttributeContent(
           $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute

objectDisplayInformation(
           $objectAttribute,  $mergeInfo
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$mergeInfo

onPublish(
           $contentObjectAttribute,  $contentObject,  $publishedNodes
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute
$contentObject
$publishedNodes

postInitializeObjectAttribute(
           $objectAttribute,  $currentVersion,  $originalContentObjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$currentVersion
$originalContentObjectAttribute

postStore(
           $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute

postUnserializeContentObjectAttribute(
           $package,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$objectAttribute

preStoreClassAttribute(
           $classAttribute,  $version
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$version

preStoreDefinedClassAttribute(
          \eZContentClassAttribute $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute	Content class attribute of the datatype

preStoreModifiedClassAttribute(
          \eZContentClassAttribute $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute	Content class attribute of the datatype

preStoreVersionedClassAttribute(
          \eZContentClassAttribute $classAttribute, int $version
          )
        
        :
          void

Hook function which is called before an content class attribute is stored

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute	Content class attribute of the datatype
$version	int	Version of the attribute to be stored

Details

See: \eZContentClassAttribute::storeVersioned()

productOptionInformation(
           $objectAttribute,  $optionID,  $productItem
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$optionID
$productItem

register(
           $dataTypeString,  $className
          )
        
        :
          void

static

Parameters

Name	Type	Description
$dataTypeString
$className

registeredDataTypes(
          
          )
        
        :
          void

static

removeRelatedObjectItem(
           $contentObjectAttribute,  $objectID
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute
$objectID

repairContentObjectAttribute(
           $contentObjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute

restoreTrashedObjectAttribute(
          \eZContentObjectAttribute $objectAttribute
          )
        
        :
          void

Restores the content object attribute $objectAttribute from trash Default implementation does nothing

Parameters

Name	Type	Description
$objectAttribute	\eZContentObjectAttribute

resultTemplate(
           $collectionAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$collectionAttribute

serializeContentClassAttribute(
           $classAttribute,  $attributeNode,  $attributeParametersNode
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$attributeNode
$attributeParametersNode

serializeContentObjectAttribute(
           $package,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$objectAttribute

sortKey(
           $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute

sortKeyType(
          
          )
        
        :
          void

storeClassAttribute(
           $classAttribute,  $version
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$version

storeDefinedClassAttribute(
          \eZContentClassAttribute $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute	Content class attribute of the datatype

Details

Note: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

storeModifiedClassAttribute(
          \eZContentClassAttribute $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute	Content class attribute of the datatype

Details

Note: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

storeObjectAttribute(
           $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute

storeVersionedClassAttribute(
          \eZContentClassAttribute $classAttribute, int $version
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute	\eZContentClassAttribute	Content class attribute of the datatype
$version	int	Version of the attribute to be stored

Details

Note: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

storedFileInformation(
           $object,  $objectVersion,  $objectLanguage,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$object
$objectVersion
$objectLanguage
$objectAttribute

supportsBatchInitializeObjectAttribute(
          
          )
        
        :
          void

templateList(
          
          )
        
        :
          void

title(
           $objectAttribute,  $name
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$name

toString(
           $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute

trashStoredObjectAttribute(
           $objectAttribute,  $version
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$version

unserializeContentClassAttribute(
           $classAttribute,  $attributeNode,  $attributeParametersNode
          )
        
        :
          void

Parameters

Name	Type	Description
$classAttribute
$attributeNode
$attributeParametersNode

unserializeContentObjectAttribute(
           $package,  $objectAttribute,  $attributeNode
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$objectAttribute
$attributeNode

validateAddToBasket(
           $objectAttribute,  $data,  $errors
          )
        
        :
          void

Parameters

Name	Type	Description
$objectAttribute
$data
$errors

validateClassAttributeHTTPInput(
           $http,  $base,  $classAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$classAttribute

validateCollectionAttributeHTTPInput(
           $http,  $base,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$objectAttribute

validateObjectAttributeHTTPInput(
           $http,  $base,  $objectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$http
$base
$objectAttribute

viewTemplate(
           $contentobjectAttribute
          )
        
        :
          void

Parameters

Name	Type	Description
$contentobjectAttribute

kernel/classes/ezdatatype.php

\eZDataTypejump to top

Properties

Methods

\eZDataType
jump to top