Option
extends Model
in package
Table of Contents
- $baseOptions : array<string|int, mixed>
- $baseSort : array<string|int, mixed>
- $collectionName : string
- add() : bool|array<string|int, mixed>
- addMany() : bool
- aggregate() : array<string|int, mixed>
- deleteById() : bool
- deleteMany() : bool
- deleteOne() : bool
- find() : array<string|int, mixed>
- Поиск объекта в бд по фильтру.
- findAll() : array<string|int, mixed>
- findById() : object|bool|array<string|int, mixed>
- findOne() : object|bool|array<string|int, mixed>
- getCursor() : Cursor
- getPermissionMask() : array<string|int, mixed>
- save() : bool
- update() : bool
- updateMany() : bool
- getCollection() : Collection
- getConfig() : AirlayConfig
- getMongoDbManager() : Manager
Properties
$baseOptions
public
static array<string|int, mixed>
$baseOptions
= ['typeMap' => ['root' => 'array', 'document' => 'array', 'array' => 'array'], 'sort' => ['_id' => 1]]
$baseSort
public
static array<string|int, mixed>
$baseSort
= ['_id' => 1]
$collectionName
public
static string
$collectionName
= 'optionsCollection'
Methods
add()
public
static add(array<string|int, mixed> $object) : bool|array<string|int, mixed>
Parameters
- $object : array<string|int, mixed>
Return values
bool|array<string|int, mixed> —addMany()
public
static addMany(array<string|int, mixed> $objects) : bool
Parameters
- $objects : array<string|int, mixed>
Return values
bool —aggregate()
public
static aggregate(array<string|int, mixed> $aggregate[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $aggregate : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —deleteById()
public
static deleteById(ObjectId $id) : bool
Parameters
- $id : ObjectId
Return values
bool —deleteMany()
public
static deleteMany(array<string|int, mixed> $filter) : bool
Parameters
- $filter : array<string|int, mixed>
Return values
bool —deleteOne()
public
static deleteOne(mixed $filter) : bool
Parameters
- $filter : mixed
Return values
bool —find()
Поиск объекта в бд по фильтру.
public
static find([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $filter : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —findAll()
public
static findAll([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —findById()
public
static findById(ObjectId|int $id[, array<string|int, mixed> $options = [] ]) : object|bool|array<string|int, mixed>
Parameters
- $id : ObjectId|int
- $options : array<string|int, mixed> = []
Return values
object|bool|array<string|int, mixed> —findOne()
public
static findOne(array<string|int, mixed> $filter[, array<string|int, mixed> $options = [] ]) : object|bool|array<string|int, mixed>
Parameters
- $filter : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
object|bool|array<string|int, mixed> —getCursor()
public
static getCursor() : Cursor
Return values
Cursor —getPermissionMask()
public
static getPermissionMask() : array<string|int, mixed>
Return values
array<string|int, mixed> —save()
public
static save(array<string|int, mixed> $objects) : bool
Parameters
- $objects : array<string|int, mixed>
Return values
bool —update()
public
static update(array<string|int, mixed> $filter, array<string|int, mixed> $query[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $filter : array<string|int, mixed>
- $query : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
bool —updateMany()
public
static updateMany(array<string|int, mixed> $filter, array<string|int, mixed> $query[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $filter : array<string|int, mixed>
- $query : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
bool —getCollection()
protected
static getCollection() : Collection
Return values
Collection —getConfig()
protected
static getConfig() : AirlayConfig
Return values
AirlayConfig —getMongoDbManager()
protected
static getMongoDbManager() : Manager