Manage your database with or without abstraction. This library is built on the PHP PDO plugin and is mainly used to build and execute SQL queries.
- PHP 7.4 and later.
- PHP PDO extension.
This library should work correctly in almost any database that uses basic SQL syntax. Databases supported by PDO and suitable drivers are available at https://www.php.net/manual/en/pdo.drivers.php.
composer require initphp/database
or include the src/init.php file from this repo in your system.
require_once "src/Init.php";require_once "vendor/autoload.php";
use \InitPHP\Database\Facade\DB;
// Connection
DB::createImmutable([
'dsn' => 'mysql:host=localhost;port=3306;dbname=test;charset=utf8mb4',
'username' => 'root',
'password' => '',
'charset' => 'utf8mb4',
'collation' => 'utf8mb4_general_ci',
]);use \InitPHP\Database\Facade\DB;
$data = [
'title' => 'Post Title',
'content' => 'Post Content',
];
$isInsert = DB::table('post')
->create($data);
/**
* This executes the following query.
*
* INSERT INTO post
* (title, content)
* VALUES
* ("Post Title", "Post Content");
*/
if($isInsert){
// Success
}use \InitPHP\Database\Facade\DB;
$data = [
[
'title' => 'Post Title 1',
'content' => 'Post Content 1',
'author' => 5
],
[
'title' => 'Post Title 2',
'content' => 'Post Content 2'
],
];
$isInsert = DB::table('post')
->createBatch($data);
/**
* This executes the following query.
*
* INSERT INTO post
* (title, content, author)
* VALUES
* ("Post Title 1", "Post Content 1", 5),
* ("Post Title 2", "Post Content 2", NULL);
*/
if($isInsert){
// Success
} use \InitPHP\Database\Facade\DB;
DB::select('user.name as author_name', 'post.id', 'post.title')
->from('post')
->selfJoin('user', 'user.id=post.author')
->where('post.status', 1)
->orderBy('post.id', 'ASC')
->orderBy('post.created_at', 'DESC')
->offset(20)->limit(10);
/**
* This executes the following query.
*
* SELECT user.name AS author_name, post.id, post.title
* FROM post, user
* WHERE user.id = post.author AND post.status = 1
* ORDER BY post ASC, post.created_at DESC
* LIMIT 20, 10
*/
$res = DB::read();
if($res->numRows() > 0){
foreach ($res->toAssoc() as $row) {
echo $row['title'] . ' by ' . $row['author_name'] . '<br />';
}
}use \InitPHP\Database\Facade\DB;
$data = [
'title' => 'New Title',
'content' => 'New Content',
];
$isUpdate = DB::from('post')
->where('id', 13)
->update($data);
/**
* This executes the following query.
*
* UPDATE post
* SET title = "New Title", content = "New Content"
* WHERE id = 13
*/
if ($isUpdate) {
// Success
}use \InitPHP\Database\Facade\DB;
$data = [
[
'id' => 5,
'title' => 'New Title #5',
'content' => 'New Content #5',
],
[
'id' => 10,
'title' => 'New Title #10',
]
];
$isUpdate = DB::from('post')
->where('status', 1)
->updateBatch($data, 'id');
/**
* This executes the following query.
*
* UPDATE post SET
* title = CASE
* WHEN id = 5 THEN 'New Title #5'
* WHEN id = 10 THEN 'New Title #10'
* ELSE title END,
* content = CASE
* WHEN id = 5 THEN 'New Content #5'
* ELSE content END
* WHERE status = 1 AND id IN (5, 10)
*/
if ($isUpdate) {
// Success
}use \InitPHP\Database\Facade\DB;
$isDelete = DB::from('post')
->where('id', 13)
->delete();
/**
* This executes the following query.
*
* DELETE FROM post WHERE id = 13
*/
if ($isUpdate) {
// Success
}use \InitPHP\Database\Facade\DB;
$res = DB::query("SELECT id FROM post WHERE user_id = :id", [
':id' => 5
]);use \InitPHP\Database\Facade\DB;
$res = DB::select(DB::raw("CONCAT(name, ' ', surname) AS fullname"))
->where(DB::raw("title = '' AND (status = 1 OR status = 0)"))
->limit(5)
->get('users');
/**
* SELECT CONCAT(name, ' ', surname) AS fullname
* FROM users
* WHERE title = '' AND (status = 1 OR status = 0)
* LIMIT 5
*/
foreach ($res->toAssoc() as $row) {
echo $row['fullname'];
}Model and Entity; are two common concepts used in database abstraction. To explain these two concepts in the roughest way;
- Model : Each model is a class that represents a table in the database.
- Entity : Entity is a class that represents a single row of data.
The most basic example of a model class would look like this.
namespace App\Model;
class Posts extends \InitPHP\Database\Model
{
/**
* If not specified, \InitPHP\Database\Entity::class is used by default.
*
* @var \InitPHP\Database\Entity|string
*/
protected $entity = \App\Entities\PostEntity::class;
/**
* If not specified, the name of your model class is used.
*
* @var string
*/
protected string $table = 'post';
/**
* The name of the PRIMARY KEY column. If not, define it as NULL.
*
* @var null|string
*/
protected ?string $primaryKey = 'id';
/**
* Specify FALSE if you want the data to be permanently deleted.
*
* @var bool
*/
protected bool $useSoftDeletes = true;
/**
* Column name to hold the creation time of the data.
*
* @var string|null
*/
protected ?string $createdField = 'created_at';
/**
* The column name to hold the last time the data was updated.
*
* @var string|null
*/
protected ?string $updatedField = 'updated_at';
/**
* Column name to keep deletion time if $useSoftDeletes is active.
*
* @var string|null
*/
protected ?string $deletedField = 'deleted_at';
/**
* An array that defines the columns that will be allowed to be used in Insert and Update operations.
* If you want to give access to all columns; You can specify it as NULL.
*
* @var null|string[]
*/
protected ?array $allowedFields = [
'title', 'content', // ...
];
/**
* Turns the use of callable functions on or off.
*
* @var bool
*/
protected bool $allowedCallbacks = false;
/**
* @var string[]|\Closure[]
*/
protected array $beforeInsert = [];
/**
* @var string[]|\Closure[]
*/
protected array $afterInsert = [];
/**
* @var string[]|\Closure[]
*/
protected array $beforeUpdate = [];
/**
* @var string[]|\Closure[]
*/
protected array $afterUpdate = [];
/**
* @var string[]|\Closure[]
*/
protected array $beforeDelete = [];
/**
* @var string[]|\Closure[]
*/
protected array $afterDelete = [];
protected bool $readable = true;
protected bool $writable = true;
protected bool $deletable = true;
protected bool $updatable = true;
protected array $validation = [
'id' => ['is_unique', 'int'],
'title' => ['required', 'string', 'length(0,255)'],
];
protected array $validationMsg = [
'id' => [],
'title' => [
'required' => '{field} cannot be left blank.',
'string' => '{field} must be a string.',
],
];
protected array $validationLabels = [
'id' => 'Post ID',
'title' => 'Post Title',
// ...
];
}The most basic example of a entity class would look like this.
namespace App\Entities;
class PostEntity extends \InitPHP\Database\Entity
{
/**
* An example of a getter method fo
8000
r the "post_title" column.
*
* Usage :
* echo $entity->post_title;
*/
public function getPostTitleAttribute($title)
{
return strtoupper($title);
}
/**
* An example of a setter method for the "post_title" column.
*
* Usage :
* $entity->post_title = 'New Post Title';
*/
public function setPostTitleAttribute($title)
{
$this->post_title = strtolower($title);
}
}use \InitPHP\Database\Facade\DB;
DB::createImmutable([
'dsn' => 'mysql:host=localhost;dbname=test;port=3306;charset=utf8mb4;',
'username' => 'root',
'password' => '',
'log' => __DIR__ '/logs/db.log', // string, callable or object
]);If you define a file path as a String; Attempts are made to write into it with file_put_contents().
Note : You can define variables such as {year}, {month}, {day} in the filename.
- You can also define an object with the
criticalmethod. The database library will pass the log message to this method as a parameter. Or define it as callable array to use any method of the object.
use \InitPHP\Database\Facade\DB;
class Logger {
public function critical(string $msg)
{
$path = __DIR__ . '/log.log';
file_put_contents($path, $msg, FILE_APPEND);
}
}
$logger = new Logger();
DB::createImmutable([
'dsn' => 'mysql:host=localhost;dbname=test;port=3306;charset=utf8mb4;',
'username' => 'root',
'password' => '',
'log' => $logger, // or [$logger, 'critical']
]);- Similarly it is possible to define it in a callable method.
use \InitPHP\Database\Facade\DB;
DB::createImmutable([
'dsn' => 'mysql:host=localhost;dbname=test;port=3306;charset=utf8mb4;',
'username' => 'root',
'password' => '',
'log' => function (string $msg) {
$path = __DIR__ . '/log.log';
file_put_contents($path, $msg, FILE_APPEND);
},
]);Debug mode is used to include the executed SQL statement in the error message. It should only be activated in the development environment.
use \InitPHP\Database\Facade\DB;
DB::createImmutable([
'dsn' => 'mysql:host=localhost;dbname=test;port=3306;charset=utf8mb4;',
'username' => 'root',
'password' => '',
'debug' => true, // boolean
]);- A more detailed documentation will be prepared.
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
All contributions to this project will be published under the MIT License. By submitting a pull request or filing a bug, issue, or feature request, you are agreeing to comply with this waiver of copyright interest.
There are two primary ways to help:
- Using the issue tracker, and
- Changing the code-base.
Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.
Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.
Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request. All new code should have associated unit tests that validate implemented features and the presence or lack of defects. Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of such guidelines, mimic the styles and patterns in the existing code-base.
Copyright © 2022 MIT License