VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]
Packages:
VCL


Classes:
ActionList
Application
ArrayPropertyEditor
BasicAuthentication
Bevel
BitBtn
Brush
BusinessObject
Button
ButtonControl
ButtonView
Canvas
CheckBox
CheckListBox
Clock
Collection
ColorPropertyEditor
ColorSelector
Column
ComboBox
Component
ComponentEditor
Control
CustomButtonView
CustomCheckBox
CustomCheckListBox
CustomConnection
CustomControl
CustomDBGrid
CustomEdit
CustomGrid
CustomIBQuery
CustomIBTable
CustomLabel
CustomLabeledEdit
CustomListBox
CustomListControl
CustomListView
CustomMainMenu
CustomMemo
CustomMultiSelectListControl
CustomPage
CustomPageControl
CustomPanel
CustomPopupMenu
CustomProgressBar
CustomQuery
CustomRadioGroup
CustomRichEdit
CustomStyleSheet
CustomTable
CustomTextField
CustomToolBar
CustomTreeView
CustomUpDown
Database
DatabaseEditor
DatabaseUser
DataModule
DataSet
Datasource
DateTimePicker
DBDataSet
DBGrid
DBPaginator
DBRepeater
DWidget
EAbort
EAssignError
ECollectionError
EDatabaseError
Edit
ENameDuplicated
EPropertyNotFound
EResNotFound
Field
Filer
FlashObject
FocusControl
Font
Frame
Frameset
GraphicControl
GraphicMainMenu
GroupBox
HiddenField
HTMLPropertyEditor
IBDatabase
IBDataSet
IBQuery
IBStoredProc
IBTable
Image
ImageList
ImagePropertyEditor
Input
InputFilter
InputParam
ItemsPropertyEditor
Label
LabeledEdit
Layout
ListBox
ListView
MainMenu
MapShape
Memo
MonthCalendar
Object
Page
PageControl
PageTemplate
PaintBox
Panel
Pen
Persistent
PopupMenu
ProgressBar
PropertyEditor
Query
QWidget
RadioButton
RadioGroup
Reader
RichEdit
Row
ScrollBar
ScrollingControl
Service
Shape
SimpleChart
SmartyTemplate
SpeedButton
StoredProc
StringListPropertyEditor
StyleSheet
SubLabel
Table
TemplateManager
TextField
Timer
ToolBar
TrackBar
TreeNode
TreeView
UpDown
User
Window

Files:
actnlist.inc.php
auth.inc.php
business.inc.php
buttons.inc.php
calendar.inc.php
chart.inc.php
checklst.inc.php
classes.inc.php
clock.inc.php
comctrls.inc.php
controls.inc.php
db.inc.php
dbctrls.inc.php
dbgrids.inc.php
dbtables.inc.php
designide.inc.php
extctrls.inc.php
forms.inc.php
graphics.inc.php
grids.inc.php
imglist.inc.php
interbase.inc.php
menus.inc.php
rtl.inc.php
smartytemplate.inc.php
stdctrls.inc.php
styles.inc.php
system.inc.php
templateplugins.inc.php
vcl.inc.php
webservices.inc.php

Class: DataSet

Source Location: /db.inc.php

Class Overview

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

DataSet component, base class to inherit and create dataset components

Class Details

[line 415]
DataSet component, base class to inherit and create dataset components



[ Top ]

Properties

Events

JS Events

    [none]

Methods

Constants

    [none]

Child classes:

DBDataSet
DBDataSet class
IBDataSet
IBDataSet 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 Active : boolean [line 1417]

Specifies if the dataset is active or not

[ Top ]

property BOF : boolean [line 1489]

If true, the pointer is at the beginning of the buffer

[ Top ]

property CanModify : boolean [line 603]

Specifies if the dataset can be modified or not

[ Top ]

property DataSetField [line 487]

[ Top ]

property EOF : boolean [line 1496]

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

[ Top ]

property FieldCount : integer [line 471]

Specifies how many fields has the dataset

[ Top ]

property Fields : array [line 464]

This property returns an array with the field names and values

[ Top ]

property Filter : string [line 751]

Specifies the filter to apply to this dataset

[ Top ]

property LimitCount [line 430]

Defines how many records will be shown

[ Top ]

property LimitStart [line 423]

Defines the starting record to filter the dataset with

[ Top ]

property MasterFields : array [line 507]

Specifies the associations with fields on this dataset and fields on the dataset attached to the MasterSource property

[ Top ]

property MasterSource : object [line 515]

Specifies the dataset is going to act as master for this datasource

[ Top ]

property Modified : boolean [line 593]

Specifies if the dataset has been modified or not

[ Top ]

property RecKey : array [line 549]

Specifies the record key for thid dataset

[ Top ]

property RecNo : integer [line 527]

Specifies the current record number

[ Top ]

property RecordCount : integer [line 1128]

Specifies how many records holds this dataset

[ Top ]

property State : enum [line 495]

Specifies the state of the dataset, i.e. dsNone, dsEdit, etc

[ Top ]

Events

property OnAfterCancel [line 711]

Fired after changes are cancelled

Overridden in child classes as:

Table::OnAfterCancel()
IBTable::OnAfterCancel()

[ Top ]

property OnAfterClose [line 639]

Fired after the dataset is closed

Overridden in child classes as:

Table::OnAfterClose()
IBTable::OnAfterClose()

[ Top ]

property OnAfterDelete [line 729]

Fired after a record is deleted

Overridden in child classes as:

Table::OnAfterDelete()
IBTable::OnAfterDelete()

[ Top ]

property OnAfterEdit [line 675]

Fired after the dataset enters in edito mode

Overridden in child classes as:

Table::OnAfterEdit()
IBTable::OnAfterEdit()

[ Top ]

property OnAfterInsert [line 657]

Fired after a record is inserted

Overridden in child classes as:

Table::OnAfterInsert()
IBTable::OnAfterInsert()

[ Top ]

property OnAfterOpen [line 621]

Fired after the dataset is open

Overridden in child classes as:

Table::OnAfterOpen()
IBTable::OnAfterOpen()

[ Top ]

property OnAfterPost [line 693]

Fired after a record is posted

Overridden in child classes as:

Table::OnAfterPost()
IBTable::OnAfterPost()

[ Top ]

property OnBeforeCancel [line 702]

Fired before changes are cancelled

Overridden in child classes as:

Table::OnBeforeCancel()
IBTable::OnBeforeCancel()

[ Top ]

property OnBeforeClose [line 630]

Fired before the dataset is closed

Overridden in child classes as:

Table::OnBeforeClose()
IBTable::OnBeforeClose()

[ Top ]

property OnBeforeDelete [line 720]

Fired before a record is deleted

Overridden in child classes as:

Table::OnBeforeDelete()
IBTable::OnBeforeDelete()

[ Top ]

property OnBeforeEdit [line 666]

Fired before the dataset enters in edit mode

Overridden in child classes as:

Table::OnBeforeEdit()
IBTable::OnBeforeEdit()

[ Top ]

property OnBeforeInsert [line 648]

Fired before a record is inserted

Overridden in child classes as:

Table::OnBeforeInsert()
IBTable::OnBeforeInsert()

[ Top ]

property OnBeforeOpen [line 612]

Fired before the dataset is open

Overridden in child classes as:

Table::OnBeforeOpen()
IBTable::OnBeforeOpen()

[ Top ]

property OnBeforePost [line 684]

Fired before a record is posted

Overridden in child classes as:

Table::OnBeforePost()
IBTable::OnBeforePost()

[ Top ]

property OnCalcFields [line 735]

[ Top ]

property OnDeleteError [line 741]

Overridden in child classes as:

Table::OnDeleteError()
IBTable::OnDeleteError()

[ Top ]

property OnFilterRecord [line 767]

[ Top ]

property OnNewRecord [line 773]

[ Top ]

property OnPostError [line 779]

[ Top ]

Javascript Events


Methods

constructor __construct [line 964]

DataSet __construct( [ $aowner = null])



Overrides Component::__construct (Constructor)

Parameters:

   $aowner  

[ Top ]

void Append [line 991]

void Append( )

Appends a record to the dataset



[ Top ]

void BeginInsertAppend [line 934]

void BeginInsertAppend( )

Begins an insert/append operation



[ Top ]

void Cancel [line 1006]

void Cancel( )

Cancel changes performed on the current record



[ Top ]

void CheckActive [line 867]

void CheckActive( )

Checks if the dataset is active, if not, raises an exception



[ Top ]

void CheckBrowseMode [line 1041]

void CheckBrowseMode( )

Checks if the dataset is in browse mode or not



[ Top ]

void CheckCanModify [line 875]

void CheckCanModify( )

Checks if the dataset can be modified, if not, raises an exception



[ Top ]

void CheckOperation [line 789]

void CheckOperation( string $Operation, string $ErrorEvent)

Checks if an specific operation can be made, if not, calls $ErrorEvent



Parameters:

string   $Operation   Operation to perform on the dataset
string   $ErrorEvent   Event to call if there is any error

[ Top ]

void CheckParentState [line 1093]

void CheckParentState( )

Sets the parent dataset in edit state



[ Top ]

void ClearBuffers [line 921]

void ClearBuffers( )

Clear buffers associated with the dataset



[ Top ]

void Close [line 1066]

void Close( )

Closes the dataset



[ Top ]

void CloseCursor [line 1232]

void CloseCursor( )

Close the cursor for this dataset



[ Top ]

boolean ControlsDisabled [line 884]

boolean ControlsDisabled( )

Returns if attached controls are disabled



[ Top ]

void DataEvent [line 818]

void DataEvent( integer $event, array $info)

Used to notify attached datasets about an specific event



Parameters:

integer   $event   Event to notify
array   $info   Info for the event

[ Top ]

void Delete [line 1074]

void Delete( )

Deletes a record on the dataset, depending on the values set in the buffer



[ Top ]

void DisableControls [line 892]

void DisableControls( )

Disables controls attached to the datasource



[ Top ]

void DoInternalOpen [line 1175]

void DoInternalOpen( )

Performs an internal open of the dataset



[ Top ]

void Edit [line 1101]

void Edit( )

Sets the dataset in edit mode, modifications will go to a buffer waiting for post()/cancel()



[ Top ]

void EnableControls [line 905]

void EnableControls( )

Enable controls attached to the datasource



[ Top ]

void EndInsertAppend [line 945]

void EndInsertAppend( )

Finishes an insert/append operation



[ Top ]

void First [line 1138]

void First( )

Moves the internal pointer of the dataset to the first record



[ Top ]

void InitRecord [line 1262]

void InitRecord( array $Buffer)

To initialize the current record



Parameters:

array   $Buffer   Initial values

[ Top ]

void Insert [line 973]

void Insert( )

Inserts a record on the dataset



[ Top ]

void InternalAddRecord [line 1273]

void InternalAddRecord( $buffer, $append)



Parameters:

   $buffer  
   $append  

[ Top ]

void InternalCancel [line 1295]

void InternalCancel( )

To be overriden to perform a cancel() operation



[ Top ]

void InternalClose [line 437]

void InternalClose( )

Override this method to perform the closing of the dataset



Overridden in child classes as:

DBDataSet::InternalClose()

[ Top ]

void InternalDelete [line 1280]

void InternalDelete( )

To be overriden to perform a delete() operation



Overridden in child classes as:

CustomTable::InternalDelete()
CustomIBTable::InternalDelete()

[ Top ]

void InternalEdit [line 1302]

void InternalEdit( )

To be overriden to perform a edit() operation



[ Top ]

void InternalFirst [line 1247]

void InternalFirst( )

To be overriden to perform a first() operation



Overridden in child classes as:

DBDataSet::InternalFirst()
IBDataSet::InternalFirst()

[ Top ]

void InternalHandleException [line 442]

void InternalHandleException( )

Override this method to handle exceptions



[ Top ]

void InternalInitFieldDefs [line 447]

void InternalInitFieldDefs( )

Override this method to init field definitions



[ Top ]

void InternalInitRecord [line 1269]

void InternalInitRecord( $buffer)



Parameters:

   $buffer  

[ Top ]

void InternalInsert [line 1309]

void InternalInsert( )

To be overriden to perform a insert() operation



[ Top ]

void InternalLast [line 1254]

void InternalLast( )

To be overriden to perform a last() operation



Overridden in child classes as:

DBDataSet::InternalLast()

[ Top ]

void InternalOpen [line 452]

void InternalOpen( )

Override this method to perform the opening of the dataset



Overridden in child classes as:

DBDataSet::InternalOpen()
IBDataSet::InternalOpen()

[ Top ]

void InternalPost [line 1287]

void InternalPost( )

To be overriden to perform a post() operation



Overridden in child classes as:

CustomTable::InternalPost()
CustomIBTable::InternalPost()

[ Top ]

void InternalRefresh [line 1316]

void InternalRefresh( )

To be overriden to perform a refresh() operation



[ Top ]

boolean IsCursorOpen [line 458]

boolean IsCursorOpen( )

Override this method to return if the cursor is open or not



[ Top ]

void Last [line 1323]

void Last( )

Moves the internal pointer to the last record on the dataset



[ Top ]

void loaded [line 1428]

void loaded( )



Overridden in child classes as:

DBDataSet::loaded()
IBDataSet::loaded()

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

[ Top ]

void MoveBy [line 1400]

void MoveBy( integer $distance)

Move the internal pointer by an specific distance



Overridden in child classes as:

DBDataSet::MoveBy()
IBDataSet::MoveBy()

Parameters:

integer   $distance   Records to move the pointer

[ Top ]

void Next [line 1357]

void Next( )

Moves the internal pointer to the next record



[ Top ]

void Open [line 1368]

void Open( )

Open the dataset



[ Top ]

void OpenCursor [line 1188]

void OpenCursor( [boolean $InfoQuery = False])

Opens the cursor for the dataset



Parameters:

boolean   $InfoQuery   If true, initialize internal field defs

[ Top ]

void OpenCursorComplete [line 1197]

void OpenCursorComplete( )

Opens the cursor for this dataset



[ Top ]

void Post [line 1376]

void Post( )

Updates or Inserts a record, depending on the current state of the dataset



[ Top ]

void Prior [line 1408]

void Prior( )

Moves the pointer one record before



[ Top ]

void Refresh [line 1348]

void Refresh( )

Refresh the dataset by opening and closing



[ Top ]

void serialize [line 553]

void serialize( )



Overrides Persistent::serialize (Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored.)

[ Top ]

void unserialize [line 572]

void unserialize( )



Overrides Persistent::unserialize (Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized.)

[ Top ]

void UpdateRecord [line 1032]

void UpdateRecord( )

Updates the current record



[ Top ]

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