Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

215 lines (194 sloc) 5.728 kb
<?php
/**
* EMongoDB.php
*
* PHP version 5.2+
*
* @author Dariusz Górecki <darek.krk@gmail.com>
* @author Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
* @copyright 2010 CleverIT http://www.cleverit.com.pl
* @license http://www.yiiframework.com/license/ BSD license
* @version 1.3
* @category ext
* @package ext.YiiMongoDbSuite
*
*/
/**
* EMongoDB
*
* This is merge work of tyohan, Alexander Makarov and mine
*/
class EMongoDB extends CApplicationComponent
{
/**
* @var string host:port
*
* Correct syntax is:
* mongodb://[username:password@]host1[:port1][,host2[:port2:],...]
*
* @example mongodb://localhost:27017
*/
public $connectionString;
/**
* @var boolean $autoConnect whether the Mongo connection should be automatically established when
* the component is being initialized. Defaults to true. Note, this property is only
* effective when the EMongoDB object is used as an application component.
*/
public $autoConnect = true;
/**
* @var false|string $persistentConnection false for non-persistent connection, string for persistent connection id to use
*/
public $persistentConnection = false;
/**
* @var string $dbName name of the Mongo database to use
*/
public $dbName = null;
/**
* @var MongoDB $_mongoDb instance of MongoDB driver
*/
private $_mongoDb;
/**
* @var Mongo $_mongoConnection instance of MongoDB driver
*/
private $_mongoConnection;
/**
* If set to TRUE all internal DB operations will use FSYNC flag with data modification requests,
* in other words, all write operations will have to wait for a disc sync!
*
* MongoDB default value for this flag is: FALSE.
*
* @var boolean $fsyncFlag state of FSYNC flag to use with internal connections (global scope)
*/
public $fsyncFlag = false;
/**
* If set to TRUE all internal DB operations will use SAFE flag with data modification requests.
*
* When SAFE flag is set to TRUE driver will wait for the response from DB, and throw an exception
* if something went wrong, is fet to false, driver will only send operation to DB but will not wait
* for response from DB.
*
* MongoDB default value for this flag is: FALSE.
*
* @var boolean $safeFlag state of SAFE flag (global scope)
*/
public $safeFlag = false;
/**
* If set to TRUE findAll* methods of models, will return {@see EMongoCursor} instead of
* raw array of models.
*
* Generally you should want to have this set to TRUE as cursor use lazy-loading/instaninating of
* models, this is set to FALSE, by default to keep backwards compatibility.
*
* Note: {@see EMongoCursor} does not implement ArrayAccess interface and cannot be used like an array,
* because offset access to cursor is highly ineffective and pointless.
*
* @var boolean $useCursor state of Use Cursor flag (global scope)
*/
public $useCursor = false;
/**
* Storage location for temporary files used by the GridFS Feature.
* If set to null, component will not use temporary storage
* @var string $gridFStemporaryFolder
*/
public $gridFStemporaryFolder = null;
/**
* Connect to DB if connection is already connected this method doeas nothing
*/
public function connect()
{
if(!$this->getConnection()->connected)
return $this->getConnection()->connect();
}
/**
* Returns Mongo connection instance if not exists will create new
*
* @return Mongo
* @throws EMongoException
*/
public function getConnection()
{
if($this->_mongoConnection === null)
{
try
{
Yii::trace('Opening MongoDB connection', 'ext.MongoDb.EMongoDB');
if(empty($this->connectionString))
throw new EMongoException(Yii::t('yii', 'EMongoDB.connectionString cannot be empty.'));
if($this->persistentConnection !== false)
$this->_mongoConnection = new Mongo($this->connectionString, array(
'connect'=>$this->autoConnect,
'persist'=>$this->persistentConnection
));
else
$this->_mongoConnection = new Mongo($this->connectionString, array(
'connect'=>$this->autoConnect,
));
return $this->_mongoConnection;
}
catch(MongoConnectionException $e)
{
throw new EMongoException(Yii::t(
'yii',
'EMongoDB failed to open connection: {error}',
array('{error}'=>$e->getMessage())
), $e->getCode());
}
}
else
return $this->_mongoConnection;
}
/**
* Set the connection
*
* @param Mongo $connection
*/
public function setConnection(Mongo $connection)
{
$this->_mongoConnection = $connection;
}
/**
* Get MongoDB instance
*/
public function getDbInstance()
{
if($this->_mongoDb === null)
return $this->_mongoDb = $this->getConnection()->selectDB($this->dbName);
else
return $this->_mongoDb;
}
/**
* Set MongoDB instance
* Enter description here ...
* @param string $name
*/
public function setDbInstance($name)
{
$this->_mongoDb = $this->getConnection()->selectDb($name);
}
/**
* Closes the currently active Mongo connection.
* It does nothing if the connection is already closed.
*/
protected function close(){
if($this->_mongoConnection!==null){
$this->_mongoConnection->close();
$this->_mongoConnection=null;
Yii::trace('Closing MongoDB connection', 'ext.MongoDb.EMongoDB');
}
}
/**
* If we have don't use presist connection, close it
*/
public function __destruct(){
if(!$this->persistentConnection){
$this->close();
}
}
/**
* Drop the current DB
*/
public function dropDb()
{
$this->getDb()->drop();
}
}
Jump to Line
Something went wrong with that request. Please try again.