apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Element index for package apidoc

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ y ] [ _ ]

_

$_lastError
in file DataObject.php, variable DB_DataObject::$_lastError
    Last Error that has occured
  • use $this->_lastError or
$last_error = PEAR::getStaticProperty('DB_DataObject','lastError');
$_resultFields
in file DataObject.php, variable DB_DataObject::$_resultFields
    ResultFields - on the last call to fetch(), resultfields is sent here, so we can clean up the memory.
_call
in file DataObject.php, method DB_DataObject::_call()
    Overload Extension support
  • enables setCOLNAME/getCOLNAME
if you define a set/get method for the item it will be called.
_loadConfig
in file DataObject.php, method DB_DataObject::_loadConfig()
    Define the global $_DB_DATAOBJECT['CONFIG'] as an alias to PEAR::getStaticProperty('DB_DataObject','options');
__call
in file DataObject.php, method DB_DataObject_Overload::__call()
__sleep
in file DataObject.php, method DB_DataObject_Overload::__sleep()
top

a

autoJoin
in file DataObject.php, method DB_DataObject::autoJoin()
    autoJoin - using the links.ini file, it builds a query with all the joins
top

b

blob
in file Cast.php, method DB_DataObject_Cast::blob()
    Blob consructor
top

c

count
in file DataObject.php, method DB_DataObject::count()
    Find the number of results from a simple query
top

d

$day
in file Cast.php, variable DB_DataObject_Cast::$day
    Data For date representation
database
in file DataObject.php, method DB_DataObject::database()
    Return or assign the name of the current database
databaseStructure
in file DataObject.php, method DB_DataObject::databaseStructure()
    Autoload or manually load the table definitions
date
in file Cast.php, method DB_DataObject_Cast::date()
    Date Constructor
dateTime
in file Cast.php, method DB_DataObject_Cast::dateTime()
    DateTime Constructor
DB_DataObject
in file DataObject.php, class DB_DataObject
    storage for connection and result objects, it is done this way so that print_r()'ing the is smaller, and it reduces the memory size of the object.
DB_DataObject_Cast
in file Cast.php, class DB_DataObject_Cast
    Common usages:
DB_DataObject_Overload
in file DataObject.php, class DB_DataObject_Overload
    storage for connection and result objects, it is done this way so that print_r()'ing the is smaller, and it reduces the memory size of the object.
debug
in file DataObject.php, method DB_DataObject::debug()
    Debugger. - use this in your extended classes to output debugging information.
debugLevel
in file DataObject.php, method DB_DataObject::debugLevel()
    sets and returns debug level eg. DB_DataObject::debugLevel(4);
delete
in file DataObject.php, method DB_DataObject::delete()
    Deletes items from table which match current objects variables
top

e

escape
in file DataObject.php, method DB_DataObject::escape()
    an escape wrapper around DB->escapeSimple() can be used when adding manual queries or clauses eg.
top

f

fetch
in file DataObject.php, method DB_DataObject::fetch()
    fetches next row into this objects var's
fetchAll
in file DataObject.php, method DB_DataObject::fetchAll()
    fetches all results as an array,
fetchRow
in file DataObject.php, method DB_DataObject::fetchRow()
    fetches a specific row into this object variables
find
in file DataObject.php, method DB_DataObject::find()
    find results, either normal or crosstable
free
in file DataObject.php, method DB_DataObject::free()
    Free global arrays associated with this object.
fromValue
in file DataObject.php, method DB_DataObject::fromValue()
    standard set* implementation.
top

g

get
in file DataObject.php, method DB_DataObject::get()
    Get a result using key, value.
getDatabaseConnection
in file DataObject.php, method DB_DataObject::getDatabaseConnection()
    Gets the DB object related to an object - so you can use funky peardb stuf with it :)
getDatabaseResult
in file DataObject.php, method DB_DataObject::getDatabaseResult()
    Gets the DB result object related to the objects active query
  • so you can use funky pear stuff with it - like pager for example.. :)
getLink
in file DataObject.php, method DB_DataObject::getLink()
    deprecited : @use link()
getLinkArray
in file DataObject.php, method DB_DataObject::getLinkArray()
    getLinkArray Fetch an array of related objects. This should be used in conjunction with a <dbname>.links.ini file configuration (see the introduction on linking for details on this).
getLinks
in file DataObject.php, method DB_DataObject::getLinks()
    load related objects
groupBy
in file DataObject.php, method DB_DataObject::groupBy()
    Adds a group by condition
top

h

$hour
in file Cast.php, variable DB_DataObject_Cast::$hour
    Data For time representation ** does not handle timezones!!
having
in file DataObject.php, method DB_DataObject::having()
    Adds a having clause
top

i

insert
in file DataObject.php, method DB_DataObject::insert()
    Insert the current objects variables into the database
top

j

joinAdd
in file DataObject.php, method DB_DataObject::joinAdd()
    joinAdd - adds another dataobject to this, building a joined query.
top

k

keys
in file DataObject.php, method DB_DataObject::keys()
    get/set an array of table primary keys
top

l

limit
in file DataObject.php, method DB_DataObject::limit()
    Sets the Limit
link
in file DataObject.php, method DB_DataObject::link()
    generic getter/setter for links
links
in file DataObject.php, method DB_DataObject::links()
    Get the links associate array as defined by the links.ini file.
top

m

$minute
in file Cast.php, variable DB_DataObject_Cast::$minute
$month
in file Cast.php, variable DB_DataObject_Cast::$month
top

n

$N
in file DataObject.php, variable DB_DataObject::$N
    The Number of rows returned from a query
top

o

orderBy
in file DataObject.php, method DB_DataObject::orderBy()
    Adds a order by condition
top

p

pid
in file DataObject.php, method DB_DataObject::pid()
    Get the value of the primary id
top

q

query
in file DataObject.php, method DB_DataObject::query()
    sends raw query to database
top

r

raiseError
in file DataObject.php, method DB_DataObject::raiseError()
    Default error handling is to create a pear error, but never return it.
top

s

$second
in file Cast.php, variable DB_DataObject_Cast::$second
selectAdd
in file DataObject.php, method DB_DataObject::selectAdd()
    Adds a select columns
selectAs
in file DataObject.php, method DB_DataObject::selectAs()
    Adds multiple Columns or objects to select with formating.
sequenceKey
in file DataObject.php, method DB_DataObject::sequenceKey()
    get/set an sequence key
setFrom
in file DataObject.php, method DB_DataObject::setFrom()
    Copies items that are in the table definitions from an array or object into the current object will not override key values.
sql
in file Cast.php, method DB_DataObject_Cast::sql()
    SQL constructor (for raw SQL insert)
sqlValue
in file DataObject.php, method DB_DataObject::sqlValue()
    Factory method for calling DB_DataObject_Cast
staticGet
in file DataObject.php, method DB_DataObject::staticGet()
    (deprecated - use ::get / and your own caching method)
string
in file Cast.php, method DB_DataObject_Cast::string()
    String consructor (actually use if for ints and everything else!!!
top

t

$type
in file Cast.php, variable DB_DataObject_Cast::$type
    Type of data Stored in the object..
table
in file DataObject.php, method DB_DataObject::table()
    get/set an associative array of table columns
tableName
in file DataObject.php, method DB_DataObject::tableName()
    Return or assign the name of the current table
time
in file Cast.php, method DB_DataObject_Cast::time()
    time Constructor
toArray
in file DataObject.php, method DB_DataObject::toArray()
    Returns an associative array from the current data (kind of oblivates the idea behind DataObjects, but is usefull if you use it with things like QuickForms.
toString
in file Cast.php, method DB_DataObject_Cast::toString()
    get the string to use in the SQL statement for this...
toStringFromBlob
in file Cast.php, method DB_DataObject_Cast::toStringFromBlob()
    get the string to use in the SQL statement from a blob of binary data ** Suppots only blob->postgres::bytea
toStringFromDate
in file Cast.php, method DB_DataObject_Cast::toStringFromDate()
    get the string to use in the SQL statement for a date
toStringFromDateTime
in file Cast.php, method DB_DataObject_Cast::toStringFromDateTime()
    get the string to use in the SQL statement for a datetime
toStringFromSql
in file Cast.php, method DB_DataObject_Cast::toStringFromSql()
    get the string to use in the SQL statement for a raw sql statement.
toStringFromString
in file Cast.php, method DB_DataObject_Cast::toStringFromString()
    get the string to use in the SQL statement for a blob from a string! ** Suppots only string->postgres::bytea
toStringFromTime
in file Cast.php, method DB_DataObject_Cast::toStringFromTime()
    get the string to use in the SQL statement for a time
toValue
in file DataObject.php, method DB_DataObject::toValue()
    standard get* implementation.
top

u

unionAdd
in file DataObject.php, method DB_DataObject::unionAdd()
    unionAdd - adds another dataobject to this, building a unioned query.
update
in file DataObject.php, method DB_DataObject::update()
    Updates current objects variables into the database uses the keys() to decide how to update Returns the true on success
useIndex
in file DataObject.php, method DB_DataObject::useIndex()
    Adds a using Index
top

v

$value
in file Cast.php, variable DB_DataObject_Cast::$value
    Generic Data..
validate
in file DataObject.php, method DB_DataObject::validate()
    validate the values of the object (usually prior to inserting/updating..)
top

w

whereAdd
in file DataObject.php, method DB_DataObject::whereAdd()
    Adds a condition to the WHERE statement, defaults to AND
whereAddIn
in file DataObject.php, method DB_DataObject::whereAddIn()
    Adds a 'IN' condition to the WHERE statement
top

y

$year
in file Cast.php, variable DB_DataObject_Cast::$year
top

Documentation generated on Mon, 11 Mar 2019 16:03:56 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.