Manual

SDK

 
   

API Reference
 

Sections

Todo

eZBinaryFileType Class Reference
[Kernel system]

The class eZBinaryFileType handles image accounts and association with content objects. More...

Inheritance diagram for eZBinaryFileType:

eZDataType List of all members.

Public Methods

 hasAttribute ($name)
& attribute ($name)
& fileHandler ()
& viewTemplate (&$contentobjectAttribute)
& editTemplate (&$contentobjectAttribute)
& informationTemplate (&$contentobjectAttribute)
 initializeObjectAttribute (&$contentObjectAttribute,$currentVersion,&$originalContentObjectAttribute)
 deleteStoredObjectAttribute (&$contentObjectAttribute,$version=null)
 checkFileUploads ()
 validateObjectAttributeHTTPInput (&$http,$base,&$contentObjectAttribute)
 fetchObjectAttributeHTTPInput (&$http,$base,&$contentObjectAttribute)
 storeObjectAttribute (&$contentObjectAttribute)
 fetchClassAttributeHTTPInput (&$http,$base,&$classAttribute)
 title (&$contentObjectAttribute,$name="filename")

Detailed Description

The class eZBinaryFileType handles image accounts and association with content objects.

Definition at line ezbinaryfiletype.php.

Member Function Documentation

& eZBinaryFileType::attribute (  $    name ) 
 

Returns:
the data for the attribute $attr or null if it does not exist.

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References eZDataType::attribute().

eZBinaryFileType::checkFileUploads (    ) 
 

Checks if file uploads are enabled, if not it gives a warning.

Definition at line ezbinaryfiletype.php.

Referenced by validateObjectAttributeHTTPInput().

eZBinaryFileType::deleteStoredObjectAttribute (  &$    contentObjectAttribute,
$    version = null
) 
 

Delete stored attribute

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References eZBinaryFile::remove().

& eZBinaryFileType::editTemplate (  &$    contentobjectAttribute ) 
 

Returns:
the template name to use for editing the attribute.
Note:
Default is to return the datatype string which is OK for most datatypes, if you want dynamic templates reimplement this function and return a template name.
The returned template name does not include the .tpl extension.
See also:
viewTemplate, informationTemplate

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References fileHandler().

eZBinaryFileType::fetchClassAttributeHTTPInput (  &$    http,
$    base,
&$    classAttribute
) 
 

Fetches the HTTP input for the content class attribute.

Note:
Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

eZBinaryFileType::fetchObjectAttributeHTTPInput (  &$    http,
$    base,
&$    contentObjectAttribute
) 
 

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

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References eZDebug::writeError().

& eZBinaryFileType::fileHandler (    ) 
 

Returns:
the binary file handler.

Definition at line ezbinaryfiletype.php.

Referenced by viewTemplate().

eZBinaryFileType::hasAttribute (  $    name ) 
 

Returns:
true if the attribute $attr exists in this object.

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References eZDataType::hasAttribute().

& eZBinaryFileType::informationTemplate (  &$    contentobjectAttribute ) 
 

Returns:
the template name to use for information collection for the attribute.
Note:
Default is to return the datatype string which is OK for most datatypes, if you want dynamic templates reimplement this function and return a template name.
The returned template name does not include the .tpl extension.
See also:
viewTemplate, editTemplate

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References fileHandler().

eZBinaryFileType::initializeObjectAttribute (  &$    contentObjectAttribute,
$    currentVersion,
&$    originalContentObjectAttribute
) 
 

Sets value according to current version

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

eZBinaryFileType::storeObjectAttribute (  &$    contentObjectAttribute ) 
 

Does nothing, since the file has been stored. See fetchObjectAttributeHTTPInput for the actual storing.

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

eZBinaryFileType::title (  &$    contentObjectAttribute,
$    name = "filename"
) 
 

Returns the object title.

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

eZBinaryFileType::validateObjectAttributeHTTPInput (  &$    http,
$    base,
&$    contentObjectAttribute
) 
 

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

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References eZHTTPFile::fetch().

& eZBinaryFileType::viewTemplate (  &$    contentobjectAttribute ) 
 

Reimplemented for internal reasons; the API is not affected.

Returns:
the template name which the handler decides upon.

Reimplemented from eZDataType.

Definition at line ezbinaryfiletype.php.

References fileHandler().

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

Exponential