KeyTrait - Code Metrics - adammbalogh/key-value-store-shared-memory - Measure and Improve Code Quality continuously with Scrutinizer

KeyTrait A
last analyzed 2016-07-11 11:15 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
wmc	14
c	2
b	1
f	0
lcom	1
cbo	2
dl	0
loc	125
rs	10

5 Methods

Rating	Name	Size	Complexity
A	delete()	14	3
A	expire()	10	2
A	getTtl()	15	3
A	has()	10	2
A	persist()	21	4

<?php namespace AdammBalogh\KeyValueStore\Adapter\SharedMemoryAdapter;

use AdammBalogh\KeyValueStore\Adapter\Util;
use AdammBalogh\KeyValueStore\Exception\KeyNotFoundException;

/**
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
trait KeyTrait
{
    /**
     * Removes a key.
     *
     * @param string $key
     *
     * @return bool True if the deletion was successful, false if the deletion was unsuccessful.
     *
     * @throws \Exception
     */
    public function delete($key)
    {
        try {
            $this->get($key);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (KeyNotFoundException $e) {
            return false;
        }

        if (!$this->shmProxy->remove($this->client, $key)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            throw new \Exception('Shm remove error');
        }

        return true;
    }

    /**
     * Sets a key's time to live in seconds.
     *
     * @param string $key
     * @param int $seconds
     *
     * @return bool True if the timeout was set, false if the timeout could not be set.
     *
     * @throws \Exception
     */
    public function expire($key, $seconds)
    {
        try {
            $value = $this->get($key);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (KeyNotFoundException $e) {
            return false;
        }

        return $this->set($key, Util::getDataWithExpire($value, $seconds, time()));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Returns the remaining time to live of a key that has a timeout.
     *
     * @param string $key
     *
     * @return int Ttl in seconds.
     *
     * @throws KeyNotFoundException
     * @throws \Exception
     */
    public function getTtl($key)
    {
        if (!$this->shmProxy->has($this->client, $key)) {
            throw new KeyNotFoundException();
        }

        $getResult = $this->shmProxy->get($this->client, $key);
        $unserialized = @unserialize($getResult);

        if (!Util::hasInternalExpireTime($unserialized)) {
            throw new \Exception('Cannot retrieve ttl');
        }

        return $this->handleTtl($key, $unserialized['ts'], $unserialized['s']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Determines if a key exists.
     *
     * @param string $key
     *
     * @return bool True if the key does exist, false if the key does not exist.
     *
     * @throws \Exception
     */
    public function has($key)
    {
        try {
            $this->get($key);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (KeyNotFoundException $e) {
            return false;
        }

        return true;
    }

    /**
     * Removes the existing timeout on key, turning the key from volatile (a key with an expire set)
     * to persistent (a key that will never expire as no timeout is associated).
     *
     * @param string $key
     *
     * @return bool True if the persist was success, false if the persis was unsuccessful.
     *
     * @throws \Exception
     */
    public function persist($key)
    {
        if (!$this->shmProxy->has($this->client, $key)) {
            return false;
        }

        $getResult = $this->shmProxy->get($this->client, $key);
        $unserialized = @unserialize($getResult);

        if (!Util::hasInternalExpireTime($unserialized)) {
            return false;
        }

        try {
            $this->handleTtl($key, $unserialized['ts'], $unserialized['s']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (KeyNotFoundException $e) {
            return false;
        }

        return $this->set($key, $unserialized['v']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1			<?php namespace AdammBalogh\KeyValueStore\Adapter\SharedMemoryAdapter;
2
3			use AdammBalogh\KeyValueStore\Adapter\Util;
4			use AdammBalogh\KeyValueStore\Exception\KeyNotFoundException;
5
6			/**
7			* @SuppressWarnings(PHPMD.UnusedFormalParameter)
8			*/
9			trait KeyTrait
10			{
11			/**
12			* Removes a key.
13			*
14			* @param string $key
15			*
16			* @return bool True if the deletion was successful, false if the deletion was unsuccessful.
17			*
18			* @throws \Exception
19			*/
20			public function delete($key)
21			{
22			try {
23			$this->get($key);
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
24			} catch (KeyNotFoundException $e) {
25			return false;
26			}
27
28			if (!$this->shmProxy->remove($this->client, $key)) {
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report The property `shmProxy` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report The property `client` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
29			throw new \Exception('Shm remove error');
30			}
31
32			return true;
33			}
34
35			/**
36			* Sets a key's time to live in seconds.
37			*
38			* @param string $key
39			* @param int $seconds
40			*
41			* @return bool True if the timeout was set, false if the timeout could not be set.
42			*
43			* @throws \Exception
44			*/
45			public function expire($key, $seconds)
46			{
47			try {
48			$value = $this->get($key);
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
49			} catch (KeyNotFoundException $e) {
50			return false;
51			}
52
53			return $this->set($key, Util::getDataWithExpire($value, $seconds, time()));
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `set()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
54			}
55
56			/**
57			* Returns the remaining time to live of a key that has a timeout.
58			*
59			* @param string $key
60			*
61			* @return int Ttl in seconds.
62			*
63			* @throws KeyNotFoundException
64			* @throws \Exception
65			*/
66			public function getTtl($key)
67			{
68			if (!$this->shmProxy->has($this->client, $key)) {
69			throw new KeyNotFoundException();
70			}
71
72			$getResult = $this->shmProxy->get($this->client, $key);
73			$unserialized = @unserialize($getResult);
74
75			if (!Util::hasInternalExpireTime($unserialized)) {
76			throw new \Exception('Cannot retrieve ttl');
77			}
78
79			return $this->handleTtl($key, $unserialized['ts'], $unserialized['s']);
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `handleTtl()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
80			}
81
82			/**
83			* Determines if a key exists.
84			*
85			* @param string $key
86			*
87			* @return bool True if the key does exist, false if the key does not exist.
88			*
89			* @throws \Exception
90			*/
91			public function has($key)
92			{
93			try {
94			$this->get($key);
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
95			} catch (KeyNotFoundException $e) {
96			return false;
97			}
98
99			return true;
100			}
101
102			/**
103			* Removes the existing timeout on key, turning the key from volatile (a key with an expire set)
104			* to persistent (a key that will never expire as no timeout is associated).
105			*
106			* @param string $key
107			*
108			* @return bool True if the persist was success, false if the persis was unsuccessful.
109			*
110			* @throws \Exception
111			*/
112			public function persist($key)
113			{
114			if (!$this->shmProxy->has($this->client, $key)) {
115			return false;
116			}
117
118			$getResult = $this->shmProxy->get($this->client, $key);
119			$unserialized = @unserialize($getResult);
120
121			if (!Util::hasInternalExpireTime($unserialized)) {
122			return false;
123			}
124
125			try {
126			$this->handleTtl($key, $unserialized['ts'], $unserialized['s']);
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `handleTtl()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
127			} catch (KeyNotFoundException $e) {
128			return false;
129			}
130
131			return $this->set($key, $unserialized['v']);
			0 ignored issues – show Bug introduced 2016-07-11 11:15 UTC by Report Bug Copy Issue Report It seems like `set()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
132			}
133			}
134

adammbalogh / key-value-store-shared-memory

KeyTrait A last analyzed 2016-07-11 11:15 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

KeyTrait A
last analyzed 2016-07-11 11:15 UTC