-
Notifications
You must be signed in to change notification settings - Fork 2
/
KeyBuilderTrait.php
85 lines (73 loc) · 1.86 KB
/
KeyBuilderTrait.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?php
/**
* Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
* Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
*/
namespace Spryker\Shared\KeyBuilder;
use Spryker\Shared\Kernel\Store;
trait KeyBuilderTrait
{
/**
* @var string
*/
protected $keySeparator = '.';
/**
* @param mixed $data
* @param string $localeName
* @param string|null $storeName
*
* @return string
*/
public function generateKey($data, $localeName, ?string $storeName = null): string
{
$keyParts = $this->getKeyParts($data, $localeName, $storeName);
return $this->escapeKey(implode($this->keySeparator, $keyParts));
}
/**
* @return string
*/
abstract public function getBundleName();
/**
* @param mixed $data
* @param string $localeName
* @param string|null $storeName
*
* @return array
*/
protected function getKeyParts($data, $localeName, ?string $storeName)
{
return [
$this->resolveStoreName($storeName),
$localeName,
$this->getBundleName(),
$this->buildKey($data),
];
}
/**
* @param string $data
*
* @return string
*/
abstract protected function buildKey($data);
/**
* @param string $key
*
* @return string
*/
protected function escapeKey($key)
{
$charsToReplace = ['"', "'", ' ', "\0", "\n", "\r"];
return str_replace($charsToReplace, '-', mb_strtolower(trim($key)));
}
/**
* @deprecated Will be removed without replacement.
*
* @param string|null $storeName
*
* @return string
*/
protected function resolveStoreName(?string $storeName): string
{
return $storeName ?? Store::getInstance()->getStoreName();
}
}