Docs For Class xPDOManager

Description

Provides data source management for an xPDO instance.

These are utility functions that only need to be loaded under special circumstances, such as creating tables, adding indexes, altering table structures, etc. xPDOManager class implementations are specific to a database driver and should include this base class in order to extend it.

abstract:
usedby: xPDO::getManager()

Located in /om/xpdomanager.class.php (line 40)

Direct descendents

Class	Description
xPDOManager_mysql	Provides MySQL data source management for an xPDO instance.
xPDOManager_sqlite	Provides SQLite data source management for an xPDO instance.
xPDOManager_sqlsrv	Provides sqlsrv data source management for an xPDO instance.

Variable Summary

xPDOGenerator $generator

xPDOTransport $transport

xPDO $xpdo

Method Summary

xPDOManager __construct ( &$xpdo, object $xpdo)

boolean createObjectContainer (string $className)

boolean createSourceContainer ([array $dsnArray = null], [string $username = null], [string $password = null], [array $containerOptions = array ()])

xPDOGenerator getGenerator ()

void getTransport ()

boolean removeObjectContainer (string $className)

boolean removeSourceContainer ([ $dsnArray = null], [string $username = null], [string $password = null], string $dsn)

Variables

xPDOGenerator $generator = null (line 50)

var: The generator class for forward and reverse engineering tasks (loaded only on demand).
access: public

xPDOTransport $transport = null (line 54)

var: The data transport class for migrating data.
access: public

xPDO $xpdo = null (line 45)

var: A reference to the XPDO instance using this manager.
access: public

Methods

Constructor __construct (line 61)

Get a xPDOManager instance.

access: public

xPDOManager __construct ( &$xpdo, object $xpdo)

object $xpdo: A reference to a specific modDataSource instance.
&$xpdo

createObjectContainer (line 96)

Creates the container for a persistent data object.

A source container is a synonym for a database table.

return: Returns true on successful creation, false on failure.
abstract:
access: public

boolean createObjectContainer (string $className)

string $className: The class of object to create a source container for.

Redefined in descendants as:

createSourceContainer (line 76)

Creates the physical data container represented by a data source.

return: True if the database is created successfully or already exists.
abstract:
access: public

boolean createSourceContainer ([array $dsnArray = null], [string $username = null], [string $password = null], [array $containerOptions = array ()])

array $dsnArray: An array of xPDO configuration properties.
string $username: Database username with privileges to create tables.
string $password: Database user password.
array $containerOptions: An array of options for controlling the creation of the container.

Redefined in descendants as:

getGenerator (line 111)

Gets an XML schema parser / generator for this manager instance.

return: A generator class for this manager.
access: public

xPDOGenerator getGenerator ()

getTransport (line 128)

Gets a data transport mechanism for this xPDOManager instance.

access: public

void getTransport ()

removeObjectContainer (line 104)

Drops a table, if it exists.

return: Returns true on successful drop, false on failure.
abstract:
access: public

boolean removeObjectContainer (string $className)

string $className: The object table to drop.

Redefined in descendants as:

removeSourceContainer (line 86)

Drops a physical data container, if it exists.

return: Returns true on successful drop, false on failure.
abstract:
access: public

boolean removeSourceContainer ([ $dsnArray = null], [string $username = null], [string $password = null], string $dsn)

string $dsn: Represents the database connection string.
string $username: Database username with privileges to drop tables.
string $password: Database user password.
$dsnArray

Redefined in descendants as: