|
|
| (15 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the ''abstract'' class ''I2CE_FormField_BINARY_FILE''.
| | #REDIRECT [[Class: I2CE_FormField_BINARY_FILE (4.1.12)]] |
| *Extends the class: [[Class: I2CE_FormField_DB_BLOB | I2CE_FormField_DB_BLOB]].
| |
| *Child Classes:
| |
| ** [[Class: I2CE_FormField_DOCUMENT | I2CE_FormField_DOCUMENT]]
| |
| ** [[Class: I2CE_FormField_IMAGE | I2CE_FormField_IMAGE]]
| |
| *Location: Part of the module [[I2CE Module List#BinField|BinField]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php 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 [[Class: I2CE_Form | ]] 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:
| |
| ** [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.
| |
| ***Default Value: array()
| |
| ===defaultExtension()===
| |
| get the default extension for this
| |
| *Signature: abstract protected function defaultExtension()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===defaultMimeType()===
| |
| get the default extension for this
| |
| *Signature: abstract protected function defaultMimeType()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getContentLength()===
| |
| Gets the length of the conten
| |
| *Signature: public function getContentLength()
| |
| *Returns: [http://www.php.net/manual/en/language.types.integer.php int ]
| |
| ===getDBValue()===
| |
| Returns the value of this field ready to be stored in the database.
| |
| *Signature: public function getDBValue()
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===getDisplayNode()===
| |
| Return the display value of this form field as a DOM Node.
| |
| *Signature: public function getDisplayNode($node,$template)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [[Class: I2CE_Template | I2CE_Template]] $template
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php 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: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>string on success or null on failure.
| |
| ===getMimeType()===
| |
| Get the magically determined mime type
| |
| *Signature: public function getMimeType()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php 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: [http://www.php.net/manual/en/language.types.boolean.php 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:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $mime_type
| |
| *Returns: true<br/>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: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of DOMNodes
| |
| ===setFromDB()===
| |
| Sets the value of this field from the database format.
| |
| *Signature: public function setFromDB($value)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
| |
| ===setFromPost()===
| |
| Sets the value of this field from the posted form.
| |
| *Signature: public function setFromPost($post)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $post
| |
| ==Inherited Methods==
| |
| ===addHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormField#addHistory() | I2CE_FormField->addHistory()]]
| |
| | |
| ===compare()===
| |
| This public method is inherited from [[Class: I2CE_FormField#compare() | I2CE_FormField->compare()]]
| |
| | |
| ===createField()===
| |
| This public method is inherited from [[Class: I2CE_FormField#createField() | I2CE_FormField->createField()]]
| |
| | |
| ===firstHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormField#firstHistory() | I2CE_FormField->firstHistory()]]
| |
| | |
| ===getAttribute()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getAttribute() | I2CE_FormField->getAttribute()]]
| |
| | |
| ===getDBType()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getDBType() | I2CE_FormField->getDBType()]]
| |
| | |
| ===getDisplays()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getDisplays() | I2CE_FormField->getDisplays()]]
| |
| | |
| ===getForm()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getForm() | I2CE_FormField->getForm()]]
| |
| | |
| ===getFromDB()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getFromDB() | I2CE_FormField->getFromDB()]]
| |
| | |
| ===getHTMLName()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getHTMLName() | I2CE_FormField->getHTMLName()]]
| |
| | |
| ===getHeader()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getHeader() | I2CE_FormField->getHeader()]]
| |
| | |
| ===getHref()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getHref() | I2CE_FormField->getHref()]]
| |
| | |
| ===getInvalid()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getInvalid() | I2CE_FormField->getInvalid()]]
| |
| | |
| ===getMDB2Type()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getMDB2Type() | I2CE_FormField->getMDB2Type()]]
| |
| | |
| ===getName()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getName() | I2CE_FormField->getName()]]
| |
| | |
| ===getOption()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getOption() | I2CE_FormField->getOption()]]
| |
| | |
| ===getString()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getString() | I2CE_FormField->getString()]]
| |
| | |
| ===getTypeString()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getTypeString() | I2CE_FormField->getTypeString()]]
| |
| | |
| ===getValue()===
| |
| This public method is inherited from [[Class: I2CE_FormField#getValue() | I2CE_FormField->getValue()]]
| |
| | |
| ===hasAttribute()===
| |
| This public method is inherited from [[Class: I2CE_FormField#hasAttribute() | I2CE_FormField->hasAttribute()]]
| |
| | |
| ===hasDisplay()===
| |
| This public method is inherited from [[Class: I2CE_FormField#hasDisplay() | I2CE_FormField->hasDisplay()]]
| |
| | |
| ===hasHeader()===
| |
| This public method is inherited from [[Class: I2CE_FormField#hasHeader() | I2CE_FormField->hasHeader()]]
| |
| | |
| ===hasInvalid()===
| |
| This public method is inherited from [[Class: I2CE_FormField#hasInvalid() | I2CE_FormField->hasInvalid()]]
| |
| | |
| ===hasNextHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormField#hasNextHistory() | I2CE_FormField->hasNextHistory()]]
| |
| | |
| ===hasOption()===
| |
| This public method is inherited from [[Class: I2CE_FormField#hasOption() | I2CE_FormField->hasOption()]]
| |
| | |
| ===isInDB()===
| |
| This public method is inherited from [[Class: I2CE_FormField#isInDB() | I2CE_FormField->isInDB()]]
| |
| | |
| ===isSameValue()===
| |
| This public method is inherited from [[Class: I2CE_FormField#isSameValue() | I2CE_FormField->isSameValue()]]
| |
| | |
| ===issetValue()===
| |
| This public method is inherited from [[Class: I2CE_FormField#issetValue() | I2CE_FormField->issetValue()]]
| |
| | |
| ===nextHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormField#nextHistory() | I2CE_FormField->nextHistory()]]
| |
| | |
| ===processDOM()===
| |
| This public method is inherited from [[Class: I2CE_FormField#processDOM() | I2CE_FormField->processDOM()]]
| |
| | |
| ===setAttribute()===
| |
| This public method is inherited from [[Class: I2CE_FormField#setAttribute() | I2CE_FormField->setAttribute()]]
| |
| | |
| ===setForm()===
| |
| This public method is inherited from [[Class: I2CE_FormField#setForm() | I2CE_FormField->setForm()]]
| |
| | |
| ===setHeaders()===
| |
| This public method is inherited from [[Class: I2CE_FormField#setHeaders() | I2CE_FormField->setHeaders()]]
| |
| | |
| ===setHref()===
| |
| This public method is inherited from [[Class: I2CE_FormField#setHref() | I2CE_FormField->setHref()]]
| |
| | |
| ===setInvalid()===
| |
| This public method is inherited from [[Class: I2CE_FormField#setInvalid() | I2CE_FormField->setInvalid()]]
| |
| | |
| ===setValue()===
| |
| This public method is inherited from [[Class: I2CE_FormField#setValue() | I2CE_FormField->setValue()]]
| |
| | |
| ===unsetValue()===
| |
| This public method is inherited from [[Class: I2CE_FormField#unsetValue() | I2CE_FormField->unsetValue()]]
| |
| | |
| ===displayInvalid()===
| |
| This protected method is inherited from [[Class: I2CE_FormField#displayInvalid() | I2CE_FormField->displayInvalid()]]
| |
| | |
| ===getElement()===
| |
| This protected method is inherited from [[Class: I2CE_FormField#getElement() | I2CE_FormField->getElement()]]
| |
| | |
| ===getOptionsByPath()===
| |
| This protected method is inherited from [[Class: I2CE_FormField#getOptionsByPath() | I2CE_FormField->getOptionsByPath()]]
| |
| | |
| ===optionsHasPath()===
| |
| This protected method is inherited from [[Class: I2CE_FormField#optionsHasPath() | I2CE_FormField->optionsHasPath()]]
| |
| | |
| ===setElement()===
| |
| This protected method is inherited from [[Class: I2CE_FormField#setElement() | I2CE_FormField->setElement()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Variables==
| |
| ===$name===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$name | I2CE_FormField->$name]]
| |
| | |
| ===$options===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$options | I2CE_FormField->$options]]
| |
| | |
| ===$value===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$value | I2CE_FormField->$value]]
| |
| | |
| ===$headers===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$headers | I2CE_FormField->$headers]]
| |
| | |
| ===$href===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$href | I2CE_FormField->$href]]
| |
| | |
| ===$form===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$form | I2CE_FormField->$form]]
| |
| | |
| ===$history===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$history | I2CE_FormField->$history]]
| |
| | |
| ===$history_idx===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$history_idx | I2CE_FormField->$history_idx]]
| |
| | |
| ===$attributes===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$attributes | I2CE_FormField->$attributes]]
| |
| | |
| ===$invalid===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormField#$invalid | I2CE_FormField->$invalid]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===cachedTableReference()===
| |
| This method is inherited from [[Class: I2CE_FormField#cachedTableReference() | I2CE_FormField->cachedTableReference()]]
| |
| | |
| ===isNumeric()===
| |
| This method is inherited from [[Class: I2CE_FormField#isNumeric() | I2CE_FormField->isNumeric()]]
| |
| | |
| ===getLimitStyles()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitStyles() | I2CE_FormField->getLimitStyles()]]
| |
| | |
| ===generateLimit()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit() | I2CE_FormField->generateLimit()]]
| |
| | |
| ===generateLimit_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_null() | I2CE_FormField->generateLimit_null()]]
| |
| | |
| ===generateLimit_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_not_null() | I2CE_FormField->generateLimit_not_null()]]
| |
| | |
| ===generateLimit_null_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_null_not_null() | I2CE_FormField->generateLimit_null_not_null()]]
| |
| | |
| ===checkLimit_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#checkLimit_null() | I2CE_FormField->checkLimit_null()]]
| |
| | |
| ===checkLimit_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#checkLimit_not_null() | I2CE_FormField->checkLimit_not_null()]]
| |
| | |
| ===checkLimit_null_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#checkLimit_null_not_null() | I2CE_FormField->checkLimit_null_not_null()]]
| |
| | |
| ===checkLimitString_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#checkLimitString_null() | I2CE_FormField->checkLimitString_null()]]
| |
| | |
| ===checkLimitString_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#checkLimitString_not_null() | I2CE_FormField->checkLimitString_not_null()]]
| |
| | |
| ===checkLimitString_null_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#checkLimitString_null_not_null() | I2CE_FormField->checkLimitString_null_not_null()]]
| |
| | |
| ===getLimitMenu_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_null() | I2CE_FormField->getLimitMenu_null()]]
| |
| | |
| ===getLimitMenu_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_not_null() | I2CE_FormField->getLimitMenu_not_null()]]
| |
| | |
| ===getLimitMenu_null_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_null_not_null() | I2CE_FormField->getLimitMenu_null_not_null()]]
| |
| | |
| ===processLimitMenu_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_null() | I2CE_FormField->processLimitMenu_null()]]
| |
| | |
| ===processLimitMenu_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_not_null() | I2CE_FormField->processLimitMenu_not_null()]]
| |
| | |
| ===processLimitMenu_null_not_null()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_null_not_null() | I2CE_FormField->processLimitMenu_null_not_null()]]
| |
| | |
| ===generateLimit_max_parent()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_max_parent() | I2CE_FormField->generateLimit_max_parent()]]
| |
| | |
| ===generateLimit_min_parent()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_min_parent() | I2CE_FormField->generateLimit_min_parent()]]
| |
| | |
| ===generateLimit_max_parent_form()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_max_parent_form() | I2CE_FormField->generateLimit_max_parent_form()]]
| |
| | |
| ===generateLimit_min_parent_form()===
| |
| This method is inherited from [[Class: I2CE_FormField#generateLimit_min_parent_form() | I2CE_FormField->generateLimit_min_parent_form()]]
| |
| | |
| ===getLimitMenu_max_parent()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_max_parent() | I2CE_FormField->getLimitMenu_max_parent()]]
| |
| | |
| ===getLimitMenu_min_parent()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_min_parent() | I2CE_FormField->getLimitMenu_min_parent()]]
| |
| | |
| ===getLimitMenu_max_parent_form()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_max_parent_form() | I2CE_FormField->getLimitMenu_max_parent_form()]]
| |
| | |
| ===getLimitMenu_min_parent_form()===
| |
| This method is inherited from [[Class: I2CE_FormField#getLimitMenu_min_parent_form() | I2CE_FormField->getLimitMenu_min_parent_form()]]
| |
| | |
| ===processLimitMenu_max_parent()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_max_parent() | I2CE_FormField->processLimitMenu_max_parent()]]
| |
| | |
| ===processLimitMenu_min_parent()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_min_parent() | I2CE_FormField->processLimitMenu_min_parent()]]
| |
| | |
| ===processLimitMenu_max_parent_form()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_max_parent_form() | I2CE_FormField->processLimitMenu_max_parent_form()]]
| |
| | |
| ===processLimitMenu_min_parent_form()===
| |
| This method is inherited from [[Class: I2CE_FormField#processLimitMenu_min_parent_form() | I2CE_FormField->processLimitMenu_min_parent_form()]]
| |
| | |
| ===save()===
| |
| This method is inherited from [[Class: I2CE_FormField#save() | I2CE_FormField->save()]]
| |
| | |
| ===populateHistory()===
| |
| This method is inherited from [[Class: I2CE_FormField#populateHistory() | I2CE_FormField->populateHistory()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
