ArrayDataProvider
in package
implements
DataProviderInterface
Clase que implementa la interfaz DataProviderInterface.
Esta clase actúa como un proveedor de datos en memoria, permitiendo el almacenamiento, recuperación y manejo de conjuntos de datos asociados a claves específicas. Si los datos no están en memoria, los cargará desde archivos.
Table of Contents
Interfaces
- DataProviderInterface
- Interfaz que define los métodos necesarios para un proveedor de datos (Data Provider).
Properties
- $dataFilepath : string
- Ruta base (con placeholder) para encontrar los archivos de datos.
- $dataStore : array<string|int, mixed>
- Almacén de datos en memoria.
Methods
- __construct() : mixed
- Constructor del proveedor de datos.
- addData() : void
- Agrega o registra un nuevo conjunto de datos bajo una clave específica.
- getAllKeys() : array<string|int, mixed>
- Devuelve una lista de todas las claves disponibles dentro del proveedor de datos.
- getData() : array<string|int, mixed>
- Obtiene un conjunto de datos completo asociado con una clave específica.
- getValue() : mixed
- Obtiene un valor específico dentro de un conjunto de datos, dada una clave y un código.
- hasData() : bool
- Verifica si hay un conjunto de datos disponible para una clave específica.
- removeData() : void
- Elimina un conjunto de datos del proveedor, identificado por una clave específica.
- search() : array<string|int, mixed>
- Obtiene un conjunto de datos que pueden ser filtrados dentro de los datos.
- loadData() : void
- Carga los datos asociados a una clave desde un archivo.
Properties
$dataFilepath
Ruta base (con placeholder) para encontrar los archivos de datos.
private
string
$dataFilepath
$dataStore
Almacén de datos en memoria.
private
array<string|int, mixed>
$dataStore
= []
Methods
__construct()
Constructor del proveedor de datos.
public
__construct([string|null $dataFilepath = null ]) : mixed
Parameters
- $dataFilepath : string|null = null
-
Ruta base para archivos de datos.
addData()
Agrega o registra un nuevo conjunto de datos bajo una clave específica.
public
addData(string $key, array<string|int, mixed> $data) : void
Parameters
- $key : string
-
Clave que identifica el conjunto de datos.
- $data : array<string|int, mixed>
-
Conjunto de datos a asociar a la clave.
getAllKeys()
Devuelve una lista de todas las claves disponibles dentro del proveedor de datos.
public
getAllKeys() : array<string|int, mixed>
Return values
array<string|int, mixed> —Arreglo de strings que contiene todas las claves disponibles.
getData()
Obtiene un conjunto de datos completo asociado con una clave específica.
public
getData(string $key) : array<string|int, mixed>
Parameters
- $key : string
-
Clave que identifica el conjunto de datos.
Return values
array<string|int, mixed> —Conjunto de datos asociado a la clave.
getValue()
Obtiene un valor específico dentro de un conjunto de datos, dada una clave y un código.
public
getValue(string $key, string|int $code[, mixed $default = null ]) : mixed
Parameters
- $key : string
-
Clave que identifica el conjunto de datos.
- $code : string|int
-
Código que se desea buscar dentro del conjunto de datos.
- $default : mixed = null
-
Valor por defecto en caso que no se encuentr el valor solicitado.
Return values
mixed —Valor asociado al código dentro del conjunto de datos. Si el código no se encuentra, se devuelve el valor por defecto.
hasData()
Verifica si hay un conjunto de datos disponible para una clave específica.
public
hasData(string $key) : bool
Parameters
- $key : string
-
Clave que identifica el conjunto de datos.
Return values
bool —true si existe un conjunto de datos asociado a la clave,
false en caso contrario.
removeData()
Elimina un conjunto de datos del proveedor, identificado por una clave específica.
public
removeData(string $key) : void
Parameters
- $key : string
-
Clave que identifica el conjunto de datos que se desea eliminar.
search()
Obtiene un conjunto de datos que pueden ser filtrados dentro de los datos.
public
search(string $key, array<string|int, mixed> $filters) : array<string|int, mixed>
Parameters
- $key : string
- $filters : array<string|int, mixed>
Return values
array<string|int, mixed> —Arreglo con los valores (arreglos) de los datos que coinciden con la búsqueda solicitada.
loadData()
Carga los datos asociados a una clave desde un archivo.
private
loadData(string $key) : void
Parameters
- $key : string
-
Clave que identifica el conjunto de datos.