PHP Класс LMongo\Connection

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$cache Illuminate\Cache\CacheManger The cache manager instance.
$config array The database connection configuration options.
$connection resource The MongoClient connection handler.
$db resource The MongoDB database handler.
$events Illuminate\Events\Dispatcher The event dispatcher instance.
$paginator Illuminate\Pagination\Paginator The paginator environment instance.

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

Метод Описание
__get ( string $name ) : MongoCollection Dynamically pass collection name to MongoCollection and return it.
collection ( string $collection ) : Builder Return new Query Builder instance
connect ( array $config ) : LMongo\Connection Establish a database connection.
getCacheManager ( ) : Illuminate\Cache\CacheManager Get the cache manager instance.
getConfig ( string $option ) : mixed Get an option from the configuration options.
getEventDispatcher ( ) : Illuminate\Events\Dispatcher Get the event dispatcher used by the connection.
getMongoClient ( ) : MongoClient return MongoClient object
getMongoDB ( ) : MongoDB return MongoDB object
getName ( ) : string | null Get the database connection name.
getPaginator ( ) : Illuminate\Pagination\Environment Get the paginator environment instance.
setCacheManager ( Illuminate\Cache\CacheManager | Closure $cache ) : void Set the cache manager instance on the connection.
setEventDispatcher ( Illuminate\Events\Dispatcher $events ) : void Set the event dispatcher instance on the connection.
setPaginator ( Illuminate\Pagination\Environment | Closure $paginator ) : void Set the pagination environment instance.

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

Метод Описание
getDsn ( array $config ) : string Create a DSN string from a configuration.

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

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

Dynamically pass collection name to MongoCollection and return it.
public __get ( string $name ) : MongoCollection
$name string
Результат MongoCollection

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

Return new Query Builder instance
public collection ( string $collection ) : Builder
$collection string
Результат LMongo\Query\Builder

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

Establish a database connection.
public connect ( array $config ) : LMongo\Connection
$config array
Результат LMongo\Connection

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

Get the cache manager instance.
public getCacheManager ( ) : Illuminate\Cache\CacheManager
Результат Illuminate\Cache\CacheManager

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

Get an option from the configuration options.
public getConfig ( string $option ) : mixed
$option string
Результат mixed

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

Create a DSN string from a configuration.
protected getDsn ( array $config ) : string
$config array
Результат string

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

Get the event dispatcher used by the connection.
public getEventDispatcher ( ) : Illuminate\Events\Dispatcher
Результат Illuminate\Events\Dispatcher

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

return MongoClient object
public getMongoClient ( ) : MongoClient
Результат MongoClient

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

return MongoDB object
public getMongoDB ( ) : MongoDB
Результат MongoDB

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

Get the database connection name.
public getName ( ) : string | null
Результат string | null

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

Get the paginator environment instance.
public getPaginator ( ) : Illuminate\Pagination\Environment
Результат Illuminate\Pagination\Environment

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

Set the cache manager instance on the connection.
public setCacheManager ( Illuminate\Cache\CacheManager | Closure $cache ) : void
$cache Illuminate\Cache\CacheManager | Closure
Результат void

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

Set the event dispatcher instance on the connection.
public setEventDispatcher ( Illuminate\Events\Dispatcher $events ) : void
$events Illuminate\Events\Dispatcher
Результат void

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

Set the pagination environment instance.
public setPaginator ( Illuminate\Pagination\Environment | Closure $paginator ) : void
$paginator Illuminate\Pagination\Environment | Closure
Результат void

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

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

The cache manager instance.
protected CacheManger,Illuminate\Cache $cache
Результат Illuminate\Cache\CacheManger

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

The database connection configuration options.
protected array $config
Результат array

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

The MongoClient connection handler.
protected resource $connection
Результат resource

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

The MongoDB database handler.
protected resource $db
Результат resource

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

The event dispatcher instance.
protected Illuminate\Events\Dispatcher $events
Результат Illuminate\Events\Dispatcher

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

The paginator environment instance.
protected Illuminate\Pagination\Paginator $paginator
Результат Illuminate\Pagination\Paginator