Class: I2CE FormField BINARY FILE: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the1 class '''I2CE_FormField_BINARY_FILE''' which extends the class [[Class: I2CE_FormField_DB_BLOB | I2CE_FormField_DB_BLOB]]
This article desrcibes the1 class '''I2CE_FormField_BINARY_FILE'''.
*Extends the class: [[Class: I2CE_FormField_DB_BLOB | I2CE_FormField_DB_BLOB]].
It is contained in the module [[iHRIS Module List#BinField|BinField]] in the package [https://launchpad.net/i2ce I2CE]
It is contained in the module [[iHRIS Module List#BinField|BinField]] in the package [https://launchpad.net/i2ce I2CE]


Line 17: Line 18:
*Signature: public function __construct($name,$options)
*Signature: public function __construct($name,$options)
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string] $name
* [http://www.php.net/manual/en/language.types.string.php string ] $name
* [http://www.php.net/manual/en/language.types.array.php array] $options<br/>A list of options for this form field.
* [http://www.php.net/manual/en/language.types.array.php array ] $options<br/>A list of options for this form field.
**Default Value: array()  
**Default Value: array()  
===defaultExtension()===
===defaultExtension()===
get the default extension for this
get the default extension for this
*Signature: abstract protected function defaultExtension()
*Signature: abstract protected function defaultExtension()
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===defaultMimeType()===
===defaultMimeType()===
get the default extension for this
get the default extension for this
*Signature: abstract protected function defaultMimeType()
*Signature: abstract protected function defaultMimeType()
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getContentLength()===
===getContentLength()===
Gets the length of the conten
Gets the length of the conten
*Signature: public function getContentLength()
*Signature: public function getContentLength()
*Returns: [http://www.php.net/manual/en/language.types.integer.php int]
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ]
===getDBValue()===
===getDBValue()===
Returns the value of this field ready to be stored in the database.
Returns the value of this field ready to be stored in the database.
*Signature: public function getDBValue()
*Signature: public function getDBValue()
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed]
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===getDisplayNode()===
===getDisplayNode()===
Return the display value of this form field as a DOM Node.
Return the display value of this form field as a DOM Node.
*Signature: public function getDisplayNode($node,$template)
*Signature: public function getDisplayNode($node,$template)
*Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode]
*Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
Parameters:
Parameters:
* [http://www.php.net/manual/en/class.domnode.php domnode] $node
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
* [[Class: I2CE_Template | I2CE_Template]] $template
* [[Class: I2CE_Template | I2CE_Template]] $template
===getDisplayValue()===
===getDisplayValue()===
Line 51: Line 52:
Any headers that need to be sent when this field is dumped
Any headers that need to be sent when this field is dumped
*Signature: public function getHeaders()
*Signature: public function getHeaders()
*Returns: [http://www.php.net/manual/en/language.types.array.php array] of string
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] of string
===getLink()===
===getLink()===
Gets the link to this binary field.  It will fail if there is field is not attached to any form
Gets the link to this binary field.  It will fail if there is field is not attached to any form
*Signature: protected function getLink()
*Signature: protected function getLink()
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed] string on success or null on failure.
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] string on success or null on failure.
===getMimeType()===
===getMimeType()===
Get the magically determined mime type
Get the magically determined mime type
*Signature: public function getMimeType()
*Signature: public function getMimeType()
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getModTime()===
===getModTime()===
Returns the last modification time of this field, or false if unknown
Returns the last modification time of this field, or false if unknown
Line 67: Line 68:
Checks to see if the current value for this is set and valid.
Checks to see if the current value for this is set and valid.
*Signature: public function isValid()
*Signature: public function isValid()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===isValidMimeType()===
===isValidMimeType()===
Checks to see if a mime type is a valid  mime type for this binary file
Checks to see if a mime type is a valid  mime type for this binary file
Line 73: Line 74:
*Returns: true if valid.  false otherwise
*Returns: true if valid.  false otherwise
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string] $mime_type
* [http://www.php.net/manual/en/language.types.string.php string ] $mime_type
===processDOMEditable()===
===processDOMEditable()===
*Signature: public function processDOMEditable($node,$template,$form_node)
*Signature: public function processDOMEditable($node,$template,$form_node)
Line 82: Line 83:
===processDOMNotEditable()===
===processDOMNotEditable()===
*Signature: public function processDOMNotEditable($node,$template,$form_node)
*Signature: public function processDOMNotEditable($node,$template,$form_node)
*Returns: [http://www.php.net/manual/en/language.types.array.php array] of DOMNodes
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] of DOMNodes
Parameters:
Parameters:
*$node  
*$node  
Line 91: Line 92:
*Signature: public function setFromDB($value)
*Signature: public function setFromDB($value)
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.pseudo-types.php mixed] $value
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===setFromPost()===
===setFromPost()===
Sets the value of this field from the posted form.
Sets the value of this field from the posted form.
*Signature: public function setFromPost($post)
*Signature: public function setFromPost($post)
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.pseudo-types.php mixed] $post
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $post
==Inherited Variables==
==Inherited Variables==
===$name===
===$name===

Revision as of 22:24, 16 October 2009

This article desrcibes the1 class I2CE_FormField_BINARY_FILE.

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

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

  • Author: Carl Leitner <litlfred@ibiblio.org>
  • Since: v2.0.0

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:

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:

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:

setFromPost()

Sets the value of this field from the posted form.

  • Signature: public function setFromPost($post)

Parameters:

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_FormField_BINARY_FILE&oldid=6477"