Type::getEncryptionKey() - Code Metrics - Inspection of "added `encrypt` setting to model properties" - jaredtking/pulsar - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a0110...06a6f8 )

by Jared

created 2020-06-11 15:24 UTC

Type::getEncryptionKey() A

↳ Parent: Type

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * @author Jared King <[email protected]>
 *
 * @see http://jaredtking.com
 *
 * @copyright 2015 Jared King
 * @license MIT
 */

namespace Pulsar;

use Defuse\Crypto\Crypto;
use Defuse\Crypto\Key;

/**
 * Handles value type casting.
 */
final class Type
{
    const STRING = 'string';
    const INTEGER = 'integer';
    const FLOAT = 'float';
    const BOOLEAN = 'boolean';
    const DATE = 'date';
    const OBJECT = 'object';
    const ARRAY = 'array';

    /** @var Key|null */
    private static $encryptionKey;

    /**
     * Marshals a value for a given property from storage.
     *
     * @param mixed $value
     *
     * @return mixed type-casted value
     */
    public static function cast(Property $property, $value)
    {
        if (null === $value) {
            return null;
        }

        // handle empty strings as null
        if ($property->isNullable() && '' === $value) {
            return null;
        }

        // perform decryption, if enabled
        if ($property->isEncrypted()) {
            $value = Crypto::decrypt($value, self::$encryptionKey);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        $type = $property->getType();
        if (!$type) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $value;
        }

        $m = 'to_'.$property->getType();

        return self::$m($value);
    }

    /**
     * Casts a value to a string.
     *
     * @param mixed $value
     */
    public static function to_string($value): string
    {
        return (string) $value;
    }

    /**
     * Casts a value to an integer.
     *
     * @param mixed $value
     */
    public static function to_integer($value): int
    {
        return (int) $value;
    }

    /**
     * Casts a value to a float.
     *
     * @param mixed $value
     */
    public static function to_float($value): float
    {
        return (float) $value;
    }

    /**
     * Casts a value to a boolean.
     *
     * @param mixed $value
     */
    public static function to_boolean($value): bool
    {
        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * Casts a date value as a UNIX timestamp.
     *
     * @param mixed $value
     */
    public static function to_date($value): int
    {
        if (!is_numeric($value)) {
            return strtotime($value);
        } else {
            return $value + 0;
        }
    }

    /**
     * Casts a value to an array.
     *
     * @param mixed $value
     */
    public static function to_array($value): array
    {
        // decode JSON strings into an array
        if (is_string($value)) {
            return (array) json_decode($value, true);
        }

        return (array) $value;
    }

    /**
     * Casts a value to an object.
     *
     * @param mixed $value
     *
     * @return object
     */
    public static function to_object($value): \stdClass
    {
        // decode JSON strings into an object
        if (is_string($value)) {
            return (object) json_decode($value);
        }

        return (object) $value;
    }

    /**
     * Sets the encryption key to be used when encryption is enabled for a property.
     */
    public static function setEncryptionKey(Key $key): void
    {
        self::$encryptionKey = $key;
    }

    /**
     * Gets the encryption key, if used.
     */
    public static function getEncryptionKey(): ?Key
    {
        return self::$encryptionKey;
    }
}


1			<?php
2
3			/**
4			* @author Jared King <[email protected]>
5			*
6			* @see http://jaredtking.com
7			*
8			* @copyright 2015 Jared King
9			* @license MIT
10			*/
11
12			namespace Pulsar;
13
14			use Defuse\Crypto\Crypto;
15			use Defuse\Crypto\Key;
16
17			/**
18			* Handles value type casting.
19			*/
20			final class Type
21			{
22			const STRING = 'string';
23			const INTEGER = 'integer';
24			const FLOAT = 'float';
25			const BOOLEAN = 'boolean';
26			const DATE = 'date';
27			const OBJECT = 'object';
28			const ARRAY = 'array';
29
30			/** @var Key\|null */
31			private static $encryptionKey;
32
33			/**
34			* Marshals a value for a given property from storage.
35			*
36			* @param mixed $value
37			*
38			* @return mixed type-casted value
39			*/
40			public static function cast(Property $property, $value)
41			{
42			if (null === $value) {
43			return null;
44			}
45
46			// handle empty strings as null
47			if ($property->isNullable() && '' === $value) {
48			return null;
49			}
50
51			// perform decryption, if enabled
52			if ($property->isEncrypted()) {
53			$value = Crypto::decrypt($value, self::$encryptionKey);
			0 ignored issues – show Bug introduced 2020-06-11 15:25 UTC by Report Bug Copy Issue Report It seems like `self::$encryptionKey` can be `null`; however, `decrypt()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
54			}
55
56			$type = $property->getType();
57			if (!$type) {
			0 ignored issues – show Bug Best Practice introduced 2020-06-07 01:17 UTC by Report Bug Copy Issue Report The expression `$type` of type `string\|null` is loosely compared to `false`; 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...
58			return $value;
59			}
60
61			$m = 'to_'.$property->getType();
62
63			return self::$m($value);
64			}
65
66			/**
67			* Casts a value to a string.
68			*
69			* @param mixed $value
70			*/
71			public static function to_string($value): string
72			{
73			return (string) $value;
74			}
75
76			/**
77			* Casts a value to an integer.
78			*
79			* @param mixed $value
80			*/
81			public static function to_integer($value): int
82			{
83			return (int) $value;
84			}
85
86			/**
87			* Casts a value to a float.
88			*
89			* @param mixed $value
90			*/
91			public static function to_float($value): float
92			{
93			return (float) $value;
94			}
95
96			/**
97			* Casts a value to a boolean.
98			*
99			* @param mixed $value
100			*/
101			public static function to_boolean($value): bool
102			{
103			return filter_var($value, FILTER_VALIDATE_BOOLEAN);
104			}
105
106			/**
107			* Casts a date value as a UNIX timestamp.
108			*
109			* @param mixed $value
110			*/
111			public static function to_date($value): int
112			{
113			if (!is_numeric($value)) {
114			return strtotime($value);
115			} else {
116			return $value + 0;
117			}
118			}
119
120			/**
121			* Casts a value to an array.
122			*
123			* @param mixed $value
124			*/
125			public static function to_array($value): array
126			{
127			// decode JSON strings into an array
128			if (is_string($value)) {
129			return (array) json_decode($value, true);
130			}
131
132			return (array) $value;
133			}
134
135			/**
136			* Casts a value to an object.
137			*
138			* @param mixed $value
139			*
140			* @return object
141			*/
142			public static function to_object($value): \stdClass
143			{
144			// decode JSON strings into an object
145			if (is_string($value)) {
146			return (object) json_decode($value);
147			}
148
149			return (object) $value;
150			}
151
152			/**
153			* Sets the encryption key to be used when encryption is enabled for a property.
154			*/
155			public static function setEncryptionKey(Key $key): void
156			{
157			self::$encryptionKey = $key;
158			}
159
160			/**
161			* Gets the encryption key, if used.
162			*/
163			public static function getEncryptionKey(): ?Key
164			{
165			return self::$encryptionKey;
166			}
167			}
168

jaredtking / pulsar

Push — master ( 4a0110...06a6f8 )

Type::getEncryptionKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like