Class: I2CE FormField BINARY FILE (4.1.12)

For other versions, see Class: I2CE_FormField_BINARY_FILE (versions) .

This article describes the abstract class I2CE_FormField_BINARY_FILE .

• Extends the class: I2CE_FormField_STORE_BINARY_FILE.
• Child Classes:
  • I2CE_FormField_DOCUMENT
  • I2CE_FormField_IMAGE
    • I2CE_FormField_PASSPORT
• Location: Part of the module BinField in the package I2CE 4.1.12-release
• Source: Defined in the file modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 28
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v2.0.0

Class for defining the binary file field used by a object.

Variables

$mime_type

The magically determined mime type @var protected mixed $file_name. Either false or a string

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 33
• Type: protected $mime_type

$null_term

The number of null \0 at the end of the string (it seems MDB2 does truncates \0 when getting results)

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 40
• Type: protected int $null_term

$file_name

The file name as it was uploaded (may not be set) . Either false or string

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 46
• Type: protected mixed $file_name

$fmod_time

The time the file was uploaded (may not be set) . Either false or integer(unix time stamp)

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 52
• Type: protected mixed $fmod_time

$keys

An array whose keys are the keys to the metadata for the file and values are the variables they should be stored in . All keys need to be a string of length 9 @protected static array of string $keys

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 77
• Type: static protected $keys

Methods

__construct()

Create a new instance of a I2CE_FormField

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 68
• 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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 487
• Signature: abstract protected function defaultExtension()
• Returns: string

defaultMimeType()

get the default extension for this

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 494
• Signature: abstract protected function defaultMimeType()
• Returns: string

getBinaryData()

Gets the binary data for the form field

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 59
• Signature: public function getBinaryData()
• Returns: string

getContentLength()

Gets the length of the conten

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 177
• Signature: public function getContentLength()
• Returns: int

getDBValue()

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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 132
• Signature: public function getDBValue()
• Returns: mixed

getDisplayNode()

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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 373
• Signature: public function getDisplayNode($node,$template)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template
• Returns: DOMNode

getDisplayValue()

Returns the value of this field as a human readable format.

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 145
• Signature: public function getDisplayValue($entry,$style)
• Parameters:
  • I2CE_Entry $entry
    If an I2CE_Entry object is passed then it will return the value for that entry assuming it's an entry for this field.
    • Default Value: false
  • $style
    • Default Value: 'default'
• Returns: mixed

getExtension()

Get the extension associated with this binary file

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 520
• Signature: public function getExtension()

getFieldLink()

Generate the link to the given binary field in the given form id

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 196
• Signature: static public function getFieldLink($formid,$field,$key)
• Parameters:
  • string $formid
  • string $field
  • string $key
    Defaults to null. Otherwise it is a temp key
    • Default Value: null
• Returns: string

getFileName()

Get the file name associated to this binary field. if none, it will generate one based on the form and field

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 456
• Signature: public function getFileName()
• Returns: string

getHeaders()

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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 475
• 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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 208
• Signature: protected function getLink()
• Returns: mixed
  string on success or null on failure.

getMetaValue()

Return the meta data as a string for this file.

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 117
• Signature: public function getMetaValue()
• Returns: string;

getMimeType()

Get the magically determined mime type

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 504
• Signature: public function getMimeType()
• Returns: string

getModTime()

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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 185
• Signature: public function getModTime()

getTmpFileKeyValue()

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 258
• Signature: protected function getTmpFileKeyValue($key)
• Parameters:
  • $key

getValue()

Returns the value of this field.

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 104
• Signature: public function getValue()
• Returns: mixed

hasTmpFileKey()

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 284
• Signature: protected function hasTmpFileKey($key)
• Parameters:
  • $key

isTooBig()

Check if the set value is too big

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 397
• Signature: public function isTooBig()

isValid()

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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 409
• Signature: public function isValid()
• Returns: boolean

isValidMimeType()

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

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 392
• Signature: abstract public function isValidMimeType($mime_type)
• Parameters:
  • string $mime_type
• Returns: true
  if valid. false otherwise

processDOMEditable()

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 418
• Signature: public function processDOMEditable($node,$template,$form_node)
• Parameters:
  • $node
  • $template
  • $form_node

processDOMNotEditable()

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 442
• Signature: public function processDOMNotEditable($node,$template,$form_node)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template
  • DOMNode $form_node

setFromDB()

Sets the value of this field from the database format.

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 83
• Signature: public function setFromDB($value)
• Parameters:
  • mixed $value

setFromData()

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 216
• Signature: public function setFromData($data,$file_name,$mime_type,$fmod_time)
• Parameters:
  • $data
  • $file_name
  • $mime_type
    • Default Value: false
  • $fmod_time
    • Default Value: false

setFromPost()

Sets the value of this field from the posted form.

• Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 315
• Signature: public function setFromPost($post)
• Parameters:
  • mixed $post

Inherited Methods

setFromTemporaryLocation()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->setFromTemporaryLocation()

setFromTemporaryTable()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->setFromTemporaryTable()

setTempKey()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->setTempKey()

storeInTemporaryLocation()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->storeInTemporaryLocation()

storeInTemporaryTable()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->storeInTemporaryTable()

save()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->save()

setFromTemporaryFile()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->setFromTemporaryFile()

setupStorageFile()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->setupStorageFile()

setupTemporaryDirectory()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->setupTemporaryDirectory()

storeInTemporaryFile()

This public method is inherited from I2CE_FormField_STORE_BINARY_FILE->storeInTemporaryFile()

setFromPostUpload()

This protected method is inherited from I2CE_FormField_STORE_BINARY_FILE->setFromPostUpload()

setValueFromTempFile()

This protected method is inherited from I2CE_FormField_STORE_BINARY_FILE->setValueFromTempFile()

getStorageFile()

This protected method is inherited from I2CE_FormField_STORE_BINARY_FILE->getStorageFile()

Inherited Variables

$tmp_key

Theis protected variable is inherited from I2CE_FormField_STORE_BINARY_FILE->$tmp_key

$setStmt

Theis protected variable is inherited from I2CE_FormField_STORE_BINARY_FILE->$setStmt

$storeStmt

Theis protected variable is inherited from I2CE_FormField_STORE_BINARY_FILE->$storeStmt

$temp_file

Theis protected variable is inherited from I2CE_FormField_STORE_BINARY_FILE->$temp_file