Class yii\mongodb\Connection
Inheritance | yii\mongodb\Connection » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-mongodb/blob/master/Connection.php |
Connection represents a connection to a MongoDb server.
Connection works together with yii\mongodb\Database and yii\mongodb\Collection to provide data access to the Mongo database. They are wrappers of the [[MongoDB PHP extension]](https://www.php.net/manual/en/book.mongodb.php).
To establish a DB connection, set $dsn and then call open() to be true.
The following example shows how to create a Connection instance and establish the DB connection:
$connection = new \yii\mongodb\Connection([
'dsn' => $dsn,
]);
$connection->open();
After the Mongo connection is established, one can access Mongo databases and collections:
$database = $connection->getDatabase('my_mongo_db');
$collection = $database->getCollection('customer');
$collection->insert(['name' => 'John Smith', 'status' => 1]);
You can work with several different databases at the same server using this class. However, while it is unlikely your application will actually need it, the Connection class provides ability to use $defaultDatabaseName as well as a shortcut method getCollection() to retrieve a particular collection instance:
// get collection 'customer' from default database:
$collection = $connection->getCollection('customer');
// get collection 'customer' from database 'mydatabase':
$collection = $connection->getCollection(['mydatabase', 'customer']);
Connection is often used as an application component and configured in the application configuration like the following:
[
'components' => [
'mongodb' => [
'class' => '\yii\mongodb\Connection',
'dsn' => 'mongodb://developer:password@localhost:27017/mydatabase',
],
],
]
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
$database | yii\mongodb\Database | Database instance. | yii\mongodb\Connection |
$defaultDatabaseName | string | Default database name. | yii\mongodb\Connection |
$driverOptions | array | Options for the MongoDB driver. | yii\mongodb\Connection |
$dsn | string | Host:port Correct syntax is: mongodb://[username:password@]host1[:port1][,host2[:port2:],...][/dbname] For example: mongodb://localhost:27017 mongodb://developer:password@localhost:27017 mongodb://developer:password@localhost:27017/mydatabase | yii\mongodb\Connection |
$enableLogging | boolean | Whether to log command and query executions. | yii\mongodb\Connection |
$enableProfiling | boolean | Whether to enable profiling the commands and queries being executed. | yii\mongodb\Connection |
$fileCollection | yii\mongodb\file\Collection | Mongo GridFS collection instance. | yii\mongodb\Connection |
$fileStreamProtocol | string | Name of the protocol, which should be used for the GridFS stream wrapper. | yii\mongodb\Connection |
$fileStreamWrapperClass | string | Name of the class, which should serve as a stream wrapper for $fileStreamProtocol protocol. | yii\mongodb\Connection |
$globalExecOptions | array | Default options for executeCommand , executeBulkWrite and executeQuery method of MongoDB\Driver\Manager in Command class. |
yii\mongodb\Connection |
$inSession | yii\mongodb\Connection | ||
$inTransaction | yii\mongodb\Connection | ||
$isActive | boolean | Whether the Mongo connection is established. | yii\mongodb\Connection |
$logBuilder | yii\mongodb\LogBuilder | The log builder for this connection. | yii\mongodb\Connection |
$manager | \MongoDB\Driver\Manager | MongoDB driver manager. | yii\mongodb\Connection |
$options | array | Connection options. | yii\mongodb\Connection |
$queryBuilder | yii\mongodb\QueryBuilder | The query builder for the this MongoDB connection. | yii\mongodb\Connection |
$session | yii\mongodb\ClientSession|null | New instance of ClientSession to replace return $this. | yii\mongodb\Connection |
$typeMap | array | Type map to use for BSON unserialization. | yii\mongodb\Connection |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Component |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of a component property. | yii\base\Component |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
__set() | Sets the value of a component property. | yii\base\Component |
__unset() | Sets a component property to be null. | yii\base\Component |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
close() | Closes the currently active DB connection. | yii\mongodb\Connection |
commitTransaction() | Commits transaction in current session | yii\mongodb\Connection |
createCommand() | Creates MongoDB command. | yii\mongodb\Connection |
detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
execOptions() | Recursive replacement on $this->globalExecOptions with new options. {@see $this->globalExecOptions} | yii\mongodb\Connection |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getCollection() | Returns the MongoDB collection with the given name. | yii\mongodb\Connection |
getDatabase() | Returns the MongoDB database with the given name. | yii\mongodb\Connection |
getDefaultDatabaseName() | Returns default database name, if it is not set, attempts to determine it from $dsn value. | yii\mongodb\Connection |
getFileCollection() | Returns the MongoDB GridFS collection. | yii\mongodb\Connection |
getInSession() | Checks whether the current connection is in session. | yii\mongodb\Connection |
getInTransaction() | Checks that the current connection is in session and transaction return bool | yii\mongodb\Connection |
getIsActive() | Returns a value indicating whether the Mongo connection is established. | yii\mongodb\Connection |
getLogBuilder() | Returns log builder for this connection. | yii\mongodb\Connection |
getQueryBuilder() | Returns the query builder for the this MongoDB connection. | yii\mongodb\Connection |
getSession() | Returns current session return ClientSession|null | yii\mongodb\Connection |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
init() | Initializes the object. | yii\base\BaseObject |
newSession() | Only starts the new session for current connection but this session does not set for current connection. | yii\mongodb\Connection |
noTransaction() | Runs your mongodb command out of session and transaction. | yii\mongodb\Connection |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
open() | Establishes a Mongo connection. | yii\mongodb\Connection |
registerFileStreamWrapper() | Registers GridFS stream wrapper for the $fileStreamProtocol protocol. | yii\mongodb\Connection |
rollBackTransaction() | Rollbacks transaction in current session | yii\mongodb\Connection |
setDefaultDatabaseName() | Sets default database name. | yii\mongodb\Connection |
setLogBuilder() | Sets log builder used for this connection. | yii\mongodb\Connection |
setQueryBuilder() | Sets the query builder for the this MongoDB connection. | yii\mongodb\Connection |
setSession() | Changes the current session of connection to execute commands (or drop session) | yii\mongodb\Connection |
startSession() | Ends the previous session and starts the new session. | yii\mongodb\Connection |
startSessionOnce() | Starts a new session if the session has not started, otherwise returns previous session. | yii\mongodb\Connection |
startTransaction() | Starts a transaction with three steps : - starts new session if has not started - starts the transaction in new session - sets new session to current connection | yii\mongodb\Connection |
startTransactionOnce() | Starts a transaction in current session if the previous transaction was not started in current session. | yii\mongodb\Connection |
transaction() | Starts and commits a transaction in easy mode. | yii\mongodb\Connection |
transactionOnce() | Starts and commits transaction in easy mode if the previous transaction was not executed, otherwise only runs your actions in previous transaction. | yii\mongodb\Connection |
transactionReady() | Throws custom error if transaction is not ready in connection | yii\mongodb\Connection |
trigger() | Triggers an event. | yii\base\Component |
Protected Methods
Method | Description | Defined By |
---|---|---|
initConnection() | Initializes the DB connection. | yii\mongodb\Connection |
selectDatabase() | Selects the database with given name. | yii\mongodb\Connection |
Events
Event | Type | Description | Defined By |
---|---|---|---|
EVENT_AFTER_OPEN | yii\mongodb\Event | An event that is triggered after a DB connection is established | yii\mongodb\Connection |
EVENT_COMMIT_TRANSACTION | yii\base\Event | An event that is triggered right after a transaction is committed | yii\mongodb\Connection |
EVENT_END_SESSION | yii\base\Event | An event that is triggered right after a mongo client session is ended | yii\mongodb\Connection |
EVENT_ROLLBACK_TRANSACTION | yii\base\Event | An event that is triggered right after a transaction is rolled back | yii\mongodb\Connection |
EVENT_START_SESSION | yii\base\Event | An event that is triggered right before a mongo client session is started | yii\mongodb\Connection |
EVENT_START_TRANSACTION | yii\base\Event | An event that is triggered right before a transaction is started | yii\mongodb\Connection |
Property Details
Default database name.
Options for the MongoDB driver. Any driver-specific options not included in MongoDB connection string specification.
See also https://php.net/manual/en/mongodb-driver-manager.construct.php.
Host:port
Correct syntax is: mongodb://[username:password@]host1[:port1][,host2[:port2:],...][/dbname] For example: mongodb://localhost:27017 mongodb://developer:password@localhost:27017 mongodb://developer:password@localhost:27017/mydatabase
Whether to log command and query executions. When enabled this option may reduce performance. MongoDB commands may contain large data, consuming both CPU and memory. It makes sense to disable this option in the production environment.
Whether to enable profiling the commands and queries being executed. This option will have no effect in case $enableLogging is disabled.
Mongo GridFS collection instance.
Name of the protocol, which should be used for the GridFS stream wrapper. Only alphanumeric values are allowed: do not use any URL special characters, such as '/', '&', ':' etc.
See also yii\mongodb\file\StreamWrapper.
Name of the class, which should serve as a stream wrapper for $fileStreamProtocol protocol.
Default options for executeCommand
, executeBulkWrite and executeQuery method of MongoDB\Driver\Manager in Command
class.
'share' => [],
'command' => [],
'bulkWrite' => [],
'query' => [],
]
Whether the Mongo connection is established.
The log builder for this connection. Note that the type of this property differs in getter and setter. See getLogBuilder() and setLogBuilder() for details.
MongoDB driver manager.
Connection options. For example:
[
'socketTimeoutMS' => 1000, // how long a send or receive on a socket can take before timing out
'ssl' => true // initiate the connection with TLS/SSL
]
See also https://docs.mongodb.com/manual/reference/connection-string/#connections-connection-options.
The query builder for the this MongoDB connection. Note that the type of this property differs in getter and setter. See getQueryBuilder() and setQueryBuilder() for details.
New instance of ClientSession to replace return $this.
Type map to use for BSON unserialization. Note: default type map will be automatically merged into this field, possibly overriding user-defined values.
See also https://php.net/manual/en/mongodb-driver-cursor.settypemap.php.
Method Details
Defined in: yii\base\Component::__call()
Calls the named method which is not a class method.
This method will check if any attached behavior has the named method and will execute it if available.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\Component::__clone()
This method is called after the object is created by cloning an existing one.
It removes all behaviors because they are attached to the old object.
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\Component::__get()
Returns the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $component->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value or the value of a behavior's property |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only. |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__isset()
Checks if a property is set, i.e. defined and not null.
This method will check in the following order and act accordingly:
- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return
false
for non existing properties
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($component->property)
.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in: yii\base\Component::__set()
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $component->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only. |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__unset()
Sets a component property to be null.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($component->property)
.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::attachBehavior()
Attaches a behavior to this component.
This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.
See also detachBehavior().
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
The name of the behavior. |
$behavior | string|array|yii\base\Behavior |
The behavior configuration. This can be one of the following:
|
return | yii\base\Behavior |
The behavior object |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in: yii\base\Component::attachBehaviors()
Attaches a list of behaviors to the component.
Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.
See also attachBehavior().
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
List of behaviors to be attached to the component |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Defined in: yii\base\Component::behaviors()
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.
Behaviors declared in this method will be attached to the component automatically (on demand).
public array behaviors ( ) | ||
return | array |
The behavior configurations. |
---|
public function behaviors()
{
return [];
}
Defined in: yii\base\Component::canGetProperty()
Returns a value indicating whether a property can be read.
A property can be read if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a readable property of the given name (when
$checkBehaviors
is true).
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::canSetProperty()
Returns a value indicating whether a property can be set.
A property can be written if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a writable property of the given name (when
$checkBehaviors
is true).
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
Closes the currently active DB connection.
It does nothing if the connection is already closed.
public void close ( ) |
public function close()
{
if ($this->manager !== null) {
Yii::debug('Closing MongoDB connection: ' . $this->dsn, __METHOD__);
$this->manager = null;
foreach ($this->_databases as $database) {
$database->clearCollections();
}
$this->_databases = [];
}
}
Commits transaction in current session
public void commitTransaction ( ) |
public function commitTransaction()
{
$this->transactionReady('commit transaction');
$this->getSession()->transaction->commit();
}
Creates MongoDB command.
public yii\mongodb\Command createCommand ( $document = [], $databaseName = null ) | ||
$document | array |
Command document contents. |
$databaseName | string|null |
Database name, if not set $defaultDatabaseName will be used. |
return | yii\mongodb\Command |
Command instance. |
---|
public function createCommand($document = [], $databaseName = null)
{
return new Command([
'db' => $this,
'databaseName' => $databaseName,
'document' => $document,
'globalExecOptions' => $this->globalExecOptions
]);
}
Defined in: yii\base\Component::detachBehavior()
Detaches a behavior from the component.
The behavior's yii\base\Behavior::detach() method will be invoked.
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
The behavior's name. |
return | yii\base\Behavior|null |
The detached behavior. Null if the behavior does not exist. |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
Defined in: yii\base\Component::detachBehaviors()
Detaches all behaviors from the component.
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
Defined in: yii\base\Component::ensureBehaviors()
Makes sure that the behaviors declared in behaviors() are attached to this component.
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
Recursive replacement on $this->globalExecOptions with new options. {@see $this->globalExecOptions}
public $this execOptions ( $newExecOptions ) | ||
$newExecOptions | array |
{@see $this->globalExecOptions} |
public function execOptions($newExecOptions)
{
if (empty($newExecOptions)) {
$this->globalExecOptions = [];
}
else {
$this->globalExecOptions = array_replace_recursive($this->globalExecOptions, $newExecOptions);
}
return $this;
}
Defined in: yii\base\Component::getBehavior()
Returns the named behavior object.
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
The behavior name |
return | yii\base\Behavior|null |
The behavior object, or null if the behavior does not exist |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
Defined in: yii\base\Component::getBehaviors()
Returns all behaviors attached to this component.
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
List of behaviors attached to this component |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
Returns the MongoDB collection with the given name.
public yii\mongodb\Collection getCollection ( $name, $refresh = false ) | ||
$name | string|array |
Collection name. If string considered as the name of the collection inside the default database. If array - first element considered as the name of the database, second - as name of collection inside that database |
$refresh | boolean |
Whether to reload the collection instance even if it is found in the cache. |
return | yii\mongodb\Collection |
Mongo collection instance. |
---|
public function getCollection($name, $refresh = false)
{
if (is_array($name)) {
list ($dbName, $collectionName) = $name;
return $this->getDatabase($dbName)->getCollection($collectionName, $refresh);
}
return $this->getDatabase()->getCollection($name, $refresh);
}
Returns the MongoDB database with the given name.
public yii\mongodb\Database getDatabase ( $name = null, $refresh = false ) | ||
$name | string|null |
Database name, if null default one will be used. |
$refresh | boolean |
Whether to reestablish the database connection even, if it is found in the cache. |
return | yii\mongodb\Database |
Database instance. |
---|
public function getDatabase($name = null, $refresh = false)
{
if ($name === null) {
$name = $this->getDefaultDatabaseName();
}
if ($refresh || !array_key_exists($name, $this->_databases)) {
$this->_databases[$name] = $this->selectDatabase($name);
}
return $this->_databases[$name];
}
Returns default database name, if it is not set, attempts to determine it from $dsn value.
public string getDefaultDatabaseName ( ) | ||
return | string |
Default database name |
---|---|---|
throws | yii\base\InvalidConfigException |
if unable to determine default database name. |
public function getDefaultDatabaseName()
{
if ($this->_defaultDatabaseName === null) {
if (preg_match('/^mongodb:\\/\\/.+\\/([^?&]+)/s', $this->dsn, $matches)) {
$this->_defaultDatabaseName = $matches[1];
} else {
throw new InvalidConfigException("Unable to determine default database name from dsn.");
}
}
return $this->_defaultDatabaseName;
}
Returns the MongoDB GridFS collection.
public yii\mongodb\file\Collection getFileCollection ( $prefix = 'fs', $refresh = false ) | ||
$prefix | string|array |
Collection prefix. If string considered as the prefix of the GridFS collection inside the default database. If array - first element considered as the name of the database, second - as prefix of the GridFS collection inside that database, if no second element present default "fs" prefix will be used. |
$refresh | boolean |
Whether to reload the collection instance even if it is found in the cache. |
return | yii\mongodb\file\Collection |
Mongo GridFS collection instance. |
---|
public function getFileCollection($prefix = 'fs', $refresh = false)
{
if (is_array($prefix)) {
list ($dbName, $collectionPrefix) = $prefix;
if (!isset($collectionPrefix)) {
$collectionPrefix = 'fs';
}
return $this->getDatabase($dbName)->getFileCollection($collectionPrefix, $refresh);
}
return $this->getDatabase()->getFileCollection($prefix, $refresh);
}
Checks whether the current connection is in session.
return bool
public void getInSession ( ) |
public function getInSession()
{
return array_key_exists('session',$this->globalExecOptions['share']);
}
Checks that the current connection is in session and transaction return bool
public void getInTransaction ( ) |
public function getInTransaction()
{
return $this->getInSession() && $this->getSession()->getInTransaction();
}
Returns a value indicating whether the Mongo connection is established.
public boolean getIsActive ( ) | ||
return | boolean |
Whether the Mongo connection is established |
---|
public function getIsActive()
{
return is_object($this->manager) && $this->manager->getServers() !== [];
}
Returns log builder for this connection.
public yii\mongodb\LogBuilder getLogBuilder ( ) | ||
return | yii\mongodb\LogBuilder |
The log builder for this connection. |
---|
public function getLogBuilder()
{
if (!is_object($this->_logBuilder)) {
$this->_logBuilder = Yii::createObject($this->_logBuilder);
}
return $this->_logBuilder;
}
Returns the query builder for the this MongoDB connection.
public yii\mongodb\QueryBuilder getQueryBuilder ( ) | ||
return | yii\mongodb\QueryBuilder |
The query builder for the this MongoDB connection. |
---|
public function getQueryBuilder()
{
if (!is_object($this->_queryBuilder)) {
$this->_queryBuilder = Yii::createObject($this->_queryBuilder, [$this]);
}
return $this->_queryBuilder;
}
Returns current session return ClientSession|null
public void getSession ( ) |
public function getSession()
{
return $this->getInSession() ? $this->globalExecOptions['share']['session'] : null;
}
Defined in: yii\base\Component::hasEventHandlers()
Returns a value indicating whether there is any handler attached to the named event.
public boolean hasEventHandlers ( $name ) | ||
$name | string |
The event name |
return | boolean |
Whether there is any handler attached to the event. |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
Defined in: yii\base\Component::hasMethod()
Returns a value indicating whether a method is defined.
A method is defined if:
- the class has a method with the specified name
- an attached behavior has a method with the given name (when
$checkBehaviors
is true).
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::hasProperty()
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a property of the given name (when
$checkBehaviors
is true).
See also:
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Defined in: yii\base\BaseObject::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
public function init()
{
}
Initializes the DB connection.
This method is invoked right after the DB connection is established. The default implementation triggers an EVENT_AFTER_OPEN event.
protected void initConnection ( ) |
protected function initConnection()
{
$this->trigger(self::EVENT_AFTER_OPEN);
}
Only starts the new session for current connection but this session does not set for current connection.
public void newSession ( $sessionOptions = [] ) | ||
$sessionOptions | array |
See doc of ClientSession::start() return ClientSession |
public function newSession($sessionOptions = [])
{
return ClientSession::start($this, $sessionOptions);
}
Runs your mongodb command out of session and transaction.
public mixed noTransaction ( callable $actions ) | ||
$actions | callable |
Your block of code must be runned out of session and transaction |
return | mixed |
Returns a result of $actions() |
---|
public function noTransaction(callable $actions)
{
$lastSession = $this->getSession();
$this->setSession(null);
try {
$result = $actions();
} finally {
$this->setSession($lastSession);
}
return $result;
}
Defined in: yii\base\Component::off()
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
Event name |
$handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
return | boolean |
If a handler is found and detached |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in: yii\base\Component::on()
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event
is an yii\base\Event object which includes parameters associated with the event.
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
The event name |
$handler | callable |
The event handler |
$data | mixed |
The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data. |
$append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
Establishes a Mongo connection.
It does nothing if a MongoDB connection has already been established.
public void open ( ) | ||
throws | yii\mongodb\Exception |
if connection fails |
---|
public function open()
{
if ($this->manager === null) {
if (empty($this->dsn)) {
throw new InvalidConfigException($this->className() . '::dsn cannot be empty.');
}
$token = 'Opening MongoDB connection: ' . $this->dsn;
try {
Yii::debug($token, __METHOD__);
Yii::beginProfile($token, __METHOD__);
$options = $this->options;
$this->manager = new Manager($this->dsn, $options, $this->driverOptions);
$this->manager->selectServer($this->manager->getReadPreference());
$this->initConnection();
Yii::endProfile($token, __METHOD__);
} catch (\Exception $e) {
Yii::endProfile($token, __METHOD__);
throw new Exception($e->getMessage(), (int) $e->getCode(), $e);
}
$this->typeMap = array_merge(
$this->typeMap,
[
'root' => 'array',
'document' => 'array'
]
);
}
}
Registers GridFS stream wrapper for the $fileStreamProtocol protocol.
public string registerFileStreamWrapper ( $force = false ) | ||
$force | boolean |
Whether to enforce registration even wrapper has been already registered. |
return | string |
Registered stream protocol name. |
---|
public function registerFileStreamWrapper($force = false)
{
if ($force || !$this->_fileStreamWrapperRegistered) {
/* @var $class \yii\mongodb\file\StreamWrapper */
$class = $this->fileStreamWrapperClass;
$class::register($this->fileStreamProtocol, $force);
$this->_fileStreamWrapperRegistered = true;
}
return $this->fileStreamProtocol;
}
Rollbacks transaction in current session
public void rollBackTransaction ( ) |
public function rollBackTransaction()
{
$this->transactionReady('roll back transaction');
$this->getSession()->transaction->rollBack();
}
Selects the database with given name.
protected yii\mongodb\Database selectDatabase ( $name ) | ||
$name | string |
Database name. |
return | yii\mongodb\Database |
Database instance. |
---|
protected function selectDatabase($name)
{
return Yii::createObject([
'class' => 'yii\mongodb\Database',
'name' => $name,
'connection' => $this,
]);
}
Sets default database name.
public void setDefaultDatabaseName ( $name ) | ||
$name | string |
Default database name. |
public function setDefaultDatabaseName($name)
{
$this->_defaultDatabaseName = $name;
}
Sets log builder used for this connection.
public void setLogBuilder ( $logBuilder ) | ||
$logBuilder | array|string|yii\mongodb\LogBuilder |
The log builder for this connection. |
public function setLogBuilder($logBuilder)
{
$this->_logBuilder = $logBuilder;
}
Sets the query builder for the this MongoDB connection.
public void setQueryBuilder ( $queryBuilder ) | ||
$queryBuilder | yii\mongodb\QueryBuilder|array|string|null |
The query builder for this MongoDB connection. |
public function setQueryBuilder($queryBuilder)
{
$this->_queryBuilder = $queryBuilder;
}
Changes the current session of connection to execute commands (or drop session)
public void setSession ( $clientSession ) | ||
$clientSession | yii\mongodb\ClientSession|null |
New instance of ClientSession to replace return $this |
public function setSession($clientSession)
{
#drop session
if (empty($clientSession)) {
unset($this->globalExecOptions['share']['session']);
}
else {
$this->globalExecOptions['share']['session'] = $clientSession;
}
return $this;
}
Ends the previous session and starts the new session.
public void startSession ( $sessionOptions = [] ) | ||
$sessionOptions | array |
See doc of ClientSession::start() return ClientSession |
public function startSession($sessionOptions = [])
{
if ($this->getInSession()) {
$this->getSession()->end();
}
$newSession = $this->newSession($sessionOptions);
$this->setSession($newSession);
return $newSession;
}
Starts a new session if the session has not started, otherwise returns previous session.
public void startSessionOnce ( $sessionOptions = [] ) | ||
$sessionOptions | array |
See doc of ClientSession::start() return ClientSession |
public function startSessionOnce($sessionOptions = [])
{
if ($this->getInSession()) {
return $this->getSession();
}
return $this->startSession($sessionOptions);
}
Starts a transaction with three steps : - starts new session if has not started - starts the transaction in new session - sets new session to current connection
public void startTransaction ( $transactionOptions = [], $sessionOptions = [] ) | ||
$transactionOptions | array |
See doc of Transaction::start() |
$sessionOptions | array |
See doc of ClientSession::start() return ClientSession |
public function startTransaction($transactionOptions = [], $sessionOptions = [])
{
$session = $this->startSession($sessionOptions);
$session->getTransaction()->start($transactionOptions);
return $session;
}
Starts a transaction in current session if the previous transaction was not started in current session.
public void startTransactionOnce ( $transactionOptions = [], $sessionOptions = [] ) | ||
$transactionOptions | array |
See doc of Transaction::start() |
$sessionOptions | array |
See doc of ClientSession::start() return ClientSession |
public function startTransactionOnce($transactionOptions = [], $sessionOptions = [])
{
if ($this->getInTransaction()) {
return $this->getSession();
}
return $this->startTransaction($transactionOptions,$sessionOptions);
}
Starts and commits a transaction in easy mode.
public void transaction ( callable $actions, $transactionOptions = [], $sessionOptions = [] ) | ||
$actions | callable |
Your block of code must be runned after transaction started and before commit if the $actions returns false then transaction rolls back. |
$transactionOptions | array |
See doc of Transaction::start() |
$sessionOptions | array |
See doc of ClientSession::start() |
public function transaction(callable $actions, $transactionOptions = [], $sessionOptions = [])
{
$session = $this->startTransaction($transactionOptions, $sessionOptions);
$success = false;
try {
$result = call_user_func($actions, $session);
if ($session->getTransaction()->getIsActive()) {
if ($result === false) {
$session->getTransaction()->rollBack();
}
else {
$session->getTransaction()->commit();
}
}
$success = true;
} finally {
if (!$success && $session->getTransaction()->getIsActive()) {
$session->getTransaction()->rollBack();
}
}
}
Starts and commits transaction in easy mode if the previous transaction was not executed, otherwise only runs your actions in previous transaction.
public void transactionOnce ( callable $actions, $transactionOptions = [], $sessionOptions = [] ) | ||
$actions | callable |
Your block of code must be runned after transaction started and before commit |
$transactionOptions | array |
See doc of Transaction::start() |
$sessionOptions | array |
See doc of ClientSession::start() |
public function transactionOnce(callable $actions, $transactionOptions = [], $sessionOptions = [])
{
if ($this->getInTransaction()) {
$actions();
}
else {
$this->transaction($actions,$transactionOptions,$sessionOptions);
}
}
Throws custom error if transaction is not ready in connection
public void transactionReady ( $operation ) | ||
$operation | string |
A custom message to be shown |
public function transactionReady($operation)
{
if (!$this->getInSession()) {
throw new Exception('You can\'t ' . $operation . ' because current connection is\'t in a session.');
}
if (!$this->getSession()->getInTransaction()) {
throw new Exception('You can\'t ' . $operation . ' because transaction not started in current session.');
}
}
Defined in: yii\base\Component::trigger()
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
The event name |
$event | yii\base\Event|null |
The event instance. If not set, a default yii\base\Event object will be created. |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
Event Details
An event that is triggered after a DB connection is established
An event that is triggered right after a transaction is committed
An event that is triggered right after a mongo client session is ended
An event that is triggered right after a transaction is rolled back
An event that is triggered right before a mongo client session is started
An event that is triggered right before a transaction is started