StackableStorage::set() - Code Metrics - appserver-io/storage - Measure and Improve Code Quality continuously with Scrutinizer

StackableStorage::set() B
last analyzed 2016-05-10 16:42 UTC

↳ Parent: StackableStorage

Complexity

Conditions	6
Paths	4

Size

Total Lines	22
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	22
rs	8.6737
cc	6
eloc	10
nc	4
nop	4

<?php

/**
 * AppserverIo\Storage\StackableStorage
 *
 * 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 <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @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 storage implementation that uses a \Stackable to hold the data persistent
 * in memory.
 *
 * This storage will completely be flushed when the the object is destroyed,
 * there is no automatic persistence functionality available.
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @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
 * @deprecated Use \AppserverIo\Storage\ThreadedStorage instead
 */
class StackableStorage extends GenericStackable implements StorageInterface

{

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

    /**
     * Passes the configuration and initializes the storage.
     *
     * The identifier will be set after the init() function has been invoked, so it'll overwrite the one
     * specified in the configuration if set.
     *
     * @return void

     */
    public function __construct()
    {
        $this->flush();
    }

    /**
     * (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)
     *
     * @return mixed The storage object itself
     * @see \AppserverIo\Storage\StorageInterface::getStorage()
     */
    public function getStorage()
    {
        return;
    }

    /**
     * (non-PHPdoc)
     *
     * @param string  $entryIdentifier Something which identifies the data - depends on concrete cache
     * @param mixed   $data            The data to cache - also depends on the concrete cache implementation
     * @param array   $tags            Tags to associate with this cache entry
     * @param integer $lifetime        Lifetime of this cache entry in seconds. If NULL is specified,
     *                                 the default lifetime is used. "0" means unlimited lifetime.
     *
     * @return void
     *
     * @see \AppserverIo\Storage\StorageInterface::set()
     */
    public function set($entryIdentifier, $data, array $tags = array(), $lifetime = null)
    {

        // set the data in the storage
        $this[$entryIdentifier] = $data;

        // if tags has been set, tag the data additionally
        foreach ($tags as $tag) {
            // assemble the tag data
            $tagData = $this->get($tag);
            if (is_array($tagData) && in_array($entryIdentifier, $tagData, true) === true) {
                // do nothing here
            } elseif (is_array($tagData) && in_array($entryIdentifier, $tagData, true) === false) {
                $tagData[] = $entryIdentifier;
            } else {
                $tagData = array($entryIdentifier);
            }

            // tag the data
            $this[$tag] = $tagData;
        }
    }

    /**
     * (non-PHPdoc)
     *
     * @param string $entryIdentifier Something which identifies the cache entry - depends on concrete cache
     *
     * @return mixed
     * @see \AppserverIo\Storage\StorageInterface::get()
     */
    public function get($entryIdentifier)
    {
        return $this[$entryIdentifier];
    }

    /**
     * (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)
    {
        return isset($this[$entryIdentifier]);
    }

    /**
     * (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::remove()
     */
    public function remove($entryIdentifier)
    {
        if ($this->has($entryIdentifier)) {
            unset($this[$entryIdentifier]);
            return true;
        }
        return false;
    }

    /**
     * (non-PHPdoc)
     *
     * @return array
     * @see \AppserverIo\Storage\StorageInterface::getAllKeys()
     */
    public function getAllKeys()
    {
        $keys = array();
        foreach ((array) $this as $key => $value) {
            $keys[] = $key;
        }
        return $keys;
    }
}


1			<?php
2
3			/**
4			* AppserverIo\Storage\StackableStorage
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2015 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link http://github.com/appserver-io/storage
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\Storage;
22
23			/**
24			* A storage implementation that uses a \Stackable to hold the data persistent
25			* in memory.
26			*
27			* This storage will completely be flushed when the the object is destroyed,
28			* there is no automatic persistence functionality available.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2015 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link http://github.com/appserver-io/storage
34			* @link http://www.appserver.io
35			* @deprecated Use \AppserverIo\Storage\ThreadedStorage instead
36			*/
37			class StackableStorage extends GenericStackable implements StorageInterface
			0 ignored issues – show Deprecated Code introduced 2016-05-10 14:25 UTC by Report Bug Copy Issue Report The class `AppserverIo\Storage\GenericStackable` has been deprecated with message: Use \AppserverIo\Storage\GenericThreaded instead This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
38			{
39
40			/**
41			* Register the trait that provides basic storage functionality.
42			*
43			* @var \Trait
44			*/
45			use StorageTrait;
46
47			/**
48			* Passes the configuration and initializes the storage.
49			*
50			* The identifier will be set after the init() function has been invoked, so it'll overwrite the one
51			* specified in the configuration if set.
52			*
53			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-05-10 14:25 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
54			*/
55			public function __construct()
56			{
57			$this->flush();
58			}
59
60			/**
61			* (non-PHPdoc)
62			*
63			* @return void
64			* @see \AppserverIo\Storage\StorageInterface::collectGarbage()
65			*/
66			public function collectGarbage()
67			{
68			// nothing to do here, because gc is handled by memcache
69			}
70
71			/**
72			* (non-PHPdoc)
73			*
74			* @param string $tag The tag to search for
75			*
76			* @return array An array with the identifier (key) and content (value) of all matching entries. An empty array if no entries matched
77			* @see \AppserverIo\Storage\StorageInterface::getByTag()
78			*/
79			public function getByTag($tag)
80			{
81			return $this->get($tag);
82			}
83
84			/**
85			* (non-PHPdoc)
86			*
87			* @return mixed The storage object itself
88			* @see \AppserverIo\Storage\StorageInterface::getStorage()
89			*/
90			public function getStorage()
91			{
92			return;
93			}
94
95			/**
96			* (non-PHPdoc)
97			*
98			* @param string $entryIdentifier Something which identifies the data - depends on concrete cache
99			* @param mixed $data The data to cache - also depends on the concrete cache implementation
100			* @param array $tags Tags to associate with this cache entry
101			* @param integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified,
102			* the default lifetime is used. "0" means unlimited lifetime.
103			*
104			* @return void
105			*
106			* @see \AppserverIo\Storage\StorageInterface::set()
107			*/
108			public function set($entryIdentifier, $data, array $tags = array(), $lifetime = null)
109			{
110
111			// set the data in the storage
112			$this[$entryIdentifier] = $data;
113
114			// if tags has been set, tag the data additionally
115			foreach ($tags as $tag) {
116			// assemble the tag data
117			$tagData = $this->get($tag);
118			if (is_array($tagData) && in_array($entryIdentifier, $tagData, true) === true) {
119			// do nothing here
120			} elseif (is_array($tagData) && in_array($entryIdentifier, $tagData, true) === false) {
121			$tagData[] = $entryIdentifier;
122			} else {
123			$tagData = array($entryIdentifier);
124			}
125
126			// tag the data
127			$this[$tag] = $tagData;
128			}
129			}
130
131			/**
132			* (non-PHPdoc)
133			*
134			* @param string $entryIdentifier Something which identifies the cache entry - depends on concrete cache
135			*
136			* @return mixed
137			* @see \AppserverIo\Storage\StorageInterface::get()
138			*/
139			public function get($entryIdentifier)
140			{
141			return $this[$entryIdentifier];
142			}
143
144			/**
145			* (non-PHPdoc)
146			*
147			* @param string $entryIdentifier An identifier specifying the cache entry
148			*
149			* @return boolean TRUE if such an entry exists, FALSE if not
150			* @see \AppserverIo\Storage\StorageInterface::has()
151			*/
152			public function has($entryIdentifier)
153			{
154			return isset($this[$entryIdentifier]);
155			}
156
157			/**
158			* (non-PHPdoc)
159			*
160			* @param string $entryIdentifier An identifier specifying the cache entry
161			*
162			* @return boolean TRUE if such an entry exists, FALSE if not
163			* @see \AppserverIo\Storage\StorageInterface::remove()
164			*/
165			public function remove($entryIdentifier)
166			{
167			if ($this->has($entryIdentifier)) {
168			unset($this[$entryIdentifier]);
169			return true;
170			}
171			return false;
172			}
173
174			/**
175			* (non-PHPdoc)
176			*
177			* @return array
178			* @see \AppserverIo\Storage\StorageInterface::getAllKeys()
179			*/
180			public function getAllKeys()
181			{
182			$keys = array();
183			foreach ((array) $this as $key => $value) {
184			$keys[] = $key;
185			}
186			return $keys;
187			}
188			}
189

appserver-io / storage

StackableStorage::set() B last analyzed 2016-05-10 16:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

StackableStorage::set() B
last analyzed 2016-05-10 16:42 UTC