Download the PHP package tamedevelopers/database without Composer

PHP ORM Database

Inspiration

Having been introduced to learning Laravel Framework; Over the past yr(s), Coming back to vanilla PHP, was pretty tough. So i decided to create a much more easier way of communicating with Database, using native PHP PDO:: Driver.

Documentation

• Requirements
• Installation
• Instantiate
• Init.php File
• BootLoader
• Database Connection
• Database Disconnect
• App Debug ENV
• More Database Connection Keys
• Usage
  • Table
  • Insert
  • Insert Or Ignore
  • Update
  • Update Or Ignore
  • Delete
  • Increment
  • Decrement
• Fetching Data
  • Get
  • First
  • First or Create
  • First or Fail
  • Count
  • Paginate
  • Exist
  • Table Exists
• Collections
  • Collection Methods
  • Collection Usage
• Pagination
  • Global Configuration
  • Pagination Query
  • Pagination Data
  • Pagination Links
  • Pagination Links Config
  • Pagination Showing
  • Pagination Showing Config
  • Pagination Foreach Numbers
  • Get Pagination
• Clause
  • Query
  • select
  • selectRaw
  • orderBy
  • orderByRaw
  • latest
  • oldest
  • inRandomOrder
  • random
  • limit
  • offset
  • join
  • leftJoin
  • where
  • orWhere
  • whereRaw
  • whereColumn
  • whereNull
  • orWhereNull
  • whereNotNull
  • orWhereNotNull
  • whereBetween
  • whereNotBetween
  • whereIn
  • whereNotIn
  • groupBy
• Database Migration
  • Create Table Schema
  • Default String Length
  • Update Column Default Value
  • Run Migration
  • Drop Migration
  • Drop Table
  • Drop Column
• Get Database Config
• Get Database Connection
• Get Database Name
• Get Database PDO
• Get Database TablePrefix
• Database Import
• Update Env Variable
• Autoload Register
• Collation And Charset
• Extend Model Class
• Helpers Functions
• Error Dump
• Error Status
• Useful links

Requirements

• >= php 8.0+

Installation

Prior to installing database package get the Composer dependency manager for PHP because it'll simplify installation.

Instantiate

Step 1 — Require composer autoload:

Step 2 — Call the below method() and Run once in browser

• This will auto setup your entire application on a go!

• or -- Helpers Function

Init.php File

• [optional] This will extends the composer autoload and other setup

BootLoader

• If you do not want to include or use the init.php file

  • All you need do is call the bootloader, to start your application.
• or -- Helpers Function

Database Connection

• You have the options to connect to multiple database
  • First navigate to [config/database.php] file and add a configuration
  • Takes two (2) params key as string and array [optional]

Database Disconnect

• If you want to connect to already connected database, You first need to disconnect
  • Takes one param as string

Database Reconnect

• same as Database Connection

App Debug Env

• The .env file contains a key called APP_DEBUG
  • It's mandatory to set to false in Production environment
  • This helps to secure your applicaiton and exit error 404
  • instead of displaying entire server errors.

More Database Connection Keys

• All available connection keys
  • The DB_CONNECTION uses only mysql
  • No other connection type is supported for now.

Usage

• All Methods of usage

Table

• Takes a parameter as string table_name

Insert

• Takes one parameter as assoc array column_name => value
  • It returns an object on success or error

Insert Or Ignore

• Same as insert() method
  • It returns an object of created data or false on error

Update

• Takes one parameter as assoc array column_name => value
  • Returns an int numbers of affected rows or error

Update Or Ignore

• Same as update() method
  • Returns an int numbers of affected rows or 0 on error

Delete

• Returns an int

Increment

• Takes three parameter
  • Only the first param is required

1 By default if the the second param not passed, this will increment by 1

• You can also pass in a second or third parameter to update additional columns

• You can ommit the second param and it'll be automatically seen as update param (If an array)

Decrement

• Same as Increment

Fetching Data

GET

First

First or Create

• Take two param as an array

  • Mandatory $conditions param as array
  • [optional] $data param as array

• First it checks if codition to retrieve data. If fails, then it merge the $conditions to $data value to create new records

• or -- Example 2

First or Fail

• Same as first() method but exit with error code 404, if data not found

Count

Paginate

• Takes param as int $per_page
  • By default if no param is given, then it displays 10 per page

Exists

• Returns boolean true \| false

Table Exists

• Takes param as string $table_name

Collections

• You can directly use methods of Collections Instance on any of the below
  • All the below methods are received by Collection class
    1. get()
    2. find()
    3. first()
    4. firstOrIgnore()
    5. firstOrCreate()
    6. firstOrFail()
    7. insert()
    8. insertOrIgnore()

Collection Methods

Collection Usage

• Colections are called automatically on all Database Fetch Request

  • With this you can access data as an object\|array key property
  • If no data found then it returns null on ->first() method only
• Example two(2) ->get() \| ->paginate() Request

Pagination

• Configuring Pagination

Global Configuration

• 1 Setup global pagination on ENV autostart most preferred method

• or -- Helpers Function

Pagination Query

Pagination Data

Pagination Links

Pagination Links Config

Pagination Showing

Pagination Showing Config

Pagination Foreach Numbers

• Page numbering starts counting from 1
  • This will format all pagination items collections
  • On each page, it starts counting from last pagination item number

Get Pagination

• Returns pagination informations

Clause

• Multiple clause

Query

• Allows the use direct sql query SQL query syntax
  • Or direct query exec()

Select

• Used to select needed columns from database

orderBy

• Takes two param $column and $direction
  • By default $direction param is set to ASC

orderByRaw

• Takes one param $query

Latest

• Takes one param $column by default the column used is id

Oldest

• Takes one param $column by default the column used is id

inRandomOrder

random

limit

• Takes one param $limit as int. By default value is 1

offset

join

• Includes join|leftJoin|rightJoin|crossJoin

• or

leftJoin

• Same as join

where

• Takes three parameter
  • Only the first param is required

orWhere

whereRaw

• Allows you to use direct raw SQL query syntax

whereColumn

• Takes three parameter column operator column2

whereNull

• Takes one parameter column

whereNotNull

whereBetween

• Takes two parameter column as string param as array
  • Doesn't support float value

whereNotBetween

whereIn

• Takes two parameter column as string param as array
  • Doesn't support float value

whereNotIn

groupBy

• Takes one param $column

Database Migration

• Similar to Laravel DB Migration Just to make database table creation more easier

Create Table Schema

• Takes param as table name

  • Second parameter string jobs|sessions (optional) -If passed will create a dummy jobs|sessions table schema
• or -- Helpers Function

Default String Length

• In some cases you may want to setup default string legnth to all Migration Tables

• or -- Helpers Function

Update Column Default Value

• In some cases you may want to update the default column value
  • Yes! It's very much possible with the help of Schema. Takes three (3) params
  • $tablename as string
  • $column_name as string
  • $values as mixed data NULL NOT NULL\|None STRING current_timestamp()

Run Migration

• This will execute and run migrations using files located at [root/database/migrations]

Drop Migration

Drop Table

Drop Column

Get Database Config

Get Database Connection

• or -- Helpers Function

Get Database Name

Get Database PDO

Get Database TablePrefix

Database Import

• You can use this class to import .sql into a database programatically

  • Remember the system already have absolute path to your project.
• or -- Helpers Function

Update Env Variable

• You can use this class to import .sql into a database programatically

• or -- Helpers Function

Collation And Charset

• Collation and Charset Data listing

Collation

• utf8_bin
• utf8_general_ci
• utf8mb4_bin
• utf8mb4_unicode_ci
• utf8mb4_general_ci
• latin1_bin
• latin1_general_ci

Charset

• utf8
• utf8mb4
• latin1

Extend Model Class

Helpers Functions

Error Dump

Error Status

• On error returns 404 status code
• On success returns 200 status code

Useful Links

• @author Fredrick Peterson (Tame Developers)
• If you love this PHP Library, you can Buy Tame Developers a coffee
• Lightweight - PHP ORM Database
• Support - Library