Sokil\Mongo\Document\RevisionManager

Complexity

Total Complexity

10

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	listen()	0	16	1
A	getRevisionsCollection()	0	18	2
A	getRevisions()	0	17	3
A	getRevision()	0	8	1
A	getRevisionsCount()	0	8	1
A	clearRevisions()	0	12	1

<?php

namespace Sokil\Mongo\Document;

use Sokil\Mongo\Document;
use Sokil\Mongo\Expression;

class RevisionManager
{

    /**
     * Suffix added to collection name to get name of revisions collection
     * @var string
     */
    const REVISION_COLLECTION_SUFFIX = '.revisions';
    
    /**
     *
     * @var \Sokil\Mongo\Document
     */
    private $document;

    private $revisionsCollection;

    public function __construct(Document $document = null)
    {
        $this->document = $document;
    }

    /**
     * Start listening for changes in document
     */
    public function listen()
    {
        $revisionsCollection = $this->getRevisionsCollection();
        $document = $this->document;

        $createRevisionCallback = function () use ($revisionsCollection, $document) {
            // create new revision
            $revisionsCollection
                ->createDocument()
                ->setDocumentData($document->getOriginalData())
                ->save();
        };

        $this->document->onBeforeUpdate($createRevisionCallback, PHP_INT_MAX);
        $this->document->onBeforeDelete($createRevisionCallback, PHP_INT_MAX);
    }

    /**
     * @return \Sokil\Mongo\Collection
     */
    private function getRevisionsCollection()
    {
        if ($this->revisionsCollection) {
            return $this->revisionsCollection;
        }

        $collection = $this->document->getCollection();
        $revisionsCollectionName = $collection->getName() . self::REVISION_COLLECTION_SUFFIX;

        $this->revisionsCollection = $collection
            ->getDatabase()
            ->map($revisionsCollectionName, array(
                'documentClass' => '\Sokil\Mongo\Revision',
            ))
            ->getCollection($revisionsCollectionName);

        return $this->revisionsCollection;
    }

    public function getRevisions($limit = null, $offset = null)
    {
        $cursor = $this

The method where does not exist on object<Sokil\Mongo\Cursor>? Since you implemented __call, maybe consider adding a @method annotation.

            ->getRevisionsCollection()
            ->find()
            ->where('__documentId__', $this->document->getId());

        if ($limit) {
            $cursor->limit($limit);
        }

        if ($offset) {
            $cursor->skip($offset);
        }

        return $cursor->findAll();
    }

    /**
     * Get revision by id
     *
     * @param int|string|\MongoId $id
     * @return \Sokil\Mongo\Revision
     */
    public function getRevision($id)
    {
        return $this

The expression $this->getRevisionsCollection()->find()->byId($id)->findOne(); of type Sokil\Mongo\Document|array|null adds the type array to the return on line 98 which is incompatible with the return type documented by Sokil\Mongo\Document\RevisionManager::getRevision of type Sokil\Mongo\Revision|null.

The method Sokil\Mongo\Cursor::findOne() has been deprecated with message: since v.1.22.2. Use ::one instead

            ->getRevisionsCollection()
            ->find()
            ->byId($id)
            ->findOne();
    }

    public function getRevisionsCount()
    {
        return $this

The method where does not exist on object<Sokil\Mongo\Cursor>? Since you implemented __call, maybe consider adding a @method annotation.

            ->getRevisionsCollection()
            ->find()
            ->where('__documentId__', $this->document->getId())
            ->count();
    }

    public function clearRevisions()
    {
        $documentId = $this->document->getId();
        $this
            ->getRevisionsCollection()
            ->batchDelete(function (Expression $expression) use ($documentId) {
                /* @var $expression \Sokil\Mongo\Expression */
                return $expression->where('__documentId__', $documentId);
            });

        return $this;
    }
}