Completed
Pull Request — master (#385)
by Marco
10:52
created

IdentifierSuffixer::loadBaseHashSalt()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 0
cts 2
cp 0
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
crap 2
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license.
17
 */
18
19
declare(strict_types=1);
20
21
namespace ProxyManager\Generator\Util;
22
23
use PackageVersions\Versions;
24
25
/**
26
 * Utility class capable of generating
27
 * valid class/property/method identifiers
28
 * with a deterministic attached suffix,
29
 * in order to prevent property name collisions
30
 * and tampering from userland
31
 *
32
 * @author Marco Pivetta <[email protected]>
33
 * @license MIT
34
 */
35
abstract class IdentifierSuffixer
36
{
37
    const VALID_IDENTIFIER_FORMAT = '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]+$/';
38
    const DEFAULT_IDENTIFIER = 'g';
39
40
    private final function __construct()
0 ignored issues
show
Coding Style introduced by
As per PSR2, final should precede the visibility keyword.
Loading history...
41
    {
42
    }
43
44
    /**
45
     * Generates a valid unique identifier from the given name,
46
     * with a suffix attached to it
47
     */
48 28
    public static function getIdentifier(string $name) : string
49
    {
50 28
        static $salt;
51
52 28
        $salt   = $salt ?? $salt = self::loadBaseHashSalt();
53 28
        $suffix = \substr(\sha1($name . $salt), 0, 5);
54
55 28
        if (! preg_match(self::VALID_IDENTIFIER_FORMAT, $name)) {
56 8
            return self::DEFAULT_IDENTIFIER . $suffix;
57
        }
58
59 20
        return $name . $suffix;
60
    }
61
62
    private static function loadBaseHashSalt() : string
63
    {
64
        return \sha1(\serialize(Versions::VERSIONS));
65
    }
66
}
67