Class: DBDataSet

Source Location: /dbtables.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --DataSet
            |
            --DBDataSet

DBDataSet class

Class Details

[line 527]
DBDataSet class

Base Class for datasets linked to a database

[ Top ]

Properties

Database [public]
EOF [public]
FieldCount [public]
Fields [public]
RecordCount [public]

Events

[none]

JS Events

[none]

Methods

Constants

[none]

Child classes:

CustomTable: Table class

Inherited Properties

Class: DataSet

DataSet::Active: Specifies if the dataset is active or not
DataSet::BOF: If true, the pointer is at the beginning of the buffer
DataSet::CanModify: Specifies if the dataset can be modified or not
DataSet::DataSetField
DataSet::EOF: If true, the pointer is at the last record of the buffer
DataSet::FieldCount: Specifies how many fields has the dataset
DataSet::Fields: This property returns an array with the field names and values
DataSet::Filter: Specifies the filter to apply to this dataset
DataSet::LimitCount: Defines how many records will be shown
DataSet::LimitStart: Defines the starting record to filter the dataset with
DataSet::MasterFields: Specifies the associations with fields on this dataset and fields on the dataset attached to the MasterSource property
DataSet::MasterSource: Specifies the dataset is going to act as master for this datasource
DataSet::Modified: Specifies if the dataset has been modified or not
DataSet::RecKey: Specifies the record key for thid dataset
DataSet::RecNo: Specifies the current record number
DataSet::RecordCount: Specifies how many records holds this dataset
DataSet::State: Specifies the state of the dataset, i.e. dsNone, dsEdit, etc

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: DataSet

DataSet::OnAfterCancel: Fired after changes are cancelled
DataSet::OnAfterClose: Fired after the dataset is closed
DataSet::OnAfterDelete: Fired after a record is deleted
DataSet::OnAfterEdit: Fired after the dataset enters in edito mode
DataSet::OnAfterInsert: Fired after a record is inserted
DataSet::OnAfterOpen: Fired after the dataset is open
DataSet::OnAfterPost: Fired after a record is posted
DataSet::OnBeforeCancel: Fired before changes are cancelled
DataSet::OnBeforeClose: Fired before the dataset is closed
DataSet::OnBeforeDelete: Fired before a record is deleted
DataSet::OnBeforeEdit: Fired before the dataset enters in edit mode
DataSet::OnBeforeInsert: Fired before a record is inserted
DataSet::OnBeforeOpen: Fired before the dataset is open
DataSet::OnBeforePost: Fired before a record is posted
DataSet::OnCalcFields
DataSet::OnDeleteError
DataSet::OnFilterRecord
DataSet::OnNewRecord
DataSet::OnPostError

Inherited JS Events

Inherited Methods

Class: DataSet

DataSet::__construct
DataSet::Append: Appends a record to the dataset
DataSet::BeginInsertAppend: Begins an insert/append operation
DataSet::Cancel: Cancel changes performed on the current record
DataSet::CheckActive: Checks if the dataset is active, if not, raises an exception
DataSet::CheckBrowseMode: Checks if the dataset is in browse mode or not
DataSet::CheckCanModify: Checks if the dataset can be modified, if not, raises an exception
DataSet::CheckOperation: Checks if an specific operation can be made, if not, calls $ErrorEvent
DataSet::CheckParentState: Sets the parent dataset in edit state
DataSet::ClearBuffers: Clear buffers associated with the dataset
DataSet::Close: Closes the dataset
DataSet::CloseCursor: Close the cursor for this dataset
DataSet::ControlsDisabled: Returns if attached controls are disabled
DataSet::DataEvent: Used to notify attached datasets about an specific event
DataSet::Delete: Deletes a record on the dataset, depending on the values set in the buffer
DataSet::DisableControls: Disables controls attached to the datasource
DataSet::DoInternalOpen: Performs an internal open of the dataset
DataSet::Edit: Sets the dataset in edit mode, modifications will go to a buffer waiting for post()/cancel()
DataSet::EnableControls: Enable controls attached to the datasource
DataSet::EndInsertAppend: Finishes an insert/append operation
DataSet::First: Moves the internal pointer of the dataset to the first record
DataSet::InitRecord: To initialize the current record
DataSet::Insert: Inserts a record on the dataset
DataSet::InternalAddRecord
DataSet::InternalCancel: To be overriden to perform a cancel() operation
DataSet::InternalClose: Override this method to perform the closing of the dataset
DataSet::InternalDelete: To be overriden to perform a delete() operation
DataSet::InternalEdit: To be overriden to perform a edit() operation
DataSet::InternalFirst: To be overriden to perform a first() operation
DataSet::InternalHandleException: Override this method to handle exceptions
DataSet::InternalInitFieldDefs: Override this method to init field definitions
DataSet::InternalInitRecord
DataSet::InternalInsert: To be overriden to perform a insert() operation
DataSet::InternalLast: To be overriden to perform a last() operation
DataSet::InternalOpen: Override this method to perform the opening of the dataset
DataSet::InternalPost: To be overriden to perform a post() operation
DataSet::InternalRefresh: To be overriden to perform a refresh() operation
DataSet::IsCursorOpen: Override this method to return if the cursor is open or not
DataSet::Last: Moves the internal pointer to the last record on the dataset
DataSet::loaded
DataSet::MoveBy: Move the internal pointer by an specific distance
DataSet::Next: Moves the internal pointer to the next record
DataSet::Open: Open the dataset
DataSet::OpenCursor: Opens the cursor for the dataset
DataSet::OpenCursorComplete: Opens the cursor for this dataset
DataSet::Post: Updates or Inserts a record, depending on the current state of the dataset
DataSet::Prior: Moves the pointer one record before
DataSet::Refresh: Refresh the dataset by opening and closing
DataSet::serialize
DataSet::unserialize
DataSet::UpdateRecord: Updates the current record

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 Database : CustomConnection [line 538]

Specifies the database object to be used to connect to the server

[ Top ]

property EOF : boolean [line 596]

If true, the pointer is at the end of the dataset

If true, the pointer is at the last record of the buffer

Defined in DataSet::EOF

[ Top ]

property FieldCount : integer [line 563]

Number of fields on the current record

Specifies how many fields has the dataset

Defined in DataSet::FieldCount

[ Top ]

property Fields : array [line 553]

Field array (name=>value) of the current record

This property returns an array with the field names and values

Defined in DataSet::Fields

[ Top ]

property RecordCount : integer [line 570]

Number of records in the dataset

Specifies how many records holds this dataset

Defined in DataSet::RecordCount

[ Top ]

Events

Javascript Events

Methods

void CheckDatabase [line 601]

void CheckDatabase(
)

[ Top ]

void InternalClose [line 608]

void InternalClose(
)

Overrides DataSet::InternalClose (Override this method to perform the closing of the dataset)

[ Top ]

void InternalFirst [line 649]

void InternalFirst(
)

Overrides DataSet::InternalFirst (To be overriden to perform a first() operation)

[ Top ]

void InternalLast [line 663]

void InternalLast(
)

Overrides DataSet::InternalLast (To be overriden to perform a last() operation)

[ Top ]

void InternalOpen [line 613]

void InternalOpen(
)

Overrides DataSet::InternalOpen (Override this method to perform the opening of the dataset)

[ Top ]

void loaded [line 542]

void loaded(
)

Overrides DataSet::loaded (parent method not documented)

[ Top ]

void MoveBy [line 579]

void MoveBy(

$distance)

Overrides DataSet::MoveBy (Move the internal pointer by an specific distance)

Parameters:

$distance

[ Top ]

mixed __get [line 683]

mixed __get(
string
$nm)

Overriden to allow get field values as properties

Overrides Object::__get (To virtualize properties)

Parameters:

string

$nm

[ Top ]

mixed __set [line 725]

mixed __set(
string
$nm, 
$val)

Overriden to allow get field values as properties

Overrides Object::__set (To virtualize properties)

Parameters:

string	$nm
	$val

[ Top ]

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