Клас бази даних Xoops

Клас XoopsDatabase забезпечує рівень абстракції бази даних для XOOPS, керуючи керуванням з’єднаннями, виконанням запитів, обробкою результатів і обробкою помилок. Він підтримує кілька драйверів бази даних через архітектуру драйвера.

Огляд класу

namespace Xoops\Database;

abstract class XoopsDatabase
{
    protected $conn;
    protected $prefix;
    protected $logger;

    abstract public function connect(bool $selectdb = true): bool;
    abstract public function query(string $sql, int $limit = 0, int $start = 0);
    abstract public function fetchArray($result): ?array;
    abstract public function fetchObject($result): ?object;
    abstract public function getRowsNum($result): int;
    abstract public function getAffectedRows(): int;
    abstract public function getInsertId(): int;
    abstract public function escape(string $string): string;
}

Ієрархія класів

XoopsDatabase (Abstract Base)
├── XoopsMySQLDatabase (MySQL Extension)
│   └── XoopsMySQLDatabaseProxy (Security Proxy)
└── XoopsMySQLiDatabase (MySQLi Extension)
    └── XoopsMySQLiDatabaseProxy (Security Proxy)

XoopsDatabaseFactory
└── Creates appropriate driver instances

Отримання екземпляра бази даних

Використання фабрики

// Recommended: Use the factory
$db = XoopsDatabaseFactory::getDatabaseConnection();

Використання getInstance

// Alternative: Direct singleton access
$db = XoopsDatabase::getInstance();

Глобальна змінна

// Legacy: Use global variable
global $xoopsDB;

Основні методи

підключення

Встановлює підключення до бази даних.

abstract public function connect(bool $selectdb = true): bool

Параметри:

Параметр	Тип	Опис
$selectdb	bool	Чи вибирати базу даних

Повертає: bool - True у разі успішного підключення

Приклад:

$db = XoopsDatabaseFactory::getDatabaseConnection();
if ($db->connect()) {
    echo "Connected successfully";
}

---

запит

Виконує запит SQL.

abstract public function query(
    string $sql,
    int $limit = 0,
    int $start = 0
): mixed

Параметри:

Параметр	Тип	Опис
$sql	рядок	SQL рядок запиту
$limit	int	Максимальна кількість рядків для повернення (0 = без обмежень)
$start	int	Початкове зміщення

Повертає: resource|bool - ресурс результату або false у разі помилки

Приклад:

$db = XoopsDatabaseFactory::getDatabaseConnection();

// Simple query
$sql = "SELECT * FROM " . $db->prefix('users') . " WHERE uid > 0";
$result = $db->query($sql);

// Query with limit
$sql = "SELECT * FROM " . $db->prefix('users');
$result = $db->query($sql, 10, 0); // First 10 rows

// Query with offset
$result = $db->query($sql, 10, 20); // 10 rows starting at row 20

---

queryF

Виконує запит із примусовою операцією (обходить перевірки безпеки).

public function queryF(string $sql, int $limit = 0, int $start = 0): mixed

Випадки використання:

• Операції INSERT, UPDATE, DELETE
• Коли потрібно обійти обмеження лише для читання

Приклад:

$sql = sprintf(
    "UPDATE %s SET views = views + 1 WHERE article_id = %d",
    $db->prefix('articles'),
    $articleId
);
$db->queryF($sql);

---

префікс

Додає префікс таблиці бази даних.

public function prefix(string $table = ''): string

Параметри:

Параметр	Тип	Опис
$table	рядок	Назва таблиці без префікса

Повертає: string - назва таблиці з префіксом

Приклад:

$db = XoopsDatabaseFactory::getDatabaseConnection();

echo $db->prefix('users');       // "xoops_users" (if prefix is "xoops_")
echo $db->prefix('modules');     // "xoops_modules"
echo $db->prefix();              // "xoops_" (just the prefix)

---

fetchArray

Отримує рядок результату як асоціативний масив.

abstract public function fetchArray($result): ?array

Параметри:

Параметр	Тип	Опис
$result	ресурс	Ресурс результатів запиту

Повертає: array|null - Асоціативний масив або null, якщо більше немає рядків

Приклад:

$sql = "SELECT * FROM " . $db->prefix('users') . " WHERE level > 0";
$result = $db->query($sql);

while ($row = $db->fetchArray($result)) {
    echo "User: " . $row['uname'] . "\n";
    echo "Email: " . $row['email'] . "\n";
}

---

fetchObject

Отримує рядок результату як об’єкт.

abstract public function fetchObject($result): ?object

Параметри:

Параметр	Тип	Опис
$result	ресурс	Ресурс результатів запиту

Повертає: object|null – об’єкт із властивостями для кожного стовпця

Приклад:

$sql = "SELECT * FROM " . $db->prefix('users') . " WHERE uid = 1";
$result = $db->query($sql);

if ($user = $db->fetchObject($result)) {
    echo "Username: " . $user->uname;
    echo "Email: " . $user->email;
}

---

fetchRow

Отримує рядок результату як числовий масив.

abstract public function fetchRow($result): ?array

Приклад:

$sql = "SELECT uname, email FROM " . $db->prefix('users');
$result = $db->query($sql);

while ($row = $db->fetchRow($result)) {
    echo "Username: " . $row[0] . ", Email: " . $row[1];
}

---

отримати обидва

Отримує рядок результатів як асоціативний, так і числовий масив.

abstract public function fetchBoth($result): ?array

Приклад:

$result = $db->query($sql);
$row = $db->fetchBoth($result);
echo $row['uname'];  // By name
echo $row[0];        // By index

---

getRowsNum

Отримує кількість рядків у наборі результатів.

abstract public function getRowsNum($result): int

Параметри:

Параметр	Тип	Опис
$result	ресурс	Ресурс результатів запиту

Повертає: int - кількість рядків

Приклад:

$sql = "SELECT * FROM " . $db->prefix('users') . " WHERE level > 0";
$result = $db->query($sql);
$count = $db->getRowsNum($result);
echo "Found $count active users";

---

getAffectedRows

Отримує кількість постраждалих рядків з останнього запиту.

abstract public function getAffectedRows(): int

Повертає: int - кількість постраждалих рядків

Приклад:

$sql = "UPDATE " . $db->prefix('users') . " SET last_login = " . time() . " WHERE uid = 1";
$db->queryF($sql);
$affected = $db->getAffectedRows();
echo "Updated $affected rows";

---

getInsertId

Отримує автоматично згенерований ідентифікатор з останнього INSERT.

abstract public function getInsertId(): int

Повертає: int - ідентифікатор останньої вставки

Приклад:

$sql = sprintf(
    "INSERT INTO %s (title, content) VALUES (%s, %s)",
    $db->prefix('articles'),
    $db->quoteString($title),
    $db->quoteString($content)
);
$db->queryF($sql);
$newId = $db->getInsertId();
echo "Created article with ID: $newId";

---

втеча

Екранує рядок для безпечного використання в запитах SQL.

abstract public function escape(string $string): string

Параметри:

Параметр	Тип	Опис
$string	рядок	Рядок для екранування

Повертає: string - екранований рядок (без лапок)

Приклад:

$unsafeInput = "O'Reilly";
$safe = $db->escape($unsafeInput);  // "O\'Reilly"

$sql = "SELECT * FROM " . $db->prefix('users') . " WHERE uname = '" . $safe . "'";

---

quoteString

Екранує та бере в лапки рядок для SQL.

public function quoteString(string $string): string

Параметри:

Параметр	Тип	Опис
$string	рядок	Рядок для цитування

Повертає: string – екранований рядок із лапками

Приклад:

$name = "John O'Connor";
$quoted = $db->quoteString($name);  // "'John O\'Connor'"

$sql = "INSERT INTO users (name) VALUES (" . $quoted . ")";

---

freeRecordSet

Звільняє пам’ять, пов’язану з результатом.

abstract public function freeRecordSet($result): void

Приклад:

$result = $db->query($sql);
// Process results...
$db->freeRecordSet($result);  // Free memory

---

Обробка помилок

помилка

Отримує останнє повідомлення про помилку.

abstract public function error(): string

Приклад:

$result = $db->query($sql);
if (!$result) {
    echo "Database error: " . $db->error();
}

---

помилка

Отримує останній номер помилки.

abstract public function errno(): int

Приклад:

$result = $db->query($sql);
if (!$result) {
    echo "Error #" . $db->errno() . ": " . $db->error();
}

---

Підготовлені оператори (MySQLi)

Драйвер MySQLi підтримує підготовлені оператори для підвищення безпеки.

підготуватися

Створює підготовлену заяву.

public function prepare(string $sql): mysqli_stmt|false

Приклад:

$db = XoopsDatabaseFactory::getDatabaseConnection();

$sql = "SELECT * FROM " . $db->prefix('users') . " WHERE uid = ?";
$stmt = $db->prepare($sql);

$stmt->bind_param('i', $userId);
$userId = 5;
$stmt->execute();
$result = $stmt->get_result();

while ($row = $result->fetch_assoc()) {
    echo $row['uname'];
}
$stmt->close();

Підготовлений оператор із кількома параметрами

$sql = "INSERT INTO " . $db->prefix('articles') . " (title, content, author_id) VALUES (?, ?, ?)";
$stmt = $db->prepare($sql);

$stmt->bind_param('ssi', $title, $content, $authorId);

$title = "My Article";
$content = "Article content here";
$authorId = 1;

if ($stmt->execute()) {
    echo "Article created with ID: " . $stmt->insert_id;
}

$stmt->close();

---

Підтримка транзакцій

beginTransaction

Починає транзакцію.

public function beginTransaction(): bool

здійснити

Фіксує поточну транзакцію.

public function commit(): bool

відкат

Відкочує поточну транзакцію.

public function rollback(): bool

Приклад:

$db = XoopsDatabaseFactory::getDatabaseConnection();

try {
    $db->beginTransaction();

    // Multiple operations
    $sql1 = "UPDATE " . $db->prefix('accounts') . " SET balance = balance - 100 WHERE id = 1";
    $db->queryF($sql1);

    $sql2 = "UPDATE " . $db->prefix('accounts') . " SET balance = balance + 100 WHERE id = 2";
    $db->queryF($sql2);

    // Check for errors
    if ($db->errno()) {
        throw new Exception($db->error());
    }

    $db->commit();
    echo "Transaction completed";

} catch (Exception $e) {
    $db->rollback();
    echo "Transaction failed: " . $e->getMessage();
}

---

Повні приклади використання

Основні операції CRUD

$db = XoopsDatabaseFactory::getDatabaseConnection();

// CREATE
$sql = sprintf(
    "INSERT INTO %s (title, content, created) VALUES (%s, %s, %d)",
    $db->prefix('articles'),
    $db->quoteString('New Article'),
    $db->quoteString('Article content'),
    time()
);
$db->queryF($sql);
$articleId = $db->getInsertId();

// READ
$sql = "SELECT * FROM " . $db->prefix('articles') . " WHERE id = " . (int)$articleId;
$result = $db->query($sql);
$article = $db->fetchArray($result);

// UPDATE
$sql = sprintf(
    "UPDATE %s SET title = %s, updated = %d WHERE id = %d",
    $db->prefix('articles'),
    $db->quoteString('Updated Title'),
    time(),
    $articleId
);
$db->queryF($sql);

// DELETE
$sql = "DELETE FROM " . $db->prefix('articles') . " WHERE id = " . (int)$articleId;
$db->queryF($sql);

Запит на сторінки

function getArticles(int $page = 1, int $perPage = 10): array
{
    $db = XoopsDatabaseFactory::getDatabaseConnection();
    $start = ($page - 1) * $perPage;

    // Get total count
    $sql = "SELECT COUNT(*) as total FROM " . $db->prefix('articles') . " WHERE published = 1";
    $result = $db->query($sql);
    $row = $db->fetchArray($result);
    $total = $row['total'];

    // Get page of results
    $sql = "SELECT * FROM " . $db->prefix('articles') .
           " WHERE published = 1 ORDER BY created DESC";
    $result = $db->query($sql, $perPage, $start);

    $articles = [];
    while ($row = $db->fetchArray($result)) {
        $articles[] = $row;
    }

    return [
        'articles' => $articles,
        'total' => $total,
        'pages' => ceil($total / $perPage),
        'current' => $page
    ];
}

Пошуковий запит з LIKE

function searchArticles(string $keyword): array
{
    $db = XoopsDatabaseFactory::getDatabaseConnection();

    $keyword = $db->escape($keyword);
    $sql = "SELECT * FROM " . $db->prefix('articles') .
           " WHERE title LIKE '%" . $keyword . "%'" .
           " OR content LIKE '%" . $keyword . "%'" .
           " ORDER BY created DESC";

    $result = $db->query($sql, 50);  // Limit to 50 results

    $articles = [];
    while ($row = $db->fetchArray($result)) {
        $articles[] = $row;
    }

    return $articles;
}

Запит на приєднання

function getArticlesWithAuthors(): array
{
    $db = XoopsDatabaseFactory::getDatabaseConnection();

    $sql = "SELECT a.*, u.uname as author_name, u.email as author_email
            FROM " . $db->prefix('articles') . " a
            LEFT JOIN " . $db->prefix('users') . " u ON a.author_id = u.uid
            WHERE a.published = 1
            ORDER BY a.created DESC";

    $result = $db->query($sql, 20);

    $articles = [];
    while ($row = $db->fetchArray($result)) {
        $articles[] = $row;
    }

    return $articles;
}

---

Клас SqlUtility

Допоміжний клас для операцій з файлами SQL.

splitMySqlFile

Розділяє файл SQL на окремі запити.

public static function splitMySqlFile(string $content): array

Приклад:

$sqlContent = file_get_contents('install.sql');
$queries = SqlUtility::splitMySqlFile($sqlContent);

foreach ($queries as $query) {
    $db->queryF($query);
    if ($db->errno()) {
        echo "Error executing: " . $query . "\n";
        echo "Error: " . $db->error() . "\n";
    }
}

prefixQuery

Замінює заповнювачі таблиці на імена таблиць із префіксом.

public static function prefixQuery(string $sql, string $prefix): string

Приклад:

$sql = "CREATE TABLE {PREFIX}_articles (id INT PRIMARY KEY)";
$prefixedSql = SqlUtility::prefixQuery($sql, $db->prefix());
// "CREATE TABLE xoops_articles (id INT PRIMARY KEY)"

---

Найкращі практики

Безпека

1. Завжди виключати введення користувача:

$safe = $db->escape($_POST['input']);

2. Використовуйте готові твердження, якщо вони доступні:

$stmt = $db->prepare("SELECT * FROM users WHERE id = ?");
$stmt->bind_param('i', $id);

3. Використовуйте quoteString для значень:

$sql = "INSERT INTO table (name) VALUES (" . $db->quoteString($name) . ")";

Продуктивність

1. Завжди використовуйте LIMIT для великих таблиць:

$result = $db->query($sql, 100);  // Limit results

2. Безкоштовні набори результатів після завершення:

$db->freeRecordSet($result);

3. Використовуйте відповідні індекси у визначеннях таблиць

4. Надавайте перевагу обробникам над необробленим SQL, коли це можливо

Обробка помилок

1. Завжди перевіряйте наявність помилок:

$result = $db->query($sql);
if (!$result) {
    trigger_error($db->error(), E_USER_WARNING);
}

2. Використовуйте транзакції для кількох пов’язаних операцій:

$db->beginTransaction();
// ... operations ...
$db->commit();  // or $db->rollback();

Пов’язана документація

• Критерії - Система критеріїв запиту
• QueryBuilder - вільне створення запитів
• ../Core/XoopsObjectHandler - Постійність об’єкта

---

Див. також: Вихідний код XOOPS