Class STPHPImage

STPHPObject
   |
   --STPHPComponent
      |
      --STPHPImage

Classes extended from STPHPImage:

Located in File: Program_Root/stphpimage.php


A class that represents an image


Class Variable Summary

Inherited Class Variable Summary
Inherited From Class STPHPComponent
Variable Default Value Description
$attributes -><- The list of attributes
$components -><- The list of components
$configuration -><- The pointer to configuration XML node
$formParent -><- The form owner name
Inherited From Class STPHPObject
Variable Default Value Description
$name -><- The name of the object

Inherited Method Summary
Inherited From Class STPHPComponent
Function Description
constructor STPHPComponent ( [$name = ] ) Creates the object
addCodeFile ( $file ) Adds a code file (Javascript)
addComponent ( &$component ) Adds a component at the end of the components list
addCssFile ( $file ) Adds a CSS file
addVSpace ( $units ) Adds vertical spaces
appendAttributes ( $attributes ) Appends an array of attributes at the current values
appendComponent ( &$component ) Appends a component at the end of the components list
attributeIsEmpty ( $key ) Returns if attribute is empty
dtor ( ) Destructor
getAttribute ( $key ) Gets the value of an attribute
getFormParent ( ) Returns the form owner name
getTranslatedAttribute ( $key ) Translate an attribute to the current language
insertComponent ( &$component ) Inserts a component at the beginning of the components list
setAttribute ( $key, $val ) Sets an attribute
setConfiguration ( &$configuration ) Load the attributes from a STPHPXMLElement object
setFormParent ( $form ) Sets the form owner name of the component (used by JS functions)
translateAttribute ( $key ) Set an attribute to its translated value
write ( ) Designs the object at runtime
Inherited From Class STPHPObject
Function Description
constructor STPHPObject ( [$name = ] ) Creates the object
dtor ( ) Destructor
errorLog ( $message ) Print an error to the log system
getName ( ) Returns the name of the object

Method Summary
STPHPForm constructor STPHPImage ( $name )
Creates the object
void loadFromDb ( $db_conf, $table, $record_id, $imgField, $imgTypeField, $imgDesc )
Load an image from a db (using ADODB library)
string write ( )
Designs the object at runtime
Variable Detail

Method Detail

constructor STPHPImage

STPHPForm constructor STPHPImage ( $name )

Creates the object

Function Parameters:
- string $name: the name of the form used in NAME tag
Function Info:
Access - public

loadFromDb

void loadFromDb ( $db_conf, $table, $record_id, $imgField, $imgTypeField, $imgDesc )

Load an image from a db (using ADODB library)

Function Parameters:
- string $db_conf: the configuration file for the db
- string $table: the table of the db
- integer $record_id: the record id
- string $imgField: the field of the db that contains the image
- string $imgTypeField: the field of the db that contains the type of the image
- string $imgDesc: the description of the image
Function Info:
Access - public

write

string write ( )

Overrides: STPHPComponent::write()

Designs the object at runtime
Available attributes :
- VISIBLE : defines if the component must be designed or not
- SRC : the source for the image
- ALIGN : the alignment of the image
- ALT : the ALT text for the image
- LINK : defines the link for the label
- LINK_TARGET : defines the target for the link
- TITLE : defines the title for the link
- ONCLICK : defines the onclick event hook
- ONMOUSEOVER : defines the onmouseover event hook
- ONMOUSEOUT : defines the onmouseout event hook
- ONMOUSEDOWN : defines the onmousedown event hook
- ONMOUSEUP : defines the onmouseup event hook
Function Parameters:
Function Info:
Return - the code that represents the object at runtime
Access - private