PHP Class 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.
Inheritance: extends Mongolid\ActiveRecord
Afficher le fichier Open project: leroy-merlin-br/mongolid-laravel

Méthodes publiques

Свойство Type Description
$errors Illuminate\Support\MessageBag Error message bag.
$localMock Mockery\Mock Public local mock.
$mock Mockery\Mock Public static mock.
$rules array Validation rules.

Protected Properties

Свойство Type Description
$hashedAttributes array List of attribute names which should be hashed on save. For example: array('password');.

Méthodes publiques

Méthode Description
__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.

Méthodes protégées

Méthode Description
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.

Method Details

__callStatic() public static méthode

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.
Résultat Mockery\Expectation | void

all() public static méthode

public static all ( )

callMockOrParent() protected static méthode

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.
Résultat mixed See parent implementation

collection() protected méthode

Returns the Mongo collection object.
protected collection ( ) : MongoDB\Collection
Résultat MongoDB\Collection

db() protected méthode

Returns the database object (the connection).
protected db ( ) : MongoDB\Database
Résultat MongoDB\Database

delete() public méthode

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
Résultat boolean

errors() public méthode

Get the contents of errors attribute.
public errors ( ) : Illuminate\Support\MessageBag
Résultat Illuminate\Support\MessageBag Validation errors

first() public static méthode

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.
Résultat Mongolid\ActiveRecord

firstOrFail() public static méthode

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.
Résultat Mongolid\ActiveRecord

firstOrNew() public static méthode

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.
Résultat Mongolid\ActiveRecord

getLocalMock() protected méthode

Get a local mock instance.
protected getLocalMock ( ) : Mock | Mockery\MockInterface
Résultat Mockery\Mock | Mockery\MockInterface

hasLocalMock() protected méthode

Check if local mock is set.
protected hasLocalMock ( ) : boolean
Résultat boolean

hashAttributes() protected méthode

Hashes the attributes specified in the hashedAttributes array.
protected hashAttributes ( ) : void
Résultat void

isValid() public méthode

Verify if the model is valid by running its validation rules, defined on static attribute $rules.
public isValid ( ) : boolean
Résultat boolean

localMockHasExpectationsFor() protected méthode

Check for a expectation for given method on local mock.
protected localMockHasExpectationsFor ( string $method ) : boolean
$method string Name of the method being checked.
Résultat boolean

localMockShouldReceive() protected méthode

Initiate a mockery expectation that is specific for the given method.
protected localMockShouldReceive ( string $method ) : Expectation
$method string Name of the method being mocked.
Résultat Mockery\Expectation

save() public méthode

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.
Résultat boolean

shouldReceiveDelete() public méthode

Initiate a mock expectation that is specific for the delete method.
public shouldReceiveDelete ( ) : Expectation
Résultat Mockery\Expectation

shouldReceiveSave() public méthode

Initiate a mock expectation that is specific for the save method.
public shouldReceiveSave ( ) : Expectation
Résultat Mockery\Expectation

update() public méthode

public update ( )

where() public static méthode

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.
Résultat Mongolid\Cursor\Cursor

Property Details

$errors public_oe property

Error message bag.
public MessageBag,Illuminate\Support $errors
Résultat Illuminate\Support\MessageBag

$hashedAttributes protected_oe property

List of attribute names which should be hashed on save. For example: array('password');.
protected array $hashedAttributes
Résultat array

$localMock public_oe property

Public local mock.
public Mock,Mockery $localMock
Résultat Mockery\Mock

$mock public_oe static_oe property

Public static mock.
public static Mock,Mockery $mock
Résultat Mockery\Mock

$rules public_oe static_oe property

Validation rules.
public static array $rules
Résultat array