README

文档可在https://absl-docs.vercel.app找到。

Absl（PHP数据库抽象库）是一个轻量级且灵活的库，旨在简化PHP应用程序中的数据库操作。它提供了一个方便的接口，用于通过PHP数据对象（PDO）扩展与各种数据库系统交互。

安装

要在您的PHP项目中使用Absl，您可以通过Composer安装它，Composer是PHP的依赖关系管理工具。按照以下步骤使用Composer安装Absl：

确保您的系统上已安装Composer。如果您尚未安装Composer，您可以按照官方Composer网站上的说明进行下载和安装：https://composer.php.ac.cn/download/
Composer安装后，在命令行界面导航到您的项目目录。
在项目目录中运行以下命令以安装Absl及其依赖项

composer require retamayo/absl

Composer将下载Absl库及其所需的依赖项，并为您设置自动加载。安装完成后，您可以在PHP文件中包含Composer自动加载器以开始使用Absl。

require 'vendor/autoload.php';

请确保根据您的项目结构调整到autoload.php文件的路径。就是这样！您已成功使用Composer在PHP项目中安装了Absl。您现在可以通过在代码中引用库来开始使用Absl的功能和方法。

连接到数据库

在开始使用Absl之前，您需要建立与数据库的连接。Absl使用PDO扩展，它支持MySQL、PostgreSQL、SQLite等多种数据库系统。

要连接到数据库，创建一个新的PDO对象并将其传递给Absl构造函数

$host = 'localhost';
$dbName = 'your_database_name';
$username = 'your_username';
$password = 'your_password';

try {
    $pdo = new PDO("mysql:host=$host;dbname=$dbName", $username, $password);
    $absl = new Absl($pdo);
} catch (PDOException $e) {
    echo "Database connection failed: " . $e->getMessage();
    // Handle the connection error gracefully
}

请确保用您的实际数据库凭据替换占位符（$host、$dbName、$username、$password）。

定义表

Absl允许您通过指定表名、主键和列详情来定义表。此步骤对于向Absl通知数据库表的结构至关重要。

要定义一个表，请使用defineTable()方法

$tableName = 'users';
$primaryKey = 'id';
$columns = ['column1', 'column2', 'column3'];

$absl->defineTable($tableName, $primaryKey, $columns);

为数据库中的每个表重复defineTable()方法。

操作表

要对特定表执行数据库操作，您需要首先使用useTable()方法选择该表

$tableName = 'users';

try {
    $absl->useTable($tableName);
} catch (Exception $e) {
    echo "Table selection failed: " . $e->getMessage();
    // Handle the error gracefully
}

一旦选择了表，Absl将使用定义的表结构进行后续操作。

检索数据

Absl提供了一些方法来从所选表中检索数据

从表中检索所有记录

$records = $absl->list();

您还可以指定要检索的列

$records = $absl->list(['column1', 'column2']);

基于唯一列检索单个记录

$record = $absl->fetch(['column1', 'column2'], 'unique_column_name', 'unique_column_value');

以JSON格式从表中检索所有记录

$jsonData = $absl->listJSON();

以JSON格式基于唯一列检索单个记录

$record = $absl->fetchJSON(['column1', 'column2'], 'unique_column_name', 'unique_column_value');

数据操作

Absl简化了数据操作操作，如创建新记录、更新现有记录和删除记录。

要创建新记录

$data = [
    'name' => 'John Doe',
    'email' => 'john@example.com',
    // Set other column values as needed
];

$newRecordId = $absl->create($data);

注意：在创建带有密码的新记录时，请确保对密码进行哈希处理，并使用 password_hash() 方法，并使用 PASSWORD_DEFAULT 作为哈希算法，否则 authentication() 方法可能无法按预期工作。

要更新现有记录

$where = 'id';
$whereValue = '1';
$data = [
    'name' => 'Jane Doe',
    'email' => 'jane@example.com',
    // Update other column values as needed
];

$updatedRows = $absl->update($data, $where, $whereValue);

要删除记录

$where = 'id';
$whereValue = '1';
$deletedRows = $absl->delete($where, $whereValue);

注意：创建、更新和删除方法根据操作状态返回 true 或 false。

Absl 提供了一个 authenticate() 方法来验证数据库中存储的用户凭据。您可以使用此方法在 PHP 应用程序中实现用户认证功能。

$username = 'john@example.com';
$password = 'password123';

if ($absl->authenticate(['column_name_of_username_or_email' => $username, 'column_name_of_password' => $password])) {
    // Authentication successful
} else {
    // Authentication failed
}

请确保通过使用哈希和加盐等技术来安全地存储密码。

注意：在将凭据数组传递给 authenticate 函数时，请确保将密码索引放在最后。

数据验证

Absl 包含一个 checkDuplicate() 方法，用于验证指定列中值的唯一性。这有助于确保数据完整性并防止数据库中的重复条目。

$columnName = 'email';
$columnValue = 'john@example.com';

if ($absl->checkDuplicate($columnName, $columnValue)) {
    // Value is already present in the column
} else {
    // Value is unique
}

数据清理

Absl 会自动清理输入值，并防止常见的安全漏洞，如 SQL 注入和跨站脚本（XSS）。

结论

本文档提供了如何使用 Absl（一个 PHP 数据库抽象库）的基本概述，以简化 PHP 应用程序中的数据库操作。您可以进一步探索库，以发现更多功能和高级使用场景。

retamayo / absl

维护者

详细信息