Class: I2CE FormField BINARY FILE (Development)
This article describes the abstract class I2CE_FormField_BINARY_FILE .
- Extends the class: I2CE_FormField_DB_BLOB.
- Child Classes:
- Location: Part of the module BinField in the package I2CE 4.0-dev
- 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 all the database fields 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:
defaultExtension()
get the default extension for this
- Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 363
- 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 370
- 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 143
- 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 114
- 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 263
- 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 131
- Signature: public function getDisplayValue($entry)
- 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
- I2CE_Entry $entry
- 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 396
- 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 161
- Signature: static public function getFieldLink($formid,$field)
- Parameters:
- 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 332
- 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 351
- 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 169
- Signature: protected function getLink()
- Returns: mixed
string on success or null on failure.
getMimeType()
Get the magically determined mime type
- Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_BINARY_FILE.php on line 380
- 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 151
- Signature: public function getModTime()
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
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 288
- 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 300
- 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 283
- 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 309
- 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 322
- 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.
- 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 177
- 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 224
- 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()
getContainer()
This public method is inherited from I2CE_FormField->getContainer()
getDBType()
This public method is inherited from I2CE_FormField->getDBType()
getDisplays()
This public method is inherited from I2CE_FormField->getDisplays()
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()
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()
setContainer()
This public method is inherited from I2CE_FormField->setContainer()
setDefaultOptions()
This public method is inherited from I2CE_FormField->setDefaultOptions()
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()
getDefaultValue()
This protected method is inherited from I2CE_FormField->getDefaultValue()
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
$container
Theis protected variable is inherited from I2CE_FormField->$container
$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()
Inherited Fuzzy CLI Methods
cachedTableReference()
This method is inherited from I2CE_FormField->cachedTableReference()