• Главная
• Sokil
• Mongo
• Collection

PHP Класс Sokil\Mongo\Collection

It aggregates \MongoCollection instance. Показать файл Открыть проект Примеры использования класса

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

Свойство	Тип	Описание
$_index		Every index definition must contain key 'keys' with list of fields and orders, and optional options from @link http://php.net/manual/en/mongocollection.createindex.php: Example: array( array( 'keys' => array('field1' => 1, 'field2' => -1), 'unique' => true ), ... )
$_queryExpressionClass		expression class. This class may be overloaded to define own query methods (whereUserAgeGreatedThan(), etc.)
$mongoCollectionClassName
$versioning		default value of versioning

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

Метод	Описание
__construct ( Database $database, $collection, Definition $definition = null )
__get ( $name )
addDocumentToDocumentPool ( Document $document ) : Collection	Store document to pool
addDocumentsToDocumentPool ( array $documents ) : Collection	Store documents to identity map
aggregate ( callable | array | Pipeline $pipeline, array $options = [], boolean $asCursor = false ) : array	Aggregate using pipeline
batchDelete ( callable | array | Expression $expression = [] ) : Collection	Delete documents by expression
batchInsert ( array $rows, $validate = true ) : Collection	Insert multiple documents defined as arrays
batchUpdate ( Expression | array | callable $expression, Operator | array | callable $updateData ) : Collection	Update multiple documents
clearDocumentPool ( )
count ( ) : integer	Total count of documents in collection
createAggregator ( ) : Pipeline	Start aggregation
createBatchDelete ( integer | string $writeConcern = null, integer $timeout = null, boolean $ordered = null ) : Sokil\Mongo\BatchDelete	Creates batch delete operation handler
createBatchInsert ( integer | string $writeConcern = null, integer $timeout = null, boolean $ordered = null ) : Sokil\Mongo\BatchInsert	Creates batch insert operation handler
createBatchUpdate ( integer | string $writeConcern = null, integer $timeout = null, boolean $ordered = null ) : Sokil\Mongo\BatchUpdate	Creates batch update operation handler
createDocument ( array $data = null ) : Document	Factory method to get not stored Document instance from array
createIndex ( array $key, array $options = [] ) : Collection	Create index
delete ( ) : Collection	Delete collection
deleteDocument ( Document $document ) : Collection
deleteDocuments ( $expression = [] )
deleteIndex ( array $key ) : Collection	Delete index
disableDocumentPool ( ) : Collection	Stop storing found documents to pool
documentPoolCount ( ) : integer	Get number of documents in document pool
enableDocumentPool ( ) : Collection	Start storing found documents to pool
enableVersioning ( ) : Collection	Start versioning documents on modify
ensure2dIndex ( string $field ) : Collection	Create geo index 2dsphere
ensure2dSphereIndex ( string $field ) : Collection	Create geo index 2dsphere
ensureFulltextIndex ( array | string $field = '$**', array $weights = null, $defaultLanguage = Language::ENGLISH, $languageOverride = null ) : Collection	Create fulltext index
ensureIndex ( array $key, array $options = [] ) : Collection	Create index
ensureSparseIndex ( array $key ) : Collection	Create sparse index.
ensureTTLIndex ( array $key, integer $seconds ) : Collection	Create TTL index
ensureUniqueIndex ( array $key, boolean $dropDups = false ) : Collection	Create unique index
explainAggregate ( array | Pipeline $pipeline ) : array	Explain aggregation
expression ( ) : Expression	Create new Expression instance to use in query builder or update operations
find ( $callable = null ) : Cursor | Expression	Create document query builder
findAsArray ( $callable = null ) : Cursor	Create document query builder
getDatabase ( ) : Database
getDistinct ( string $selector, array | callable | Expression $expression = null ) : array	Retrieve a list of distinct values for the given key across a collection.
getDocument ( string | MongoId $id, callable $callable = null ) : Document | array | null	Get document by id If callable specified, document always loaded directly omitting document pool.
getDocumentByReference ( array $ref, boolean $useDocumentPool = true ) : Document | null	Get Document instance by it's reference
getDocumentClassName ( array $documentData = null ) : string	Override to define class name of document by document data
getDocumentDirectly ( string | MongoId $id, callable $callable = null ) : Document | array | null	Get document by id directly omitting cache Method may return document as array if cursor configured through Cursor::asArray()
getDocumentFromDocumentPool ( string | integer | MongoId $id ) : Document	Get document from identity map by it's id
getDocuments ( array $idList, callable $callable = null ) : array | null	Get documents by list of id
getDocumentsFromDocumentPool ( array $ids = null )	Get documents from pool if they stored
getIndexes ( ) : array	Get index info
getMongoCollection ( ) : MongoCollection	Get native collection instance of mongo driver
getName ( ) : string	Get name of collection
getOption ( string | integer $name ) : mixed	Get option
getOptions ( )
getReadPreference ( )
getWriteConcern ( ) : integer | string	Get currently active write concern on all requests to collection
hasDocument ( Document $document ) : type	Check if document belongs to collection
hydrate ( array $data, $useDocumentPool = true ) : Document	Factory method to get document object from array of stored document
initIndexes ( ) : Collection	Create indexes based on self::$_index metadata
insert ( array $document ) : Collection	Direct insert of array to MongoDB without creating document object and validation
insertMultiple ( $rows, $validate = true )
isDocumentInDocumentPool ( Document | MongoId | integer | string $document ) : boolean	Check if document exists in identity map
isDocumentPoolEmpty ( ) : boolean	Check if documents are in pool
isDocumentPoolEnabled ( ) : boolean	Check if document pool enabled and requested documents store to it
isVersioningEnabled ( ) : boolean	Check if versioning enabled
operator ( ) : Operator	Create Operator instance to use in update operations
readNearest ( array $tags = null )
readPrimaryOnly ( )
readPrimaryPreferred ( array $tags = null )
readSecondaryOnly ( array $tags = null )
readSecondaryPreferred ( array $tags = null )
removeDocumentFromDocumentPool ( Document $document ) : Collection	Remove document instance from identity map
setMajorityWriteConcern ( integer $timeout = 10000 ) : Collection	Define majority write concern for all requests to current collection
setUnacknowledgedWriteConcern ( integer $timeout = 10000 ) : Collection	Define unacknowledged write concern for all requests to current collection
setWriteConcern ( string | integer $w, integer $timeout = 10000 ) : Collection	Define write concern for all requests to current collection
stats ( ) : array	Get collection stat
update ( Expression | array | callable $expression, Operator | array | callable $updateData, array $options = [] ) : Collection	Update multiple documents
updateAll ( Operator | array | callable $updateData ) : Collection	Update all documents
updateMultiple ( $expression, $updateData )
validate ( boolean $full = false ) : array	Validates a collection. The method scans a collection’s data structures for correctness and returns a single document that describes the relationship between the logical collection and the physical representation of the data.

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

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