Class: I2CE FormField IMAGE (4.1.7)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

This article describes the class I2CE_FormField_IMAGE .

Extends the class: I2CE_FormField_BINARY_FILE.
Child Classes:
- I2CE_FormField_PASSPORT
Location: Part of the module BinField in the package I2CE 4.1.7-release
Source: Defined in the file modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.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

$image_rsrc

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 76
Type: protected $image_rsrc

Methods

createImageResource()

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 154
Signature: protected function createImageResource()

defaultExtension()

get the default extension for this image

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 62
Signature: protected function defaultExtension()
Returns: string

defaultMimeType()

get the default extension for this image

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 71
Signature: protected function defaultMimeType()
Returns: string

getDisplayNode()

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

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

getImageHeight()

Gets the height of the image in pixels

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 197
Signature: public function getImageHeight()
Returns: mixed.
Int on success, false on failure

getImageResource()

Returns an image resource (see PHP GD http://us2.php.net/manual/en/ref.image.php) for the internal data. This resource can then be manipulated (resized etc). Once manipulation is done, then {@see setFromReosurce} should be called.

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 83
Signature: public function getImageResource()
Returns: mixed.
False on failure, an image resource on success.

getImageWidth()

Gets the width of the image in pixels

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 186
Signature: public function getImageWidth()
Returns: mixed.
Int on success, false on failure

isValidMimeType()

Checks to see if a mime type is a valid image mime type

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 34
Signature: public function isValidMimeType($mime_type)
Parameters:
- string $mime_type
  The mime type we are varifying is valid
Returns: true
if valid. false otherwise

processDOMEditable()

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

setFromDB()

Sets the value of this field from the database format.

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 174
Signature: public function setFromDB($value)
Parameters:
- mixed $value

setFromData()

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

setFromResource()

Reload the image data from the image reousrce

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_FormField_IMAGE.php on line 94
Signature: public function setFromResource()
Returns: boolean
true on success

Inherited Methods

getLink()

This protected method is inherited from I2CE_FormField_BINARY_FILE->getLink()

getTmpFileKeyValue()

This protected method is inherited from I2CE_FormField_BINARY_FILE->getTmpFileKeyValue()

hasTmpFileKey()

This protected method is inherited from I2CE_FormField_BINARY_FILE->hasTmpFileKey()

addHistory()

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

cleanup()

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

compare()

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

compareEntryDate()

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

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

getElement()

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

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

getHistory()

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

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

postprocessDOMEditable()

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

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

setElement()

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

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

setInvalidMessage()

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

setOption()

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

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

getOptionsByPath()

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

optionsHasPath()

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

processHeaderEditable()

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

withinForm()

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

_hasMethod()

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

Inherited Variables

$mime_type

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$mime_type

$null_term

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$null_term

$file_name

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$file_name

$fmod_time

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$fmod_time

$keys

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$keys

$setStmt

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$setStmt

$storeStmt

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$storeStmt

$tmp_key

Theis protected variable is inherited from I2CE_FormField_BINARY_FILE->$tmp_key

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

describeLimit()

This method is inherited from I2CE_FormField->describeLimit()

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

globalFieldUpdate()

This method is inherited from I2CE_FormField->globalFieldUpdate()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Inherited Fuzzy CLI Methods