Docs For Class XTPicture

Description

Abstract class to manage Pictures

author: SimpliciWeb
version: $Id: xt_picture.class.php 781 2007-12-27 13:07:16Z stephanet $

Located in /core/internal_components/common/t_picture/xt_picture.class.php (line 56)

Direct descendents

Class	Description
TPictureLogoBill	manage the picture for bill
TPictureLogoTop	Manage the front banner (logo on top)
TPictureTLanguage	Picture for any language (the flags for example)
TPictureTPage	Manage the picture for a web page
TPictureTProductSlave	Manage the picture for a product (slave)

Variable Summary

DbConnexion $m_object_dbconnexion

Format $m_object_format

siteInformation $m_object_siteinformation

array $m_position_used

array $m_supported_formats

array $m_supported_formats_string

array $m_types_used

string $req_delete

string $req_delete_by_type

string $req_insert

string $req_select

string $req_select_by_type

string $req_update_desc

string $req_update_position_by_type

Method Summary

XTPicture XTPicture ()

bool getRatio (array $p_array_picture, integer $p_next_width, integer $p_next_height, &$r_ratio, integer $r_ratio)

array getSupportedImageFormat ()

bool xDelete (integer $p_picture_id, string $p_picture_type)

bool xDeleteByType (string $p_picture_type)

bool xGet (integer $id, string $p_picture_type, &$r_result, array $r_result)

bool xGetByType (string $p_picture_type, &$r_result, [string $p_database_selected = ""], array $r_result)

bool xInsert (string $p_picture_type, array $p_file_array, &$r_result_id, [integer $p_next_width = 0], [integer $p_next_height = 0], [string $p_desc = ""], [bool $p_only_one_by_type = false], [string $p_pic_position = ""], [bool $p_force_resize = true], [bool $p_form_src = true], integer $r_result_id)

bool xIsNotValidDesc ( $value, string $p_value)

bool xIsNotValidFilename ( $value, string $p_value)

bool xIsNotValidHeight ( $value, string $p_value)

bool xIsNotValidId ( $value, string $p_value)

bool xIsNotValidPositionnement ( &$value, string $p_value)

bool xIsNotValidSize ( $value, string $p_value)

bool xIsNotValidType ( &$value, string $p_value)

bool xIsNotValidWidth ( $value, string $p_value)

bool xUpdateDesc (integer $p_id, string $p_picture_type, string $p_desc)

bool xUpdatePositionByType (string $p_picture_type, string $p_new_position)

Variables

DbConnexion $m_object_dbconnexion = NULL (line 63)

Database Connexion object

Format $m_object_format = NULL (line 132)

Format Object

siteInformation $m_object_siteinformation = NULL (line 69)

SiteInformation Object

array $m_position_used = array() (line 140)

array $m_supported_formats = array() (line 120)

Supported formats

array $m_supported_formats_string = "" (line 126)

Supported formats string

array $m_types_used = array() (line 136)

string $req_delete = "" (line 107)

SQL Request : Delete

string $req_delete_by_type = "" (line 89)

SQL Request : Delete by type

string $req_insert = "" (line 77)

SQL Request : Insert

string $req_select = "" (line 101)

SQL Request : Select

string $req_select_by_type = "" (line 83)

SQL Request : Select by type

string $req_update_desc = "" (line 113)

SQL Request : Update desc

string $req_update_position_by_type = "" (line 95)

SQL Request : Update position by type

Methods

Constructor XTPicture (line 147)

Constructor, init the requests and objects

XTPicture XTPicture ()

getRatio (line 940)

Get Ratio

return: TRUE on error

bool getRatio (array $p_array_picture, integer $p_next_width, integer $p_next_height, &$r_ratio, integer $r_ratio)

array $p_array_picture
integer $p_next_width
integer $p_next_height
integer $r_ratio
&$r_ratio

getSupportedImageFormat (line 317)

Get supported image format

array getSupportedImageFormat ()

xDelete (line 861)

Delete

return: TRUE on error
access: private

bool xDelete (integer $p_picture_id, string $p_picture_type)

integer $p_picture_id
string $p_picture_type

xDeleteByType (line 826)

Delete by type

return: TRUE on error
access: private

bool xDeleteByType (string $p_picture_type)

string $p_picture_type

xGet (line 700)

Provide an array with all the picture properties

Va renvoyer un tableaux contenant toutes les informations necessaires à l'affichage d'une image Entree: int : represente l'identifiant de l'image Sortie: array

return: TRUE on error
access: private

bool xGet (integer $id, string $p_picture_type, &$r_result, array $r_result)

integer $id
string $p_picture_type
array $r_result
&$r_result

xGetByType (line 641)

Get by type

return: TRUE on error
access: private

bool xGetByType (string $p_picture_type, &$r_result, [string $p_database_selected = ""], array $r_result)

string $p_picture_type
array $r_result
string $p_database_selected
&$r_result

xInsert (line 343)

Insert

return: TRUE on error
access: private

bool xInsert (string $p_picture_type, array $p_file_array, &$r_result_id, [integer $p_next_width = 0], [integer $p_next_height = 0], [string $p_desc = ""], [bool $p_only_one_by_type = false], [string $p_pic_position = ""], [bool $p_force_resize = true], [bool $p_form_src = true], integer $r_result_id)

string $p_picture_type
array $p_file_array: $_FILES
integer $r_result_id
integer $p_next_width
integer $p_next_height
string $p_desc
bool $p_only_one_by_type
string $p_pic_position
bool $p_force_resize
bool $p_form_src
&$r_result_id

xIsNotValidDesc (line 216)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidDesc ( $value, string $p_value)

string $p_value
$value

xIsNotValidFilename (line 238)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidFilename ( $value, string $p_value)

string $p_value
$value

xIsNotValidHeight (line 248)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidHeight ( $value, string $p_value)

string $p_value
$value

xIsNotValidId (line 226)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidId ( $value, string $p_value)

string $p_value
$value

xIsNotValidPositionnement (line 295)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidPositionnement ( &$value, string $p_value)

string $p_value
&$value

xIsNotValidSize (line 268)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidSize ( $value, string $p_value)

string $p_value
$value

xIsNotValidType (line 278)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidType ( &$value, string $p_value)

string $p_value
&$value

xIsNotValidWidth (line 258)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidWidth ( $value, string $p_value)

string $p_value
$value

xUpdateDesc (line 906)

Udpate desc

return: TRUE on error

bool xUpdateDesc (integer $p_id, string $p_picture_type, string $p_desc)

integer $p_id
string $p_picture_type
string $p_desc

xUpdatePositionByType (line 795)

Update position by type

return: TRUE on error

bool xUpdatePositionByType (string $p_picture_type, string $p_new_position)

string $p_picture_type
string $p_new_position