PathManager
in package
Clase para administrar las rutas que utiliza la biblioteca para sus archivos.
Table of Contents
Constants
- BASE_PATH = __DIR__ . '/../..'
- Ubicación base, es la ruta donde está la biblioteca.
- CACHE_PATH = self::VAR_PATH . '/cache'
- Ubicación del directorio de caché dentro del directorio de datos variables.
- CERTIFICATES_PATH = self::RESOURCES_PATH . '/certificates'
- Ubicación de los certificados dentro del directorio de recursos.
- DATA_PATH = self::RESOURCES_PATH . '/data'
- Ubicación de los archivos PHP de datos dentro del directorio de recursos.
- RESOURCES_PATH = self::BASE_PATH . '/resources'
- Ubicación de los recursos.
- SCHEMAS_PATH = self::RESOURCES_PATH . '/schemas'
- Ubicación de los esquemas XML dentro del directorio de recursos.
- TESTS_PATH = self::BASE_PATH . '/tests'
- Ubicación de los tests.
- VAR_PATH = self::BASE_PATH . '/var'
- Ubicación de los datos variables que puede escribir la biblioteca en su ciclo de ejecución normal.
- WSDL_PATH = self::RESOURCES_PATH . '/wsdl'
- Ubicación de los WSDL de API SOAP dentro del directorio de recursos.
Methods
- getCachePath() : string
- Obtiene la ruta completa del directorio de caché.
- getCertificatesPath() : string|null
- Obtiene la ruta completa del directorio de certificados o de un certificado en específico si fue pasado.
- getDataPath() : string|null
- Obtiene la ruta completa de un archivo PHP de datos.
- getSchemasPath() : string|null
- Obtiene la ruta completa del directorio de esquemas XML o de un esquema XML en específico si fue pasado.
- getTestsPath() : string
- Obtiene la ruta completa del directorio de pruebas.
- getWsdlPath() : string|null
- Obtiene la ruta completa a un archivo WSDL en el almacenamiento local.
- checkFilepath() : string|null
- Valida que una ruta a un archivo se pueda leer (y por ende que exista).
Constants
BASE_PATH
Ubicación base, es la ruta donde está la biblioteca.
private
mixed
BASE_PATH
= __DIR__ . '/../..'
CACHE_PATH
Ubicación del directorio de caché dentro del directorio de datos variables.
private
mixed
CACHE_PATH
= self::VAR_PATH . '/cache'
CERTIFICATES_PATH
Ubicación de los certificados dentro del directorio de recursos.
private
mixed
CERTIFICATES_PATH
= self::RESOURCES_PATH . '/certificates'
DATA_PATH
Ubicación de los archivos PHP de datos dentro del directorio de recursos.
private
mixed
DATA_PATH
= self::RESOURCES_PATH . '/data'
RESOURCES_PATH
Ubicación de los recursos.
private
mixed
RESOURCES_PATH
= self::BASE_PATH . '/resources'
SCHEMAS_PATH
Ubicación de los esquemas XML dentro del directorio de recursos.
private
mixed
SCHEMAS_PATH
= self::RESOURCES_PATH . '/schemas'
TESTS_PATH
Ubicación de los tests.
private
mixed
TESTS_PATH
= self::BASE_PATH . '/tests'
VAR_PATH
Ubicación de los datos variables que puede escribir la biblioteca en su ciclo de ejecución normal.
private
mixed
VAR_PATH
= self::BASE_PATH . '/var'
WSDL_PATH
Ubicación de los WSDL de API SOAP dentro del directorio de recursos.
private
mixed
WSDL_PATH
= self::RESOURCES_PATH . '/wsdl'
Methods
getCachePath()
Obtiene la ruta completa del directorio de caché.
public
static getCachePath() : string
Return values
stringgetCertificatesPath()
Obtiene la ruta completa del directorio de certificados o de un certificado en específico si fue pasado.
public
static getCertificatesPath([string $filename = null ]) : string|null
Parameters
- $filename : string = null
-
Nombre del archivo del certificado.
Return values
string|null —Ubicación del certificado o null
si no se encontró.
getDataPath()
Obtiene la ruta completa de un archivo PHP de datos.
public
static getDataPath(string $key) : string|null
Parameters
- $key : string
-
Clave del archivo de datos.
Return values
string|null —Ubicación del archivo o null
si no se encontró.
getSchemasPath()
Obtiene la ruta completa del directorio de esquemas XML o de un esquema XML en específico si fue pasado.
public
static getSchemasPath([string $filename = null ]) : string|null
Parameters
- $filename : string = null
-
Nombre del archivo del esquema XML.
Return values
string|null —Ubicación del esquema XML o null
si no se encontró.
getTestsPath()
Obtiene la ruta completa del directorio de pruebas.
public
static getTestsPath() : string
Return values
stringgetWsdlPath()
Obtiene la ruta completa a un archivo WSDL en el almacenamiento local.
public
static getWsdlPath(string $server, string $service) : string|null
Parameters
- $server : string
-
Servidor del SII al que se busca un WSDL.
- $service : string
-
Servicio para el que se busca su WSDL.
Return values
string|null —Ubicación del WSDL o null
si no se encontró.
checkFilepath()
Valida que una ruta a un archivo se pueda leer (y por ende que exista).
private
static checkFilepath(string $filepath) : string|null
Parameters
- $filepath : string
-
Ruta completa al archivo a verificar.
Return values
string|null —Ruta al archivo si es válida o null
si no lo es.