$webapi
$webapi : \Visionline\Crm\WebApi\WebApi
The WebApi
Internal class that defines the file-operation "get"
$webapi : \Visionline\Crm\WebApi\WebApi
The WebApi
$connection : \Visionline\Crm\WebApi\Connection
The connection
__construct(\Visionline\Crm\WebApi\WebApi $webapi, string $getFileUrl, \Visionline\Crm\WebApi\Connection $connection, integer $bufferSize)
Create a get file operation
| \Visionline\Crm\WebApi\WebApi | $webapi | The WebApi |
| string | $getFileUrl | The URL of the GetFile-Handler |
| \Visionline\Crm\WebApi\Connection | $connection | The connection settings to the CRM-VISIONLINE system |
| integer | $bufferSize | The buffer size for file operations |
exec(integer|\Visionline\Crm\WebApi\QueryResult $document, array $stream_context_options, integer $width = NULL, integer $height = NULL, string $resizeMode = NULL) : mixed
Executes the file operation
| integer|\Visionline\Crm\WebApi\QueryResult | $document | The document to retrieve |
| array | $stream_context_options | The stream context options |
| integer | $width | The width to which an image should be resized |
| integer | $height | The height to which an image should be resized |
| string | $resizeMode | Specifies how an image should be resized |
If an invalid argument was supplied
if an exception occured
The result of this file operation
execMultiple(array $documents, array $stream_context_options, integer $width = NULL, integer $height = NULL, string $resizeMode = NULL) : mixed
Executes the file operation
| array | $documents | The documents to retrieve |
| array | $stream_context_options | The stream context options |
| integer | $width | The width to which an image should be resized |
| integer | $height | The height to which an image should be resized |
| string | $resizeMode | Specifies how an image should be resized |
If an invalid argument was supplied
if an exception occured
The results of this file operation
process(string $data)
Appends the retrieved data to the internal buffer.
| string | $data | The data |
processMetaData(integer $id, integer $width, integer $height, string $resizeMode, string $contentType, string $filename, string $extension, integer $lastModified)
Does nothing.
| integer | $id | The id of the entity |
| integer | $width | The width to which an image should be resized |
| integer | $height | The height to which an image should be resized |
| string | $resizeMode | Specifies how an image should be resized |
| string | $contentType | The content type of the file |
| string | $filename | The filename of the file |
| string | $extension | The file extension of the file |
| integer | $lastModified | The timestamp of the last modification of the file |
getResult() : string
Returns the internal buffer
Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376The internal buffer
shouldDownload(\Visionline\Crm\WebApi\QueryResult $document, integer $width, integer $height, string $resizeMode) : \Visionline\Crm\WebApi\true,
Returns true.
| \Visionline\Crm\WebApi\QueryResult | $document | The document in question |
| integer | $width | The width to which an image should be resized |
| integer | $height | The height to which an image should be resized |
| string | $resizeMode | Specifies how an image should be resized |
if the file should be downloaded; false, if the file should not be downloaded; or a timestamp if the file should be downloaded if it is newer than this timestamp
download(integer $id, integer $width, integer $height, string $resizeMode, array $stream_context_options, integer $ifModifiedSince = null)
Downloads the contents of the specified document
| integer | $id | The id of the document |
| integer | $width | The width to which an image should be resized |
| integer | $height | The height to which an image should be resized |
| string | $resizeMode | Specifies how an image should be resized |
| array | $stream_context_options | The stream context options |
| integer | $ifModifiedSince | If specified, the file is only downloaded if it was modified since |
If an error occurs during download