Bitrix API

DocumentGeneratorManager

Table of Contents

Constants

ACTUALIZATION_POSITION_BACKGROUND  = 'actualizationBackground'
ACTUALIZATION_POSITION_IMMEDIATELY  = 'actualizationImmediately'
ACTUALIZATION_POSITION_QUEUE  = 'actualizationQueue'
DOCUMENT_CREATE_EVENT_NAME  = 'onCreateDocument'
DOCUMENT_DELETE_EVENT_NAME  = '\Bitrix\DocumentGenerator\Model\Document::OnBeforeDelete'
DOCUMENT_PUBLIC_VIEW_EVENT_NAME  = 'onPublicView'
DOCUMENT_UPDATE_EVENT_NAME  = 'onUpdateDocument'
PROVIDER_LIST_EVENT_NAME  = 'onGetDataProviderList'
VALUE_PAYMENT_ID  = '_paymentId'

Methods

__construct()  : mixed
actualizeDocumentImmediately()  : void
bindDocumentToPayment()  : Result
clearPaymentBindings()  : void
copyTemplatesProviders()  : Result
createDocumentActivity()  : Result
createDocumentForItem()  : Result
deleteDocumentsByOwner()  : Result|null
enqueueItemScheduledDocumentsForActualization()  : void
Add scheduled documents found by $itemIdentifier to the queue for actualization on $position.
getAddTemplateUrl()  : bool|string
Returns url to add template.
getCrmOwnerTypeProvider()  : string|null
getCrmOwnerTypeProvidersMap()  : array<string|int, mixed>
Returns array where key - id from \CCrmOwnerType and value - data provider class name
getDataProviders()  : array<string|int, mixed>
Returns list of providers and their descriptions (@see \Bitrix\DocumentGenerator\Registry\DataProvider::getList())
getDocumentButtonParameters()  : array<string|int, mixed>
Returns parameters for "Documents" button.
getDocumentDetailUrl()  : Uri|null
getDocumentsByIdentifier()  : array<string|int, Document>
getEntityTypeIdByProvider()  : int
getInstance()  : DocumentGeneratorManager
getLastBoundPaymentDocumentTemplateId()  : int|null
getPaymentBoundDocumentId()  : int|null
getProductLoader()  : ProductLoader
getTemplatesByIdentifier()  : array<string|int, Template>
isDocumentButtonAvailable()  : bool
Returns true if current user can access to some actions with documents.
isEnabled()  : bool
Returns true if module documentgenerator is enabled.
isEntitySupportsPaymentDocumentBinding()  : bool
onCreateDocument()  : bool
onDeleteDocument()  : bool
onDocumentTransformationComplete()  : bool
onPublicView()  : bool
onUpdateDocument()  : bool
replacePlaceholdersInText()  : string|null
transferDocumentsOwnership()  : void

Constants

ACTUALIZATION_POSITION_BACKGROUND

public mixed ACTUALIZATION_POSITION_BACKGROUND = 'actualizationBackground'

ACTUALIZATION_POSITION_IMMEDIATELY

public mixed ACTUALIZATION_POSITION_IMMEDIATELY = 'actualizationImmediately'

DOCUMENT_DELETE_EVENT_NAME

public mixed DOCUMENT_DELETE_EVENT_NAME = '\Bitrix\DocumentGenerator\Model\Document::OnBeforeDelete'

Methods

actualizeDocumentImmediately()

public actualizeDocumentImmediately(Document $document) : void
Parameters
$document : Document

bindDocumentToPayment()

public bindDocumentToPayment(int $documentId, int $paymentId) : Result
Parameters
$documentId : int
$paymentId : int
Return values
Result

copyTemplatesProviders()

public copyTemplatesProviders(string $sourceProvider, string $destinationProvider) : Result
Parameters
$sourceProvider : string
$destinationProvider : string
Return values
Result

createDocumentActivity()

public createDocumentActivity(Document $document, ItemIdentifier $itemIdentifier[, int|null $userId = null ]) : Result
Parameters
$document : Document
$itemIdentifier : ItemIdentifier
$userId : int|null = null
Return values
Result

createDocumentForItem()

public createDocumentForItem(ItemIdentifier $identifier, int $templateId[, int $paymentId = null ]) : Result
Parameters
$identifier : ItemIdentifier
$templateId : int
$paymentId : int = null
Return values
Result

deleteDocumentsByOwner()

public deleteDocumentsByOwner(mixed $entityTypeId, mixed $entityId) : Result|null
Parameters
$entityTypeId : mixed
$entityId : mixed
Return values
Result|null

enqueueItemScheduledDocumentsForActualization()

Add scheduled documents found by $itemIdentifier to the queue for actualization on $position.

public final enqueueItemScheduledDocumentsForActualization(ItemIdentifier $itemIdentifier[, int|null $userId = null ][, string $position = self::ACTUALIZATION_POSITION_QUEUE ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$userId : int|null = null
$position : string = self::ACTUALIZATION_POSITION_QUEUE

getAddTemplateUrl()

Returns url to add template.

public getAddTemplateUrl([string $provider = null ]) : bool|string
Parameters
$provider : string = null
Return values
bool|string

getCrmOwnerTypeProvider()

public getCrmOwnerTypeProvider(int $entityTypeId[, bool $isSourceEntitiesOnly = true ]) : string|null
Parameters
$entityTypeId : int
$isSourceEntitiesOnly : bool = true
Return values
string|null

getCrmOwnerTypeProvidersMap()

Returns array where key - id from \CCrmOwnerType and value - data provider class name

public getCrmOwnerTypeProvidersMap([bool $isSourceEntitiesOnly = true ]) : array<string|int, mixed>
Parameters
$isSourceEntitiesOnly : bool = true

. If true - returns only those providers which can be source for a new document.

Return values
array<string|int, mixed>

getDataProviders()

Returns list of providers and their descriptions (@see \Bitrix\DocumentGenerator\Registry\DataProvider::getList())

public static getDataProviders() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDocumentButtonParameters()

Returns parameters for "Documents" button.

public getDocumentButtonParameters(string $className, mixed $value) : array<string|int, mixed>
Parameters
$className : string
  • FQN of a provider
$value : mixed
Return values
array<string|int, mixed>

getDocumentDetailUrl()

public getDocumentDetailUrl(int $entityTypeId[, int|null $entityId = null ][, int|null $documentId = null ][, int|null $templateId = null ]) : Uri|null
Parameters
$entityTypeId : int
$entityId : int|null = null
$documentId : int|null = null
$templateId : int|null = null
Return values
Uri|null

getDocumentsByIdentifier()

public getDocumentsByIdentifier(ItemIdentifier $item[, int $paymentId = null ]) : array<string|int, Document>
Parameters
$item : ItemIdentifier
$paymentId : int = null
Return values
array<string|int, Document>

getEntityTypeIdByProvider()

public getEntityTypeIdByProvider(string $provider) : int
Parameters
$provider : string
Return values
int

getLastBoundPaymentDocumentTemplateId()

public getLastBoundPaymentDocumentTemplateId() : int|null
Return values
int|null

getPaymentBoundDocumentId()

public getPaymentBoundDocumentId(int $paymentId) : int|null
Parameters
$paymentId : int
Return values
int|null

getTemplatesByIdentifier()

public getTemplatesByIdentifier(ItemIdentifier $item[, int $userId = null ]) : array<string|int, Template>
Parameters
$item : ItemIdentifier
$userId : int = null
Return values
array<string|int, Template>

isDocumentButtonAvailable()

Returns true if current user can access to some actions with documents.

public isDocumentButtonAvailable() : bool
Return values
bool

isEnabled()

Returns true if module documentgenerator is enabled.

public isEnabled() : bool
Return values
bool

isEntitySupportsPaymentDocumentBinding()

public isEntitySupportsPaymentDocumentBinding(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

onCreateDocument()

public static onCreateDocument(Event $event) : bool
Parameters
$event : Event
Return values
bool

onDeleteDocument()

public static onDeleteDocument(Event $event) : bool
Parameters
$event : Event
Return values
bool

onDocumentTransformationComplete()

public final static onDocumentTransformationComplete(Event $event) : bool
Parameters
$event : Event
Return values
bool

onPublicView()

public static onPublicView(Event $event) : bool
Parameters
$event : Event
Return values
bool

onUpdateDocument()

public static onUpdateDocument(Event $event) : bool
Parameters
$event : Event
Return values
bool

replacePlaceholdersInText()

public replacePlaceholdersInText(int $entityTypeId, int $entityId, string $text[, string|null $placeholderForEmptyValue = null ]) : string|null
Parameters
$entityTypeId : int
$entityId : int
$text : string
$placeholderForEmptyValue : string|null = null
Return values
string|null

transferDocumentsOwnership()

public transferDocumentsOwnership(mixed $oldEntityTypeID, mixed $oldEntityID, mixed $newEntityTypeID, mixed $newEntityID) : void
Parameters
$oldEntityTypeID : mixed
$oldEntityID : mixed
$newEntityTypeID : mixed
$newEntityID : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results