Neevo Public API
  • Namespace
  • Class
  • Tree

Namespaces

  • Neevo
    • Cache
    • Drivers
    • Nette
  • PHP

Classes

  • BaseStatement
  • Connection
  • Literal
  • Manager
  • Parser
  • Result
  • ResultIterator
  • Row
  • Statement

Interfaces

  • DriverInterface
  • ObservableInterface
  • ObserverInterface

Exceptions

  • DriverException
  • ImplementationException
  • NeevoException

Interface DriverInterface

Interface implemented by all Neevo drivers.

All Neevo drivers must implement this interface, not only reproduce all it's methods, or they won't be recognised as valid drivers.

If something is not implemented, the method must throw Neevo\Drivers\ImplementationException. The exception will be catched and Neevo will decide, what to do next.

If something is not supported by the driver (e.g. number of result rows on unbuffered queries) the driver should throw Neevo\DriverException.

When the driver needs to rewrite default output of SQL commands, it must extend Neevo\Parser class. For proper use, see source of Neevo\Parser class.

Direct known implementers

Neevo\Drivers\MySQLDriver, Neevo\Drivers\MySQLiDriver, Neevo\Drivers\PDODriver, Neevo\Drivers\PgSQLDriver, Neevo\Drivers\SQLite2Driver, Neevo\Drivers\SQLite3Driver

Namespace: Neevo
Author: Smasty
Located at Neevo/DriverInterface.php

Methods summary

public
# __construct( )

Checks for required PHP extension.

Checks for required PHP extension.

Throws

Neevo\DriverException
public
# connect( array $config )

Creates connection to database.

Creates connection to database.

Parameters

$config
array
$config Configuration options
public
# closeConnection( )

Closes the connection.

Closes the connection.

public boolean
# freeResultSet( resource $resultSet )

Frees memory used by given result.

Frees memory used by given result.

Parameters

$resultSet
resource
$resultSet

Returns

boolean
public resource|boolean
# runQuery( string $queryString )

Executes given SQL statement.

Executes given SQL statement.

Parameters

$queryString
string
$queryString

Returns

resource|boolean
public
# beginTransaction( string $savepoint = null )

Begins a transaction if supported.

Begins a transaction if supported.

Parameters

$savepoint
string
$savepoint
public
# commit( string $savepoint = null )

Commits statements in a transaction.

Commits statements in a transaction.

Parameters

$savepoint
string
$avepoint
public
# rollback( string $savepoint = null )

Rollbacks changes in a transaction.

Rollbacks changes in a transaction.

Parameters

$savepoint
string
$savepoint
public array
# fetch( resource $resultSet )

Fetches row from given result set as an associative array.

Fetches row from given result set as an associative array.

Parameters

$resultSet
resource
$resultSet

Returns

array
public boolean
# seek( resource $resultSet, integer $offset )

Moves internal result pointer.

Moves internal result pointer.

Parameters

$resultSet
resource
$resultSet
$offset
integer
$offset

Returns

boolean
public integer
# getInsertId( )

Returns the ID generated in the INSERT statement.

Returns the ID generated in the INSERT statement.

Returns

integer
public
# randomizeOrder( Neevo\BaseStatement $statement )

Randomizes result order.

Randomizes result order.

Parameters

$statement
Neevo\BaseStatement
$statement
public integer|boolean
# getNumRows( resource $resultSet )

Returns the number of rows in the given result set.

Returns the number of rows in the given result set.

Parameters

$resultSet
resource
$resultSet

Returns

integer|boolean
public integer
# getAffectedRows( )

Returns the number of affected rows in previous operation.

Returns the number of affected rows in previous operation.

Returns

integer
public mixed
# escape( mixed $value, string $type )

Escapes given value.

Escapes given value.

Parameters

$value
mixed
$value
$type
string
$type

Returns

mixed
public mixed
# unescape( mixed $value, string $type )

Decodes given value.

Decodes given value.

Parameters

$value
mixed
$value
$type
string
$type

Returns

mixed
public string|null
# getPrimaryKey( string $table )

Returns the PRIMARY KEY column for given table.

Returns the PRIMARY KEY column for given table.

Parameters

$table
string
$table

Returns

string|null
public array
# getColumnTypes( resource $resultSet, string $table )

Returns types of columns in given result set.

Returns types of columns in given result set.

Parameters

$resultSet
resource
$resultSet
$table
string
$table

Returns

array

Magic methods summary

Neevo Public API API documentation generated by ApiGen 2.8.0