Caf
in package
implements
CafInterface
Entidad que representa un Código de Autorización de Folios (CAF).
Un CAF es un archivo XML que contiene los folios autorizados por el Servicio de Impuestos Internos (SII) de Chile para la emisión de Documentos Tributarios Electrónicos (DTE).
Table of Contents
Interfaces
- CafInterface
- Interfaz para la entidad que representa archivos CAF.
Constants
- AMBIENTES = [self::IDK_CERTIFICACION => \libredte\lib\Core\Package\Billing\Component\Integration\Enum\Ambiente::CERTIFICACION, self::IDK_PRODUCCION => \libredte\lib\Core\Package\Billing\Component\Integration\Enum\Ambiente::PRODUCCION]
- Mapa de ambientes disponibles para el CAF.
- IDK_CERTIFICACION = 100
- Ambiente de certificación del SII.
- IDK_PRODUCCION = 300
- Ambiente de producción del SII.
Properties
- $xmlDocument : XmlInterface
- Documento XML del CAF.
Methods
- __construct() : mixed
- Constructor del CAF.
- enRango() : bool
- Determina si el folio pasado como argumento está o no dentro del rango del CAF.
- getAmbiente() : Ambiente|null
- Entrega el ambiente del SII asociado al CAF.
- getAutorizacion() : array<string|int, mixed>
- Entrega los datos del código de autorización de folios (CAF).
- getCantidadFolios() : int
- Obtiene la cantidad de folios autorizados en el CAF.
- getCertificacion() : int|null
- Indica si el CAF es de certificación o producción.
- getEmisor() : array<string|int, mixed>
- Obtiene el contribuyente emisor del CAF.
- getFechaAutorizacion() : string
- Obtiene la fecha de autorización del CAF.
- getFechaVencimiento() : string|null
- Obtiene la fecha de vencimiento del CAF.
- getFirma() : string
- Obtiene la firma del SII sobre el nodo DA del CAF.
- getFolioDesde() : int
- Obtiene el folio inicial autorizado en el CAF.
- getFolioHasta() : int
- Obtiene el folio final autorizado en el CAF.
- getId() : string
- Entrega un ID para el CAF generado a partir de los datos del mismo.
- getIdk() : int
- Obtiene el identificador del certificado utilizado en el CAF.
- getMesesAutorizacion() : float
- Entrega la cantidad de meses que han pasado desde la solicitud del CAF.
- getPrivateKey() : string
- Obtiene la clave privada proporcionada en el CAF.
- getPublicKey() : string
- Obtiene la clave pública proporcionada en el CAF.
- getTipoDocumento() : int
- Obtiene el código del tipo de documento tributario del CAF.
- getXml() : string
- Obtiene el documento XML como string.
- getXmlDocument() : XmlInterface
- Obtiene el documento XML.
- vence() : bool
- Indica si el CAF de este tipo de documento vence o no.
- vigente() : bool
- Indica si el CAF está o no vigente.
- loadXml() : static
- Carga un documento XML de un CAF en la instancia de la entidad Caf.
Constants
AMBIENTES
Mapa de ambientes disponibles para el CAF.
private
array<int, Ambiente>
AMBIENTES
= [self::IDK_CERTIFICACION => \libredte\lib\Core\Package\Billing\Component\Integration\Enum\Ambiente::CERTIFICACION, self::IDK_PRODUCCION => \libredte\lib\Core\Package\Billing\Component\Integration\Enum\Ambiente::PRODUCCION]
Asocia los valores de los ambientes con las configuraciones correspondientes de conexión al SII (certificación o producción).
IDK_CERTIFICACION
Ambiente de certificación del SII.
private
mixed
IDK_CERTIFICACION
= 100
Este valor se utiliza para identificar que el CAF pertenece al ambiente de pruebas o certificación.
IDK_PRODUCCION
Ambiente de producción del SII.
private
mixed
IDK_PRODUCCION
= 300
Este valor se utiliza para identificar que el CAF pertenece al ambiente de producción.
Properties
$xmlDocument
Documento XML del CAF.
private
XmlInterface
$xmlDocument
Este objeto representa el XML cargado del CAF, utilizado para interactuar con el contenido y extraer los datos necesarios.
Methods
__construct()
Constructor del CAF.
public
__construct(string|XmlInterface $xml) : mixed
Parameters
- $xml : string|XmlInterface
-
Documento XML del CAF.
enRango()
Determina si el folio pasado como argumento está o no dentro del rango del CAF.
public
enRango(int $folio) : bool
Parameters
- $folio : int
Return values
boolgetAmbiente()
Entrega el ambiente del SII asociado al CAF.
public
getAmbiente() : Ambiente|null
Return values
Ambiente|nullgetAutorizacion()
Entrega los datos del código de autorización de folios (CAF).
public
getAutorizacion() : array<string|int, mixed>
Return values
array<string|int, mixed>getCantidadFolios()
Obtiene la cantidad de folios autorizados en el CAF.
public
getCantidadFolios() : int
Return values
int —Cantidad de folios.
getCertificacion()
Indica si el CAF es de certificación o producción.
public
getCertificacion() : int|null
Return values
int|nullgetEmisor()
Obtiene el contribuyente emisor del CAF.
public
getEmisor() : array<string|int, mixed>
Return values
array<string|int, mixed> —Arreglo con el RUT y razón social del contribuyente emisor.
getFechaAutorizacion()
Obtiene la fecha de autorización del CAF.
public
getFechaAutorizacion() : string
Return values
string —Fecha de autorización en formato YYYY-MM-DD.
getFechaVencimiento()
Obtiene la fecha de vencimiento del CAF.
public
getFechaVencimiento() : string|null
Return values
string|null —Fecha de vencimiento en formato YYYY-MM-DD o null
si no aplica.
getFirma()
Obtiene la firma del SII sobre el nodo DA del CAF.
public
getFirma() : string
Return values
string —Firma en base64.
getFolioDesde()
Obtiene el folio inicial autorizado en el CAF.
public
getFolioDesde() : int
Return values
int —Folio inicial.
getFolioHasta()
Obtiene el folio final autorizado en el CAF.
public
getFolioHasta() : int
Return values
int —Folio final.
getId()
Entrega un ID para el CAF generado a partir de los datos del mismo.
public
getId() : string
Return values
stringgetIdk()
Obtiene el identificador del certificado utilizado en el CAF.
public
getIdk() : int
Return values
int —ID del certificado.
getMesesAutorizacion()
Entrega la cantidad de meses que han pasado desde la solicitud del CAF.
public
getMesesAutorizacion() : float
Return values
float —Cantidad de meses transcurridos.
getPrivateKey()
Obtiene la clave privada proporcionada en el CAF.
public
getPrivateKey() : string
Return values
string —Clave privada.
getPublicKey()
Obtiene la clave pública proporcionada en el CAF.
public
getPublicKey() : string
Return values
string —Clave pública.
getTipoDocumento()
Obtiene el código del tipo de documento tributario del CAF.
public
getTipoDocumento() : int
Return values
int —Código con el tipo de documento tributario.
getXml()
Obtiene el documento XML como string.
public
getXml() : string
Return values
string —Contenido del XML.
getXmlDocument()
Obtiene el documento XML.
public
getXmlDocument() : XmlInterface
Return values
XmlInterfacevence()
Indica si el CAF de este tipo de documento vence o no.
public
vence() : bool
Return values
bool —true
si los folios de este tipo de documento vencen,
false
si no vencen.
vigente()
Indica si el CAF está o no vigente.
public
vigente([string|null $timestamp = null ]) : bool
Parameters
- $timestamp : string|null = null
-
Marca de tiempo para consultar vigencia en un momento específico. Si no se indica, por defecto es la fecha y hora actual.
Return values
bool —true
si el CAF está vigente, false
si no está vigente.
loadXml()
Carga un documento XML de un CAF en la instancia de la entidad Caf.
private
loadXml(string|XmlInterface $xml) : static
Parameters
- $xml : string|XmlInterface
-
Documento XML del CAF.