Class: CustomConnection

Source Location: /db.inc.php

Class Overview

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

Component class

Class Details

[line 52]
Component class

Base class for components, it provides owner relationships properties and basic methods to call events.

Non-visible components must inherit from Component and not from Control, the IDE automatically handles the component as iconic.

[ Top ]

Properties

Clients [public]
Connected [public]
DataSets [public]

Events

OnAfterConnect [public]
OnAfterDisconnect [public]
OnBeforeConnect [public]
OnBeforeDisconnect [public]
OnLogin [public]

JS Events

[none]

Methods

Constants

[none]

Child classes:

Database: Database class

IBDatabase: IBDatabase class

Inherited Properties

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

Inherited JS Events

Inherited Methods

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 Clients : collection [line 154]

Returns the clients of this database

[ Top ]

property Connected : boolean [line 244]

Determines if the database is connected or not

[ Top ]

property DataSets [line 63]

[ Top ]

Events

property OnAfterConnect [line 163]

Fired after the database is connected

Overridden in child classes as:

Database::OnAfterConnect()

IBDatabase::OnAfterConnect()

[ Top ]

property OnAfterDisconnect [line 181]

Fired after the database is disconnected

Overridden in child classes as:

Database::OnAfterDisconnect()

IBDatabase::OnAfterDisconnect()

[ Top ]

property OnBeforeConnect [line 172]

Fired before the database is connected

Overridden in child classes as:

Database::OnBeforeConnect()

IBDatabase::OnBeforeConnect()

[ Top ]

property OnBeforeDisconnect [line 190]

Fired before the database is disconnected

Overridden in child classes as:

Database::OnBeforeDisconnect()

IBDatabase::OnBeforeDisconnect()

[ Top ]

property OnLogin [line 199]

Fired when requesting login information for this database

[ Top ]

Javascript Events

Methods

constructor __construct [line 203]

CustomConnection __construct(
[
$aowner = null])

Overridden in child classes as:

Database::__construct()

IBDatabase::__construct()

Overrides Component::__construct (Constructor)

Parameters:

$aowner

[ Top ]

void BeginTrans [line 81]

void BeginTrans(
)

Begins a transaction

Overridden in child classes as:

Database::BeginTrans()

IBDatabase::BeginTrans()

[ Top ]

void Close [line 224]

void Close(
)

Close the database

[ Top ]

void CompleteTrans [line 90]

void CompleteTrans(
[bool
$autocomplete = true])

Completes a transaction

Overridden in child classes as:

Database::CompleteTrans()

IBDatabase::CompleteTrans()

Parameters:

bool

$autocomplete

If true, the transaction will be commited, if false, will be rolled back

[ Top ]

string DBDate [line 118]

string DBDate(
string
$input)

Returns a date formatted to be used on this database, depending on the type

Overridden in child classes as:

Database::DBDate()

IBDatabase::DBDate()

Parameters:

string

$input

Date to convert

[ Top ]

void DoConnect [line 280]

void DoConnect(
)

Place here the connection code

Overridden in child classes as:

Database::DoConnect()

IBDatabase::DoConnect()

[ Top ]

void DoDisconnect [line 288]

void DoDisconnect(
)

Place here the disconnection code

Overridden in child classes as:

Database::DoDisconnect()

IBDatabase::DoDisconnect()

[ Top ]

void loaded [line 230]

void loaded(
)

Overrides Component::loaded (A virtual method to get notified when the object has been fully loaded from a stream)

[ Top ]

array MetaFields [line 74]

array MetaFields(
string
$tablename)

Returns the fieldnames for the table

Overridden in child classes as:

Database::MetaFields()

IBDatabase::MetaFields()

Parameters:

string

$tablename

Table to get the fields for

[ Top ]

void Open [line 215]

void Open(
)

Open the database

[ Top ]

string Param [line 137]

string Param(
string
$input)

Returns a parameter formatted depending on the database type

Overridden in child classes as:

Database::Param()

IBDatabase::Param()

Parameters:

string

$input

Parameter name

[ Top ]

void Prepare [line 127]

void Prepare(
string
$query)

Prepares the query, to optimize it

Overridden in child classes as:

Database::Prepare()

IBDatabase::Prepare()

Parameters:

string

$query

SQL sentence to be prepared

[ Top ]

void QuoteStr [line 145]

void QuoteStr(

$input)

Quote a string depending on the database type

Overridden in child classes as:

Database::QuoteStr()

IBDatabase::QuoteStr()

Parameters:

$input

[ Top ]

void SendConnectEvent [line 101]

void SendConnectEvent(

$connecting)

Parameters:

$connecting

[ Top ]

Documentation generated on Tue, 27 Mar 2007 13:34:09 +0200 by phpDocumentor 1.3.1