Przejdź do głównej zawartości

Klasy Criteria i CriteriaCompo

Klasy Criteria i CriteriaCompo zapewniają fluent, zorientowany na obiekty interfejs do budowania złożonych zapytań do bazy danych. Klasy te abstrahują klauzule SQL WHERE, pozwalając deweloperom konstruować dynamiczne zapytania bezpiecznie i czytelnie.

Klasa Criteria reprezentuje pojedynczy warunek w klauzuli WHERE:

namespace Xoops\Database;
class Criteria
{
protected $column;
protected $operator;
protected $value;
protected $function;
public function __construct(
string $column,
mixed $value = null,
string $operator = '=',
string $function = ''
) {}
public function render(string $prefix = ''): string {}
}
use Xoops\Database\Criteria;
use Xoops\Database\CriteriaCompo;
// Pojedynczy warunek
$criteria = new Criteria('status', 'active');
// Renders: `status` = 'active'
// Równość (domyślnie)
$criteria = new Criteria('status', 'active', '=');
// Nie równa się
$criteria = new Criteria('status', 'active', '<>');
// Większe niż
$criteria = new Criteria('age', 18, '>');
// Mniejsze niż lub równe
$criteria = new Criteria('age', 65, '<=');
// LIKE (do dopasowania wzorca)
$criteria = new Criteria('email', '%@example.com', 'LIKE');
// IN (dla wielu wartości)
$criteria = new Criteria('status', ['active', 'pending', 'review'], 'IN');
$criteria = new CriteriaCompo();
$criteria->add(new Criteria('status', 'active'));
$criteria->add(new Criteria('age', 18, '>='));
$criteria->add(new Criteria('verified', 1));
// Renders: `status` = 'active' AND `age` >= 18 AND `verified` = 1
$criteria = new CriteriaCompo('OR');
$criteria->add(new Criteria('role', 'admin'));
$criteria->add(new Criteria('role', 'moderator'));
$criteria->add(new Criteria('role', 'editor'));
namespace MyModule\Repository;
use Xoops\Database\XoopsDatabase;
use Xoops\Database\Criteria;
use Xoops\Database\CriteriaCompo;
class UserRepository
{
private $db;
private $table = 'users';
public function __construct(XoopsDatabase $db)
{
$this->db = $db;
}
public function findByCriteria(CriteriaCompo $criteria): array
{
$sql = "SELECT * FROM {$this->table}";
if ($criteria->count() > 0) {
$sql .= " WHERE " . $criteria->render();
}
$result = $this->db->query($sql);
$users = [];
while ($row = $this->db->fetchArray($result)) {
$users[] = new User($row);
}
return $users;
}
}

Klasa Criteria automatycznie ucieka od wartości, aby zapobiec wstrzykiwaniu SQL:

// Bezpieczne - wartość jest automatycznie uciekana
$userInput = "'; DROP TABLE users; --";
$criteria = new Criteria('username', $userInput);
// Bezpiecznie renderuje: `username` = '\''; DROP TABLE users; --'
MetodaOpisZwraca
__construct()Inicjalizuj warunek kryteriówvoid
render($prefix = '')Renderuj do segmentu klauzuli WHERE SQLstring
getColumn()Pobierz nazwę kolumnystring
getValue()Pobierz wartość porównaniamixed
getOperator()Pobierz operator porównaniastring
MetodaOpisZwraca
__construct($logic = 'AND')Inicjalizuj złożone kryteriavoid
add($criteria, $logic = null)Dodaj kryteria lub zagnieżdżoną złożonąvoid
render($prefix = '')Renderuj do kompletnej klauzuli WHEREstring
count()Pobierz liczbę kryteriówint
clear()Usuń wszystkie kryteriavoid
  • XoopsDatabase - Odniesienie klasy bazy danych
  • ../../03-Module-Development/Patterns/Repository-Pattern - Wzorzec repozytorium w XOOPS
  • ../../03-Module-Development/Patterns/Service-Layer-Pattern - Wzorzec warstwy serwisowej
  • Wprowadzono: XOOPS 2.5.0
  • Ostatnia Aktualizacja: XOOPS 4.0
  • Kompatybilność: PHP 7.4+