Element index for package jargon
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ i ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
top
top
c
- $columns
- in file DataSet.php, variable DataSet::$columns
the columns in the SELECT statement for this DataSet
- $conn
- in file Query.php, variable Query::$conn
- $conn
- in file DataSet.php, variable DataSet::$conn
this DataSet's connection object
- clearRecords
- in file DataSet.php, method DataSet::clearRecords()
Remove all records from the DataSet and nulls those records out and close() the DataSet.
- close
- in file DataSet.php, method DataSet::close()
Releases the records, closes the ResultSet and the Statement, and nulls the Schema and Connection references.
- columns
- in file Record.php, method Record::columns()
Get the column names for current record.
- connection
- in file DataSet.php, method DataSet::connection()
Gets the current database connection
- containsAttrib
- in file KeyDef.php, method KeyDef::containsAttrib()
Determines if the KeyDef contains the requested Attribute.
- containsRecord
- in file DataSet.php, method DataSet::containsRecord()
Check to see if the DataSet contains a Record at 0 based position
top
d
- dataset
- in file Record.php, method Record::dataset()
Gets the DataSet for this Record.
- DataSet
- in file DataSet.php, class DataSet
The DataSet represents the results of a query.
- DataSetException
- in file DataSetException.php, class DataSetException
A DataSetException represents exception specific to the DataSet/Record layer.
- delete
- in file Record.php, method Record::delete()
Shortcut method to delete this record.
- DataSetException.php
- procedural page DataSetException.php
- DataSet.php
- procedural page DataSet.php
top
top
f
- AFTERDELETE
- in file Record.php, class constant Record::AFTERDELETE
- AFTERINSERT
- in file Record.php, class constant Record::AFTERINSERT
- AFTERUPDATE
- in file Record.php, class constant Record::AFTERUPDATE
- fetchRecords
- in file DataSet.php, method DataSet::fetchRecords()
Causes the DataSet to hit the database and fetch max records, starting at start. Record count begins at 0.
- fetchRecords
- in file TableDataSet.php, method TableDataSet::fetchRecords()
Fetch start to max records. start is at Record 0
- findRecord
- in file DataSet.php, method DataSet::findRecord()
Find Record at 0 based index position. This is an internal alternative to getRecord which tries to be smart about the type of record it is.
top
g
- getAssoc
- in file Query.php, method Query::getAssoc()
Fetch the entire result set of a query and return it as an associative array using the first column as the key.
- getAttrib
- in file KeyDef.php, method KeyDef::getAttrib()
getAttrib is 1 based. Setting pos to 0 will attempt to return pos 1.
- getCol
- in file Query.php, method Query::getCol()
Gets array of values for first column in result set.
- getColumns
- in file DataSet.php, method DataSet::getColumns()
Returns the columns attribute for the DataSet
- getDataSet
- in file Query.php, method Query::getDataSet()
Gets a QueryDataSet representing results of this query.
- getIterator
- in file DataSet.php, method DataSet::getIterator()
Return iterator (for IteratorAggregate interface).
- getOne
- in file Query.php, method Query::getOne()
Gets value of first column of first returned row.
- getOrder
- in file TableDataSet.php, method TableDataSet::getOrder()
Gets the value of the SQL portion of ORDER.
- getOther
- in file TableDataSet.php, method TableDataSet::getOther()
Gets the value of the SQL portion of OTHER.
- getPage
- in file PagedQuery.php, method PagedQuery::getPage()
Get current page.
- getRecord
- in file DataSet.php, method DataSet::getRecord()
Get Record at 0 based index position
- getRefreshSql
- in file Record.php, method Record::getRefreshSql()
This builds the SELECT statement in order to refresh the contents of this Record. It depends on a valid KeyDef to exist and it must have been created with a TableDataSet.
- getRow
- in file Query.php, method Query::getRow()
Gets first rows (hash).
- getRows
- in file Query.php, method Query::getRows()
Gets array of rows (hashes).
- getRowsPerPage
- in file PagedQuery.php, method PagedQuery::getRowsPerPage()
Get number of rows per page.
- getSaveType
- in file Record.php, method Record::getSaveType()
Gets the internal save type as one of the defined privates (ie: ZOMBIE)
- getSelectSql
- in file DataSet.php, method DataSet::getSelectSql()
Classes extending this class must implement this method.
- getSelectSql
- in file QueryDataSet.php, method QueryDataSet::getSelectSql()
get the Select String that was used to create this QueryDataSet
- getSelectSql
- in file TableDataSet.php, method TableDataSet::getSelectSql()
Builds the select string that was used to populate this TableDataSet.
- getTotalRecordCount
- in file PagedQuery.php, method PagedQuery::getTotalRecordCount()
Gets the total number (un-LIMITed) of records.
- getValue
- in file Record.php, method Record::getValue()
Gets the value for specified column.
- getWhere
- in file TableDataSet.php, method TableDataSet::getWhere()
Gets the value of the SQL portion of WHERE.
top
i
- isAZombie
- in file Record.php, method Record::isAZombie()
Determines if this record is a Zombie. A Zombie is a record that has been deleted from the database, but not yet removed from the DataSet.
top
k
- $keyDef
- in file DataSet.php, variable DataSet::$keyDef
the KeyDef for this DataSet
- KeyDef.php
- procedural page KeyDef.php
- KeyDef
- in file KeyDef.php, class KeyDef
A KeyDef is a way to define the key columns in a table.
- keydef
- in file DataSet.php, method DataSet::keydef()
gets the KeyDef object for this DataSet
top
l
- $lastFetchSize
- in file DataSet.php, variable DataSet::$lastFetchSize
number of records that were last fetched
- ALL_RECORDS
- in file DataSet.php, class constant DataSet::ALL_RECORDS
indicates that all records should be retrieved during a fetch
- lastFetchSize
- in file DataSet.php, method DataSet::lastFetchSize()
The number of records that were fetched with the last fetchRecords.
top
m
- $max
- in file Query.php, variable Query::$max
- markForInsert
- in file Record.php, method Record::markForInsert()
Marks this record to be inserted when a save is executed.
- markForUpdate
- in file Record.php, method Record::markForUpdate()
Marks this record to be updated when a save is executed.
- markRecordClean
- in file Record.php, method Record::markRecordClean()
Marks all the values in this record as clean.
- markToBeDeleted
- in file Record.php, method Record::markToBeDeleted()
Marks this record to be deleted when a save is executed.
- markValueClean
- in file Record.php, method Record::markValueClean()
Marks a value with a given column name as clean (unmodified).
- markValueDirty
- in file Record.php, method Record::markValueDirty()
Marks a value with a given column as "dirty" (modified).
top
n
- INSERT
- in file Record.php, class constant Record::INSERT
- needsToBeSaved
- in file Record.php, method Record::needsToBeSaved()
If the record is not clean, needs to be saved with an Update, Delete or Insert, it returns true.
- UNKNOWN
- in file Record.php, class constant Record::UNKNOWN
top
top
p
- PagedQuery.php
- procedural page PagedQuery.php
- PagedQuery
- in file PagedQuery.php, class PagedQuery
Class for representing a SQL query for retrieving paged results from a database.
- UPDATE
- in file Record.php, class constant Record::UPDATE
top
q
- QueryDataSet.php
- procedural page QueryDataSet.php
- Query.php
- procedural page Query.php
- Query
- in file Query.php, class Query
Class for representing a SQL query for RETRIEVING results from a database.
- QueryDataSet
- in file QueryDataSet.php, class QueryDataSet
This class is used to represent the results of a SQL select statements on the database.
top
r
- $recordRetrievedCount
- in file DataSet.php, variable DataSet::$recordRetrievedCount
number of records retrieved
- $records
- in file DataSet.php, variable DataSet::$records
this DataSet's collection of Record objects
- $resultSet
- in file DataSet.php, variable DataSet::$resultSet
the result set for this DataSet
- Record.php
- procedural page Record.php
- Record
- in file Record.php, class Record
A Record represents a row in the database. It contains a hash of values which represent the column values for each row.
- recordIsClean
- in file Record.php, method Record::recordIsClean()
Goes through all the values in the record to determine if it is clean or not.
- refresh
- in file Record.php, method Record::refresh()
This method refreshes this Record's Value's. It can only be performed on a Record that has not been modified and has been created with a TableDataSet and corresponding KeyDef.
- refresh
- in file TableDataSet.php, method TableDataSet::refresh()
This method refreshes all of the Records stored in this TableDataSet.
- refreshOnSave
- in file TableDataSet.php, method TableDataSet::refreshOnSave()
Setting this causes each Record to refresh itself when a save() is performed on it.
- releaseRecords
- in file DataSet.php, method DataSet::releaseRecords()
Removes the records from the DataSet, but does not null the records out
- removeDeletedRecords
- in file TableDataSet.php, method TableDataSet::removeDeletedRecords()
Removes any records that are marked as a zombie.
- removeRecord
- in file DataSet.php, method DataSet::removeRecord()
Remove a record from the DataSet's internal storage
- reset
- in file DataSet.php, method DataSet::reset()
Essentially the same as releaseRecords, but it won't work on a QueryDataSet that has been created with a ResultSet
- resultSet
- in file DataSet.php, method DataSet::resultSet()
Gets the ResultSet for this DataSet
top
s
- $selectSql
- in file DataSet.php, variable DataSet::$selectSql
the select string that was used to build this DataSet
- $sql
- in file Query.php, variable Query::$sql
- $start
- in file Query.php, variable Query::$start
- $stmt
- in file DataSet.php, variable DataSet::$stmt
the Statement for this DataSet
- save
- in file Record.php, method Record::save()
Saves the data in this Record to the database.
- save
- in file TableDataSet.php, method TableDataSet::save()
Saves all the records in the DataSet.
- schema
- in file DataSet.php, method DataSet::schema()
Gets the Schema for this DataSet
- setAllRecordsRetrieved
- in file DataSet.php, method DataSet::setAllRecordsRetrieved()
Set all records retrieved
- setMax
- in file Query.php, method Query::setMax()
Sets max rows (limit).
- setOptimisticLockingColumn
- in file TableDataSet.php, method TableDataSet::setOptimisticLockingColumn()
Sets the table column used for optomistic locking.
- setPage
- in file PagedQuery.php, method PagedQuery::setPage()
Set the current page number (First page is 1).
- setParentDataSet
- in file Record.php, method Record::setParentDataSet()
Sets the parent DataSet for this record.
- setRefreshOnSave
- in file TableDataSet.php, method TableDataSet::setRefreshOnSave()
Setting this causes each Record to refresh itself when a save() is performed on it.
- setRowsPerPage
- in file PagedQuery.php, method PagedQuery::setRowsPerPage()
Set the number of rows per page.
- setSaveType
- in file Record.php, method Record::setSaveType()
Sets the internal save type as one of the defined privates (ie: ZOMBIE)
- setSql
- in file Query.php, method Query::setSql()
Sets the SQL we are using.
- setStart
- in file Query.php, method Query::setStart()
Sets the start row or offset.
- setValue
- in file Record.php, method Record::setValue()
Sets the value of col.
- size
- in file KeyDef.php, method KeyDef::size()
Returns number of columns in KeyDef.
- size
- in file Record.php, method Record::size()
The number of columns in this object.
- size
- in file DataSet.php, method DataSet::size()
Gets the number of Records in this DataSet. It is 0 based.
top
t
- $totalFetchCount
- in file DataSet.php, variable DataSet::$totalFetchCount
number of records total that have been fetched
- TableDataSet.php
- procedural page TableDataSet.php
- TableDataSet
- in file TableDataSet.php, class TableDataSet
This class is used for doing select/insert/delete/update on the database.
- tableInfo
- in file TableDataSet.php, method TableDataSet::tableInfo()
Load the TableInfo (metadata) object for this table.
- tableName
- in file TableDataSet.php, method TableDataSet::tableName()
Gets the tableName defined in the schema
- toBeSavedWithDelete
- in file Record.php, method Record::toBeSavedWithDelete()
Whether or not this Record is to be saved with an SQL delete statement
- toBeSavedWithInsert
- in file Record.php, method Record::toBeSavedWithInsert()
Whether or not this Record is to be saved with an SQL insert statement
- toBeSavedWithUpdate
- in file Record.php, method Record::toBeSavedWithUpdate()
Whether or not this Record is to be saved with an SQL update statement
top
top
v
- valueIsClean
- in file Record.php, method Record::valueIsClean()
Determines whether or not a value stored in the record is clean.
top
w
- where
- in file TableDataSet.php, method TableDataSet::where()
Sets the value for the SQL portion of the WHERE statement.
top
|
|
