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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Customer\Model\Metadata;
use Magento\Config\App\Config\Type\System;
use Magento\Customer\Api\Data\AttributeMetadataInterface;
use Magento\Eav\Model\Cache\Type;
use Magento\Eav\Model\Entity\Attribute;
use Magento\Framework\App\Cache\StateInterface;
use Magento\Framework\App\CacheInterface;
use Magento\Framework\Serialize\SerializerInterface;
use Magento\Store\Model\StoreManagerInterface;
/**
* Cache for attribute metadata
*/
class AttributeMetadataCache
{
/**
* Cache prefix
*/
const ATTRIBUTE_METADATA_CACHE_PREFIX = 'ATTRIBUTE_METADATA_INSTANCES_CACHE';
/**
* @var CacheInterface
*/
private $cache;
/**
* @var StateInterface
*/
private $state;
/**
* @var AttributeMetadataInterface[]
*/
private $attributes;
/**
* @var bool
*/
private $isAttributeCacheEnabled;
/**
* @var AttributeMetadataHydrator
*/
private $attributeMetadataHydrator;
/**
* @var SerializerInterface
*/
private $serializer;
/**
* @var StoreManagerInterface
*/
private $storeManager;
/**
* Constructor
*
* @param CacheInterface $cache
* @param StateInterface $state
* @param SerializerInterface $serializer
* @param AttributeMetadataHydrator $attributeMetadataHydrator
* @param StoreManagerInterface $storeManager
*/
public function __construct(
CacheInterface $cache,
StateInterface $state,
SerializerInterface $serializer,
AttributeMetadataHydrator $attributeMetadataHydrator,
StoreManagerInterface $storeManager = null
) {
$this->cache = $cache;
$this->state = $state;
$this->serializer = $serializer;
$this->attributeMetadataHydrator = $attributeMetadataHydrator;
$this->storeManager = $storeManager ?: \Magento\Framework\App\ObjectManager::getInstance()
->get(StoreManagerInterface::class);
}
/**
* Load attributes metadata from cache
*
* @param string $entityType
* @param string $suffix
* @return AttributeMetadataInterface[]|bool
*/
public function load($entityType, $suffix = '')
{
$storeId = $this->storeManager->getStore()->getId();
if (isset($this->attributes[$entityType . $suffix . $storeId])) {
return $this->attributes[$entityType . $suffix . $storeId];
}
if ($this->isEnabled()) {
$cacheKey = self::ATTRIBUTE_METADATA_CACHE_PREFIX . $entityType . $suffix . $storeId;
$serializedData = $this->cache->load($cacheKey);
if ($serializedData) {
$attributesData = $this->serializer->unserialize($serializedData);
$attributes = [];
foreach ($attributesData as $key => $attributeData) {
$attributes[$key] = $this->attributeMetadataHydrator->hydrate($attributeData);
}
$this->attributes[$entityType . $suffix . $storeId] = $attributes;
return $attributes;
}
}
return false;
}
/**
* Save attributes metadata to cache
*
* @param string $entityType
* @param AttributeMetadataInterface[] $attributes
* @param string $suffix
* @return void
*/
public function save($entityType, array $attributes, $suffix = '')
{
$storeId = $this->storeManager->getStore()->getId();
$this->attributes[$entityType . $suffix . $storeId] = $attributes;
if ($this->isEnabled()) {
$cacheKey = self::ATTRIBUTE_METADATA_CACHE_PREFIX . $entityType . $suffix . $storeId;
$attributesData = [];
foreach ($attributes as $key => $attribute) {
$attributesData[$key] = $this->attributeMetadataHydrator->extract($attribute);
}
$serializedData = $this->serializer->serialize($attributesData);
$this->cache->save(
$serializedData,
$cacheKey,
[
Type::CACHE_TAG,
Attribute::CACHE_TAG,
System::CACHE_TAG
]
);
}
}
/**
* Clean attributes metadata cache
*
* @return void
*/
public function clean()
{
unset($this->attributes);
if ($this->isEnabled()) {
$this->cache->clean(
[
Type::CACHE_TAG,
Attribute::CACHE_TAG,
]
);
}
}
/**
* Check if cache enabled
*
* @return bool
*/
private function isEnabled()
{
if (null === $this->isAttributeCacheEnabled) {
$this->isAttributeCacheEnabled = $this->state->isEnabled(Type::TYPE_IDENTIFIER);
}
return $this->isAttributeCacheEnabled;
}
}