eZStringType Class Reference
[Kernel system]

A content datatype which handles text lines. More...

Inheritance diagram for eZStringType:

eZDataType List of all members.

Public Methods

 eZStringType ()
 initializeObjectAttribute (&$contentObjectAttribute,$currentVersion,&$originalContentObjectAttribute)
 validateObjectAttributeHTTPInput (&$http,$base,&$contentObjectAttribute)
 fetchObjectAttributeHTTPInput (&$http,$base,&$contentObjectAttribute)
 storeObjectAttribute (&$attribute)
 storeClassAttribute (&$attribute,$version)
 storeDefinedClassAttribute (&$attribute)
 validateClassAttributeHTTPInput (&$http,$base,&$classAttribute)
 fixupClassAttributeHTTPInput (&$http,$base,&$classAttribute)
 fetchClassAttributeHTTPInput (&$http,$base,&$classAttribute)
objectAttributeContent (&$contentObjectAttribute)
 metaData (&$contentObjectAttribute)
 contentActionList (&$classAttribute)
 title (&$contentObjectAttribute)
 isIndexable ()
 isInformationCollector ()
serializeContentObjectAttribute ($objectAttribute)

Private Attributes

 MaxLenValidator

Detailed Description

A content datatype which handles text lines.

It provides the functionality to work as a text line and handles class definition input, object definition input and object viewing.

It uses the spare field data_text in a content object attribute for storing the attribute data.

Definition at line ezstringtype.php.


Constructor & Destructor Documentation

eZStringType::eZStringType  
 

Initializes with a string id and a description.

Definition at line ezstringtype.php.

References MaxLenValidator.


Member Function Documentation

eZStringType::contentActionList &$    classAttribute
 

\reuturn the collect information action if enabled

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

eZStringType::fetchClassAttributeHTTPInput &$    http,
  base,
&$    classAttribute
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

eZStringType::fetchObjectAttributeHTTPInput &$    http,
  base,
&$    contentObjectAttribute
 

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

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

eZStringType::fixupClassAttributeHTTPInput &$    http,
  base,
&$    classAttribute
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

References MaxLenValidator.

eZStringType::initializeObjectAttribute &$    contentObjectAttribute,
  currentVersion,
&$    originalContentObjectAttribute
 

Sets the default value.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

eZStringType::isIndexable  
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

eZStringType::isInformationCollector  
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

eZStringType::metaData &$    contentObjectAttribute
 

Returns the meta data used for storing search indeces.

Definition at line ezstringtype.php.

& eZStringType::objectAttributeContent &$    contentObjectAttribute
 

Returns the content.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

& eZStringType::serializeContentObjectAttribute   objectAttribute
 

Returns:
a DOM representation of the content object attribute

Definition at line ezstringtype.php.

References eZDOMDocument::createTextNode().

eZStringType::storeClassAttribute &$    attribute,
  version
 

Stores the datatype data to the database which is related to the class attribute. The $version parameter determines which version is currently being stored, 0 is the real version while 1 is the temporary version.

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:
fetchClassAttributeHTTPInput

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

References eZDataType::attribute().

eZStringType::storeObjectAttribute &$    attribute
 

Does nothing since it uses the data_text field in the content object attribute. See fetchObjectAttributeHTTPInput for the actual storing.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

References eZDataType::attribute().

eZStringType::title &$    contentObjectAttribute
 

Returns the content of the string for use as a title

Definition at line ezstringtype.php.

eZStringType::validateClassAttributeHTTPInput &$    http,
  base,
&$    classAttribute
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezstringtype.php.

References MaxLenValidator.

eZStringType::validateObjectAttributeHTTPInput &$    http,
  base,
&$    contentObjectAttribute
 

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

Reimplemented from eZDataType.

Definition at line ezstringtype.php.


Member Data Documentation

eZStringType::MaxLenValidator [private]
 

The max len validator

Definition at line ezstringtype.php.

Referenced by validateClassAttributeHTTPInput().


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

Exponential