phramework doc
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • Phramework
    • Authentication
    • Database
      • Operations
    • Exceptions
    • Extensions
    • Models
    • URIStrategy
    • Validate
    • Viewers

Classes

  • Database
  • MySQL
  • PostgreSQL

Interfaces

  • IAdapter

Class Database

Database model
Defined settings:

  • array database
    • string adapter
    • string name, Database name
    • string username
    • string password
    • string host
    • integer port
Namespace: Phramework\Database
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Since: 0.0.0
Todo: Add option to convert fetched data into objects insted of array
Located at Database.php

Methods summary

public static
# setAdapter( Phramework\Database\IAdapter $adapter )

Parameters

$adapter

Throws

Exception
public static Phramework\Database\IAdapter|null
# getAdapter( )

Get current adapter

Get current adapter

Returns

Phramework\Database\IAdapter|null
public static string
# getAdapterName( )

Get adapter's name

Get adapter's name

Returns

string
Adapter's name (lowercase)
public static integer
# execute( string $query, array $parameters = [] )

Execute a query and return the row count

Execute a query and return the row count

Parameters

$query
$parameters

Returns

integer
Returns the number of rows affected or selected

Throws

Phramework\Exceptions\DatabaseException

Example

$status = Database::execute(
    'UPDATE "user"
    SET "first_name" = ?
    WHERE "id" = ?
    LIMIT 1',
    [$firstName, $id]
);
public static mixed
# executeLastInsertId( string $query, array $parameters = [] )

Execute a query and return last instert id

Execute a query and return last instert id

Parameters

$query
$parameters
Query parameters

Returns

mixed
Returns returns the id of last inserted item

Throws

Phramework\Exceptions\DatabaseException

Example

$id = Database::executeLastInsertId(
    'INSERT INTO "user"
    ("first_name")
    VALUES (?)',
    [$firstName]
);
public static array
# executeAndFetch( string $query, array $parameters = [], $castModel = null )

Execute a query and fetch first row as associative array

Execute a query and fetch first row as associative array

Parameters

$query
$parameters
Query parameters
$castModel

Returns

array

Throws

Phramework\Exceptions\DatabaseException

Example

$record = Database::executeAndFetch(
    'SELECT "id", "first_name"
    FROM "user"
    WHERE "id" = ?
    LIMIT 1',
    [$id]
);
public static array[]
# executeAndFetchAll( string $query, array $parameters = [], $castModel = null )

Execute a query and fetch all rows as associative array

Execute a query and fetch all rows as associative array

Parameters

$query
$parameters
Query parameters
$castModel

Returns

array[]

Throws

Phramework\Exceptions\DatabaseException

Example

$records = Database::executeAndFetchAll(
    'SELECT "id", "first_name"
    FROM "user"'
);
public static array
# executeAndFetchArray( string $query, array $parameters = [] )

Execute a query and fetch first row as array

Execute a query and fetch first row as array

Parameters

$query
$parameters
Query parameters

Returns

array

Throws

Phramework\Exceptions\DatabaseException
public static array[]
# executeAndFetchAllArray( string $query, array $parameters = [] )

Parameters

$query
Query string
$parameters
Query parameters

Returns

array[]

Throws

Phramework\Exceptions\DatabaseException
public static mixed
# bindExecuteLastInsertId( string $query, array $parameters = [] )

Bind Execute a query and return last instert id

Bind Execute a query and return last instert id

Parameters

$query
Query string
$parameters
Query parameters

Returns

mixed

Throws

Phramework\Exceptions\DatabaseException
public static integer
# bindExecute( string $query, array $parameters = [] )

Bind Execute a query and return the row count

Bind Execute a query and return the row count

Parameters

$query
Query string
$parameters
Query parameters

Returns

integer
Returns the number of rows affected or selected

Throws

Phramework\Exceptions\DatabaseException

Uses

PDOStatement::bindValue https://secure.php.net/manual/en/pdostatement.bindvalue.php

Example

$status = Database::bindExecute(
    'UPDATE "user"
    SET "first_name" = ?
    WHERE "id" = ?
    LIMIT 1',
    [
        $first_name, //PDO::PARAM_STR by default
        ['value' => $id, 'params' => \PDO::PARAM_INT]
    ]
);
public static array
# bindExecuteAndFetch( string $query, array $parameters = [], $castModel = null )

Bind Execute a query and fetch first row as associative array

Bind Execute a query and fetch first row as associative array

Parameters

$query
Query string
$parameters
Query parameters
$castModel

Returns

array

Throws

Phramework\Exceptions\DatabaseException
public static array[]
# bindExecuteAndFetchAll( string $query, array $parameters = [], $castModel = null )

Bind Execute a query and fetch all rows as associative array

Bind Execute a query and fetch all rows as associative array

Parameters

$query
Query string
$parameters
Query parameters
$castModel

Returns

array[]

Throws

Phramework\Exceptions\DatabaseException
public static
# close( )

Close the Database connection

Close the Database connection

Properties summary

protected static Phramework\Database\IAdapter $adapter
# null
phramework doc API documentation generated by ApiGen