Application/Resource/Multidb.php

Show:

inherited

Classes
- \Zend_Application_Resource_Multidb

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Application
Subpackage: Resource
Version: $Id: Multidb.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Application_Resource_Multidb
jump to top

Package: Zend\Application\Resource

Cache Manager resource

Example configuration:

  resources.multidb.defaultMetadataCache = "database"

  resources.multidb.db1.adapter = "pdo_mysql"
  resources.multidb.db1.host = "localhost"
  resources.multidb.db1.username = "webuser"
  resources.multidb.db1.password = "XXXX"
  resources.multidb.db1.dbname = "db1"
  resources.multidb.db1.default = true

  resources.multidb.db2.adapter = "pdo_pgsql"
  resources.multidb.db2.host = "example.com"
  resources.multidb.db2.username = "dba"
  resources.multidb.db2.password = "notthatpublic"
  resources.multidb.db2.dbname = "db2"

Parent(s): \Zend_Application_Resource_ResourceAbstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Application_Bootstrap_Bootstrapper $_bootstrap =

inherited

Parent bootstrap

Inherited from: \Zend_Application_Resource_ResourceAbstract::$$_bootstrap

Details

Type: \Zend_Application_Bootstrap_Bootstrapper
Inherited_from: \Zend_Application_Resource_ResourceAbstract::$$_bootstrap

array $_dbs = array()

Associative array containing all configured db's

Default valuearray()Details

Type: array

null|\Zend_Db_Adapter_Abstract $_defaultDb =

An instance of the default db, if set

Details

Type: null | \Zend_Db_Adapter_Abstract

array $_options = array()

inherited

Options for the resource

Inherited from: \Zend_Application_Resource_ResourceAbstract::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Application_Resource_ResourceAbstract::$$_options

array $_skipOptions = array('options', 'config')

inherited

Option keys to skip when calling setOptions()

Inherited from: \Zend_Application_Resource_ResourceAbstract::$$_skipOptions

Default valuearray('options', 'config')Details

Type: array
Inherited_from: \Zend_Application_Resource_ResourceAbstract::$$_skipOptions

Methods

__construct(mixed $options = null) : void

inherited

Create a instance with options

Inherited from: \Zend_Application_Resource_ResourceAbstract::__construct()

Must take an optional single argument, $options.

Parameters

Name	Type	Description
$options	mixed

_setDefault( $adapter) : void

Set the default db adapter

Parameters

Name	Type	Description
$adapter

Details

: \Zend_Db_Adapter_Abstract
Adapter to set as default

_setDefaultMetadataCache(string | \Zend_Cache_Core $cache) : \Zend_Application_Resource_Multidb

Set the default metadata cache

Parameters

Name	Type	Description
$cache	string \| \Zend_Cache_Core

Returns

Type	Description
\Zend_Application_Resource_Multidb

getBootstrap() : null | \Zend_Application_Bootstrap_Bootstrapper

inherited

Retrieve the bootstrap to which the resource is attached

Inherited from: \Zend_Application_Resource_ResourceAbstract::getBootstrap()

Returns

Type	Description
null \| \Zend_Application_Bootstrap_Bootstrapper

getDb(null | string | \Zend_Db_Adapter_Abstract $db = null) : \Zend_Db_Adapter_Abstract

Retrieve the specified database connection

Parameters

Name	Type	Description
$db	null \| string \| \Zend_Db_Adapter_Abstract	The adapter to retrieve. Null to retrieve the default connection

Returns

Type	Description
\Zend_Db_Adapter_Abstract

Throws

Exception	Description
\Zend_Application_Resource_Exception	if the given parameter could not be found

getDefaultDb(boolean $justPickOne = true) : null | \Zend_Db_Adapter_Abstract

Get the default db connection

Parameters

Name	Type	Description
$justPickOne	boolean	If true, a random (the first one in the stack) connection is returned if no default was set. If false, null is returned if no default was set.

Returns

Type	Description
null \| \Zend_Db_Adapter_Abstract

getOptions() : array

inherited

Retrieve resource options

Inherited from: \Zend_Application_Resource_ResourceAbstract::getOptions()

Returns

Type	Description
array

init() : \Zend_Application_Resource_Multidb

Initialize the Database Connections (instances of Zend_Db_Table_Abstract)

Returns

Type	Description
\Zend_Application_Resource_Multidb

isDefault(string | \Zend_Db_Adapter_Abstract $db) : boolean

Determine if the given db(identifier) is the default db.

Parameters

Name	Type	Description
$db	string \| \Zend_Db_Adapter_Abstract	The db to determine whether it's set as default

Returns

Type	Description
boolean	True if the given parameter is configured as default. False otherwise

mergeOptions(array $array1, mixed $array2 = null) : array

inherited

Merge options recursively

Inherited from: \Zend_Application_Resource_ResourceAbstract::mergeOptions()

Parameters

Name	Type	Description
$array1	array
$array2	mixed

Returns

Type	Description
array

setBootstrap(\Zend_Application_Bootstrap_Bootstrapper $bootstrap) : \Zend_Application_Resource_Resource

inherited

Set the bootstrap to which the resource is attached

Inherited from: \Zend_Application_Resource_ResourceAbstract::setBootstrap()

Parameters

Name	Type	Description
$bootstrap	\Zend_Application_Bootstrap_Bootstrapper

Returns

Type	Description
\Zend_Application_Resource_Resource

setOptions(array $options) : \Zend_Application_Resource_ResourceAbstract

inherited

Set options from array

Inherited from: \Zend_Application_Resource_ResourceAbstract::setOptions()

Parameters

Name	Type	Description
$options	array	Configuration for resource

Returns

Type	Description
\Zend_Application_Resource_ResourceAbstract

Application/Resource/Multidb.php

\Zend_Application_Resource_Multidbjump to top

Properties

Methods

\Zend_Application_Resource_Multidb
jump to top