LibreDTE

CatalogWorkerInterface extends WorkerInterface

Interfaz para la exploración genérica de repositorios de datos.

No depende de ninguna entidad o repositorio específico: cualquier repositorio registrado en el RepositoryManagerInterface de la aplicación puede consultarse a través de este worker, identificándolo por su FQCN (clase de entidad o interfaz), tal como se usa con RepositoryManagerInterface::getRepository().

Table of Contents

Methods

count()  : int
Cuenta los elementos de un repositorio que cumplen ciertos criterios.
find()  : object|null
Busca un elemento de un repositorio por su identificador.
findAll()  : array<string|int, object>
Entrega todos los elementos de un repositorio.
findBy()  : array<string|int, object>
Busca elementos de un repositorio según criterios de coincidencia.
findOneBy()  : object|null
Busca un único elemento de un repositorio según criterios de coincidencia.
list()  : array<string|int, string>
Entrega los identificadores de los repositorios disponibles.

Methods

count()

Cuenta los elementos de un repositorio que cumplen ciertos criterios.

public count(string $repository[, array<string|int, mixed> $criteria = [] ]) : int
Parameters
$repository : string

Identificador del repositorio.

$criteria : array<string|int, mixed> = []

Criterios de búsqueda (ver findBy()). Vacío para contar todos los elementos del repositorio.

Tags
throws
CatalogException

Si el repositorio no existe o no se puede resolver.

Return values
int

find()

Busca un elemento de un repositorio por su identificador.

public find(string $repository, int|string $id) : object|null
Parameters
$repository : string

Identificador del repositorio (FQCN de la entidad o de su interfaz).

$id : int|string

Identificador del elemento buscado.

Tags
throws
CatalogException

Si el repositorio no existe o no se puede resolver.

Return values
object|null

El elemento encontrado o null si no existe.

findAll()

Entrega todos los elementos de un repositorio.

public findAll(string $repository) : array<string|int, object>
Parameters
$repository : string

Identificador del repositorio.

Tags
throws
CatalogException

Si el repositorio no existe o no se puede resolver.

Return values
array<string|int, object>

findBy()

Busca elementos de un repositorio según criterios de coincidencia.

public findBy(string $repository[, array<string|int, mixed> $criteria = [] ][, array<string|int, mixed>|null $orderBy = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, object>
Parameters
$repository : string

Identificador del repositorio.

$criteria : array<string|int, mixed> = []

Criterios de búsqueda, formato ['campo' => 'valor'] (o ['campo' => ['valor1', 'valor2']] para coincidencia con cualquiera de varios valores).

$orderBy : array<string|int, mixed>|null = null

Orden de los resultados, formato ['campo' => 'ASC'|'DESC'].

$limit : int|null = null

Cantidad máxima de resultados.

$offset : int|null = null

Cantidad de resultados a saltar.

Tags
throws
CatalogException

Si el repositorio no existe o no se puede resolver.

Return values
array<string|int, object>

findOneBy()

Busca un único elemento de un repositorio según criterios de coincidencia.

public findOneBy(string $repository[, array<string|int, mixed> $criteria = [] ][, array<string|int, mixed>|null $orderBy = null ]) : object|null
Parameters
$repository : string

Identificador del repositorio.

$criteria : array<string|int, mixed> = []

Criterios de búsqueda (ver findBy()).

$orderBy : array<string|int, mixed>|null = null

Orden usado para elegir el primer resultado.

Tags
throws
CatalogException

Si el repositorio no existe o no se puede resolver.

Return values
object|null

El primer elemento que cumple los criterios o null si no hay ninguno.

list()

Entrega los identificadores de los repositorios disponibles.

public list() : array<string|int, string>

No carga ningún repositorio, solo lista los identificadores que pueden usarse con el resto de los métodos de este worker.

Return values
array<string|int, string>
On this page

Search results