Overview

Packages

  • awl
    • AuthPlugin
    • AwlDatabase
    • Browser
    • classEditor
    • DataEntry
    • DataUpdate
    • EMail
    • iCalendar
    • MenuSet
    • PgQuery
    • Session
    • Translation
    • User
    • Utilities
    • Validation
    • vCalendar
    • vComponent
    • XMLDocument
    • XMLElement
  • None

Classes

  • AwlDatabase
  • AwlDBDialect
  • AwlQuery
  • AwlUpgrader

Functions

  • _awl_connect_configured_database
  • Overview
  • Package
  • Class

Class AwlDatabase

Typically there will only be a single instance of the database level class in an application.

AwlDBDialect
Extended by AwlDatabase
Package: awl\AwlDatabase
Copyright: Morphoss Ltd
License: GNU GPL v3 or later
Author: Andrew McMillan andrew@morphoss.com
Located at AwlDatabase.php
Methods summary
public
# prepare( string $statement, array $driver_options = array() )

Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.

Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.

Parameters

$statement
$sql_query_string The SQL string containing optional variable replacements
$driver_options
PDO driver options to the prepare statement, commonly to do with cursors
public
# query( string $statement )

Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.

Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.

Parameters

$statement
$sql_query_string The SQL string containing optional variable replacements
public
# Begin( )

Begin a transaction.

Begin a transaction.

public
# Commit( )

Complete a transaction.

Complete a transaction.

public
# Rollback( )

Cancel a transaction in progress.

Cancel a transaction in progress.

public integer
# TransactionState( )

Returns the current state of a transaction, indicating if we have begun a transaction, whether the transaction has failed, or if we are not in a transaction.

Returns the current state of a transaction, indicating if we have begun a transaction, whether the transaction has failed, or if we are not in a transaction.

Returns

integer
0 = not started, 1 = in progress, -1 = error pending rollback/commit
public
# PrepareTranslated( $statement, $driver_options = array() )

Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.

Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.

public
# TranslateAll( $onoff_boolean )

Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.

Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.

public
# ErrorInfo( )
Methods inherited from AwlDBDialect
GetFields(), GetVersion(), Quote(), ReplaceNamedParameters(), ReplaceParameters(), SetSearchPath(), TranslateSQL(), __construct()
Constants inherited from AwlDBDialect
HttpDateFormat, SqlDateFormat, SqlDurationFormat, SqlUTCFormat
Properties summary
protected integer $txnstate

Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit

Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit

# 0
protected boolean $translate_all

Holds whether we are translating all statements.

Holds whether we are translating all statements.

# false
Properties inherited from AwlDBDialect
$db, $dialect
API documentation generated by ApiGen