Class: I2CE FormField IMAGE (Development)
This article describes the class I2CE_FormField_IMAGE .
- Extends the class: I2CE_FormField_BINARY_FILE.
- Child Classes:
- Location: Part of the module BinField in the package I2CE 4.1-dev
- 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
- string $mime_type
- 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
__construct()
This public method is inherited from I2CE_FormField_BINARY_FILE->__construct()
getBinaryData()
This public method is inherited from I2CE_FormField_BINARY_FILE->getBinaryData()
getContentLength()
This public method is inherited from I2CE_FormField_BINARY_FILE->getContentLength()
getDBValue()
This public method is inherited from I2CE_FormField_BINARY_FILE->getDBValue()
getDisplayValue()
This public method is inherited from I2CE_FormField_BINARY_FILE->getDisplayValue()
getExtension()
This public method is inherited from I2CE_FormField_BINARY_FILE->getExtension()
getFieldLink()
This public method is inherited from I2CE_FormField_BINARY_FILE->getFieldLink()
getFileName()
This public method is inherited from I2CE_FormField_BINARY_FILE->getFileName()
getHeaders()
This public method is inherited from I2CE_FormField_BINARY_FILE->getHeaders()
getMetaValue()
This public method is inherited from I2CE_FormField_BINARY_FILE->getMetaValue()
getMimeType()
This public method is inherited from I2CE_FormField_BINARY_FILE->getMimeType()
getModTime()
This public method is inherited from I2CE_FormField_BINARY_FILE->getModTime()
getValue()
This public method is inherited from I2CE_FormField_BINARY_FILE->getValue()
isTooBig()
This public method is inherited from I2CE_FormField_BINARY_FILE->isTooBig()
isValid()
This public method is inherited from I2CE_FormField_BINARY_FILE->isValid()
processDOMNotEditable()
This public method is inherited from I2CE_FormField_BINARY_FILE->processDOMNotEditable()
setFromPost()
This public method is inherited from I2CE_FormField_BINARY_FILE->setFromPost()
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()
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
$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
$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
