AbstractDocument
        
        extends Entity
    
    
            
            in package
            
        
    
            
            implements
                            DocumentInterface                    
    
    
Clase abstracta (base) de la representación de un documento tributario electrónico.
Table of Contents
Interfaces
- DocumentInterface
- Interfaz para las entidades que representan documentos tributarios.
Properties
- $tipoDocumento : CodigoDocumento
- Código del tipo de documento tributario al que está asociada esta instancia de un documento.
- $xmlDocument : XmlDocumentInterface
- Instancia del documento XML asociado a los datos.
- $datos : array<string|int, mixed>
- Datos del documento tributario estandarizados.
Methods
- __construct() : void
- Constructor del documento tributario.
- __toString() : string
- {@inheritDoc}
- get() : mixed
- Obtiene un elemento del DTE utilizando un selector.
- getCodigo() : int
- Obtiene el código numérico del documento tributario.
- getDatos() : array<string|int, mixed>
- Entrega los datos del DTE.
- getDetalle() : array<string|int, mixed>
- Entrega el detalle del documento.
- getEmisor() : array<string|int, mixed>
- Obtiene el contribuyente emisor del documento.
- getFechaEmision() : string
- Entrega la fecha de emisión asignada al documento tributario.
- getFolio() : int
- Entrega el folio del documento tributario.
- getId() : string
- Entrega el ID asignado al documento.
- getMoneda() : string
- Entrega la moneda asociada al documento.
- getMontoTotal() : int|float
- Entrega el monto total del documento.
- getPlantillaTED() : array<string|int, mixed>
- Entrega un arreglo con una plantilla con la estructura del TED.
- getRazonSocialReceptor() : string
- Obtiene la razón social del receptor del documento.
- getReceptor() : array<string|int, mixed>
- Obtiene el contribuyente receptor del documento.
- getRutEmisor() : string
- Obtiene el RUT del emisor del documento.
- getRutReceptor() : string
- Obtiene el RUT del receptor del documento.
- getTED() : string|null
- Entrega el nodo TED aplanado y listo para ser usado en el PDF417.
- getTipoDocumento() : CodigoDocumento
- Entrega el tipo de documento (como enum) asociado al DTE.
- getTotales() : array<string|int, mixed>
- Entrega todos los valores del tag "Totales".
- getXml() : string
- Genera el documentto XML como string sin encabezado ni saltos de línea al inicio y final.
- getXmlDocument() : XmlDocumentInterface
- Entrega el documento XML asociado al DTE.
- jsonSerialize() : array<string|int, mixed>
- {@inheritDoc}
- query() : string|array<string|int, mixed>|null
- Realiza una consulta XPath al XML del DTE.
- saveXml() : string
- Genera el documentto XML como string incluyendo encabezado.
- toArray() : array<string|int, mixed>
- Entrega los datos del DTE como un arreglo.
Properties
$tipoDocumento
Código del tipo de documento tributario al que está asociada esta instancia de un documento.
        protected
            CodigoDocumento
    $tipoDocumento
    
        Este valor está definido en cada clase que hereda de esta.
$xmlDocument read-only
Instancia del documento XML asociado a los datos.
        protected
            XmlDocumentInterface
    $xmlDocument
    
    
    
    
    
    
$datos
Datos del documento tributario estandarizados.
        private
            array<string|int, mixed>
    $datos
    
    
    
    
    
    
Methods
__construct()
Constructor del documento tributario.
    public
                    __construct(XmlDocumentInterface $xmlDocument) : void
    Parameters
- $xmlDocument : XmlDocumentInterface
__toString()
{@inheritDoc}
    public
                    __toString() : string
    Return values
stringget()
Obtiene un elemento del DTE utilizando un selector.
    public
                    get(string $selector) : mixed
    Parameters
- $selector : string
- 
                    Selector del elemento que se desea obtener. 
getCodigo()
Obtiene el código numérico del documento tributario.
    public
                    getCodigo() : int
    Return values
intgetDatos()
Entrega los datos del DTE.
    public
                    getDatos() : array<string|int, mixed>
    Return values
array<string|int, mixed>getDetalle()
Entrega el detalle del documento.
    public
                    getDetalle([int|null $index = null ]) : array<string|int, mixed>
    Parameters
- $index : int|null = null
- 
                    Índice de la línea de detalle solicitada o null(por defecto) para obtener todas las líneas.
Return values
array<string|int, mixed>getEmisor()
Obtiene el contribuyente emisor del documento.
    public
                    getEmisor() : array<string|int, mixed>
    Return values
array<string|int, mixed> —Datos del emisor en el DTE.
getFechaEmision()
Entrega la fecha de emisión asignada al documento tributario.
    public
                    getFechaEmision() : string
    Return values
stringgetFolio()
Entrega el folio del documento tributario.
    public
                    getFolio() : int
    Return values
intgetId()
Entrega el ID asignado al documento.
    public
                    getId() : string
    Return values
stringgetMoneda()
Entrega la moneda asociada al documento.
    public
                    getMoneda() : string
    Return values
stringgetMontoTotal()
Entrega el monto total del documento.
    public
                    getMontoTotal() : int|float
    Return values
int|float —Monto total del documento.
getPlantillaTED()
Entrega un arreglo con una plantilla con la estructura del TED.
    public
                    getPlantillaTED() : array<string|int, mixed>
    Return values
array<string|int, mixed>getRazonSocialReceptor()
Obtiene la razón social del receptor del documento.
    public
                    getRazonSocialReceptor() : string
    Return values
stringgetReceptor()
Obtiene el contribuyente receptor del documento.
    public
                    getReceptor() : array<string|int, mixed>
    Return values
array<string|int, mixed> —Datos del receptor en el DTE.
getRutEmisor()
Obtiene el RUT del emisor del documento.
    public
                    getRutEmisor() : string
    Return values
stringgetRutReceptor()
Obtiene el RUT del receptor del documento.
    public
                    getRutReceptor() : string
    Return values
stringgetTED()
Entrega el nodo TED aplanado y listo para ser usado en el PDF417.
    public
                    getTED() : string|null
    Return values
string|nullgetTipoDocumento()
Entrega el tipo de documento (como enum) asociado al DTE.
    public
                    getTipoDocumento() : CodigoDocumento
    Return values
CodigoDocumentogetTotales()
Entrega todos los valores del tag "Totales".
    public
                    getTotales() : array<string|int, mixed>
    Return values
array<string|int, mixed>getXml()
Genera el documentto XML como string sin encabezado ni saltos de línea al inicio y final.
    public
                    getXml() : string
    Return values
stringgetXmlDocument()
Entrega el documento XML asociado al DTE.
    public
                    getXmlDocument() : XmlDocumentInterface
    Return values
XmlDocumentInterfacejsonSerialize()
{@inheritDoc}
    public
                    jsonSerialize() : array<string|int, mixed>
    Return values
array<string|int, mixed>query()
Realiza una consulta XPath al XML del DTE.
    public
                    query(string $query[, array<string|int, mixed> $params = [] ]) : string|array<string|int, mixed>|null
    Parameters
- $query : string
- 
                    Consulta XPath con marcadores nombrados (ej.: ":param"). 
- $params : array<string|int, mixed> = []
- 
                    Arreglo de parámetros en formato ['param' => 'value']. 
Return values
string|array<string|int, mixed>|nullsaveXml()
Genera el documentto XML como string incluyendo encabezado.
    public
                    saveXml() : string
    Return values
stringtoArray()
Entrega los datos del DTE como un arreglo.
    public
                    toArray() : array<string|int, mixed>