HandlerTrait::hashKey() - Code Metrics - fwolf/fwlib - Measure and Improve Code Quality continuously with Scrutinizer

HandlerTrait::hashKey() A
last analyzed 2019-05-09 15:53 UTC

↳ Parent: HandlerTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	1
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0

<?php
namespace Fwlib\Cache;

use Fwlib\Config\ConfigAwareTrait;

/**
 * Shared code of cache handlers
 *
 * @property    string  $emptyKeyReplacement
 * @property    string  $hashAlgorithm
 *
 * @copyright   Copyright 2012-2015 Fwolf
 * @license     http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
 */
trait HandlerTrait
{
    use ConfigAwareTrait;
    use LoggerAwareTrait;


    /**
     * Compute expiration timestamp
     *
     * @param   int     $lifetime       Length, in seconds
     * @param   int     $startTime      Start timestamp, default use time()
     * @return  int                     End timestamp or 0 for never expire
     */
    protected function computeExpireTime($lifetime = null, $startTime = 0)
    {
        // If not set, read lifetime from config
        if (is_null($lifetime)) {
            $lifetime = $this->getLifetime();
        }

        // 0 means never expire
        if (0 == $lifetime) {
            return 0;
        }

        if (0 == $startTime) {
            $startTime = time();
        }

        return $startTime + $lifetime;
    }


    /**
     * Get lifetime length, in seconds
     *
     * For solid lifetime length, define them in configs.
     * For dynamic lifetime length, overwrite this method to compute it.
     *
     * This implement will return 0 if config not set, means never expire.
     *
     * @param   string  $key
     * @return  int
     */
    protected function getLifetime($key = null)
    {
        true || $key;
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false

        return $this->getConfig('lifetime', 0);
    }


    /**
     * Convert required key to actual key inner used
     *
     * In some cache system, key may need manual hashed.
     *
     * @param   string  $key
     * @return  string
     */
    protected function hashKey($key)
    {
        $key = trim($key);

        // Key can not be empty
        if (empty($key)) {
            return $this->emptyKeyReplacement;
        }

        return empty($this->hashAlgorithm)
            ? $key
            : hash($this->hashAlgorithm, $key);
    }
}


1			<?php
2			namespace Fwlib\Cache;
3
4			use Fwlib\Config\ConfigAwareTrait;
5
6			/**
7			* Shared code of cache handlers
8			*
9			* @property string $emptyKeyReplacement
10			* @property string $hashAlgorithm
11			*
12			* @copyright Copyright 2012-2015 Fwolf
13			* @license http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
14			*/
15			trait HandlerTrait
16			{
17			use ConfigAwareTrait;
18			use LoggerAwareTrait;
19
20
21			/**
22			* Compute expiration timestamp
23			*
24			* @param int $lifetime Length, in seconds
25			* @param int $startTime Start timestamp, default use time()
26			* @return int End timestamp or 0 for never expire
27			*/
28			protected function computeExpireTime($lifetime = null, $startTime = 0)
29			{
30			// If not set, read lifetime from config
31			if (is_null($lifetime)) {
32			$lifetime = $this->getLifetime();
33			}
34
35			// 0 means never expire
36			if (0 == $lifetime) {
37			return 0;
38			}
39
40			if (0 == $startTime) {
41			$startTime = time();
42			}
43
44			return $startTime + $lifetime;
45			}
46
47
48			/**
49			* Get lifetime length, in seconds
50			*
51			* For solid lifetime length, define them in configs.
52			* For dynamic lifetime length, overwrite this method to compute it.
53			*
54			* This implement will return 0 if config not set, means never expire.
55			*
56			* @param string $key
57			* @return int
58			*/
59			protected function getLifetime($key = null)
60			{
61			true \|\| $key;
			0 ignored issues – show Bug Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report The expression `$key` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
62
63			return $this->getConfig('lifetime', 0);
64			}
65
66
67			/**
68			* Convert required key to actual key inner used
69			*
70			* In some cache system, key may need manual hashed.
71			*
72			* @param string $key
73			* @return string
74			*/
75			protected function hashKey($key)
76			{
77			$key = trim($key);
78
79			// Key can not be empty
80			if (empty($key)) {
81			return $this->emptyKeyReplacement;
82			}
83
84			return empty($this->hashAlgorithm)
85			? $key
86			: hash($this->hashAlgorithm, $key);
87			}
88			}
89

fwolf / fwlib

HandlerTrait::hashKey() A last analyzed 2019-05-09 15:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HandlerTrait::hashKey() A
last analyzed 2019-05-09 15:53 UTC