PHP Class Pimcore\Web2Print\Processor

Show file Open project: pimcore/pimcore Class Usage Examples

Public Methods

Method Description
cancelGeneration ( $documentId )
getInstance ( ) : PdfReactor8 | WkHtmlToPdf
getJobConfigFile ( $processId ) : string
getProcessingOptions ( ) : array
getStatusUpdate ( $documentId ) : array
preparePdfGeneration ( $documentId, $config )
startPdfGeneration ( $documentId )

Protected Methods

Method Description
buildPdf ( PrintAbstract $document, $config ) : mixed
getPrintDocument ( $documentId ) : Printpage
loadJobConfigObject ( $documentId ) : stdClass
saveJobConfigObjectFile ( $jobConfig ) : boolean
updateStatus ( $documentId, $status, $statusUpdate )

Method Details

buildPdf() abstract protected method

abstract protected buildPdf ( PrintAbstract $document, $config ) : mixed
$document Pimcore\Model\Document\PrintAbstract
$config
return mixed

cancelGeneration() public method

public cancelGeneration ( $documentId )
$documentId

getInstance() public static method

public static getInstance ( ) : PdfReactor8 | WkHtmlToPdf
return Pimcore\Web2Print\Processor\PdfReactor8 | Pimcore\Web2Print\Processor\WkHtmlToPdf

getJobConfigFile() public static method

public static getJobConfigFile ( $processId ) : string
$processId
return string

getPrintDocument() protected method

protected getPrintDocument ( $documentId ) : Printpage
$documentId
return Pimcore\Model\Document\Printpage

getProcessingOptions() abstract public method

abstract public getProcessingOptions ( ) : array
return array

getStatusUpdate() public method

public getStatusUpdate ( $documentId ) : array
$documentId
return array

loadJobConfigObject() protected method

protected loadJobConfigObject ( $documentId ) : stdClass
$documentId
return stdClass

preparePdfGeneration() public method

public preparePdfGeneration ( $documentId, $config )
$documentId
$config

saveJobConfigObjectFile() protected method

protected saveJobConfigObjectFile ( $jobConfig ) : boolean
$jobConfig
return boolean

startPdfGeneration() public method

public startPdfGeneration ( $documentId )
$documentId

updateStatus() protected method

protected updateStatus ( $documentId, $status, $statusUpdate )
$documentId
$statusUpdate