class.WebserviceSpecificManagementImagesCore.md

Class WebserviceSpecificManagementImagesCore

• Class name: WebserviceSpecificManagementImagesCore
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 27
• This class implements: WebserviceSpecificManagementInterface

Contents

Properties

• $acceptedImgMimeTypes
• $defaultImage
• $imageResource
• $imageType
• $imageTypes
• $imgExtension
• $imgMaxUploadSize
• $imgToDisplay
• $objOutput
• $output
• $productImageDeclinationId
• $wsObject

Methods

• deleteImageOnDisk
• getContent
• getObjectOutput
• getWsObject
• manage
• manageDeclinatedImages
• manageDeclinatedImagesCRUD
• manageDefaultDeclinatedImages
• manageEntityDeclinatedImages
• manageGeneralImages
• manageImages
• manageListDeclinatedImages
• manageProductImages
• setObjectOutput
• setWsObject
• writeImageOnDisk
• writePostedImageOnDisk

Properties

$acceptedImgMimeTypes

protected array $acceptedImgMimeTypes = array('image/gif', 'image/jpg', 'image/jpeg', 'image/pjpeg', 'image/png', 'image/x-png')

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 68.

$defaultImage

protected boolean $defaultImage = false

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 78.

$imageResource

public mixed $imageResource = null

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 84.

$imageType

protected string $imageType = null

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 58.

$imageTypes

protected array $imageTypes = array('general' => array('header' => array(), 'mail' => array(), 'invoice' => array(), 'store_icon' => array()), 'products' => array(), 'categories' => array(), 'manufacturers' => array(), 'suppliers' => array(), 'stores' => array())

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 41.

$imgExtension

protected string $imgExtension

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 36.

$imgMaxUploadSize

protected integer $imgMaxUploadSize = 3000000

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 63.

$imgToDisplay

public string $imgToDisplay = null

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 83.

$objOutput

protected mixed $objOutput

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 29.

$output

protected mixed $output

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 30.

$productImageDeclinationId

protected string $productImageDeclinationId = null

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 73.

$wsObject

protected mixed $wsObject

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 31.

Methods

deleteImageOnDisk

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

Delete the image on disk

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 739

Arguments

• $filePath string - the image file path
• $imageTypes array - The differents sizes
• $parentPath string - The parent path

getContent

mixed WebserviceSpecificManagementImagesCore::getContent()

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

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 115

getObjectOutput

mixed WebserviceSpecificManagementImagesCore::getObjectOutput()

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 96

getWsObject

mixed WebserviceSpecificManagementImagesCore::getWsObject()

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 107

manage

mixed WebserviceSpecificManagementImagesCore::manage()

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 149

manageDeclinatedImages

boolean WebserviceSpecificManagementImagesCore::manageDeclinatedImages(string $directory)

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

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 633

Arguments

• $directory string - the file path of the root of the images folder type

manageDeclinatedImagesCRUD

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

Management of normal images CRUD

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 668

Arguments

• $filename_exists boolean - if the filename exists
• $filename string - the image path
• $imageSizes array - The
• $directory string

manageDefaultDeclinatedImages

mixed WebserviceSpecificManagementImagesCore::manageDefaultDeclinatedImages($directory, $normal_image_sizes)

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 420

Arguments

• $directory mixed
• $normal_image_sizes mixed

manageEntityDeclinatedImages

mixed WebserviceSpecificManagementImagesCore::manageEntityDeclinatedImages($directory, $normal_image_sizes)

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 512

Arguments

• $directory mixed
• $normal_image_sizes mixed

manageGeneralImages

boolean WebserviceSpecificManagementImagesCore::manageGeneralImages()

Management of general images

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 325

manageImages

boolean WebserviceSpecificManagementImagesCore::manageImages()

Management of images URL segment

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 160

manageListDeclinatedImages

mixed WebserviceSpecificManagementImagesCore::manageListDeclinatedImages($directory, $normal_image_sizes)

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 465

Arguments

• $directory mixed
• $normal_image_sizes mixed

manageProductImages

mixed WebserviceSpecificManagementImagesCore::manageProductImages()

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 654

setObjectOutput

mixed WebserviceSpecificManagementImagesCore::setObjectOutput(\WebserviceOutputBuilderCore $obj)

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 90

Arguments

• $obj WebserviceOutputBuilderCore

setWsObject

mixed WebserviceSpecificManagementImagesCore::setWsObject(\WebserviceRequestCore $obj)

• Visibility: public
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 101

Arguments

• $obj WebserviceRequestCore

writeImageOnDisk

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

Write the image on disk

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 782

Arguments

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

writePostedImageOnDisk

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

Write the posted image on disk

• Visibility: protected
• Source: classes/webservice/WebserviceSpecificManagementImages.php line 892

Arguments

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