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
• Tame Cli
  • Tame Cli Scaffold
  • Tame Cli DB
  • Tame Cli Migrate
  • Tame Cli Make
  • Tame Cli Key
  • Tame Artisan Call
• BootLoader
• Database Connection
• Database Disconnect
• App Debug ENV
• Usage
  • table
  • from
  • insert
  • insertOrIgnore
  • update
  • updateOrIgnore
  • destroy
  • delete
  • increment
  • decrement
  • min
  • max
  • sum
  • avg
  • average
• Database Connection Keys
• Fetching Data
  • get
  • first
  • firstOrCreate
  • firstOrFail
  • count
  • paginate
  • exists
  • doesntExist
  • tableExists
• Collections
  • Collection Methods
  • Collection Usage
• Auth
  • Auth Methods
  • Auth Usage
  • guard
  • attempt
  • login
  • user
  • logout
  • id
• Pagination
  • Global Configuration
  • Pagination Query
  • Pagination Data
  • Pagination Links
  • Pagination Links Config
  • Pagination Showing
  • Pagination Showing Config
  • Pagination Foreach Numbers
  • Pagination Ajax Loading
  • Get Pagination
• Clause
  • query
  • select
  • selectRaw
  • orderBy
  • orderByRaw
  • orderByDesc
  • orderByAsc
  • latest
  • oldest
  • inRandomOrder
  • random
  • limit
  • take
  • offset
  • join
  • joinWhere
  • leftJoin
  • leftJoinWhere
  • rightJoin
  • rightJoinWhere
  • crossJoin
  • where
  • orWhere
  • whereNot
  • orWhereNot
  • whereRaw
  • whereColumn
  • orWhereColumn
  • whereNull
  • orWhereNull
  • whereNotNull
  • orWhereNotNull
  • whereBetween
  • orWhereBetween
  • whereNotBetween
  • orWhereNotBetween
  • whereBetweenColumns
  • orWhereBetweenColumns
  • whereNotBetweenColumns
  • orWhereNotBetweenColumns
  • whereDate
  • orWhereDate
  • whereTime
  • orWhereTime
  • whereDay
  • orWhereDay
  • whereMonth
  • orWhereMonth
  • whereYear
  • orWhereYear
  • having
  • orHaving
  • havingNull
  • orHavingNull
  • havingNotNull
  • orHavingNotNull
  • havingBetween
  • havingRaw
  • whereIn
  • orWhereIn
  • whereNotIn
  • orWhereNotIn
  • orHavingRaw
  • groupBy
  • groupByRaw
• Database Migration
  • Create Table Schema
  • Default String Length
  • Update Column Default Value
  • Run Migration
  • Drop Migration
  • dropTable
  • dropColumn
• 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 — [optional] If you want the Package scalfolding

• This will auto setup your entire application on a go!
  • It's helper class can be called, using -- autoloader_start()

init php

• [optional] This will extends the composer autoload and other setup
  • If you used the package Package scalfolding this file will be automatically generated, that you can include at the beginning of your project.

Tame Cli

• Custom commands support for CLI

tame-cli-scaffold

• Scalffold the database files, instead of running AutoLoader::start() in browser.
  • The -f|--force flag is needed if you're inside a framework or if on production server.
  • This doesn't alter nor replace any files that exists and safe.

tame-artisan-call

• Using the CLI from within php, without the CMD interface.

BootLoader

• [optional] from version ^6.0.3 If you do not want to include or use the init.php file
  • You can as well call the bootloader, to start the database life-circle.

Database Connection

• Take two param as [$name|$options]
  • Mandatory $name as string of connection name
  • [optional] $options and an array, if no connection data is found
  • First navigate to [config/database.php] file and add connection configuration or use .env

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 on Production environment
  • This helps to secure your applicaiton and exit with error 404
  • instead of displaying entire server errors.

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
  • Without calling the DB::connection() and passing the driver name you want. It will automatically be using the default connection driver, you've in your setup'

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

destroy

• Take two param as [value|column]
  • Mandatory value as mixed value
  • [optional] column as Default is id
  • 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

min

• Take one param as Expression|string

max

• Same as min

sum

• Take one param as Expression|string

avg

• Take one param as Expression|string

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

Auth

• Lightweight guard-based authentication similar to Laravel.
• attempt() only validates and sets in-memory user; call login() to persist to session.

auth-guard

• Set the authentication guard (Takes two param)
  • Mandatory $table param as string
  • [optional] $connection param as string | null database connection name.

Auth Usage

Pagination

• Configuring Pagination
  • It's helper class can be called, using -- config_pagination()

Global Configuration

• 1 Setup global pagination on ENV autostart most preferred method

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

Pagination Ajax Loading

• When the view is either loading| | onloading | cursor | bootstrap
  • This can automatically fetched data without page load
  • You need to give your DOM-element data-pagination-content and data-pagination-append

Get Pagination

• Returns pagination informations

Clause

• Multiple clause

Query

• Allows the use direct sql query SQL query syntax
  • Or direct query exec()
  • [important] you cannot use paginate on query() method

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 string $table
  • [optional] Second parameter string jobs|sessions If passed will create a dummy jobs|sessions table schema
  • It's helper class can be called, using -- migration()

Default String Length

• In some cases you may want to setup default string legnth to all Migration Tables
  • It's helper class can be called, using -- schema()

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

• It's helper class can be called, using -- db_connection()

Get Database Name

Get Database PDO

Get Database TablePrefix

Database Import

• You can use this class to import .sql into a database programatically
  • Take two param as [$path|$connection]
  • Mandatory $path as string of path to .sql file
  • [optional] $connection define the connection of database you want to run

Update Env Variable

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

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