DataProviderInterface
in
Interfaz que define los métodos necesarios para un proveedor de datos (Data Provider).
Un Data Provider es responsable de suministrar conjuntos de datos asociados a claves específicas.
Table of Contents
Methods
- 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.
Methods
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.
Tags
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.
Tags
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>
Este método requiere que los valores en los datos sean arreglos para poder realizar el filtrado.
Si se desea filtrar por el ID o código de los datos se puede utilizar
cualquiera de estos índices (filtros): id, code o codigo.
Si se desea filtrar buscando coincidencia de más de un valor para el mismo filtro (condición "OR") se debe pasar el valor del filtro como un arreglo.
La búsqueda se hace utilizando comparación estricta, por lo que se si el tipo de datos del valor del atributo buscado no coincide no se considerará como encontrado.
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.