Filtros Where

A menudo al seleccionar, al modificar o al borrar información de la base de datos necesitamos filtrar los registros con los que queremos trabajar. Este tipo de filtrado en SQL se realiza mediante la cláusula WHERE. En FacturaScripts 2020 se ha implementado una clase que nos facilita la creación de estas condiciones de filtrado de una manera sencilla mediante un array de condiciones. De todo ello se encarga la clase DataBaseWhere.

Creación de Filtros

Para crear un filtro where necesitaremos incluir en nuestra clase el uso del espacio de nombre FacturaScriptsCoreBaseDataBaseDataBaseWhere, que nos dará acceso a la clase. Luego simplemente crearemos un array con las condiciones de filtrado que necesitemos, siendo cada una de las condiciones una instancia de la clase DataBaseWhere.

Al crear la instancia debemos informar de los parámetros:

• fields : Nombre de campo o lista separada por “|” a los que se aplicará el valor.
• value : Valor por el cual se filtra. Permite usar carácter comodín % (ver operador LIKE).

• operator : (opcional)(“=” por defecto) operador aritmético a aplicar.

  [“=”, “<”, “>”, “<=”, “>=”, “!=”, “IN”, “IS”, “IS NOT”, “LIKE”, “XLIKE”, “REGEXP”]

• operation : (opcional)(“AND” por defecto) Indica el operador lógico a aplicar. [“AND”, “OR”]. Esta operación se aplica al propio elemento, no al siguiente.

Ejemplos:

/// where codagente = 'Agente01'
$where = [new DataBaseWhere('codagente', 'Agente01')];

/// where fecha >= '01-01-2020' and fecha <= '31-12-2020'
$where = [
  new DataBaseWhere('fecha', '01-01-2020', '>='),
  new DataBaseWhere('fecha', '31-12-2020', '<='),
];

/// where codcliente = '181432' and estado != 'Pagado'
$where = [];
$where[] = new DataBaseWhere('codcliente', '181432');
$where[] = new DataBaseWhere('estado', 'Pagado', '!=');

/// where name = 'MyView' and nick is null and date is null
$where = [
    new DataBaseWhere('name', 'MyView'),
    new DataBaseWhere('nick|date', 'null', 'IS')
];

/// where codejercicio = '2020' and codcuentaesp in ('IVAREX','IVAREP','IVARRE')
$where = [
    new DataBaseWhere('codejercicio', '2020'),
    new DataBaseWhere('codcuentaesp', 'IVAREX,IVAREP,IVARRE', 'IN')
];

Operador LIKE

Este operador permite buscar si una cadena se encuentra dentro de otra cadena. Permite un uso avanzado con el uso del carácter comodín % para indicar si el valor a buscar está contenido en, comienza por o termina en. Si no se incluye ningún comodín en el valor a buscar se entiende que se busca un valor contenido en.

Ejemplos:

/// where nombre LIKE '%sanchez%' (contiene)
$where = [new DataBaseWhere('nombre', 'sanchez', 'LIKE')];

/// where nombre LIKE 'sanchez%' (comienza por)
$where = [new DataBaseWhere('nombre', 'sanchez%', 'LIKE')];

/// where nombre LIKE '%sanchez' (termina por)
$where = [new DataBaseWhere('nombre', '%sanchez', 'LIKE')];

Operador XLIKE

Esta es una variación del operador LIKE, pero con soporte para buscar por múltiples palabras. Para ello debemos informar en el parámetro value varios valores separados por espacio, y cada valor puede de manera opcional incluir comodines.

/// where (nombre LIKE '%sanchez%' AND nombre LIKE '%martinez')
///     OR (nombrecomercial LIKE '%sanchez%' AND nombrecomercial LIKE '%martinez'))
$where = [new DataBaseWhere('nombre|nombrecomercial', 'sanchez %martinez', 'XLIKE')];

Obtener sentencia WHERE

getSQLWhere

En el contexto del manejo de la base de datos, la mayoría de métodos esperan recibir un array con las condiciones para el filtrado mediante DataBaseWhere, pero en ocasiones necesitamos obtener la sentencia where. Para estos casos utilizamos este método statico. Al llamarlo nos transformará el array de condiciones en una cadena de texto con “ WHERE “ más el conjunto de condiciones o vacía si no se han informado condiciones.

/// where codagente = 'Agente01'
$where = [new DataBaseWhere('codagente', 'Agente01')];
$sqlWhere = DataBaseWhere::getSQLWhere($where);