LibreDTE

DocumentEnvelope
in package
implements DocumentEnvelopeInterface

Contenedor de datos del sobre de documentos tributarios electrónicos.

Permite "mover" un sobre con varios documentos, junto a otros datos asociados, por métodos de manera sencilla y, sobre todo, extensible.

Table of Contents

Interfaces

DocumentEnvelopeInterface
Interfaz para el sobre (contenedor) de documentos tributarios para el proceso de envío al SII e intercambio entre contribuyentes.

Properties

$optionsSchema  : array<string|int, mixed>
Reglas de esquema de las opciones del documento.
$caratula  : array<string|int, mixed>|null
Datos de la carátula del sobre.
$certificate  : CertificateInterface|null
Certificado digital (firma electrónica) para la firma del sobre.
$documents  : array<string|int, DocumentBagInterface>|null
Lista de bolsas de documentos tributarios que este sobre contendrá.
$emisor  : EmisorInterface|null
Emisor del sobre de documentos.
$mandatario  : MandatarioInterface|null
Mandatario del sobre de documentos.
$options  : DataContainerInterface|null
Opciones para los workers asociados al documento.
$receptor  : ReceptorInterface|null
Receptor del sobre de documentos.
$sobre_envio  : SobreEnvioInterface|null
Entidad del sobre del envío de documentos.
$tipo_sobre  : TipoSobre|null
Tipo del sobre de documentos.
$xmlDocument  : XmlInterface|null
Instancia del documento XML asociado al sobre de documentos tributarios.

Methods

addDocument()  : static
Agrega un nuevo documento al sobre de documentos.
getCaratula()  : array<string|int, mixed>|null
Obtiene los datos de la carátula del sobre de documentos.
getCertificate()  : CertificateInterface|null
Obtiene el certificado para firmar el sobre de documentos.
getDispatcherOptions()  : array<string|int, mixed>
Obtiene las opciones del despachador del sobre de documentos al SII.
getDocuments()  : array<string|int, DocumentBagInterface>|null
Obtiene todos los documentos del sobre.
getEmisor()  : EmisorInterface|null
Obtiene el emisor del sobre de documentos.
getId()  : string
Entrega el identificador del sobre de documentos.
getMandatario()  : MandatarioInterface|null
Obtiene el mandatario del emisor (mandante) autorizado en el SII a enviar el sobre con los documentos tributarios.
getOptions()  : DataContainerInterface|null
Obtiene las opciones del sobre de documentos.
getReceptor()  : ReceptorInterface|null
Obtiene el receptor del sobre de documentos.
getSobreEnvio()  : SobreEnvioInterface|null
Obtiene la entidad del sobre del envío de documentos.
getTipoSobre()  : TipoSobre
Entrega el tipo de sobre de documentos.
getXmlDocument()  : XmlInterface|null
Obtiene el documento XML que representa al sobre de documentos.
setCaratula()  : static
Asigna los datos de la carátula del sobre de documentos.
setCertificate()  : static
Asigna el certificado para firmar el sobre de documentos.
setDocuments()  : static
Asigna todos los documentos del sobre de una vez.
setEmisor()  : static
Asigna el emisor del sobre de documentos.
setMandatario()  : static
Asigna el mandatario del emisor (mandante) autorizado en el SII a enviar el sobre con los documentos tributarios.
setOptions()  : static
Asigna las opciones del sobre de documentos.
setReceptor()  : static
Asigna el receptor del sobre de documentos.
setSobreEnvio()  : static
Asigna la entidad del sobre del envío de documentos.
setXmlDocument()  : static
Asigna el documento XML que representa al sobre de documentos.
withCertificate()  : DocumentEnvelopeInterface
Retorna una nueva sobre con los datos del sobre actual e incluye un certificado.

Properties

$optionsSchema

Reglas de esquema de las opciones del documento.

protected array<string|int, mixed> $optionsSchema = ['dispatcher' => ['types' => 'array', 'default' => []]]

El formato del esquema es el utilizado por Symfony\Component\OptionsResolver\OptionsResolver.

Acá solo se indicarán los índices que deben pueden existir en las opciones. No se define el esquema de cada opción pues cada clase que utilice estas opciones deberá resolver y validar sus propias opciones.

$caratula

Datos de la carátula del sobre.

private array<string|int, mixed>|null $caratula = null

$certificate

Certificado digital (firma electrónica) para la firma del sobre.

private CertificateInterface|null $certificate = null

$options

Opciones para los workers asociados al documento.

private DataContainerInterface|null $options = null

Se definen los siguientes índices para las opciones:

  • dispatcher: Opciones para el despachador del sobre.

Se usarán las opciones por defecto en cada worker si no se indican los índices en el arreglo $options.

$xmlDocument

Instancia del documento XML asociado al sobre de documentos tributarios.

private XmlInterface|null $xmlDocument = null

Methods

getCaratula()

Obtiene los datos de la carátula del sobre de documentos.

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

getCertificate()

Obtiene el certificado para firmar el sobre de documentos.

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

getDispatcherOptions()

Obtiene las opciones del despachador del sobre de documentos al SII.

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

getId()

Entrega el identificador del sobre de documentos.

public getId() : string
Return values
string

getOptions()

Obtiene las opciones del sobre de documentos.

public getOptions() : DataContainerInterface|null
Return values
DataContainerInterface|null

getXmlDocument()

Obtiene el documento XML que representa al sobre de documentos.

public getXmlDocument() : XmlInterface|null
Return values
XmlInterface|null

setCaratula()

Asigna los datos de la carátula del sobre de documentos.

public setCaratula(array<string|int, mixed> $caratula) : static
Parameters
$caratula : array<string|int, mixed>
Return values
static

setCertificate()

Asigna el certificado para firmar el sobre de documentos.

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

setDocuments()

Asigna todos los documentos del sobre de una vez.

public setDocuments(array<string|int, mixed> $documents) : static
Parameters
$documents : array<string|int, mixed>
Return values
static

setMandatario()

Asigna el mandatario del emisor (mandante) autorizado en el SII a enviar el sobre con los documentos tributarios.

public setMandatario(MandatarioInterface|null $mandatario) : static
Parameters
$mandatario : MandatarioInterface|null
Return values
static

setOptions()

Asigna las opciones del sobre de documentos.

public setOptions(array<string|int, mixed>|DataContainerInterface|null $options) : static
Parameters
$options : array<string|int, mixed>|DataContainerInterface|null
Return values
static

setXmlDocument()

Asigna el documento XML que representa al sobre de documentos.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results