PHP Класс MongolidLaravel\MongolidModel

The MongolidLaravel\MongolidModel simply extends the original and framework agnostic model of MongoLid and implements some validation rules using Laravel validation components. Remember, this package is meant to be used with Laravel while the "leroy-merlin\mongolid" is meant to be used with other frameworks or even without any.
Наследование: extends Mongolid\ActiveRecord
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$errors Illuminate\Support\MessageBag Error message bag.
$localMock Mockery\Mock Public local mock.
$mock Mockery\Mock Public static mock.
$rules array Validation rules.

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

Свойство Тип Описание
$hashedAttributes array List of attribute names which should be hashed on save. For example: array('password');.

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

Метод Описание
__callStatic ( string $name, array $arguments ) : Expectation | void Initiate a mock expectation on the facade.
all ( )
delete ( ) : boolean Overwrites the delete method in order to be able to check for the expectation in the localMock in order to call the delete method into the existing mock and avoid touching the database.
errors ( ) : Illuminate\Support\MessageBag Get the contents of errors attribute.
first ( mixed $query = [], array $projection = [], boolean $useCache = false ) : ActiveRecord Gets the first entity of this kind that matches the query.
firstOrFail ( mixed $query = [], array $projection = [], boolean $useCache = false ) : ActiveRecord Gets the first entity of this kind that matches the query. If no document was found, throws ModelNotFoundException.
firstOrNew ( mixed $id ) : ActiveRecord Gets the first entity of this kind that matches the query. If no document was found, a new entity will be returned with the _id field filled.
isValid ( ) : boolean Verify if the model is valid by running its validation rules, defined on static attribute $rules.
save ( boolean $force = false ) : boolean Save the model to the database if it's valid. This method also checks for the presence of the localMock in order to call the save method into the existing Mock in order not to touch the database.
shouldReceiveDelete ( ) : Expectation Initiate a mock expectation that is specific for the delete method.
shouldReceiveSave ( ) : Expectation Initiate a mock expectation that is specific for the save method.
update ( )
where ( array $query = [], array $projection = [], boolean $useCache = false ) : Cursor Gets a cursor of this kind of entities that matches the query from the database.

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

Метод Описание
callMockOrParent ( string $method, array $arguments ) : mixed Calls mock method if its have expectations. Calls parent method otherwise.
collection ( ) : MongoDB\Collection Returns the Mongo collection object.
db ( ) : MongoDB\Database Returns the database object (the connection).
getLocalMock ( ) : Mock | Mockery\MockInterface Get a local mock instance.
hasLocalMock ( ) : boolean Check if local mock is set.
hashAttributes ( ) : void Hashes the attributes specified in the hashedAttributes array.
localMockHasExpectationsFor ( string $method ) : boolean Check for a expectation for given method on local mock.
localMockShouldReceive ( string $method ) : Expectation Initiate a mockery expectation that is specific for the given method.

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

__callStatic() публичный статический метод

Initiate a mock expectation on the facade.
public static __callStatic ( string $name, array $arguments ) : Expectation | void
$name string Name of the method being called.
$arguments array Method arguments.
Результат Mockery\Expectation | void

all() публичный статический метод

public static all ( )

callMockOrParent() защищенный статический метод

Calls mock method if its have expectations. Calls parent method otherwise.
protected static callMockOrParent ( string $method, array $arguments ) : mixed
$method string Name of the method being called.
$arguments array Arguments to pass in method call.
Результат mixed See parent implementation

collection() защищенный метод

Returns the Mongo collection object.
protected collection ( ) : MongoDB\Collection
Результат MongoDB\Collection

db() защищенный метод

Returns the database object (the connection).
protected db ( ) : MongoDB\Database
Результат MongoDB\Database

delete() публичный метод

Overwrites the delete method in order to be able to check for the expectation in the localMock in order to call the delete method into the existing mock and avoid touching the database.
public delete ( ) : boolean
Результат boolean

errors() публичный метод

Get the contents of errors attribute.
public errors ( ) : Illuminate\Support\MessageBag
Результат Illuminate\Support\MessageBag Validation errors

first() публичный статический метод

Gets the first entity of this kind that matches the query.
public static first ( mixed $query = [], array $projection = [], boolean $useCache = false ) : ActiveRecord
$query mixed MongoDB selection criteria.
$projection array Fields to project in MongoDB query.
$useCache boolean Retrieves the entity through a CacheableCursor.
Результат Mongolid\ActiveRecord

firstOrFail() публичный статический метод

Gets the first entity of this kind that matches the query. If no document was found, throws ModelNotFoundException.
public static firstOrFail ( mixed $query = [], array $projection = [], boolean $useCache = false ) : ActiveRecord
$query mixed MongoDB selection criteria.
$projection array Fields to project in Mongo query.
$useCache boolean Retrieves the entity through a CacheableCursor.
Результат Mongolid\ActiveRecord

firstOrNew() публичный статический метод

Gets the first entity of this kind that matches the query. If no document was found, a new entity will be returned with the _id field filled.
public static firstOrNew ( mixed $id ) : ActiveRecord
$id mixed Document id.
Результат Mongolid\ActiveRecord

getLocalMock() защищенный метод

Get a local mock instance.
protected getLocalMock ( ) : Mock | Mockery\MockInterface
Результат Mockery\Mock | Mockery\MockInterface

hasLocalMock() защищенный метод

Check if local mock is set.
protected hasLocalMock ( ) : boolean
Результат boolean

hashAttributes() защищенный метод

Hashes the attributes specified in the hashedAttributes array.
protected hashAttributes ( ) : void
Результат void

isValid() публичный метод

Verify if the model is valid by running its validation rules, defined on static attribute $rules.
public isValid ( ) : boolean
Результат boolean

localMockHasExpectationsFor() защищенный метод

Check for a expectation for given method on local mock.
protected localMockHasExpectationsFor ( string $method ) : boolean
$method string Name of the method being checked.
Результат boolean

localMockShouldReceive() защищенный метод

Initiate a mockery expectation that is specific for the given method.
protected localMockShouldReceive ( string $method ) : Expectation
$method string Name of the method being mocked.
Результат Mockery\Expectation

save() публичный метод

Save the model to the database if it's valid. This method also checks for the presence of the localMock in order to call the save method into the existing Mock in order not to touch the database.
public save ( boolean $force = false ) : boolean
$force boolean Force save even if the object is invalid.
Результат boolean

shouldReceiveDelete() публичный метод

Initiate a mock expectation that is specific for the delete method.
public shouldReceiveDelete ( ) : Expectation
Результат Mockery\Expectation

shouldReceiveSave() публичный метод

Initiate a mock expectation that is specific for the save method.
public shouldReceiveSave ( ) : Expectation
Результат Mockery\Expectation

update() публичный метод

public update ( )

where() публичный статический метод

Gets a cursor of this kind of entities that matches the query from the database.
public static where ( array $query = [], array $projection = [], boolean $useCache = false ) : Cursor
$query array MongoDB selection criteria.
$projection array Fields to project in MongoDB query.
$useCache boolean Retrieves a CacheableCursor instead.
Результат Mongolid\Cursor\Cursor

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

$errors публичное свойство

Error message bag.
public MessageBag,Illuminate\Support $errors
Результат Illuminate\Support\MessageBag

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

List of attribute names which should be hashed on save. For example: array('password');.
protected array $hashedAttributes
Результат array

$localMock публичное свойство

Public local mock.
public Mock,Mockery $localMock
Результат Mockery\Mock

$mock публичное статическое свойство

Public static mock.
public static Mock,Mockery $mock
Результат Mockery\Mock

$rules публичное статическое свойство

Validation rules.
public static array $rules
Результат array