DB

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

Packages:
DB

Classes:

DB
DB_common
DB_dbase
DB_Error
DB_fbsql
DB_ibase
DB_ifx
DB_msql
DB_mssql
DB_mysql
DB_mysqli
DB_oci8
DB_odbc
DB_pgsql
DB_result
DB_row
DB_sqlite
DB_storage
DB_sybase

Files:

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

Class: DB_storage

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

Class Overview

PEAR
 |
 --DB_storage

Provides an object interface to a table row

Author(s):

Stig Bakken <stig at php.net>

Version:

Release: 1.9.2

Copyright:

1997-2007 The PHP Group

Inherited Variables

Inherited Methods

Class Details

[line 44]
Provides an object interface to a table row

It lets you add, delete and change rows using objects rather than SQL statements.

Author: Stig Bakken <stig@php.net>
Version: Release: 1.9.2
Copyright: 1997-2007 The PHP Group
Link: http://pear.php.net/package/DB
License: PHP License 3.0

[ Top ]

Method Detail

__construct (Constructor) [line 97]

DB_storage __construct(
$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 428]

void _DB_storage(
)

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

[ Top ]

create [line 293]

object a &create(
$data
$table, 
&$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

&$data —

[ Top ]

dump [line 275]

void dump(
)

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

[ Top ]

get [line 411]

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 197]

void insert(
$newpk)

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

Parameters:

$newpk —

[ Top ]

remove [line 476]

mixed remove(
)

Remove the row represented by this object from the database.

Return: DB_OK or a DB error

[ Top ]

set [line 362]

void set(
$property, 
$newvalue)

Modify an attriute value.

Parameters:

$property —

$newvalue —

[ Top ]

setup [line 167]

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 446]

DB_OK store(
)

Stores changes to this object in the database.

Return: or a DB error

[ Top ]

toString [line 228]

string toString(
)

Output a simple description of this DB_storage object.

Return: object description

[ Top ]