DocumentBagInterface
in
Interfaz para el contenedor de un documento.
Table of Contents
Methods
- getAlias() : string
- Entrega el alias del tipo de documento que contiene la bolsa.
- getBuilderOptions() : array<string|int, mixed>
- Obtiene las opciones del constructor del documento.
- getCaf() : CafInterface|null
- Obtiene el CAF para timbrar el documento.
- getCertificate() : CertificateInterface|null
- Obtiene el certificado para firmar el documento.
- getCodigoTipoDocumento() : int|null
- getData() : array<string|int, mixed>|null
- Obtiene los datos del documento.
- getDocument() : DocumentInterface|null
- Obtiene el documento tributario electrónico.
- getDocumentType() : TipoDocumentoInterface|null
- Obtiene el tipo de documento tributario electrónico.
- getDocumentTypeId() : int|null
- Obtiene el código numérico del documento tributario electrónico.
- getEmisor() : EmisorInterface|null
- Obtiene el emisor del documento.
- getId() : string
- Entrega el ID del documento.
- getInputData() : string|null
- Obtiene los datos de entrada del documento.
- getNormalizedData() : array<string|int, mixed>|null
- Obtiene los datos normalizados del documento.
- getNormalizerOptions() : array<string|int, mixed>
- Obtiene las opciones del normalizador del documento.
- getOptions() : DataContainerInterface|null
- Obtiene las opciones del documento.
- getParsedData() : array<string|int, mixed>|null
- Obtiene los datos procesados (parseados) del documento.
- getParserOptions() : array<string|int, mixed>
- Obtiene las opciones del procesador (parser) del documento.
- getReceptor() : ReceptorInterface|null
- Obtiene el receptor del documento.
- getRendererOptions() : array<string|int, mixed>
- Obtiene las opciones del renderizador del documento.
- getSanitizerOptions() : array<string|int, mixed>
- Obtiene las opciones del sanitizador del documento.
- getTimbre() : array<string|int, mixed>|null
- Obtiene el timbre del documento.
- getTipoDocumento() : TipoDocumentoInterface|null
- getValidatorOptions() : array<string|int, mixed>
- Obtiene las opciones del validador del documento.
- getXmlDocument() : XmlInterface|null
- Obtiene el documento XML.
- setCaf() : static
- Asigna el CAF para timbrar el documento.
- setCertificate() : static
- Asigna el certificado para firmar el documento.
- setDocument() : static
- Asigna el documento tributario electrónico.
- setDocumentType() : static
- Asigna el tipo de documento tributario electrónico.
- setEmisor() : static
- Asigna el emisor del documento.
- setInputData() : static
- Asignar los datos de entrada del documento.
- setNormalizedData() : static
- Asigna los datos normalizados del documento.
- setOptions() : static
- Asigna las opciones del documento.
- setParsedData() : static
- Asigna los datos procesados (parseados) del documento.
- setReceptor() : static
- Asigna el receptor del documento.
- setTimbre() : static
- Asigna el timbre del documento.
- setTipoDocumento() : static
- setXmlDocument() : static
- Asigna el documento XML.
- withCaf() : DocumentBagInterface
- Retorna una nueva bolsa con los datos del DTE e incluye un archivo CAF.
- withCertificate() : DocumentBagInterface
- Retorna una nueva bolsa con los datos del DTE e incluye un certificado.
Methods
getAlias()
Entrega el alias del tipo de documento que contiene la bolsa.
public
getAlias() : string
Return values
stringgetBuilderOptions()
Obtiene las opciones del constructor del documento.
public
getBuilderOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getCaf()
Obtiene el CAF para timbrar el documento.
public
getCaf() : CafInterface|null
Return values
CafInterface|nullgetCertificate()
Obtiene el certificado para firmar el documento.
public
getCertificate() : CertificateInterface|null
Return values
CertificateInterface|nullgetCodigoTipoDocumento()
public
getCodigoTipoDocumento() : int|null
Tags
Return values
int|nullgetData()
Obtiene los datos del documento.
public
getData() : array<string|int, mixed>|null
Los datos se arman en un nodo DTE con los datos normalizados. Si está disponible además se agrega el timbre.
Estos datos no incluyen la firma electrónica.
Return values
array<string|int, mixed>|nullgetDocument()
Obtiene el documento tributario electrónico.
public
getDocument() : DocumentInterface|null
Return values
DocumentInterface|nullgetDocumentType()
Obtiene el tipo de documento tributario electrónico.
public
getDocumentType() : TipoDocumentoInterface|null
Return values
TipoDocumentoInterface|nullgetDocumentTypeId()
Obtiene el código numérico del documento tributario electrónico.
public
getDocumentTypeId() : int|null
Return values
int|nullgetEmisor()
Obtiene el emisor del documento.
public
getEmisor() : EmisorInterface|null
Return values
EmisorInterface|nullgetId()
Entrega el ID del documento.
public
getId() : string
Return values
stringgetInputData()
Obtiene los datos de entrada del documento.
public
getInputData() : string|null
Return values
string|nullgetNormalizedData()
Obtiene los datos normalizados del documento.
public
getNormalizedData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetNormalizerOptions()
Obtiene las opciones del normalizador del documento.
public
getNormalizerOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getOptions()
Obtiene las opciones del documento.
public
getOptions() : DataContainerInterface|null
Return values
DataContainerInterface|nullgetParsedData()
Obtiene los datos procesados (parseados) del documento.
public
getParsedData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetParserOptions()
Obtiene las opciones del procesador (parser) del documento.
public
getParserOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getReceptor()
Obtiene el receptor del documento.
public
getReceptor() : ReceptorInterface|null
Return values
ReceptorInterface|nullgetRendererOptions()
Obtiene las opciones del renderizador del documento.
public
getRendererOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getSanitizerOptions()
Obtiene las opciones del sanitizador del documento.
public
getSanitizerOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getTimbre()
Obtiene el timbre del documento.
public
getTimbre() : array<string|int, mixed>|null
Este es el nodo TED del documento.
Return values
array<string|int, mixed>|nullgetTipoDocumento()
public
getTipoDocumento() : TipoDocumentoInterface|null
Tags
Return values
TipoDocumentoInterface|nullgetValidatorOptions()
Obtiene las opciones del validador del documento.
public
getValidatorOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getXmlDocument()
Obtiene el documento XML.
public
getXmlDocument() : XmlInterface|null
Return values
XmlInterface|nullsetCaf()
Asigna el CAF para timbrar el documento.
public
setCaf(CafInterface|null $caf) : static
Parameters
- $caf : CafInterface|null
Return values
staticsetCertificate()
Asigna el certificado para firmar el documento.
public
setCertificate(CertificateInterface|null $certificate) : static
Parameters
- $certificate : CertificateInterface|null
Return values
staticsetDocument()
Asigna el documento tributario electrónico.
public
setDocument(DocumentInterface|null $document) : static
Parameters
- $document : DocumentInterface|null
Return values
staticsetDocumentType()
Asigna el tipo de documento tributario electrónico.
public
setDocumentType(TipoDocumentoInterface|null $documentType) : static
Parameters
- $documentType : TipoDocumentoInterface|null
Return values
staticsetEmisor()
Asigna el emisor del documento.
public
setEmisor(EmisorInterface|null $emisor) : static
Parameters
- $emisor : EmisorInterface|null
Return values
staticsetInputData()
Asignar los datos de entrada del documento.
public
setInputData(string|array<string|int, mixed>|stdClass|null $inputData) : static
Si los datos no son string se serializan como JSON.
Parameters
- $inputData : string|array<string|int, mixed>|stdClass|null
Return values
staticsetNormalizedData()
Asigna los datos normalizados del documento.
public
setNormalizedData(array<string|int, mixed>|null $normalizedData) : static
Parameters
- $normalizedData : array<string|int, mixed>|null
Return values
staticsetOptions()
Asigna las opciones del documento.
public
setOptions(array<string|int, mixed>|DataContainerInterface|null $options) : static
Parameters
- $options : array<string|int, mixed>|DataContainerInterface|null
Return values
staticsetParsedData()
Asigna los datos procesados (parseados) del documento.
public
setParsedData(array<string|int, mixed>|null $parsedData) : static
Parameters
- $parsedData : array<string|int, mixed>|null
Return values
staticsetReceptor()
Asigna el receptor del documento.
public
setReceptor(ReceptorInterface|null $receptor) : static
Parameters
- $receptor : ReceptorInterface|null
Return values
staticsetTimbre()
Asigna el timbre del documento.
public
setTimbre(array<string|int, mixed>|null $timbre) : static
Este es el nodo TED del documento.
Parameters
- $timbre : array<string|int, mixed>|null
Return values
staticsetTipoDocumento()
public
setTipoDocumento(TipoDocumentoInterface|null $documentType) : static
Parameters
- $documentType : TipoDocumentoInterface|null
Tags
Return values
staticsetXmlDocument()
Asigna el documento XML.
public
setXmlDocument(XmlInterface|null $xml) : static
Parameters
- $xml : XmlInterface|null
Return values
staticwithCaf()
Retorna una nueva bolsa con los datos del DTE e incluye un archivo CAF.
public
withCaf(CafInterface $caf) : DocumentBagInterface
Las bolsas no se pueden reutilizar una vez se normalizaron, porque ya se generó el DTE. Este método sirve para agregar a una bolsa sin CAF el CAF y tener una nueva bolsa sin el DTE para volver a construir y timbrar.
Parameters
- $caf : CafInterface
Return values
DocumentBagInterfacewithCertificate()
Retorna una nueva bolsa con los datos del DTE e incluye un certificado.
public
withCertificate(CertificateInterface $certificate) : DocumentBagInterface
Las bolsas no se pueden reutilizar una vez se normalizaron, porque ya se generó el DTE. Este método sirve para agregar a una bolsa sin certificado digital el certificado y tener una nueva bolsa sin el DTE para volver a construir y firmar.
Parameters
- $certificate : CertificateInterface