Documentación para desarrolladores

DataBaseWhere

La clase DataBaseWhere es utilizada en FacturaScripts para filtrar resultados en los métodos all(), count() y loadFromCode() de los modelos. Podemos pasar un array de DataBaseWhere a estos métodos para que realicen los filtros que deseemos.

Cargar la clase

Lo primero que debemos hacer para usar un DataBaseWhere es cargar la clase, si todavía no lo hemos hecho:

use FacturaScripts\Core\Base\DataBase\DataBaseWhere;

new DataBaseWhere(fields, value, operator, operation)

  • fields: nombre del campo sobre el que se realiza el filtro.
    • También puede ser una lista como esta: 'campo1|campo2|campo3'.
  • value: valor por el cual se filtra.
    • También podemos comparar con otro campo usando el prefijo field:
  • operator: (opcional) ('=' por defecto)
    • Operador a aplicar: '=', '<', '>', '<=', '>=', '!=', 'IN', 'NOT IN', 'IS', 'IS NOT', 'LIKE', 'XLIKE', 'REGEXP'
  • operation: (opcional) ('AND' por defecto)
    • Operador lógico a aplicar: 'AND', 'OR'.
    • Importante: esta operación se aplica al propio elemento, no al siguiente.

Ejemplo: obtener todos los productos de la familia 1234

$productoModel = new Producto();
$where = [new DataBaseWhere('codfamilia', '1234')];
$productos1234 = $productoModel->all($where);

Como vemos, podemos llamar al método all() del modelo Producto un array de DataBaseWhere para que nos devuelva todos los productos que coincidan con ese filtro. En este caso todos aquellos productos de la familia 1234.

Ejemplo: obtener todo el stock con cantidad por debajo del mínimo

$stockModel = new Stock();
$where = [new DataBaseWhere('cantidad', 'field:stockmin', '<')];
$stockMinimo = $stockModel->all($where);

Ejemplo: obtener todas las facturas del cliente 1 en diciembre de 2020

$facturaModel = new FacturaCliente();
$where = [
   new DataBaseWhere('codcliente', '1'),
   new DataBaseWhere('fecha', '01-12-2020', '>='),
   new DataBaseWhere('fecha', '31-12-2020', '<='),
];
$facturasDiciembre = $facturaModel->all($where);

Ejemplo: obtener el número de facturas sin pagar del cliente 3

$facturaModel = new FacturaCliente();
$where = [
   new DataBaseWhere('codcliente', '1'),
   new DataBaseWhere('pagada', false),
];
$numero = $facturaModel->count($where);

Ejemplo: obtener todas las variantes cuya referencia o código de barras sea 666

$varianteModel = new Variante();
$where = [new DataBaseWhere('codbarras|referencia', '666')];
$variantes666 = $varianteModel->all($where);

Ejemplo: borrar todos los clientes sin teléfono o con el email admin@admin.com

$clienteModel = new Cliente();
$where = [
   new DataBaseWhere('telefono1', ''),
   new DataBaseWhere('email', 'admin@admin.com', '=', 'OR'),
];
foreach($clienteModel->all($where) as $cliente) {
   $cliente->delete();
}

Fíjese que indicamos el OR en el segundo elemento. Esto es porque se le aplica al propio elemento, no al siguiente.

Operador IN (y NOT IN)

Este operador permite mostrar los resultados cuyo valor está incluido en una lista u otra consulta:

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

$where = [new DataBaseWhere('codcliente', "select codcliente from contactos where codpais = 'ESP'", 'IN')];
/// RESULTADO: where codcliente IN (select codcliente from contactos where codpais = 'ESP')

Operador LIKE

Este operador permite buscar dentro de una cadena de texto:

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

Podemos buscar solamente al principio o al final gracias al uso del caracter %:

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

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

Operador XLIKE

Esta es una variación del operador LIKE, pero con soporte para buscar múltiples palabras. Imaginemos que queremos buscar productos con "gran caja" en la descripción, construimos nuestro LIKE con "gran caja", pero resulta que tenemos productos que en lugar de poner "gran caja" pone "caja grande". La consulta no nos vale. Tendríamos que buscar tanto "gran caja" como "caja gran". Bien, aquí entra el operador XLIKE que realiza precisamente esta operación:

$where = [new DataBaseWhere('descripcion', 'gran caja', 'XLIKE')];
/// RESULTADO: where (descripcion LIKE '%gran%' AND descripcion LIKE '%caja%')
Buscar

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
neorazorx_1
neorazorx_1
1390 Puntos 8 años
Fecha de creación 11-05-2018 00:00:00
Última actualización 25-10-2019
Contador de visitas 1050

Copyright (c) 2013-2021 FacturaScripts