Class: I2CE FormField BINARY FILE

This article desrcibes the1 class I2CE_FormField_BINARY_FILE.

Extends the class: I2CE_FormField_DB_BLOB.
Parent Classses: I2CE_FormField_DB_BLOB I2CE_FormField I2CE_Fuzzy
Child Classes:
- I2CE_FormField_DOCUMENT
- I2CE_FormField_IMAGE
Location: Part of the module BinField in the package I2CE
Source: 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

Class for defining all the database fields used by a object.

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)
Parameters:
- DOMNode $node
- I2CE_Template $template
Returns: DOMNode

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)
Parameters:
- string $mime_type
Returns: true
if valid. false otherwise

processDOMEditable()

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

processDOMNotEditable()

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

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 Methods

addHistory()

This public method is inherited from I2CE_FormField->addHistory()

compare()

This public method is inherited from I2CE_FormField->compare()

createField()

This public method is inherited from I2CE_FormField->createField()

firstHistory()

This public method is inherited from I2CE_FormField->firstHistory()

getAttribute()

This public method is inherited from I2CE_FormField->getAttribute()

getDBType()

This public method is inherited from I2CE_FormField->getDBType()

getDisplays()

This public method is inherited from I2CE_FormField->getDisplays()

getForm()

This public method is inherited from I2CE_FormField->getForm()

getFromDB()

This public method is inherited from I2CE_FormField->getFromDB()

getHTMLName()

This public method is inherited from I2CE_FormField->getHTMLName()

getHeader()

This public method is inherited from I2CE_FormField->getHeader()

getHref()

This public method is inherited from I2CE_FormField->getHref()

getInvalid()

This public method is inherited from I2CE_FormField->getInvalid()

getMDB2Type()

This public method is inherited from I2CE_FormField->getMDB2Type()

getName()

This public method is inherited from I2CE_FormField->getName()

getOption()

This public method is inherited from I2CE_FormField->getOption()

getString()

This public method is inherited from I2CE_FormField->getString()

getTypeString()

This public method is inherited from I2CE_FormField->getTypeString()

getValue()

This public method is inherited from I2CE_FormField->getValue()

hasAttribute()

This public method is inherited from I2CE_FormField->hasAttribute()

hasDisplay()

This public method is inherited from I2CE_FormField->hasDisplay()

hasHeader()

This public method is inherited from I2CE_FormField->hasHeader()

hasInvalid()

This public method is inherited from I2CE_FormField->hasInvalid()

hasNextHistory()

This public method is inherited from I2CE_FormField->hasNextHistory()

hasOption()

This public method is inherited from I2CE_FormField->hasOption()

isInDB()

This public method is inherited from I2CE_FormField->isInDB()

isSameValue()

This public method is inherited from I2CE_FormField->isSameValue()

issetValue()

This public method is inherited from I2CE_FormField->issetValue()

nextHistory()

This public method is inherited from I2CE_FormField->nextHistory()

processDOM()

This public method is inherited from I2CE_FormField->processDOM()

setAttribute()

This public method is inherited from I2CE_FormField->setAttribute()

setForm()

This public method is inherited from I2CE_FormField->setForm()

setHeaders()

This public method is inherited from I2CE_FormField->setHeaders()

setHref()

This public method is inherited from I2CE_FormField->setHref()

setInvalid()

This public method is inherited from I2CE_FormField->setInvalid()

setValue()

This public method is inherited from I2CE_FormField->setValue()

unsetValue()

This public method is inherited from I2CE_FormField->unsetValue()

displayInvalid()

This protected method is inherited from I2CE_FormField->displayInvalid()

getElement()

This protected method is inherited from I2CE_FormField->getElement()

getOptionsByPath()

This protected method is inherited from I2CE_FormField->getOptionsByPath()

optionsHasPath()

This protected method is inherited from I2CE_FormField->optionsHasPath()

setElement()

This protected method is inherited from I2CE_FormField->setElement()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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()

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()

Anonymous

Search