Class yii\mongodb\Database

All Classes | Properties | Methods
Inheritanceyii\mongodb\Database » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-mongodb/blob/master/Database.php

Database represents the MongoDB database information.

Public Properties

Hide inherited properties

Property Type Description Defined By
$connection yii\mongodb\Connection MongoDB connection. yii\mongodb\Database
$fileCollection yii\mongodb\file\Collection Mongo GridFS collection. yii\mongodb\Database
$name string Name of this database. yii\mongodb\Database

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
clearCollections() Clears internal collection lists. yii\mongodb\Database
createCollection() Creates new collection. yii\mongodb\Database
createCommand() Creates MongoDB command associated with this database. yii\mongodb\Database
dropCollection() Drops specified collection. yii\mongodb\Database
getCollection() Returns the Mongo collection with the given name. yii\mongodb\Database
getFileCollection() Returns Mongo GridFS collection with given prefix. yii\mongodb\Database
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
listCollections() Returns the list of available collections in this database. yii\mongodb\Database

Protected Methods

Hide inherited methods

Method Description Defined By
selectCollection() Selects collection with given name. yii\mongodb\Database
selectFileCollection() Selects GridFS collection with given prefix. yii\mongodb\Database

Property Details

Hide inherited properties

$connection public property

MongoDB connection.

public yii\mongodb\Connection $connection = null
$fileCollection public property

Mongo GridFS collection.

public yii\mongodb\file\Collection $fileCollection = null
$name public property

Name of this database.

public string $name = null

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

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)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

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();
}
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
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)) {
        return $this->$getter();
    } elseif (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);
}
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->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)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

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);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable 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);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable 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);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::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();
}
clearCollections() public method

Clears internal collection lists.

This method can be used to break cycle references between yii\mongodb\Database and yii\mongodb\Collection instances.

public void clearCollections ( )

                public function clearCollections()
{
    $this->_collections = [];
    $this->_fileCollections = [];
}
createCollection() public method

Creates new collection.

Note: Mongo creates new collections automatically on the first demand, this method makes sense only for the migration script or for the case you need to create collection with the specific options.

public boolean createCollection ( $name, $options = [], $execOptions = [] )
$name string

Name of the collection
$options array

Collection options in format: "name" => "value"
$execOptions array

-> goto Command::execute()
return boolean

Whether operation was successful.
throws yii\mongodb\Exception

on failure.

 

                public function createCollection($name, $options = [], $execOptions = [])
{
    return $this->createCommand()->createCollection($name, $options, $execOptions);
}
createCommand() public method (available since version 2.1)

Creates MongoDB command associated with this database.

public yii\mongodb\Command createCommand ( $document = [] )
$document array

Command document contents.
return yii\mongodb\Command

Command instance.

 

                public function createCommand($document = [])
{
    return $this->connection->createCommand($document, $this->name);
}
dropCollection() public method (available since version 2.1)

Drops specified collection.

public boolean dropCollection ( $name, $execOptions = [] )
$name string

Name of the collection
$execOptions array

-> goto Command::execute()
return boolean

Whether operation was successful.

 

                public function dropCollection($name, $execOptions = [])
{
    return $this->createCommand()->dropCollection($name, $execOptions);
}
getCollection() public method

Returns the Mongo collection with the given name.

public yii\mongodb\Collection getCollection ( $name, $refresh = false )
$name string

Collection name
$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 ($refresh || !array_key_exists($name, $this->_collections)) {
        $this->_collections[$name] = $this->selectCollection($name);
    }
    return $this->_collections[$name];
}
getFileCollection() public method

Returns Mongo GridFS collection with given prefix.

public yii\mongodb\file\Collection getFileCollection ( $prefix = 'fs', $refresh = false )
$prefix string

Collection prefix.
$refresh boolean

Whether to reload the collection instance even if it is found in the cache.
return yii\mongodb\file\Collection

Mongo GridFS collection.

 

                public function getFileCollection($prefix = 'fs', $refresh = false)
{
    if ($refresh || !array_key_exists($prefix, $this->_fileCollections)) {
        $this->_fileCollections[$prefix] = $this->selectFileCollection($prefix);
    }
    return $this->_fileCollections[$prefix];
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

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);

See also:

public boolean hasProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

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()
{
}
listCollections() public method (available since version 2.1.1)

Returns the list of available collections in this database.

public array listCollections ( $condition = [], $options = [], $execOptions = [] )
$condition array

Filter condition.
$options array

Options list.
$execOptions array

-> goto Command::execute()
return array

Collections information.

 

                public function listCollections($condition = [], $options = [], $execOptions = [])
{
    return $this->createCommand()->listCollections($condition, $options, $execOptions);
}
selectCollection() protected method

Selects collection with given name.

protected yii\mongodb\Collection selectCollection ( $name )
$name string

Collection name.
return yii\mongodb\Collection

Collection instance.

 

                protected function selectCollection($name)
{
    return Yii::createObject([
        'class' => 'yii\mongodb\Collection',
        'database' => $this,
        'name' => $name,
    ]);
}
selectFileCollection() protected method

Selects GridFS collection with given prefix.

protected yii\mongodb\file\Collection selectFileCollection ( $prefix )
$prefix string

File collection prefix.
return yii\mongodb\file\Collection

File collection instance.

 

                protected function selectFileCollection($prefix)
{
    return Yii::createObject([
        'class' => 'yii\mongodb\file\Collection',
        'database' => $this,
        'prefix' => $prefix,
    ]);
}