MongoDbConnection

MongoDbConnection

This is a MongoDbConnection component that used for connect to mongoDb database

Usage: in config file in "components" array, insert following:

'mongodb'=>[ 'class'=>'path.to.mongo.Mongo.Connection.MongoDbConnection', 'host'=>'localhost', 'user'=>'mongo_user', 'password'=>'mongo_password', 'db'=>'my_db_name', ],

• Class name: MongoDbConnection
• Namespace:
• Parent class: CApplicationComponent

Properties

$dbConnection

private \MongoClient $dbConnection

• Visibility: private

$db

private string $db

• Visibility: private

$user

private string $user

• Visibility: private

$password

private string $password

• Visibility: private

$port

private integer $port = 27017

• Visibility: private

$host

private string $host = 'localhost'

• Visibility: private

$driverOptions

private array $driverOptions = array()

Driver options

• Visibility: private

$options

private array $options = array('connect' => true)

Basic options

• Visibility: private

Methods

getDb

\MongoDB MongoDbConnection::getDb()

• Visibility: public

setDb

mixed MongoDbConnection::setDb(string $dbName)

• Visibility: public

Arguments

• $dbName string

getConnection

\MongoClient MongoDbConnection::getConnection()

• Visibility: public

buildConnectionString

string MongoDbConnection::buildConnectionString()

• Visibility: private

buildAnonymousConnectionString

string MongoDbConnection::buildAnonymousConnectionString()

• Visibility: private

init

mixed MongoDbConnection::init()

• Visibility: public

getUser

string MongoDbConnection::getUser()

• Visibility: public

setUser

mixed MongoDbConnection::setUser(string $config)

• Visibility: public

Arguments

• $config string - <p>Username</p>

getPassword

string MongoDbConnection::getPassword()

• Visibility: public

setPassword

mixed MongoDbConnection::setPassword(string $config)

• Visibility: public

Arguments

• $config string

getHost

string MongoDbConnection::getHost()

• Visibility: public

setHost

mixed MongoDbConnection::setHost(string $config)

• Visibility: public

Arguments

• $config string

getPort

integer MongoDbConnection::getPort()

• Visibility: public

setPort

mixed MongoDbConnection::setPort(integer $port)

• Visibility: public

Arguments

• $port integer

setOptions

mixed MongoDbConnection::setOptions(array $options)

• Visibility: public

Arguments

• $options array

setDriverOptions

mixed MongoDbConnection::setDriverOptions(array $driverOptions)

• Visibility: public

Arguments

• $driverOptions array