Class: IBDatabase

Source Location: /interbase.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --CustomConnection
            |
            --IBDatabase

IBDatabase class

Class Details

[line 35]
IBDatabase class

A database component for InterBase

[ Top ]

Properties Connected [published] Connected [public] DatabaseName [published] Debug [published] Dialect [published] Dictionary [published] DictionaryProperties [public] Host [published] UserName [published] UserPassword [published]	Events OnAfterConnect [published] OnAfterDisconnect [published] OnBeforeConnect [published] OnBeforeDisconnect [published]	JS Events [none]
Methods __construct BeginTrans CompleteTrans createDictionaryTable databases DBDate DoConnect DoDisconnect execute executelimit extractIndexes MetaFields Param Prepare PrepareSP QuoteStr readFieldDictionaryProperties tables	Constants [none]

Inherited Properties Class: CustomConnection CustomConnection::Clients Returns the clients of this database CustomConnection::Connected Determines if the database is connected or not CustomConnection::DataSets Class: Component Component::ComponentCount Indicates how many components this component is owner Component::Components Component list containing all the components owned by this component Component::ControlState A flag to know the state of the control, csLoading, csDesigning Component::DataFieldValue This function returns the value of the datafield, if any Component::Name Name for the component, to be used as an identifier, should be unique Component::NamePath The path to uniquely identify a component, qualified by the owner when required Component::Owner The owner of this component, usually the page component, but the owner of pages is the application object Component::Tag A versatily property of every Component that can be used in any way you want Class: Persistent Persistent::NamePath Used to serialize/unserialize Persistent::Owner Owner of the component, in Persistent always return null	Inherited Events Class: CustomConnection CustomConnection::OnAfterConnect Fired after the database is connected CustomConnection::OnAfterDisconnect Fired after the database is disconnected CustomConnection::OnBeforeConnect Fired before the database is connected CustomConnection::OnBeforeDisconnect Fired before the database is disconnected CustomConnection::OnLogin Fired when requesting login information for this database	Inherited JS Events
Inherited Methods Class: CustomConnection CustomConnection::__construct CustomConnection::BeginTrans Begins a transaction CustomConnection::Close Close the database CustomConnection::CompleteTrans Completes a transaction CustomConnection::DBDate Returns a date formatted to be used on this database, depending on the type CustomConnection::DoConnect Place here the connection code CustomConnection::DoDisconnect Place here the disconnection code CustomConnection::loaded CustomConnection::MetaFields Returns the fieldnames for the table CustomConnection::Open Open the database CustomConnection::Param Returns a parameter formatted depending on the database type CustomConnection::Prepare Prepares the query, to optimize it CustomConnection::QuoteStr Quote a string depending on the database type CustomConnection::SendConnectEvent Class: Component Component::__construct Constructor Component::ajaxCall Returns the js event attribute to call the server using ajax Component::callEvent Calls a server event Component::dumpChildrenHeaderCode Dump the header code for all the children Component::dumpChildrenJavascript Dump the javascript code for all the children Component::dumpHeaderCode To dump header code required Component::dumpHiddenKeyFields This function dumps out the key fields for the current row, useful to Component::dumpJavascript To dump the javascript code needed by this component Component::fixupProperty This method returns the right object (or the input string if object not found) for an object name Should be used on the loaded method for object properties to find the right reference Component::generateAjaxEvent Returns the js event attribute to call the server using Ajax we use xajax to handle all the ajax stuff. Component::hasValidDataField This function returns true if the datafield is valid Component::init To initialize a component, the right place to process events Component::insertComponent Insert a component into the components collection Component::loaded A virtual method to get notified when the object has been fully loaded from a stream Component::loadedChildren Calls childrens loaded recursively Component::loadResource Load this component from a string Component::preinit To initialize a component, called before init() Component::readAccessibility Overwrite this method to provide accessibility info for the RPC engine Component::readFromResource Read a component from a resource file Component::removeComponent Remove a component from the components collection Component::serializeChildren Serialize all children Component::unserializeChildren Unserialize all children Component::updateDataField Checks if there is any datafield attached to the component Class: Persistent Persistent::assign Assing the source properties to this object Persistent::assignError Raises an assignation error Persistent::assignTo Assign this object to another object Persistent::serialize Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored. Persistent::unserialize Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized. Class: Object Object::__construct Constructor Object::className Returns the name of the object class Object::classNameIs Check if the object is from a specific class Object::classParent Returns the parent class of the object Object::inheritsFrom Check if the object inherits from a specific class Object::methodExists Check if a method exists Object::readProperty Reads a property from the streams Object::__get To virtualize properties Object::__set To virtualize properties

Properties

property Connected [line 76]

Determines if the database is connected or not

Defined in CustomConnection::Connected

[ Top ]

property Connected [line 74]

Determines if the database is connected or not

Defined in CustomConnection::Connected

[ Top ]

property DatabaseName [line 89]

[ Top ]

property Debug [line 80]

[ Top ]

property Dialect : string [line 122]

Specifies the dialect to be used when connecting to the server

[ Top ]

property Dictionary [line 85]

[ Top ]

property DictionaryProperties [line 325]

[ Top ]

property Host [line 93]

[ Top ]

property UserName [line 97]

[ Top ]

property UserPassword [line 101]

[ Top ]

Events

property OnAfterConnect [line 104]

Fired after the database is connected

Defined in CustomConnection::OnAfterConnect

[ Top ]

property OnAfterDisconnect [line 110]

Fired after the database is disconnected

Defined in CustomConnection::OnAfterDisconnect

[ Top ]

property OnBeforeConnect [line 107]

Fired before the database is connected

Defined in CustomConnection::OnBeforeConnect

[ Top ]

property OnBeforeDisconnect [line 113]

Fired before the database is disconnected

Defined in CustomConnection::OnBeforeDisconnect

[ Top ]

Javascript Events

Methods

constructor __construct [line 151]

IBDatabase __construct(
[
$aowner = null])

Overrides CustomConnection::__construct (parent method not documented)

Parameters:

$aowner

[ Top ]

void BeginTrans [line 60]

void BeginTrans(
[
$args = array()])

Overrides CustomConnection::BeginTrans (Begins a transaction)

Parameters:

$args

[ Top ]

void CompleteTrans [line 65]

void CompleteTrans(
[
$autocomplete = true])

Overrides CustomConnection::CompleteTrans (Completes a transaction)

Parameters:

$autocomplete

[ Top ]

boolean createDictionaryTable [line 334]

boolean createDictionaryTable(
)

Creates the dictionary table on the database

[ Top ]

array databases [line 362]

array databases(
)

Return all the databases using the connection information

[ Top ]

void DBDate [line 136]

void DBDate(

$input)

Overrides CustomConnection::DBDate (Returns a date formatted to be used on this database, depending on the type)

Parameters:

$input

[ Top ]

void DoConnect [line 209]

void DoConnect(
)

Overrides CustomConnection::DoConnect (Place here the connection code)

[ Top ]

void DoDisconnect [line 222]

void DoDisconnect(
)

Overrides CustomConnection::DoDisconnect (Place here the disconnection code)

[ Top ]

object execute [line 164]

object execute(
string
$query, [
$params = array()])

Executes a query

Parameters:

string	$query
	$params

[ Top ]

object executelimit [line 182]

object executelimit(
string
$query, 
$numrows, 
$offset)

Executes a limited query

Parameters:

string	$query
	$numrows
	$offset

[ Top ]

array extractIndexes [line 281]

array &extractIndexes(
string
$table, [boolean
$primary = FALSE])

Return indexes for a table

Parameters:

string	$table
boolean	$primary

[ Top ]

void MetaFields [line 47]

void MetaFields(

$tablename)

Overrides CustomConnection::MetaFields (Returns the fieldnames for the table)

Parameters:

$tablename

[ Top ]

void Param [line 141]

void Param(

$input)

Overrides CustomConnection::Param (Returns a parameter formatted depending on the database type)

Parameters:

$input

[ Top ]

void Prepare [line 126]

void Prepare(

$query)

Overrides CustomConnection::Prepare (Prepares the query, to optimize it)

Parameters:

$query

[ Top ]

void PrepareSP [line 131]

void PrepareSP(

$query)

Parameters:

$query

[ Top ]

void QuoteStr [line 146]

void QuoteStr(

$input)

Overrides CustomConnection::QuoteStr (Quote a string depending on the database type)

Parameters:

$input

[ Top ]

array readFieldDictionaryProperties [line 238]

array readFieldDictionaryProperties(
string
$table, string
$field)

Return properties for a field

Parameters:

string	$table
string	$field

[ Top ]

array tables [line 372]

array tables(
[
$ttype = false], [
$showSchema = false], [
$mask = false])

Return tables on this database

Parameters:

	$ttype
	$showSchema
	$mask

[ Top ]

Documentation generated on Tue, 27 Mar 2007 13:35:14 +0200 by phpDocumentor 1.3.1

Class: IBDatabase

Class Overview

Class Details

Properties

Events

JS Events

Methods

Constants

Inherited Properties

Class: CustomConnection

Class: Component

Class: Persistent

Inherited Events

Class: CustomConnection

Inherited JS Events

Inherited Methods

Class: CustomConnection

Class: Component

Class: Persistent

Class: Object

Properties

property Connected [line 76]

property Connected [line 74]

property DatabaseName [line 89]

property Debug [line 80]

property Dialect : string [line 122]

property Dictionary [line 85]

property DictionaryProperties [line 325]

property Host [line 93]

property UserName [line 97]

property UserPassword [line 101]

Events

property OnAfterConnect [line 104]

property OnAfterDisconnect [line 110]

property OnBeforeConnect [line 107]

property OnBeforeDisconnect [line 113]

Javascript Events

Methods

constructor __construct [line 151]

Parameters:

void BeginTrans [line 60]

Parameters:

void CompleteTrans [line 65]

Parameters:

boolean createDictionaryTable [line 334]

array databases [line 362]

void DBDate [line 136]

Parameters:

void DoConnect [line 209]

void DoDisconnect [line 222]

object execute [line 164]

Parameters:

object executelimit [line 182]

Parameters:

array extractIndexes [line 281]

Parameters:

void MetaFields [line 47]

Parameters:

void Param [line 141]

Parameters:

void Prepare [line 126]

Parameters:

void PrepareSP [line 131]

Parameters:

void QuoteStr [line 146]

Parameters:

array readFieldDictionaryProperties [line 238]

Parameters:

array tables [line 372]

Parameters: