King23\Mongo\MongoObject

Complexity

Total Complexity

16

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setCollection()	0	5	1
A	loadFromArray()	0	4	1
A	delete()	0	4	1
A	save()	0	4	1
A	refresh()	0	6	2
A	getIterator()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetUnset()	0	4	1
A	offsetSet()	0	4	1
A	__set()	0	4	1
A	__get()	0	8	2
A	__wakeup()	0	4	1

<?php
/*
 MIT License
 Copyright (c) 2010 - 2018 Peter Petermann

 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:

 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.

*/
namespace King23\Mongo;

/**
 * Base class to handle objects stored in MongoDB
 *
 * @throws Exception
 */
abstract class MongoObject implements \IteratorAggregate, \ArrayAccess
{
    /**
     * @var \MongoCollection collection used by instance
     */
    protected $myCollection;

    /**
     * @var String
     */
    protected $myCollectionName;

    /**
     * @var array container to store the data of this object
     */
    protected $myData = null;

    /**
     * @var MongoServiceInterface
     */
    protected $myFactory;

    /**
     * constructor, meant to setup the object, should be called by derived classes
     *
     * @param MongoServiceInterface $factory
     */
    public function __construct(MongoServiceInterface $factory)
    {
        $this->myFactory = $factory;
    }

    /**
     * sets the collection name - this will call
     * __wakeup to ensure the right collection is loaded,
     * use with care.
     *
     * @param string $collectioName
     * @throws \MongoException
     */
    public function setCollection($collectioName)
    {
        $this->myCollectionName = $collectioName;
        $this->__wakeup();
    }

    /**
     * load data from array
     *
     * @param  $data
     * @return void
     */
    public function loadFromArray(array $data)
    {
        $this->myData = $data;
    }

    /**
     * remove the instance from the mongodb - this will not kill the object in local space however
     *
     * @return void
     * @throws \MongoCursorException
     * @throws \MongoCursorTimeoutException
     */
    public function delete()
    {
        $this->myCollection->remove(['_id' => $this->myData['_id']]);
    }

    /**
     * save the object in the mongodb, will insert on new object, or update if _id is set
     *
     * @return void
     * @throws \MongoCursorException
     * @throws \MongoCursorTimeoutException
     * @throws \MongoException
     */
    public function save()
    {
        $this->myCollection->save($this->myData);
    }

    /**
     * refreshes object from database (all changes be lost!)
     *
     * @return void
     */
    public function refresh()
    {
        if ($data = $this->myCollection->findOne(['_id' => $this->myData['_id']])) {
            $this->myData = $data;
        }
    }
    // --------------------------- Iterator Fun
    /**
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->myData);
    }
    // --------------------------- ARRAY ACCESS
    /**
     * @param string $offset
     * @return bool
     */
    public function offsetExists($offset)
    {
        return isset($this->myData[$offset]);
    }

    /**
     * @param string $offset
     * @return mixed
     */
    public function offsetGet($offset)
    {
        return $this->myData[$offset];
    }

    /**
     * @param string $offset
     */
    public function offsetUnset($offset)
    {
        unset($this->myData[$offset]);
    }

    /**
     * @param  $offset
     * @param  $value
     * @return mixed
     */
    public function offsetSet($offset, $value)
    {
        return $this->myData[$offset] = $value;
    }
    // --------------------------- OBJECT STYLE ACCESS
    /**
     * @param string $name
     * @param mixed $value
     * @return void
     */
    public function __set($name, $value)
    {
        $this->myData[$name] = $value;
    }

    /**
     * @param string $name
     * @return mixed
     */
    public function __get($name)
    {
        if (isset($this->myData[$name])) {
            return $this->myData[$name];
        }

        return null;
    }
    // --------------------- unserialize

    /**
     * Magic wakeup method, will reconnect object on unserialze
     *
     * @throws \MongoException
     * @throws \Exception
     * @return void
     */
    public function __wakeup()
    {
        $this->myCollection = $this->myFactory->getDB()->selectCollection($this->myCollectionName);
    }
}