AppserverIo\Storage\AbstractStorage

Complexity

Total Complexity

8

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__wakeup()	0	4	1
	init()	0	1	?
A	collectGarbage()	0	4	1
A	getByTag()	0	4	1
A	has()	0	7	2
A	injectStorage()	0	4	1
A	getStorage()	0	4	1

<?php

/**
 * AppserverIo\Storage\AbstractStorage
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@techdivision.com>
 * @copyright 2015 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      http://github.com/appserver-io/storage
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Storage;

/**
 * A abstract storage implementation.
 *
 * @author    Tim Wagner <tw@techdivision.com>
 * @copyright 2015 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      http://github.com/appserver-io/storage
 * @link      http://www.appserver.io
 */
abstract class AbstractStorage implements StorageInterface
{

    /**
     * Register the trait that provides basic storage functionality.
     *
     * @var \Trait
     */
    use StorageTrait;

    /**
     * A storage backend, a \Stackable for example.
     *
     * @var mixed
     */
    protected $storage;

    /**
     * Passes the configuration and initializes the storage.
     */
    public function __construct()
    {
        $this->init();
        $this->flush();
    }

    /**
     * Restores the storage after the instance has been recovered
     * from sleep.
     *
     * @return void
     */
    public function __wakeup()
    {
        $this->init();
    }

    /**
     * Initializes the storage when the instance is constructed and the
     * __wakeup() method is invoked.
     *
     * @return void
     */
    abstract public function init();

    /**
     * (non-PHPdoc)
     *
     * @return void
     * @see \AppserverIo\Storage\StorageInterface::collectGarbage()
     */
    public function collectGarbage()
    {
        // nothing to do here, because gc is handled by memcache
    }

    /**
     * (non-PHPdoc)
     *
     * @param string $tag The tag to search for
     *
     * @return array An array with the identifier (key) and content (value) of all matching entries. An empty array if no entries matched
     * @see \AppserverIo\Storage\StorageInterface::getByTag()
     */
    public function getByTag($tag)
    {
        return $this->get($tag);
    }

    /**
     * (non-PHPdoc)
     *
     * @param string $entryIdentifier An identifier specifying the cache entry
     *
     * @return boolean TRUE if such an entry exists, FALSE if not
     * @see \AppserverIo\Storage\StorageInterface::has()
     */
    public function has($entryIdentifier)
    {
        if ($this->get($entryIdentifier) !== false) {
            return true;
        }
        return false;
    }

    /**
     * Injects the storage instance to use.
     *
     * @param mixed $storage The storge instance to use
     *
     * @return void
     */
    public function injectStorage($storage)
    {
        $this->storage = $storage;
    }

    /**
     * (non-PHPdoc)
     *
     * @return mixed The storage object itself
     * @see \AppserverIo\Storage\StorageInterface::getStorage()
     */
    public function getStorage()
    {
        return $this->storage;
    }
}