eZPublish(LegacyStack)  5.1
eZISBNType Class Reference

Handles ISBN type strings. More...

+ Inheritance diagram for eZISBNType:
+ Collaboration diagram for eZISBNType:

Public Member Functions

 classAttributeContent ($classAttribute)
 
 cleanDBDataBeforeImport ()
 
 customClassAttributeHTTPAction ($http, $action, $classAttribute)
 
 eZISBNType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeClassAttribute ($classAttribute)
 
 isIndexable ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 storeClassAttributeContent ($classAttribute, $content)
 
 storeObjectAttribute ($attribute)
 
 supportsBatchInitializeObjectAttribute ()
 
 title ($data_instance, $name=null)
 
 toString ($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)
 
 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)
 

Static Public Member Functions

static convertISBN10toISBN13 ($isbnNr)
 
- 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 CLASS_IS_ISBN13 = 'data_int1'
 
const CONTENT_VALUE = 'data_text'
 
const DATA_TYPE_STRING = "ezisbn"
 
- 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

 validateISBN13Checksum ($isbnNr, &$error)
 
 validateISBNChecksum ($isbnNr)
 

Detailed Description

Handles ISBN type strings.

Member Function Documentation

eZISBNType::classAttributeContent (   $classAttribute)
eZISBNType::cleanDBDataBeforeImport ( )
static eZISBNType::convertISBN10toISBN13 (   $isbnNr)
static

Calculate the ISBN-13 checkdigit and return a valid ISBN-13 number based on an ISBN-10 number as input.

Returns
a valid ISBN-13 number.

Referenced by fetchObjectAttributeHTTPInput(), and eZISBN10To13Converter\updateContentObjectAttribute().

eZISBNType::customClassAttributeHTTPAction (   $http,
  $action,
  $classAttribute 
)
eZISBNType::eZISBNType ( )
eZISBNType::fetchClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZISBNType::fetchObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

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

eZISBNType::fromString (   $contentObjectAttribute,
  $string 
)
eZISBNType::hasObjectAttributeContent (   $contentObjectAttribute)

Check if an ISBN value exist in the datatype.

eZISBNType::initializeClassAttribute (   $classAttribute)

Initializes the class attribute. data_int will be se default to 1, as this is ISBN-13.

eZISBNType::isIndexable ( )

ISBN numbers are indexable, returns true.

eZISBNType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indeces.

eZISBNType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

eZISBNType::preStoreClassAttribute (   $classAttribute,
  $version 
)
eZISBNType::storeClassAttributeContent (   $classAttribute,
  $content 
)

Referenced by preStoreClassAttribute().

eZISBNType::storeObjectAttribute (   $attribute)

Store the content.

eZISBNType::supportsBatchInitializeObjectAttribute ( )
eZISBNType::title (   $data_instance,
  $name = null 
)

Returns the text.

eZISBNType::toString (   $contentObjectAttribute)
Returns
string representation of an contentobjectattribute data for simplified export
eZISBNType::validateISBN13Checksum (   $isbnNr,
$error 
)
private
Deprecated:
, should use the class eZISBN13 instead. Validates the ISBN-13 number $isbnNr.
Parameters
$isbnNrA string containing the number without any dashes.
Returns
true if it is valid.
eZISBNType::validateISBNChecksum (   $isbnNr)
private

Validates the ISBN number $isbnNr. All characters should be numeric except the last digit that may be the character X, which should be calculated as 10.

Parameters
$isbnNrA string containing the number without any dashes.
Returns
true if it is valid.

Referenced by validateObjectAttributeHTTPInput().

eZISBNType::validateObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

Validates the input and returns true if the input was valid for this datatype.

Member Data Documentation

const eZISBNType::CLASS_IS_ISBN13 = 'data_int1'
const eZISBNType::CONTENT_VALUE = 'data_text'
const eZISBNType::DATA_TYPE_STRING = "ezisbn"

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