tesis/db-layer

Simple DB layer for mysqli extension and PDO class. It is based on mappers, files holding database table fields, primary key and auto_increment properties, which is helpful to compare fields for CRUD or select operations, and to provide better way to prevent SQL injections (only existing fields are

dev-master / 1.0.x-dev 2018-05-09 13:41 UTC

Requires

• php: >=5.6.0

Requires (Dev)

• phpunit/phpunit: ^6.5

MIT

• Tereza Simcic

• pdo
• wrapper
• crud
• mapper
• mysqli
• SQL Injection
• sql-generator

README

DB layers for mysqli extension and PDO class. DBLayer is working with mappers (files holding tables' properties) to provide safer SQL operations.

Installing DBLayer

The recommended way to install DBLayer is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of DBLayer:

composer require tesis/db-layer

# Add scripts to composer json:
"scripts": {
    "post-update-cmd": "DBLayer\\Loader::postUpdate",
    "post-install-cmd": "DBLayer\\Loader::postInstall"
}

or insert in your composer:

"require": {
    "tesis/db-layer": "1.0.x-dev"
},
"require-dev": {
    "phpunit/phpunit": "^6.5"
},

"scripts": {
    "post-update-cmd": "DBLayer\\Loader::postUpdate",
    "post-install-cmd": "DBLayer\\Loader::postInstall"
}

# Run: composer update / composer install

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

You can then later update DBLayer using composer:

composer update

DB Layer - ORM

migrate sql files (simple SQL, see folders db/migrations, db/seeders)

generate database mapper (default - json format, optional (.ini file, or .php file returning an array) (examples of generated files are in tests/data folder)

for CRUD or select statements, provided two layers: mysqli and PDO

Start with

# Change database credentials, write env.ini file
php vendor/tesis/db-layer/init

Credentials

add/change credentials in config/dbLayer.php file

Migrate

if you database and / or tables are not yet created, create them manually or prepare simple migration and seeder file (examples in database/migrations and database/seeders dir)

php vendor/tesis/db-layer/migrator

after running migrator, new database is created tables are created tables are populated

Example of configuration file

$config = [
    'dbHost' => 'localhost',
    'dbUser' => 'user',
    'dbPass' => 'pass',
    'dbName' => 'test_db',
    'dbCharset' => 'utf8',
    'mapperDir' => 'mappers',
    'mapperFile' => 'dbTablesMapper',
    'mapperType' => 'json',
    'contactEmail' => '[e-mail]',
    'environment' => 'dev',
    'debug' => true
];

Geneate table mapper

run the command bellow and you'll be guided through the process

php vendor/tesis/db-layer/generator

Documentation / Usage

At the moment, there are examples provided in example dir.

License

MIT License

Last Version

1.0