class ExportHandler

Class ExportHandler

Methods

__construct( EventDispatcherInterface $eventDispatcher, ContainerInterface $container)

Class constructor

null|Export
getExport( integer $exportId, boolean $dispatchException = false)

Get export model based on given identifier

null|Export
getExportByRef( string $exportRef, boolean $dispatchException = false)

Get export model based on given reference

getCategory( integer $exportCategoryId, boolean $dispatchException = false)

Get export category model based on given identifier

export( Export $export, SerializerInterface $serializer, ArchiverInterface $archiver = null, Lang $language = null, boolean $includeImages = false, boolean $includeDocuments = false, null|array $rangeDate = null)

Export

Details

at line 49
__construct( EventDispatcherInterface $eventDispatcher, ContainerInterface $container)

Class constructor

Parameters

EventDispatcherInterface $eventDispatcher An event dispatcher interface
ContainerInterface $container

at line 65
null|Export getExport( integer $exportId, boolean $dispatchException = false)

Get export model based on given identifier

Parameters

integer $exportId An export identifier
boolean $dispatchException Dispatch exception if model doesn't exist

Return Value

null|Export

Exceptions

ErrorException

at line 93
null|Export getExportByRef( string $exportRef, boolean $dispatchException = false)

Get export model based on given reference

Parameters

string $exportRef An export reference
boolean $dispatchException Dispatch exception if model doesn't exist

Return Value

null|Export

Exceptions

ErrorException

at line 121
null|ExportCategory getCategory( integer $exportCategoryId, boolean $dispatchException = false)

Get export category model based on given identifier

Parameters

integer $exportCategoryId An export category identifier
boolean $dispatchException Dispatch exception if model doesn't exist

Return Value

null|ExportCategory

Exceptions

ErrorException

at line 152
ExportEvent export( Export $export, SerializerInterface $serializer, ArchiverInterface $archiver = null, Lang $language = null, boolean $includeImages = false, boolean $includeDocuments = false, null|array $rangeDate = null)

Export

Parameters

Export $export
SerializerInterface $serializer
ArchiverInterface $archiver
Lang $language
boolean $includeImages
boolean $includeDocuments
null|array $rangeDate

Return Value

ExportEvent