LibreDTE

DocumentBagInterface extends OptionsAwareInterface
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.
getDocumentAuth()  : array<string|int, mixed>|null
Obtiene los datos de la autorización del emisor para emitir DTE.
getDocumentData()  : array<string|int, mixed>|null
Obtiene los datos del documento agregando los datos específicos de LibreDTE.
getDocumentExtra()  : array<string|int, mixed>|null
Obtiene los datos extras del documento.
getDocumentStamp()  : string|null
Obtiene el timbre del DTE.
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.
getFolio()  : int|string|null
Obtiene el folio del documento.
getId()  : string
Entrega el ID del documento.
getInputData()  : string|null
Obtiene los datos de entrada del documento.
getLibredteData()  : array<string|int, mixed>|null
Obtiene los datos de LibreDTE que están asociados al documento pero no son parte de la estructura oficial que utiliza el SII.
getNormalizedData()  : array<string|int, mixed>|null
Obtiene los datos normalizados del documento.
getNormalizerOptions()  : array<string|int, mixed>
Obtiene las opciones del normalizador 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.
setFolio()  : static
Asigna el folio numérico al documento.
setInputData()  : static
Asignar los datos de entrada del documento.
setLibredteData()  : static
Asigna los datos de LibreDTE que están asociados al documento pero no son parte de la estructura oficial que utiliza el SII.
setNormalizedData()  : static
Asigna los datos normalizados 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
string

getBuilderOptions()

Obtiene las opciones del constructor del documento.

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

getCertificate()

Obtiene el certificado para firmar el documento.

public getCertificate() : CertificateInterface|null
Return values
CertificateInterface|null

getData()

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.

Tampoco se incluyen datos específicos de LibreDTE. Si se necesitan los datos del documento completo, con los datos específicos de LibreDTE, usar el método getDocumentData().

Return values
array<string|int, mixed>|null

getDocumentAuth()

Obtiene los datos de la autorización del emisor para emitir DTE.

public getDocumentAuth() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDocumentData()

Obtiene los datos del documento agregando los datos específicos de LibreDTE.

public getDocumentData() : array<string|int, mixed>|null

Si se quieren solo los datos del documento, sin los agregados de LibreDTE se deben extrar directamente del DTE.

Por otro lado, si se quieren los datos normalizados preparados para firma se debe utilizar getData().

Return values
array<string|int, mixed>|null

getDocumentExtra()

Obtiene los datos extras del documento.

public getDocumentExtra() : array<string|int, mixed>|null

Esto entregará todos los datos extras del documento menos aquellos que son parte de los datos que se agregan a la estructura de datos del documento tributario para completar tags entre diferentes tipos de documentos. O sea, todo lo extra, menos el índice dte.

Return values
array<string|int, mixed>|null

getDocumentStamp()

Obtiene el timbre del DTE.

public getDocumentStamp() : string|null
Return values
string|null

getDocumentTypeId()

Obtiene el código numérico del documento tributario electrónico.

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

getFolio()

Obtiene el folio del documento.

public getFolio() : int|string|null

Cuando el folio es un entero se asume que es un folio oficial del SII.

Cuando es un folio alfanumérico (string) se asume que es un folio de una cotización de LibreDTE.

Cuando el folio no existe (es false o 0) se entregará null.

El folio puede provenir del documento normalizado (si existe) o del documento parseado (si aun no se normaliza).

Return values
int|string|null

getInputData()

Obtiene los datos de entrada del documento.

public getInputData() : string|null
Return values
string|null

getLibredteData()

Obtiene los datos de LibreDTE que están asociados al documento pero no son parte de la estructura oficial que utiliza el SII.

public getLibredteData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getNormalizedData()

Obtiene los datos normalizados del documento.

public getNormalizedData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getNormalizerOptions()

Obtiene las opciones del normalizador del documento.

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

getParsedData()

Obtiene los datos procesados (parseados) del documento.

public getParsedData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getParserOptions()

Obtiene las opciones del procesador (parser) del documento.

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

getRendererOptions()

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>|null

getValidatorOptions()

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|null

setCertificate()

Asigna el certificado para firmar el documento.

public setCertificate(CertificateInterface|null $certificate) : static
Parameters
$certificate : CertificateInterface|null
Return values
static

setFolio()

Asigna el folio numérico al documento.

public setFolio(int $folio) : static

El folio se asignará a los datos normalizados si existen o bien a los datos parseados si aun no se normaliza.

Parameters
$folio : int
Return values
static

setInputData()

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
static

setLibredteData()

Asigna los datos de LibreDTE que están asociados al documento pero no son parte de la estructura oficial que utiliza el SII.

public setLibredteData(array<string|int, mixed>|null $libredteData) : static
Parameters
$libredteData : array<string|int, mixed>|null
Return values
static

setNormalizedData()

Asigna los datos normalizados del documento.

public setNormalizedData(array<string|int, mixed>|null $normalizedData) : static
Parameters
$normalizedData : array<string|int, mixed>|null
Return values
static

setParsedData()

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
static

setTimbre()

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
static

setXmlDocument()

Asigna el documento XML.

public setXmlDocument(XmlInterface|null $xml) : static
Parameters
$xml : XmlInterface|null
Return values
static

withCaf()

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
DocumentBagInterface

withCertificate()

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
Return values
DocumentBagInterface 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results