Class: I2CE FormField BINARY FILE

This article desrcibes the1 class I2CE_FormField_BINARY_FILE which extends the class I2CE_FormField_DB_BLOB It is contained in the module BinField in the package I2CE

The class is defined in the file: modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php

@author Carl Leitner <litlfred@ibiblio.org>

@since v2.0.0

@version v2.0.0

Class for defining all the database fields used by a {@link I2CE_Form} object.

@package I2CE

@access public

Variables

$mime_type

The magically determined mim type

• Type: protected $mime_type

Methods

__construct()

Create a new instance of a I2CE_FormField

• Signature: public function __construct($name,$options)

Parameters:

• string $name
• array $options
  A list of options for this form field.
  • Default Value: array()

defaultExtension()

get the default extension for this

• Signature: abstract protected function defaultExtension()
• Returns: string

defaultMimeType()

get the default extension for this

• Signature: abstract protected function defaultMimeType()
• Returns: string

getContentLength()

Gets the length of the conten

• Signature: public function getContentLength()
• Returns: int

getDBValue()

Returns the value of this field ready to be stored in the database.

• Signature: public function getDBValue()
• Returns: mixed

getDisplayNode()

Return the display value of this form field as a DOM Node.

• Signature: public function getDisplayNode($node,$template)
• Returns: DOMNode

Parameters:

• domnode $node
• I2CE_Template $template

getDisplayValue()

• Signature: public function getDisplayValue()

getExtension()

Get the extension associated with this binary file

• Signature: protected function getExtension()

getHeaders()

Any headers that need to be sent when this field is dumped

• Signature: public function getHeaders()
• Returns: array of string

getLink()

Gets the link to this binary field. It will fail if there is field is not attached to any form

• Signature: protected function getLink()
• Returns: mixed string on success or null on failure.

getMimeType()

Get the magically determined mime type

• Signature: public function getMimeType()
• Returns: string

getModTime()

Returns the last modification time of this field, or false if unknown @param mixed.

• Signature: public function getModTime()

isValid()

Checks to see if the current value for this is set and valid.

• Signature: public function isValid()
• Returns: boolean

isValidMimeType()

Checks to see if a mime type is a valid mime type for this binary file

• Signature: abstract public function isValidMimeType($mime_type)
• Returns: true if valid. false otherwise

Parameters:

• string $mime_type

processDOMEditable()

• Signature: public function processDOMEditable($node,$template,$form_node)

Parameters:

• $node
• $template
• $form_node

processDOMNotEditable()

• Signature: public function processDOMNotEditable($node,$template,$form_node)
• Returns: array of DOMNodes

Parameters:

• $node
• $template
• $form_node

setFromDB()

Sets the value of this field from the database format.

• Signature: public function setFromDB($value)

Parameters:

• mixed $value

setFromPost()

Sets the value of this field from the posted form.

• Signature: public function setFromPost($post)

Parameters:

• mixed $post

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormField->$name

$options

Theis protected variable is inherited from I2CE_FormField->$options

$value

Theis protected variable is inherited from I2CE_FormField->$value

$headers

Theis protected variable is inherited from I2CE_FormField->$headers

$href

Theis protected variable is inherited from I2CE_FormField->$href

$form

Theis protected variable is inherited from I2CE_FormField->$form

$history

Theis protected variable is inherited from I2CE_FormField->$history

$history_idx

Theis protected variable is inherited from I2CE_FormField->$history_idx

$attributes

Theis protected variable is inherited from I2CE_FormField->$attributes

$invalid

Theis protected variable is inherited from I2CE_FormField->$invalid

Inherited Fuzzy Methods

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()

isNumeric()

This method is inherited from I2CE_FormField->isNumeric()

getLimitStyles()

This method is inherited from I2CE_FormField->getLimitStyles()

generateLimit()

This method is inherited from I2CE_FormField->generateLimit()

generateLimit_null()

This method is inherited from I2CE_FormField->generateLimit_null()

generateLimit_not_null()

This method is inherited from I2CE_FormField->generateLimit_not_null()

generateLimit_null_not_null()

This method is inherited from I2CE_FormField->generateLimit_null_not_null()

checkLimit_null()

This method is inherited from I2CE_FormField->checkLimit_null()

checkLimit_not_null()

This method is inherited from I2CE_FormField->checkLimit_not_null()

checkLimit_null_not_null()

This method is inherited from I2CE_FormField->checkLimit_null_not_null()

checkLimitString_null()

This method is inherited from I2CE_FormField->checkLimitString_null()

checkLimitString_not_null()

This method is inherited from I2CE_FormField->checkLimitString_not_null()

checkLimitString_null_not_null()

This method is inherited from I2CE_FormField->checkLimitString_null_not_null()

getLimitMenu_null()

This method is inherited from I2CE_FormField->getLimitMenu_null()

getLimitMenu_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_not_null()

getLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()

processLimitMenu_null()

This method is inherited from I2CE_FormField->processLimitMenu_null()

processLimitMenu_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_not_null()

processLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()

generateLimit_max_parent()

This method is inherited from I2CE_FormField->generateLimit_max_parent()

generateLimit_min_parent()

This method is inherited from I2CE_FormField->generateLimit_min_parent()

generateLimit_max_parent_form()

This method is inherited from I2CE_FormField->generateLimit_max_parent_form()

generateLimit_min_parent_form()

This method is inherited from I2CE_FormField->generateLimit_min_parent_form()

getLimitMenu_max_parent()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent()

getLimitMenu_min_parent()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent()

getLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()

getLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()

processLimitMenu_max_parent()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent()

processLimitMenu_min_parent()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent()

processLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()

processLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()

save()

This method is inherited from I2CE_FormField->save()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()