XOOPS Query Builder
XOOPS Query Builder giver en moderne, flydende grænseflade til opbygning af SQL-forespørgsler. Det hjælper med at forhindre SQL-injektion, forbedrer læsbarheden og giver databaseabstraktion til flere databasesystemer.
Forespørgselsbyggerarkitektur
Sektion kaldt “Forespørgselsbyggerarkitektur”graph TD A[QueryBuilder] -->|builds| B[SELECT Queries] A -->|builds| C[INSERT Queries] A -->|builds| D[UPDATE Queries] A -->|builds| E[DELETE Queries]
F[Table] -->|chains| G[select] F -->|chains| H[where] F -->|chains| I[orderBy] F -->|chains| J[limit]
G -->|chains| K[join] G -->|chains| H H -->|chains| I I -->|chains| J
L[Execute Methods] -->|returns| M[Results] L -->|returns| N[Count] L -->|returns| O[First/Last]QueryBuilder klasse
Sektion kaldt “QueryBuilder klasse”Hovedforespørgselsbyggerklassen med flydende grænseflade.
Klasseoversigt
Sektion kaldt “Klasseoversigt”namespace Xoops\Database;
class QueryBuilder{ protected string $table = ''; protected string $type = 'SELECT'; protected array $selects = []; protected array $joins = []; protected array $wheres = []; protected array $orders = []; protected int $limit = 0; protected int $offset = 0; protected array $bindings = [];}Statiske metoder
Sektion kaldt “Statiske metoder”Opretter en ny forespørgselsbygger til en tabel.
public static function table(string $table): QueryBuilderParametre:
| Parameter | Skriv | Beskrivelse |
|---|---|---|
$table | streng | Tabelnavn (med eller uden præfiks) |
Returneringer: QueryBuilder - Forespørgselsbyggerforekomst
Eksempel:
$query = QueryBuilder::table('users');$query = QueryBuilder::table('xoops_users'); // With prefixSELECT Forespørgsler
Sektion kaldt “SELECT Forespørgsler”Angiver kolonner, der skal vælges.
public function select(...$columns): selfParametre:
| Parameter | Skriv | Beskrivelse |
|---|---|---|
...$columns | række | Kolonnenavne eller -udtryk |
Returneringer: self - Til metodekæde
Eksempel:
// Simple selectQueryBuilder::table('users') ->select('id', 'username', 'email') ->get();
// Select with aliasesQueryBuilder::table('users') ->select('id as user_id', 'username as name') ->get();
// Select all columnsQueryBuilder::table('users') ->select('*') ->get();
// Select with expressionsQueryBuilder::table('orders') ->select('id', 'COUNT(*) as total_items') ->groupBy('id') ->get();Tilføjer en WHERE-tilstand.
public function where(string $column, string $operator = '=', mixed $value = null): selfParametre:
| Parameter | Skriv | Beskrivelse |
|---|---|---|
$column | streng | Kolonnenavn |
$operator | streng | Sammenligningsoperatør |
$value | blandet | Værdi at sammenligne |
Returneringer: self - Til metodekæde
Operatører:
| Operatør | Beskrivelse | Eksempel |
|---|---|---|
= | Lige | ->where('status', '=', 'active') |
!= eller <> | Ikke lige | ->where('status', '!=', 'deleted') |
> | Større end | ->where('price', '>', 100) |
< | Mindre end | ->where('price', '<', 100) |
>= | Større eller lig | ->where('age', '>=', 18) |
<= | Mindre eller lig | ->where('age', '<=', 65) |
LIKE | Mønster match | ->where('name', 'LIKE', '%john%') |
IN | På listen | ->where('status', 'IN', ['active', 'pending']) |
NOT IN | Ikke på listen | ->where('id', 'NOT IN', [1, 2, 3]) |
BETWEEN | Rækkevidde | ->where('age', 'BETWEEN', [18, 65]) |
IS NULL | Er null | ->where('deleted_at', 'IS NULL') |
IS NOT NULL | Ikke null | ->where('deleted_at', 'IS NOT NULL') |
Eksempel:
// Single conditionQueryBuilder::table('users') ->select('*') ->where('status', '=', 'active') ->get();
// Multiple conditions (AND)QueryBuilder::table('users') ->select('*') ->where('status', '=', 'active') ->where('age', '>=', 18) ->get();
// IN operatorQueryBuilder::table('products') ->select('*') ->where('category_id', 'IN', [1, 2, 3]) ->get();
// LIKE operatorQueryBuilder::table('users') ->select('*') ->where('email', 'LIKE', '%@example.com') ->get();
// NULL checkQueryBuilder::table('users') ->select('*') ->where('deleted_at', 'IS NULL') ->get();eller Hvor
Sektion kaldt “eller Hvor”Tilføjer en OR-betingelse.
public function orWhere(string $column, string $operator = '=', mixed $value = null): selfEksempel:
QueryBuilder::table('users') ->select('*') ->where('status', '=', 'active') ->orWhere('premium', '=', 1) ->get(); // SELECT * FROM users WHERE status = 'active' OR premium = 1whereIn / whereNotIn
Sektion kaldt “whereIn / whereNotIn”Praktiske metoder til IN/NOT IN.
public function whereIn(string $column, array $values): selfpublic function whereNotIn(string $column, array $values): selfEksempel:
QueryBuilder::table('posts') ->select('*') ->whereIn('status', ['published', 'scheduled']) ->get();
QueryBuilder::table('comments') ->select('*') ->whereNotIn('spam_score', [8, 9, 10]) ->get();whereNull / whereNotNull
Sektion kaldt “whereNull / whereNotNull”Praktiske metoder til NULL-tjek.
public function whereNull(string $column): selfpublic function whereNotNull(string $column): selfEksempel:
QueryBuilder::table('users') ->select('*') ->whereNotNull('verified_at') ->get();whereBetween
Sektion kaldt “whereBetween”Kontrollerer, om værdien er mellem to værdier.
public function whereBetween(string $column, array $values): selfEksempel:
QueryBuilder::table('products') ->select('*') ->whereBetween('price', [10, 100]) ->get();
QueryBuilder::table('orders') ->select('*') ->whereBetween('created_at', ['2024-01-01', '2024-12-31']) ->get();deltag
Sektion kaldt “deltag”Tilføjer en INNER JOIN.
public function join( string $table, string $first, string $operator = '=', string $second = null): selfEksempel:
QueryBuilder::table('posts') ->select('posts.*', 'users.username', 'categories.name') ->join('users', 'posts.user_id', '=', 'users.id') ->join('categories', 'posts.category_id', '=', 'categories.id') ->where('posts.published', '=', 1) ->get();leftJoin / rightJoin
Sektion kaldt “leftJoin / rightJoin”Alternative sammenføjningstyper.
public function leftJoin( string $table, string $first, string $operator = '=', string $second = null): self
public function rightJoin( string $table, string $first, string $operator = '=', string $second = null): selfEksempel:
QueryBuilder::table('users') ->select('users.*', 'COUNT(posts.id) as post_count') ->leftJoin('posts', 'users.id', '=', 'posts.user_id') ->groupBy('users.id') ->get();gruppeAf
Sektion kaldt “gruppeAf”Grupperer resultater efter kolonne(r).
public function groupBy(...$columns): selfEksempel:
QueryBuilder::table('orders') ->select('user_id', 'COUNT(*) as order_count', 'SUM(total) as total_spent') ->groupBy('user_id') ->get();
QueryBuilder::table('sales') ->select('department', 'region', 'SUM(amount) as total') ->groupBy('department', 'region') ->get();Tilføjer en HAVING-tilstand.
public function having(string $column, string $operator = '=', mixed $value = null): selfEksempel:
QueryBuilder::table('orders') ->select('user_id', 'COUNT(*) as order_count') ->groupBy('user_id') ->having('order_count', '>', 5) ->get();bestil efter
Sektion kaldt “bestil efter”Ordrer resultater.
public function orderBy(string $column, string $direction = 'ASC'): selfParametre:
| Parameter | Skriv | Beskrivelse |
|---|---|---|
$column | streng | Kolonne til bestilling efter |
$direction | streng | ASC eller DESC |
Eksempel:
// Single orderQueryBuilder::table('users') ->select('*') ->orderBy('created_at', 'DESC') ->get();
// Multiple ordersQueryBuilder::table('posts') ->select('*') ->orderBy('category_id', 'ASC') ->orderBy('created_at', 'DESC') ->get();
// Random orderQueryBuilder::table('quotes') ->select('*') ->orderBy('RAND()') ->get();grænse / offset
Sektion kaldt “grænse / offset”Begrænser og forskyder resultater.
public function limit(int $limit): selfpublic function offset(int $offset): selfEksempel:
// Simple limitQueryBuilder::table('posts') ->select('*') ->limit(10) ->get();
// Pagination$page = 2;$perPage = 20;$offset = ($page - 1) * $perPage;
QueryBuilder::table('posts') ->select('*') ->limit($perPage) ->offset($offset) ->get();Udførelsesmetoder
Sektion kaldt “Udførelsesmetoder”Udfører forespørgsel og returnerer alle resultater.
public function get(): arrayReturneringer: array - Array af resultatrækker
Eksempel:
$users = QueryBuilder::table('users') ->select('id', 'username', 'email') ->where('status', '=', 'active') ->orderBy('username') ->get();
foreach ($users as $user) { echo $user['username'] . ' (' . $user['email'] . ')' . "\n";}Får det første resultat.
public function first(): ?arrayReturneringer: ?array - Første række eller null
Eksempel:
$user = QueryBuilder::table('users') ->select('*') ->where('id', '=', 123) ->first();
if ($user) { echo 'Found: ' . $user['username'];}Får det sidste resultat.
public function last(): ?arrayEksempel:
$latestPost = QueryBuilder::table('posts') ->select('*') ->orderBy('created_at', 'DESC') ->last();tæller
Sektion kaldt “tæller”Får optællingen af resultater.
public function count(): intReturneringer: int - Antal rækker
Eksempel:
$activeUsers = QueryBuilder::table('users') ->where('status', '=', 'active') ->count();
echo "Active users: $activeUsers";findes
Sektion kaldt “findes”Kontrollerer, om forespørgslen giver resultater.
public function exists(): boolReturneringer: bool - Sandt, hvis resultater findes
Eksempel:
if (QueryBuilder::table('users')->where('email', '=', 'test@example.com')->exists()) { echo 'User already exists';}samlet
Sektion kaldt “samlet”Får samlede værdier.
public function aggregate(string $function, string $column): mixedEksempel:
$maxPrice = QueryBuilder::table('products') ->aggregate('MAX', 'price');
$avgAge = QueryBuilder::table('users') ->aggregate('AVG', 'age');
$totalSales = QueryBuilder::table('orders') ->aggregate('SUM', 'total');INSERT Forespørgsler### indsæt
Sektion kaldt “INSERT Forespørgsler### indsæt”Indsætter en række.
public function insert(array $values): boolEksempel:
QueryBuilder::table('users')->insert([ 'username' => 'john', 'email' => 'john@example.com', 'password' => password_hash('secret', PASSWORD_BCRYPT), 'created_at' => date('Y-m-d H:i:s')]);indsæt Mange
Sektion kaldt “indsæt Mange”Indsætter flere rækker.
public function insertMany(array $rows): boolEksempel:
QueryBuilder::table('log_entries')->insertMany([ ['action' => 'login', 'user_id' => 1, 'timestamp' => time()], ['action' => 'logout', 'user_id' => 2, 'timestamp' => time()], ['action' => 'update', 'user_id' => 3, 'timestamp' => time()]]);UPDATE Forespørgsler
Sektion kaldt “UPDATE Forespørgsler”opdatering
Sektion kaldt “opdatering”Opdaterer rækker.
public function update(array $values): intReturneringer: int - Antal berørte rækker
Eksempel:
// Update single userQueryBuilder::table('users') ->where('id', '=', 123) ->update([ 'email' => 'newemail@example.com', 'updated_at' => date('Y-m-d H:i:s') ]);
// Update multiple rowsQueryBuilder::table('posts') ->where('status', '=', 'draft') ->where('created_at', '<', date('Y-m-d', strtotime('-30 days'))) ->update([ 'status' => 'archived' ]);stigning/mindsk
Sektion kaldt “stigning/mindsk”Forøger eller formindsker en kolonne.
public function increment(string $column, int $amount = 1): intpublic function decrement(string $column, int $amount = 1): intEksempel:
// Increment view countQueryBuilder::table('posts') ->where('id', '=', 123) ->increment('views');
// Decrement stockQueryBuilder::table('products') ->where('id', '=', 456) ->decrement('stock', 5);DELETE Forespørgsler
Sektion kaldt “DELETE Forespørgsler”Sletter rækker.
public function delete(): intReturneringer: int - Antal slettede rækker
Eksempel:
// Delete single recordQueryBuilder::table('comments') ->where('id', '=', 789) ->delete();
// Delete multiple recordsQueryBuilder::table('log_entries') ->where('created_at', '<', date('Y-m-d', strtotime('-30 days'))) ->delete();afkorte
Sektion kaldt “afkorte”Sletter alle rækker fra tabellen.
public function truncate(): boolEksempel:
// Clear all sessionsQueryBuilder::table('sessions')->truncate();Avancerede funktioner
Sektion kaldt “Avancerede funktioner”Rå udtryk
Sektion kaldt “Rå udtryk”QueryBuilder::table('products') ->select('id', 'name', QueryBuilder::raw('price * quantity as total')) ->get();Underforespørgsler
Sektion kaldt “Underforespørgsler”$recentPostIds = QueryBuilder::table('posts') ->select('id') ->where('created_at', '>', date('Y-m-d', strtotime('-7 days'))) ->toSql();
$comments = QueryBuilder::table('comments') ->select('*') ->whereIn('post_id', $recentPostIds) ->get();Henter SQL
Sektion kaldt “Henter SQL”public function toSql(): stringEksempel:
$sql = QueryBuilder::table('users') ->select('id', 'username') ->where('status', '=', 'active') ->toSql();
echo $sql;// SELECT id, username FROM xoops_users WHERE status = ?Fuldstændige eksempler
Sektion kaldt “Fuldstændige eksempler”Kompleks udvalg med sammenføjninger
Sektion kaldt “Kompleks udvalg med sammenføjninger”<?php/** * Get posts with author and category info */
$posts = QueryBuilder::table('posts') ->select( 'posts.id', 'posts.title', 'posts.content', 'posts.created_at', 'users.username as author', 'categories.name as category' ) ->join('users', 'posts.user_id', '=', 'users.id') ->join('categories', 'posts.category_id', '=', 'categories.id') ->where('posts.published', '=', 1) ->orderBy('posts.created_at', 'DESC') ->limit(10) ->get();
foreach ($posts as $post) { echo '<article>'; echo '<h2>' . htmlspecialchars($post['title']) . '</h2>'; echo '<p class="meta">By ' . htmlspecialchars($post['author']) . ' in ' . htmlspecialchars($post['category']) . '</p>'; echo '<p>' . htmlspecialchars($post['content']) . '</p>'; echo '</article>';}Sideinddeling med QueryBuilder
Sektion kaldt “Sideinddeling med QueryBuilder”<?php/** * Paginated results */
$page = isset($_GET['page']) ? (int)$_GET['page'] : 1;$perPage = 20;$offset = ($page - 1) * $perPage;
// Get total count$total = QueryBuilder::table('articles') ->where('status', '=', 'published') ->count();
// Get page results$articles = QueryBuilder::table('articles') ->select('*') ->where('status', '=', 'published') ->orderBy('created_at', 'DESC') ->limit($perPage) ->offset($offset) ->get();
// Calculate pagination$pages = ceil($total / $perPage);
// Display resultsforeach ($articles as $article) { echo '<div class="article">' . htmlspecialchars($article['title']) . '</div>';}
// Display pagination linksif ($pages > 1) { echo '<nav class="pagination">'; for ($i = 1; $i <= $pages; $i++) { if ($i == $page) { echo '<span class="current">' . $i . '</span>'; } else { echo '<a href="?page=' . $i . '">' . $i . '</a>'; } } echo '</nav>';}Dataanalyse med aggregater
Sektion kaldt “Dataanalyse med aggregater”<?php/** * Sales analysis */
// Total sales by region$regionSales = QueryBuilder::table('orders') ->select('region', QueryBuilder::raw('SUM(total) as total_sales'), QueryBuilder::raw('COUNT(*) as order_count')) ->groupBy('region') ->orderBy('total_sales', 'DESC') ->get();
foreach ($regionSales as $region) { echo $region['region'] . ': $' . number_format($region['total_sales'], 2) . ' (' . $region['order_count'] . ' orders)' . "\n";}
// Average order value$avgOrderValue = QueryBuilder::table('orders') ->aggregate('AVG', 'total');
echo 'Average order value: $' . number_format($avgOrderValue, 2);Bedste praksis
Sektion kaldt “Bedste praksis”- Brug parametriserede forespørgsler - QueryBuilder håndterer parameterbinding automatisk
- Kædemetoder - Udnyt flydende grænseflade til læsbar kode
- Test SQL output - Brug
toSql()til at bekræfte genererede forespørgsler - Brug indekser - Sørg for, at hyppigt forespurgte kolonner er indekseret
- Begræns resultater - Brug altid
limit()til store datasæt - Brug aggregater - Lad databasen tælle/summere i stedet for PHP
- Escape-output - Undgå altid viste data med
htmlspecialchars() - Indeksydelse - Overvåg langsomme forespørgsler og optimer derefter
Relateret dokumentation
Sektion kaldt “Relateret dokumentation”- XoopsDatabase - Databaselag og forbindelser
- Kriterier - Legacy Criteria-baseret forespørgselssystem
- ../Core/XoopsObject - Dataobjektpersistens
- ../Module/Module-System - Moduldatabaseoperationer
Se også: XOOPS Database API