kakserpom / phpdaemon

PHPDaemon/Clients/Mongo/Collection.php

<?php
namespace PHPDaemon\Clients\Mongo;

/**
 * @package    Applications
 * @subpackage MongoClientAsync
 * @author     Vasily Zorin <maintainer@daemon.io>
 */
class Collection
{
    use \PHPDaemon\Traits\ClassWatchdog;
    use \PHPDaemon\Traits\StaticObjectWatchdog;

    /**
     * @var Pool Related Pool object
     */
    public $pool;

    /**
     * @var string Name of collection
     */
    public $name;

    /**
     * Contructor of MongoClientAsyncCollection
     * @param  string $name Name of collection
     * @param  Pool $pool Pool
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($name, $pool)
    {
        $this->name = $name;
        $this->pool = $pool;
    }

    /**
     * Finds objects in collection
     * @param  callable $cb Callback called when response received
     * @param  array $p Hash of properties (offset, limit, opts, tailable, where, col, fields, sort, hint, explain, snapshot, orderby, parse_oplog)
     * @callback $cb ( )
     * @return void
     */
    public function find($cb, $p = [])
    {
        $p['col'] = $this->name;
        $this->pool->find($p, $cb);
    }

    /**
     * Finds objects in collection and fires callback when got all objects
     * @param  callable $cb Callback called when response received
     * @param  array $p Hash of properties (offset, limit, opts, tailable, where, col, fields, sort, hint, explain, snapshot, orderby, parse_oplog)
     * @callback $cb ( )
     * @return void
     */
    public function findAll($cb, $p = [])
    {
        $p['col'] = $this->name;
        $this->pool->findAll($p, $cb);
    }

    /**
     * Finds one object in collection
     * @param  callable $cb Callback called when response received
     * @param  array $p Hash of properties (offset,  opts, where, col, fields, sort, hint, explain, snapshot, orderby, parse_oplog)
     * @callback $cb ( )
     * @return void
     */
    public function findOne($cb, $p = [])
    {
        $p['col'] = $this->name;
        $this->pool->findOne($p, $cb);
    }

    /**
     * Counts objects in collection
     * @param  callable $cb Callback called when response received
     * @param  array $p Hash of properties (offset, limit, opts, where, col)
     * @callback $cb ( )
     * @return void
     */
    public function count($cb, $p = [])
    {
        $p['col'] = $this->name;
        $this->pool->findCount($p, $cb);
    }

    /**
     * Ensure index
     * @param  array $keys Keys
     * @param  array $options Optional. Options
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @callback $cb ( )
     * @return void
     */
    public function ensureIndex($keys, $options = [], $cb = null)
    {
        $this->pool->ensureIndex($this->name, $keys, $options, $cb);
    }

    /**
     * Groupping function
     * @param  callable $cb Callback called when response received
     * @param  array $p Hash of properties (offset, limit, opts, key, col, reduce, initial)
     * @callback $cb ( )
     * @return void
     */
    public function group($cb, $p = [])
    {
        $p['col'] = $this->name;
        $this->pool->group($p, $cb);
    }

    /**
     * Inserts an object
     * @param  array $doc Data
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return MongoId
     */
    public function insert($doc, $cb = null, $params = null)
    {
        return $this->pool->insert($this->name, $doc, $cb, $params);

It seems like $params defined by parameter $params on line 122 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::insert() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Inserts an object
     * @param  array $doc Data
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return MongoId
     */
    public function insertOne($doc, $cb = null, $params = null)
    {
        return $this->pool->insert($this->name, $doc, $cb, $params);

It seems like $params defined by parameter $params on line 135 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::insert() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Inserts several documents
     * @param  array $docs Array of docs
     * @param  callable $cb Optional. Callback called when response received.

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return array    IDs
     */
    public function insertMulti($docs, $cb = null, $params = null)
    {
        return $this->pool->insertMulti($this->name, $docs, $cb, $params);

It seems like $params defined by parameter $params on line 148 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::insertMulti() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Updates one object in collection
     * @param  array $cond Conditions
     * @param  array $data Data
     * @param  integer $flags Optional. Flags
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function update($cond, $data, $flags = 0, $cb = null, $params = null)
    {
        $this->pool->update($this->name, $cond, $data, $flags, $cb, $params);

It seems like $params defined by parameter $params on line 163 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::update() does only seem to accept array, maybe add an additional type check?

    }


    /**
     * Updates one object in collection
     * @param  array $cond Conditions
     * @param  array $data Data
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function updateOne($cond, $data, $cb = null, $params = null)
    {
        $this->pool->updateOne($this->name, $cond, $data, $cb, $params);

It seems like $params defined by parameter $params on line 178 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::updateOne() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Updates one object in collection
     * @param  array $cond Conditions
     * @param  array $data Data
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function updateMulti($cond, $data, $cb = null, $params = null)
    {
        $this->pool->updateMulti($this->name, $cond, $data, $cb, $params);

It seems like $params defined by parameter $params on line 192 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::updateMulti() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Upserts an object (updates if exists, insert if not exists)
     * @param  array $cond Conditions
     * @param  array $data Data
     * @param  boolean $multi Optional. Multi-flag
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function upsert($cond, $data, $multi = false, $cb = null, $params = null)
    {
        $this->pool->upsert($this->name, $cond, $data, $multi, $cb, $params);

It seems like $params defined by parameter $params on line 207 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::upsert() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Upserts an object (updates if exists, insert if not exists)
     * @param  array $cond Conditions
     * @param  array $data Data
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function upsertOne($cond, $data, $cb = null, $params = null)
    {
        $this->pool->upsertOne($this->name, $cond, $data, $cb, $params);

It seems like $params defined by parameter $params on line 221 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::upsertOne() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Upserts an object (updates if exists, insert if not exists)
     * @param  array $cond Conditions
     * @param  array $data Data
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function upsertMulti($cond, $data, $cb = null, $params = null)
    {
        $this->pool->upsertMulti($this->name, $cond, $data, $cb, $params);

It seems like $params defined by parameter $params on line 235 can also be of type null; however, PHPDaemon\Clients\Mongo\Pool::upsertMulti() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Removes objects from collection
     * @param  array $cond Conditions
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @param  array $params Optional. Params

Should the type for parameter $params not be array|null?

     * @callback $cb ( )
     * @return void
     */
    public function remove($cond = [], $cb = null, $params = null)

The parameter $params is not used and could be removed.

    {
        $this->pool->remove($this->name, $cond, $cb);
    }

    /**
     * Evaluates a code on the server side
     * @param  string $code Code
     * @param  callable $cb Callback called when response received
     * @callback $cb ( )
     * @return void
     */
    public function evaluate($code, $cb)
    {
        $this->pool->evaluate($code, $cb);
    }


    /**
     * Aggregate
     * @param  array $p Params
     * @param  callable $cb Callback called when response received
     * @callback $cb ( )
     * @return void
     */
    public function aggregate($p, $cb)
    {
        $p['col'] = $this->name;
        $this->pool->aggregate($p, $cb);
    }

    /**
     * Generation autoincrement
     * @param  callable $cb Called when response received
     * @param  boolean $plain Plain?
     * @callback $cb ( )
     * @return void
     */
    public function autoincrement($cb, $plain = false)
    {
        $e = explode('.', $this->name);
        $col = (isset($e[1]) ? $e[0] . '.' : '') . 'autoincrement';
        $this->pool->{$col}->findAndModify([
            'query' => ['_id' => isset($e[1]) ? $e[1] : $e[0]],
            'update' => ['$inc' => ['seq' => 1]],
            'new' => true,
            'upsert' => true,
        ], $plain ? function ($lastError) use ($cb) {
            $cb(isset($lastError['value']['seq']) ? $lastError['value']['seq'] : false);
        } : $cb);
    }

    /**
     * Generation autoincrement
     * @param  array $p Params
     * @param  callable $cb Callback called when response received
     * @callback $cb ( )
     * @return void
     */
    public function findAndModify($p, $cb)
    {
        $p['col'] = $this->name;
        $this->pool->findAndModify($p, $cb);
    }
}