• Home
• lithium
• data
• source
• MongoDb

PHP Class lithium\data\source\MongoDb

Rather than operating on records and record sets, queries against MongoDB will return nested sets of Document objects. A Document's fields can contain both simple and complex data types (i.e. arrays) including other Document objects. After installing MongoDB, you can connect to it as follows: {{{//app/config/bootstrap/connections.php: Connections::add('default', array('type' => 'MongoDb', 'database' => 'myDb'));}}} By default, it will attempt to connect to a Mongo instance running on localhost on port 27017. See __construct() for details on the accepted configuration settings. Mostra file Open project: unionofrad/lithium Class Usage Examples

Public Properties

Property	Type	Description
$connection	object	The MongoDB object instance.
$server	object	The Mongo class instance.

Protected Properties

Property	Type	Description
$_autoConfig	array	List of configuration keys which will be automatically assigned to their corresponding protected class properties.
$_boolean	array	List of comparison operators to use when performing boolean logic in a query.
$_classes	array	Classes used by this class.
$_operators		Map of typical SQL-like operators to their MongoDB equivalents.
$_schema	Closure	A closure or anonymous function which receives an instance of this class, a collection name and associated meta information, and returns an array defining the schema for an associated model, where the keys are field names, and the values are arrays defining the type information for each field. At a minimum, type arrays must contain a 'type' key. For more information on schema definitions, and an example schema callback implementation, see the $_schema property of the Model class.

Public Methods

Method	Description
__call ( string $method, array $params ) : mixed	A method dispatcher that allows direct calls to native methods in PHP's Mongo object. Read more here: http://php.net/manual/class.mongo.php
__construct ( array $config = [] ) : void	Constructor.
__destruct ( ) : void	Destructor. Ensures that the server connection is closed and resources are freed when the adapter instance is destroyed.
calculation ( string $type, mixed $query, array $options = [] ) : integer	Executes calculation-related queries, such as those required for count.
conditions ( array $conditions, object $context ) : array	Maps incoming conditions with their corresponding MongoDB-native operators.
configureClass ( string $class ) : Returns	Configures a model class by overriding the default dependencies for 'set' and 'entity' , and sets the primary key to '_id', in keeping with Mongo's conventions.
connect ( ) : boolean	Connects to the Mongo server. Matches up parameters from the constructor to create a Mongo database connection.
create ( string $query, array $options = [] ) : boolean	Create new document
delete ( string $query, array $options = [] ) : boolean	Delete document
describe ( mixed $collection, mixed $fields = [], array $meta = [] ) : array	Gets the column 'schema' for a given MongoDB collection. Only returns a schema if the 'schema' configuration flag has been set in the constructor.
disconnect ( ) : boolean	Disconnect from the Mongo server.
enabled ( string $feature = null ) : boolean	With no parameter, checks to see if the mongo extension is installed. With a parameter, queries for a specific supported feature.
fields ( array $fields, object $context ) : array	Return formatted identifiers for fields.
group ( string | array $group, object $context ) : array	Formats group clauses for MongoDB.
limit ( mixed $limit, object $context ) : mixed	Return formatted clause for limit.
name ( string $name ) : string	Quotes identifiers.
order ( mixed $order, object $context ) : mixed	Return formatted clause for order.
read ( string $query, array $options = [] ) : object	Read from document
relationFieldName ( $type, $name ) : string	Returns the field name of a relation name (camelBack).
relationship ( string $class, string $type, string $name, array $config = [] ) : array	Document relationships.
respondsTo ( string $method, boolean $internal = false ) : boolean	Determines if a given method can be called.
schema ( $query, $resource = null, $context = null ) : array	Normally used in cases where the query is a raw string (as opposed to a Query object), to database must determine the correct column names from the result resource. Not applicable to this data source.
sources ( string $class = null ) : array	Returns the list of collections in the currently-connected database.
update ( string $query, array $options = [] ) : boolean	Update document

Protected Methods

Method	Description
_checkConnection ( )
_conditions ( array $conditions, string $model, object $schema, object $context ) : array	Protected helper method used to format conditions.
_deleteFile ( $conditions, $options = [] )
_group ( $group, $args, $options )
_init ( ) : void	Initializer. Adds operator handlers which will later allow to correctly cast any values.
_isMongoCode ( $conditions )
_ok ( $result ) : boolean	Parse a MongoCollection::() response and return true on success.
_operators ( $field, $operators, $schema )
_saveFile ( $data )

Method Details

Property Details