eZPublish  4.5
eZCountryType Class Reference

A content datatype that contains country. More...

+ Inheritance diagram for eZCountryType:
+ Collaboration diagram for eZCountryType:

Public Member Functions

 classAttributeContent ($classAttribute)
 
 diff ($old, $new, $options=false)
 
 eZCountryType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 insertSimpleString ($object, $objectVersion, $objectLanguage, $objectAttribute, $string, &$result)
 
 isIndexable ()
 
 isInformationCollector ()
 
 isSimpleStringInsertionSupported ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 sortKey ($contentObjectAttribute)
 
 sortKeyType ()
 
 storeClassAttributeContent ($classAttribute, $content)
 
 storeObjectAttribute ($contentObjectAttribute)
 
 supportsBatchInitializeObjectAttribute ()
 
 title ($contentObjectAttribute, $name=null)
 
 toString ($contentObjectAttribute)
 
 validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 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)
 
 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)
 

Static Public Member Functions

static fetchCountry ($value, $fetchBy=false)
 
static fetchCountryList ()
 
static fetchTranslatedNames (&$countries)
 
- Static Public Member Functions inherited from eZDataType
static allowedTypes ()
 
static create ($dataTypeString)
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($type)
 
static register ($dataTypeString, $className)
 
static registeredDataTypes ()
 

Public Attributes

const DATA_TYPE_STRING = 'ezcountry'
 
const DEFAULT_LIST_FIELD = 'data_text5'
 
const MULTIPLE_CHOICE_FIELD = 'data_int1'
 
- 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...
 

Static Protected Member Functions

static compareCountryNames ($a, $b)
 Sort callback used by fetchTranslatedNames to compare two country arrays. More...
 

Detailed Description

A content datatype that contains country.

The list of countries is fetched from contenet.ini. Country is stored as text string.

Member Function Documentation

eZCountryType::classAttributeContent (   $classAttribute)
static eZCountryType::compareCountryNames (   $a,
  $b 
)
staticprotected

Sort callback used by fetchTranslatedNames to compare two country arrays.

Parameters
array$aCountry 1
array$bCountry 2
Returns
bool
eZCountryType::diff (   $old,
  $new,
  $options = false 
)
eZCountryType::eZCountryType ( )
eZCountryType::fetchClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZCountryType::fetchCollectionAttributeHTTPInput (   $collection,
  $collectionAttribute,
  $http,
  $base,
  $contentObjectAttribute 
)

Fetches the http post variables for collected information

static eZCountryType::fetchCountry (   $value,
  $fetchBy = false 
)
static

Fetches country by $fetchBy. if $fetchBy is false country name will be used.

Referenced by classAttributeContent(), fetchClassAttributeHTTPInput(), eZContentFunctionCollection\fetchCountryList(), fetchObjectAttributeHTTPInput(), and objectAttributeContent().

static eZCountryType::fetchCountryList ( )
static
eZCountryType::fetchObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

Fetches the http post var and stores it in the data instance.

static eZCountryType::fetchTranslatedNames ( $countries)
static

Fetches translated country names from locale $countries will be updated.

Referenced by fetchCountryList().

eZCountryType::fromString (   $contentObjectAttribute,
  $string 
)
eZCountryType::hasObjectAttributeContent (   $contentObjectAttribute)
eZCountryType::initializeObjectAttribute (   $contentObjectAttribute,
  $currentVersion,
  $originalContentObjectAttribute 
)

Sets the default value.

eZCountryType::insertSimpleString (   $object,
  $objectVersion,
  $objectLanguage,
  $objectAttribute,
  $string,
$result 
)
eZCountryType::isIndexable ( )
eZCountryType::isInformationCollector ( )
eZCountryType::isSimpleStringInsertionSupported ( )

Simple string insertion is supported.

eZCountryType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indeces.

eZCountryType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

eZCountryType::preStoreClassAttribute (   $classAttribute,
  $version 
)
eZCountryType::sortKey (   $contentObjectAttribute)
eZCountryType::sortKeyType ( )
eZCountryType::storeClassAttributeContent (   $classAttribute,
  $content 
)

Referenced by preStoreClassAttribute().

eZCountryType::storeObjectAttribute (   $contentObjectAttribute)
eZCountryType::supportsBatchInitializeObjectAttribute ( )
eZCountryType::title (   $contentObjectAttribute,
  $name = null 
)

Returns the country for use as a title

eZCountryType::toString (   $contentObjectAttribute)
Returns
string representation of an contentobjectattribute data for simplified export
eZCountryType::validateCollectionAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)
eZCountryType::validateObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

Member Data Documentation

const eZCountryType::DATA_TYPE_STRING = 'ezcountry'
const eZCountryType::DEFAULT_LIST_FIELD = 'data_text5'
const eZCountryType::MULTIPLE_CHOICE_FIELD = 'data_int1'

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