Properties

$imgToDisplay

$imgToDisplay : string

Type

string — The file path of the image to display. If not null, the image will be displayed, even if the XML output was not empty

$imageResource

$imageResource : 

Type

$objOutput

$objOutput : 

Type

$output

$output : 

Type

$wsObject

$wsObject : 

Type

$imgExtension

$imgExtension : string

Type

string — The extension of the image to display

$imageTypes

$imageTypes : array

Type

array — The type of images (general, categories, manufacturers, suppliers, stores...)

$imageType

$imageType : string

Type

string — The image type (product, category, general,...)

$imgMaxUploadSize

$imgMaxUploadSize : integer

Type

integer — The maximum size supported when uploading images, in bytes

$acceptedImgMimeTypes

$acceptedImgMimeTypes : array

Type

array — The list of supported mime types

$productImageDeclinationId

$productImageDeclinationId : string

Type

string — The product image declination id

$defaultImage

$defaultImage : boolean

Type

boolean — If the current image management has to manage a "default" image (i.e. "No product available")

Methods

getObjectOutput()

getObjectOutput() 

getWsObject()

getWsObject() 

getContent()

getContent() : array

This must be return an array with specific values as WebserviceRequest expects.

Returns

array

manage()

manage() 

manageImages()

manageImages() : boolean

Management of images URL segment

Returns

boolean

manageGeneralImages()

manageGeneralImages() : boolean

Management of general images

Returns

boolean

manageDefaultDeclinatedImages()

manageDefaultDeclinatedImages(  $directory,   $normal_image_sizes) 

Parameters

$directory
$normal_image_sizes

manageListDeclinatedImages()

manageListDeclinatedImages(  $directory,   $normal_image_sizes) 

Parameters

$directory
$normal_image_sizes

manageEntityDeclinatedImages()

manageEntityDeclinatedImages(  $directory,   $normal_image_sizes) 

Parameters

$directory
$normal_image_sizes

manageDeclinatedImages()

manageDeclinatedImages(string  $directory) : boolean

Management of normal images (as categories, suppliers, manufacturers and stores)

Parameters

string $directory

the file path of the root of the images folder type

Returns

boolean

manageProductImages()

manageProductImages() 

getCustomizations()

getCustomizations() 

manageCustomizationImages()

manageCustomizationImages() 

manageDeclinatedImagesCRUD()

manageDeclinatedImagesCRUD(boolean  $filename_exists, string  $filename, array  $imageSizes, string  $directory) : boolean

Management of normal images CRUD

Parameters

boolean $filename_exists

if the filename exists

string $filename

the image path

array $imageSizes

The

string $directory

Returns

boolean

deleteImageOnDisk()

deleteImageOnDisk(string  $filePath, array  $imageTypes = null, string  $parentPath = null) : boolean

Delete the image on disk

Parameters

string $filePath

the image file path

array $imageTypes

The differents sizes

string $parentPath

The parent path

Returns

boolean

writeImageOnDisk()

writeImageOnDisk(string  $basePath, string  $newPath, integer  $destWidth = null, integer  $destHeight = null, array  $imageTypes = null, string  $parentPath = null) : string

Write the image on disk

Parameters

string $basePath
string $newPath
integer $destWidth
integer $destHeight
array $imageTypes
string $parentPath

Returns

string

writePostedImageOnDisk()

writePostedImageOnDisk(  $receptionPath, integer  $destWidth = null, integer  $destHeight = null, array  $imageTypes = null, string  $parentPath = null) : boolean

Write the posted image on disk

Parameters

$receptionPath
integer $destWidth
integer $destHeight
array $imageTypes
string $parentPath

Returns

boolean