Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Interface EntityManagerInterface

Direct known implementers

Maslosoft\Mangan\EntityManager, Maslosoft\Mangan\Interfaces\ActiveRecordInterface

Indirect known implementers

Maslosoft\Mangan\Document, Maslosoft\Mangan\Example\ExampleUser, Maslosoft\Mangan\Model\Trash, Maslosoft\Mangan\Model\TrashItem

Namespace: Maslosoft\Mangan\Interfaces
Author: Piotr Maselkowski
Located at Interfaces/EntityManagerInterface.php

Methods summary

`public boolean`	# `replace( boolean $runValidation = true )` Replaces the current document. Replaces the current document. NOTE: This will overwrite entire document. Any filtered out properties will be removed as well. The record is inserted as a documnent into the database collection, if exists it will be replaced. Validation will be performed before saving the record. If the validation fails, the record will not be saved. You can call getErrors() to retrieve the validation errors. Parameters `$runValidation` whether to perform validation before saving the record. If the validation fails, the record will not be saved to database. Returns boolean whether the saving succeeds Since v1.0
`public boolean`	# `insert( Maslosoft\Addendum\Interfaces\AnnotatedInterface $model = null )` Inserts a row into the table based on this active record attributes. If the table's primary key is auto-incremental and is null before insertion, it will be populated with the actual value after insertion. Note, validation is not performed in this method. You may call validate to perform the validation. After the record is inserted to DB successfully, its isNewRecord property will be set false, and its scenario property will be set to be 'update'. Inserts a row into the table based on this active record attributes. If the table's primary key is auto-incremental and is null before insertion, it will be populated with the actual value after insertion. Note, validation is not performed in this method. You may call validate to perform the validation. After the record is inserted to DB successfully, its isNewRecord property will be set false, and its scenario property will be set to be 'update'. Parameters `$model` if want to insert different model than set in constructor Returns boolean whether the attributes are valid and the record is inserted successfully. Throws `Maslosoft\Mangan\Exceptions\ManganException` if the record is not new `Maslosoft\Mangan\Exceptions\ManganException` on fail of insert or insert of empty document `Maslosoft\Mangan\Exceptions\ManganException` on fail of insert, when safe flag is set to true `Maslosoft\Mangan\Exceptions\ManganException` on timeout of db operation , when safe flag is set to true Since v1.0
`public boolean`	# `update( array $attributes = null )` Updates the document represented by this active record. All loaded attributes will be saved to the database. Updates the document represented by this active record. All loaded attributes will be saved to the database. Note, validation is not performed in this method. You may call validate to perform the validation. Parameters `$attributes` list of attributes that need to be updated. Defaults to null, meaning all attributes that are loaded from DB will be saved. Returns boolean whether the update is successful Throws `Maslosoft\Mangan\Exceptions\ManganException` if the record is new `Maslosoft\Mangan\Exceptions\ManganException` on fail of update `Maslosoft\Mangan\Exceptions\ManganException` on timeout of db operation , when safe flag is set to true Since v1.0
`public`	# `updateOne( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null, array $attributes = null, boolean $modify = false )` Updates one document with the specified criteria and attributes Updates one document with the specified criteria and attributes This is more raw update: Does not raise any events or signals Does not perform any validation Parameters `$criteria` query criteria. `$attributes` list of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved. `$modify` tu force update/upsert document Since v1.0
`public boolean\|mixed[]`	# `updateAll( Maslosoft\Mangan\Modifier $modifier, Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Atomic, in-place update method. Atomic, in-place update method. Parameters `$modifier` updating rules to apply `$criteria` condition to limit updating rules Returns boolean\|mixed[] Since v1.3.6
`public boolean`	# `save( boolean $runValidation = true )` Saves the current record. Will insert new document, or update if exists. Saves the current record. Will insert new document, or update if exists. Validation will be performed before saving the document. If the validation fails, the record will not be saved. You can call getErrors() to retrieve the validation errors. Parameters `$runValidation` whether to perform validation before saving the record. If the validation fails, the record will not be saved to database. Returns boolean whether the saving succeeds Since v1.0
`public boolean`	# `upsert( boolean $runValidation = true )` Updates or inserts the current document. This will try to update existing fields. Will keep already stored data if present in document. Updates or inserts the current document. This will try to update existing fields. Will keep already stored data if present in document. If document does not exist, a new one will be inserted. Parameters `$runValidation` Returns boolean Throws `Maslosoft\Mangan\Exceptions\ManganException`
`public boolean`	# `delete( )` Deletes the row corresponding to this Document. Deletes the row corresponding to this Document. Returns boolean whether the deletion is successful. Throws `Maslosoft\Mangan\Exceptions\ManganException` if the record is new Since v1.0
`public`	# `deleteOne( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Deletes one document with the specified primary key or by passed criteria. Deletes one document with the specified primary key or by passed criteria. This is more raw method than delete: Does not raise events Does not emit signals See `Criteria` class for detailed explanation about $criteria param. Parameters `$criteria` query criteria. See `Maslosoft\Mangan\Criteria` `Maslosoft\Mangan\Interfaces\CriteriaInterface` Since v1.0
`public`	# `deleteByPk( mixed $pkValue, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Deletes document with the specified primary key with optional criteria. Deletes document with the specified primary key with optional criteria. See `Criteria` class for detailed explanation about $criteria param. Parameters `$pkValue` primary key value(s). Use array for multiple primary keys. For composite key, each key value must be an array (column name=>column value). `$criteria` query criteria. See `Maslosoft\Mangan\Criteria` `Maslosoft\Mangan\Interfaces\CriteriaInterface` Since v1.0
`public`	# `deleteAllByPk( mixed[] $pkValues, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Deletes documents with the specified primary keys. Deletes documents with the specified primary keys. See `Criteria` class for detailed explanation about $criteria param. Parameters `$pkValues` Primary keys array `$criteria` query criteria. See `Maslosoft\Mangan\Criteria` `Maslosoft\Mangan\Interfaces\CriteriaInterface` Since v1.0
`public`	# `deleteAll( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Deletes all documents specified by criteria. Deletes all documents specified by criteria. See `Criteria` class for detailed explanation about $criteria param. Parameters `$criteria` query criteria. See `Maslosoft\Mangan\Criteria` `Maslosoft\Mangan\Interfaces\CriteriaInterface` Since v1.0
`public boolean`	# `refresh( )` Repopulates this active record with the latest data. Repopulates this active record with the latest data. Returns boolean whether the row still exists in the database. If true, the latest data will be populated to this active record. Since v1.0
`public MongoCollection`	# `getCollection( )` Get mongodb collection Get mongodb collection Returns MongoCollection PHP Driver MongoCollection instance

Constants summary

`string`	`EventBeforeSave`	# `'beforeSave'`
`string`	`EventAfterSave`	# `'afterSave'`
`string`	`EventBeforeInsert`	# `'beforeInsert'`
`string`	`EventAfterInsert`	# `'afterInsert'`
`string`	`EventBeforeUpdate`	# `'beforeUpdate'`
`string`	`EventAfterUpdate`	# `'afterUpdate'`
`string`	`EventBeforeDelete`	# `'beforeDelete'`
`string`	`EventAfterDelete`	# `'afterDelete'`

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Interfaces

Interface EntityManagerInterface

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Returns

Throws

Since

Parameters

See

Since

Parameters

See

Since

Parameters

See

Since

Parameters

See

Since

Returns

Since

Returns

Constants summary

Contact us