[ Index ]
 

Code source de dotProject 2.1 RC1

Accédez au Source d'autres logiciels libres | Soutenez Angelica Josefina !

title

Body

[fermer]

/classes/ -> dp.class.php (summary)

(pas de description)

Version: $Revision: 1.25.6.6 $
Poids: 423 lignes (12 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

CDpObject:: (16 méthodes):
  CDpObject()
  getError()
  bind()
  load()
  loadAll()
  getQuery()
  check()
  duplicate()
  dPTrimAll()
  store()
  canDelete()
  delete()
  getDeniedRecords()
  getAllowedRecords()
  getAllowedSQL()
  setAllowedSQL()


Classe: CDpObject  - X-Ref

CDpObject Abstract Class.

Parent class to all database table derived objects
CDpObject( $table, $key )   X-Ref
Object constructor to set table and key field

Can be overloaded/supplemented by the child class
param: string $table name of the table in the db schema relating to child class
param: string $key name of the primary key field in the table

getError()   X-Ref

return: string Returns the error message

bind( $hash )   X-Ref
Binds a named array/hash to this object

can be overloaded/supplemented by the child class
param: array $hash named array
return: null|string    null is operation was satisfactory, otherwise returns an error

load( $oid=null , $strip = true)   X-Ref
Binds an array/hash to this object

param: int $oid optional argument, if not specifed then the value of current key is used
return: any result from the database operation

loadAll($order = null, $where = null)   X-Ref
Returns an array, keyed by the key field, of all elements that meet
the where clause provided. Ordered by $order key.


getQuery($alias = null)   X-Ref
Return a DBQuery object seeded with the table name.

param: string $alias optional alias for table queries.
return: DBQuery object

check()   X-Ref
Generic check method

Can be overloaded/supplemented by the child class
return: null if the object is ok

duplicate()   X-Ref
Clone the current record

author: handco <handco@users.sourceforge.net>
return: object    The new record object or null if error

dPTrimAll()   X-Ref
Default trimming method for class variables of type string

param: object Object to trim class variables for
return: none

store( $updateNulls = false )   X-Ref
Inserts a new row if id is zero or updates an existing row in the database table

Can be overloaded/supplemented by the child class
return: null|string null if successful otherwise returns and error message

canDelete( &$msg, $oid=null, $joins=null )   X-Ref
Generic check for whether dependencies exist for this object in the db schema

Can be overloaded/supplemented by the child class
param: string $msg Error message returned
param: int Optional key index
param: array Optional array to compiles standard joins: format [label=>'Label',name=>'table name',idfield=>'field',joinfield=>'field']
return: true|false

delete( $oid=null )   X-Ref
Default delete method

Can be overloaded/supplemented by the child class
return: null|string null if successful otherwise returns and error message

getDeniedRecords( $uid )   X-Ref
Get specifically denied records from a table/module based on a user

param: int User id number
return: array

getAllowedRecords( $uid, $fields='*', $orderby='', $index=null, $extra=null )   X-Ref
Returns a list of records exposed to the user

param: int User id number
param: string Optional fields to be returned by the query, default is all
param: string Optional sort order for the query
param: string Optional name of field to index the returned array
param: array Optional array of additional sql parameters (from and where supported)
return: array

getAllowedSQL( $uid, $index = null )   X-Ref
Pas de description

setAllowedSQL($uid, &$query, $index = null, $key = null)   X-Ref
Pas de description



Généré le : Sun Feb 18 19:46:52 2007 par Balluche grâce à PHPXref 0.7