PHP Класс Doctrine\MongoDB\Connection

См. ссылку: www.doctrine-project.org
С версии: 1.0
Автор: Jonathan H. Wage ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$config Doctrine\MongoDB\Configuration The Configuration for this connection.
$driverOptions array Driver options used to construct the MongoClient instance (optional).
$eventManager Doctrine\Common\EventManager The EventManager used to dispatch events.
$mongoClient MongoClient The PHP MongoClient instance being wrapped.
$options array Options used to construct the MongoClient instance (optional).
$server string Server string used to construct the MongoClient instance (optional).

Открытые методы

Метод Описание
__construct ( string | MongoClient $server = null, array $options = [], Doctrine\MongoDB\Configuration $config = null, Doctrine\Common\EventManager $evm = null, array $driverOptions = [] ) Constructor.
__get ( string $database ) : MongoDB Wrapper method for MongoClient::__get().
__toString ( ) : string Wrapper method for MongoClient::__toString().
close ( ) : boolean Wrapper method for MongoClient::close().
connect ( ) : boolean Wrapper method for MongoClient::connect().
dropDatabase ( string $database ) : array Wrapper method for MongoClient::dropDB().
getConfiguration ( ) : Doctrine\MongoDB\Configuration Get the Configuration used by this Connection.
getEventManager ( ) : Doctrine\Common\EventManager Get the EventManager used by this Connection.
getMongo ( ) : MongoClient Get the MongoClient instance being wrapped.
getMongoClient ( ) : MongoClient Get the MongoClient instance being wrapped.
getReadPreference ( ) : array Wrapper method for MongoClient::getReadPreference().
getServer ( ) : string | null Get the server string.
getStatus ( ) : string Gets the $status property of the wrapped MongoClient instance.
initialize ( ) Construct the wrapped MongoClient instance if necessary.
isConnected ( ) : boolean Checks whether the connection is initialized and connected.
listDatabases ( ) : array Wrapper method for MongoClient::listDBs().
log ( array $log ) Log something using the configured logger callable (if available).
selectCollection ( string $db, string $collection ) : Doctrine\MongoDB\Collection Wrapper method for MongoClient::selectCollection().
selectDatabase ( string $name ) : Doctrine\MongoDB\Database Wrapper method for MongoClient::selectDatabase().
setMongo ( MongoClient $mongoClient ) Set the MongoClient instance to wrap.
setReadPreference ( string $readPreference, array $tags = null ) : boolean Wrapper method for MongoClient::setReadPreference().

Защищенные методы

Метод Описание
convertConnectTimeout ( array $options ) : array Converts "timeout" MongoClient constructor option to "connectTimeoutMS" for driver versions 1.4.0+.
convertWriteTimeout ( array $options ) : array Converts "wTimeout" MongoClient constructor option to "wTimeoutMS" for driver versions 1.4.0+.
doSelectDatabase ( string $name ) : Doctrine\MongoDB\Database Return a new Database instance.
retry ( Closure $retry ) : mixed Conditionally retry a closure if it yields an exception.

Описание методов

__construct() публичный Метод

If $server is an existing MongoClient instance, the $options parameter will not be used.
public __construct ( string | MongoClient $server = null, array $options = [], Doctrine\MongoDB\Configuration $config = null, Doctrine\Common\EventManager $evm = null, array $driverOptions = [] )
$server string | MongoClient Server string or MongoClient instance
$options array MongoClient constructor options
$config Doctrine\MongoDB\Configuration Configuration instance
$evm Doctrine\Common\EventManager EventManager instance
$driverOptions array MongoClient constructor options

__get() публичный Метод

Wrapper method for MongoClient::__get().
См. также: http://php.net/manual/en/mongoclient.get.php
public __get ( string $database ) : MongoDB
$database string
Результат MongoDB

__toString() публичный Метод

Wrapper method for MongoClient::__toString().
См. также: http://php.net/manual/en/mongoclient.tostring.php
public __toString ( ) : string
Результат string

close() публичный Метод

Wrapper method for MongoClient::close().
См. также: http://php.net/manual/en/mongoclient.close.php
public close ( ) : boolean
Результат boolean

connect() публичный Метод

Wrapper method for MongoClient::connect().
См. также: http://php.net/manual/en/mongoclient.connect.php
public connect ( ) : boolean
Результат boolean

convertConnectTimeout() защищенный Метод

Note: MongoClient actually allows case-insensitive option names, but we'll only process the canonical version here.
protected convertConnectTimeout ( array $options ) : array
$options array
Результат array

convertWriteTimeout() защищенный Метод

Note: MongoClient actually allows case-insensitive option names, but we'll only process the canonical version here.
protected convertWriteTimeout ( array $options ) : array
$options array
Результат array

doSelectDatabase() защищенный Метод

If a logger callable was defined, a LoggableDatabase will be returned.
См. также: Connection::selectDatabase()
protected doSelectDatabase ( string $name ) : Doctrine\MongoDB\Database
$name string
Результат Doctrine\MongoDB\Database

dropDatabase() публичный Метод

This method will dispatch preDropDatabase and postDropDatabase events.
См. также: http://php.net/manual/en/mongoclient.dropdb.php
public dropDatabase ( string $database ) : array
$database string
Результат array

getConfiguration() публичный Метод

Get the Configuration used by this Connection.
public getConfiguration ( ) : Doctrine\MongoDB\Configuration
Результат Doctrine\MongoDB\Configuration

getEventManager() публичный Метод

Get the EventManager used by this Connection.
public getEventManager ( ) : Doctrine\Common\EventManager
Результат Doctrine\Common\EventManager

getMongo() публичный Метод

Get the MongoClient instance being wrapped.
Устаревший: 1.1 Replaced by getMongoClient(); will be removed for 2.0
public getMongo ( ) : MongoClient
Результат MongoClient

getMongoClient() публичный Метод

Get the MongoClient instance being wrapped.
public getMongoClient ( ) : MongoClient
Результат MongoClient

getReadPreference() публичный Метод

For driver versions between 1.3.0 and 1.3.3, the return value will be converted for consistency with {@link Connection::setReadPreference()}.
См. также: http://php.net/manual/en/mongoclient.getreadpreference.php
public getReadPreference ( ) : array
Результат array

getServer() публичный Метод

Get the server string.
public getServer ( ) : string | null
Результат string | null

getStatus() публичный Метод

Gets the $status property of the wrapped MongoClient instance.
Устаревший: 1.1 No longer used in driver; Will be removed for 1.2
public getStatus ( ) : string
Результат string

initialize() публичный Метод

This method will dispatch preConnect and postConnect events.
public initialize ( )

isConnected() публичный Метод

Checks whether the connection is initialized and connected.
public isConnected ( ) : boolean
Результат boolean

listDatabases() публичный Метод

Wrapper method for MongoClient::listDBs().
См. также: http://php.net/manual/en/mongoclient.listdbs.php
public listDatabases ( ) : array
Результат array

log() публичный Метод

Log something using the configured logger callable (if available).
public log ( array $log )
$log array

retry() защищенный Метод

If the closure does not return successfully within the configured number of retries, its first exception will be thrown.
protected retry ( Closure $retry ) : mixed
$retry Closure
Результат mixed

selectCollection() публичный Метод

Wrapper method for MongoClient::selectCollection().
См. также: http://php.net/manual/en/mongoclient.selectcollection.php
public selectCollection ( string $db, string $collection ) : Doctrine\MongoDB\Collection
$db string
$collection string
Результат Doctrine\MongoDB\Collection

selectDatabase() публичный Метод

This method will dispatch preSelectDatabase and postSelectDatabase events.
См. также: http://php.net/manual/en/mongoclient.selectdatabase.php
public selectDatabase ( string $name ) : Doctrine\MongoDB\Database
$name string
Результат Doctrine\MongoDB\Database

setMongo() публичный Метод

Set the MongoClient instance to wrap.
Устаревший: 1.1 Will be removed for 2.0
public setMongo ( MongoClient $mongoClient )
$mongoClient MongoClient

setReadPreference() публичный Метод

Wrapper method for MongoClient::setReadPreference().
См. также: http://php.net/manual/en/mongoclient.setreadpreference.php
public setReadPreference ( string $readPreference, array $tags = null ) : boolean
$readPreference string
$tags array
Результат boolean

Описание свойств

$config защищенное свойство

The Configuration for this connection.
protected Configuration,Doctrine\MongoDB $config
Результат Doctrine\MongoDB\Configuration

$driverOptions защищенное свойство

Driver options used to construct the MongoClient instance (optional).
protected array $driverOptions
Результат array

$eventManager защищенное свойство

The EventManager used to dispatch events.
protected EventManager,Doctrine\Common $eventManager
Результат Doctrine\Common\EventManager

$mongoClient защищенное свойство

The PHP MongoClient instance being wrapped.
protected MongoClient $mongoClient
Результат MongoClient

$options защищенное свойство

Options used to construct the MongoClient instance (optional).
protected array $options
Результат array

$server защищенное свойство

Server string used to construct the MongoClient instance (optional).
protected string $server
Результат string