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


Files:
common.php
DB.php
dbase.php
fbsql.php
ibase.php
ifx.php
msql.php
mssql.php
mysql.php
oci8.php
odbc.php
pgsql.php
storage.php
sybase.php

Classes:
DB
DB_Error
DB_result
DB_storage

Class: DB_storage

Source Location: /DB-1.4.0/DB/storage.php

Class Overview

PEAR
   |
   --DB_storage

DB_storage provides an object interface to a table row. It lets you add, delete and change rows without using SQL.


Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

[line 36]
DB_storage provides an object interface to a table row. It lets you add, delete and change rows without using SQL.


[ Top ]

Method Detail

DB_storage (Constructor)   [line 89]

DB_storage DB_storage( $table $table, $keycolumn $keycolumn, $dbh &$dbh, [$validator $validator = null])

Constructor

Parameters:

$table   $table   —   string the name of the database table
$keycolumn   $keycolumn   —   mixed string with name of key column, or array of strings if the table has a primary key of more than one column
$dbh   &$dbh   —   object database connection object
$validator   $validator   —   mixed function or method used to validate each new value, called with three parameters: the name of the field/column that is changing, a reference to the new value and a reference to this object

[ Top ]

_DB_storage (Destructor)   [line 418]

void _DB_storage( )

Destructor, calls DB_storage::store() if there are changes that are to be kept.

[ Top ]

create   [line 287]

object a &create( $data $table, mixed &$data)

Static method used to create new DB storage objects.
  • Return: new instance of DB_storage or a subclass of it

Parameters:

$data   $table   —   assoc. array where the keys are the names of properties/columns

[ Top ]

dump   [line 268]

void dump( )

Dump the contents of this object to "standard output".

[ Top ]

get   [line 402]

attribute &get( string $property)

Fetch an attribute value.
  • Return: contents, or null if the attribute name is unknown

Parameters:

string   $property   —   attribute name

[ Top ]

insert   [line 190]

void insert( mixed $newpk)

Create a new (empty) row in the configured table for this object.

[ Top ]

remove   [line 464]

mixed remove( )

Remove the row represented by this object from the database.
  • Return: DB_OK or a DB error

[ Top ]

set   [line 357]

void set( mixed $property, mixed $newvalue)

Modify an attriute value.

[ Top ]

setup   [line 159]

int setup( $keyval $keyval)

Method used to initialize a DB_storage object from the configured table.
  • Return: DB_OK on success, a DB error if not

Parameters:

$keyval   $keyval   —   mixed the key[s] of the row to fetch (string or array)

[ Top ]

store   [line 436]

DB_OK store( )

Stores changes to this object in the database.
  • Return: or a DB error

[ Top ]

toString   [line 221]

string toString( )

Output a simple description of this DB_storage object.
  • Return: object description

[ Top ]
Documentation generated on Fri, 30 Apr 2004 23:19:50 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.