eZ Publish  [4.2]
eZPriceType Class Reference

Stores a price (float) More...

+ Inheritance diagram for eZPriceType:
+ Collaboration diagram for eZPriceType:

List of all members.

Public Member Functions

 classAttributeContent ($classAttribute)
 contentActionList ($classAttribute)
 eZPriceType ()
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 fromString ($contentObjectAttribute, $string)
 hasObjectAttributeContent ($contentObjectAttribute)
 initializeClassAttribute ($classAttribute)
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 metaData ($contentObjectAttribute)
 objectAttributeContent ($contentObjectAttribute)
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 sortKey ($contentObjectAttribute)
 sortKeyType ()
 storeObjectAttribute ($attribute)
 supportsBatchInitializeObjectAttribute ()
 title ($contentObjectAttribute, $name=null)
 toString ($contentObjectAttribute)
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)

Public Attributes

const DATA_TYPE_STRING = "ezprice"
const EXCLUDED_VAT = 2
const INCLUDE_VAT_FIELD = 'data_int1'
const INCLUDE_VAT_VARIABLE = '_ezprice_include_vat_'
const INCLUDED_VAT = 1
const VAT_ID_FIELD = 'data_float1'
const VAT_ID_VARIABLE = '_ezprice_vat_id_'

Detailed Description

Stores a price (float)

Definition at line 38 of file ezpricetype.php.


Member Function Documentation

eZPriceType::classAttributeContent ( classAttribute)

Returns class content.

Reimplemented from eZDataType.

Definition at line 193 of file ezpricetype.php.

eZPriceType::contentActionList ( classAttribute)
Returns:
the content action(s) which can be performed on object containing the current datatype.

Reimplemented from eZDataType.

Definition at line 200 of file ezpricetype.php.

eZPriceType::eZPriceType ( )

Definition at line 48 of file ezpricetype.php.

eZPriceType::fetchClassAttributeHTTPInput ( http,
base,
classAttribute 
)

Fetches the HTTP input for the content class attribute.

Note:
Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 133 of file ezpricetype.php.

eZPriceType::fetchObjectAttributeHTTPInput ( http,
base,
contentObjectAttribute 
)

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

Reimplemented from eZDataType.

Definition at line 153 of file ezpricetype.php.

eZPriceType::fromString ( contentObjectAttribute,
string 
)

Reimplemented from eZDataType.

Definition at line 242 of file ezpricetype.php.

eZPriceType::hasObjectAttributeContent ( contentObjectAttribute)
Returns:
true if the datatype finds any content in the attribute $contentObjectAttribute.

Reimplemented from eZDataType.

Definition at line 226 of file ezpricetype.php.

eZPriceType::initializeClassAttribute ( classAttribute)

Set default class attribute value

Reimplemented from eZDataType.

Definition at line 127 of file ezpricetype.php.

eZPriceType::initializeObjectAttribute ( contentObjectAttribute,
currentVersion,
originalContentObjectAttribute 
)

reimp

Reimplemented from eZDataType.

Definition at line 113 of file ezpricetype.php.

eZPriceType::metaData ( contentObjectAttribute)
Returns:
the text which should be indexed in the search engine. An associative array can be returned to enable searching in specific parts of the data. E.g. array( 'first_column' => "foo", 'second_column' => "bar" );

Reimplemented from eZDataType.

Definition at line 105 of file ezpricetype.php.

eZPriceType::objectAttributeContent ( contentObjectAttribute)

Returns the content.

Reimplemented from eZDataType.

Definition at line 173 of file ezpricetype.php.

eZPriceType::serializeContentClassAttribute ( classAttribute,
attributeNode,
attributeParametersNode 
)

Adds the necessary dom structure to the attribute parameters.

Note:
The default is to add unsupported='true' to the attribute node, meaning that the datatype does not support serializing.

Reimplemented from eZDataType.

Definition at line 260 of file ezpricetype.php.

eZPriceType::sortKey ( objectAttribute)
Returns:
the sort key for the datatype. This is used for sorting on attribute level.

Reimplemented from eZDataType.

Definition at line 215 of file ezpricetype.php.

eZPriceType::sortKeyType ( )
Returns:
the type of the sort key int|string False is returned if sorting is not supported

Reimplemented from eZDataType.

Definition at line 221 of file ezpricetype.php.

eZPriceType::storeObjectAttribute ( objectAttribute)

Stores the datatype data to the database which is related to the object attribute.

Returns:
True if the value was stored correctly.
Note:
The method is entirely up to the datatype, for instance it could reuse the available types in the the attribute or store in a separate object.
See also:
fetchObjectAttributeHTTPInput

Reimplemented from eZDataType.

Definition at line 101 of file ezpricetype.php.

eZPriceType::supportsBatchInitializeObjectAttribute ( )

Reimplemented from eZDataType.

Definition at line 326 of file ezpricetype.php.

eZPriceType::title ( objectAttribute,
name = null 
)

Returns the title of the current type, this is to form the title of the object.

Reimplemented from eZDataType.

Definition at line 210 of file ezpricetype.php.

eZPriceType::toString ( objectAttribute)
Returns:
string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 231 of file ezpricetype.php.

eZPriceType::unserializeContentClassAttribute ( classAttribute,
attributeNode,
attributeParametersNode 
)

Extracts values from the attribute parameters and sets it in the class attribute.

Note:
This function is called after the attribute has been stored and a second store is called after this function is done.

Reimplemented from eZDataType.

Definition at line 291 of file ezpricetype.php.

eZPriceType::validateObjectAttributeHTTPInput ( http,
base,
contentObjectAttribute 
)

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

Reimplemented from eZDataType.

Definition at line 59 of file ezpricetype.php.


Member Data Documentation

const eZPriceType::DATA_TYPE_STRING = "ezprice"

Definition at line 40 of file ezpricetype.php.

Definition at line 46 of file ezpricetype.php.

Referenced by unserializeContentClassAttribute().

const eZPriceType::INCLUDE_VAT_FIELD = 'data_int1'

Definition at line 41 of file ezpricetype.php.

Referenced by eZPrice\eZPrice().

const eZPriceType::INCLUDE_VAT_VARIABLE = '_ezprice_include_vat_'

Definition at line 42 of file ezpricetype.php.

Definition at line 45 of file ezpricetype.php.

Referenced by unserializeContentClassAttribute().

const eZPriceType::VAT_ID_FIELD = 'data_float1'

Definition at line 43 of file ezpricetype.php.

Referenced by eZPrice\eZPrice().

const eZPriceType::VAT_ID_VARIABLE = '_ezprice_vat_id_'

Definition at line 44 of file ezpricetype.php.


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