Accessor.php
252 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Session; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 6 | use stdClass; |
| 7 | |
| 8 | /** |
| 9 | * Class Access |
| 10 | * |
| 11 | * In legacy core session data load in array which contains multiple keys like give_purchase, receipt_access etc. |
| 12 | * This class helps to convert them into objects. Every subclass will treat a specific key as group of session data. |
| 13 | * |
| 14 | * @package Give\Session |
| 15 | */ |
| 16 | abstract class Accessor |
| 17 | { |
| 18 | /** |
| 19 | * Session Id. |
| 20 | * |
| 21 | * @var string |
| 22 | */ |
| 23 | protected $sessionKey; |
| 24 | |
| 25 | /** |
| 26 | * Session data as array. |
| 27 | * |
| 28 | * We use this array internally to perform database related operations. |
| 29 | * |
| 30 | * @var mixed |
| 31 | */ |
| 32 | protected $data; |
| 33 | |
| 34 | /** |
| 35 | * Session data as object. |
| 36 | * Session data in object format will be return when query. |
| 37 | * |
| 38 | * @var stdClass |
| 39 | */ |
| 40 | protected $dataObj; |
| 41 | |
| 42 | /** |
| 43 | * Class constructor. |
| 44 | */ |
| 45 | public function __construct() |
| 46 | { |
| 47 | $this->get(); |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Convert session data to object. |
| 52 | * |
| 53 | * @since 2.7.0 |
| 54 | * |
| 55 | * @param array $data |
| 56 | * |
| 57 | * @return stdClass |
| 58 | */ |
| 59 | protected function convertToObject($data) |
| 60 | { |
| 61 | $dataObj = new stdClass(); |
| 62 | $data = $this->renameArrayKeysToPropertyNames($data); |
| 63 | |
| 64 | foreach ($data as $key => $value) { |
| 65 | if (is_array($value)) { |
| 66 | $dataObj->{$key} = $this->convertToObject($value); |
| 67 | continue; |
| 68 | } |
| 69 | |
| 70 | $dataObj->{$key} = $value; |
| 71 | } |
| 72 | |
| 73 | return $dataObj; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Get data from session. |
| 78 | * |
| 79 | * @since 2.7.0 |
| 80 | * @return stdClass |
| 81 | */ |
| 82 | public function get() |
| 83 | { |
| 84 | if ($this->dataObj) { |
| 85 | return $this->dataObj; |
| 86 | } |
| 87 | |
| 88 | $this->data = Give()->session->get($this->sessionKey, $this->data); |
| 89 | $this->dataObj = $this->convertToObject($this->data); |
| 90 | |
| 91 | return $this->dataObj; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Get data from session. |
| 96 | * |
| 97 | * @since 2.7.0 |
| 98 | * |
| 99 | * @param string $key |
| 100 | * |
| 101 | * @return stdClass |
| 102 | */ |
| 103 | public function getByKey($key) |
| 104 | { |
| 105 | $result = null; |
| 106 | |
| 107 | if (null !== $this->dataObj) { |
| 108 | $result = property_exists($this->dataObj, $key) ? $this->dataObj->{$key} : $result; |
| 109 | } |
| 110 | |
| 111 | return $result; |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Save/Replace/Remove data into session |
| 116 | * |
| 117 | * @param string $key |
| 118 | * @param mixed $data |
| 119 | * |
| 120 | * @return string |
| 121 | */ |
| 122 | public function store($key, $data) |
| 123 | { |
| 124 | $this->validateData($data); |
| 125 | |
| 126 | if ( ! empty($this->data[$key])) { |
| 127 | // Merge data. |
| 128 | $this->data[$key] = array_merge( |
| 129 | $this->data[$key], |
| 130 | $data |
| 131 | ); |
| 132 | } else { |
| 133 | $this->data[$key] = $data; |
| 134 | } |
| 135 | |
| 136 | return $this->set(); |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Store data into session. |
| 141 | * |
| 142 | * @since 2.7.0 |
| 143 | * @return string |
| 144 | */ |
| 145 | protected function set() |
| 146 | { |
| 147 | $this->dataObj = $this->convertToObject($this->data); |
| 148 | |
| 149 | return Give()->session->set($this->sessionKey, $this->data); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Replace session data. |
| 154 | * |
| 155 | * @since 2.7.0 |
| 156 | * |
| 157 | * @param mixed $data |
| 158 | * |
| 159 | * @param string $key |
| 160 | * |
| 161 | * @return string |
| 162 | */ |
| 163 | public function replace($key, $data) |
| 164 | { |
| 165 | $this->validateData($data); |
| 166 | $this->data[$key] = $data; |
| 167 | |
| 168 | return $this->set(); |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Delete session data. |
| 173 | * |
| 174 | * @since 2.7.0 |
| 175 | * |
| 176 | * @param string $key |
| 177 | * |
| 178 | * @return string |
| 179 | */ |
| 180 | public function delete($key) |
| 181 | { |
| 182 | if (array_key_exists($key, $this->data)) { |
| 183 | unset($this->data[$key]); |
| 184 | } |
| 185 | |
| 186 | return $this->set(); |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Return session data in array format. |
| 191 | * |
| 192 | * @since 2.7.0 |
| 193 | * @return array |
| 194 | */ |
| 195 | public function toArray() |
| 196 | { |
| 197 | return $this->data; |
| 198 | } |
| 199 | |
| 200 | /** |
| 201 | * Rename array key to property name |
| 202 | * |
| 203 | * @since 2.7.0 |
| 204 | * |
| 205 | * @param array $data |
| 206 | * |
| 207 | * @return array |
| 208 | */ |
| 209 | protected function renameArrayKeysToPropertyNames($data) |
| 210 | { |
| 211 | foreach ($data as $key => $value) { |
| 212 | // Convert array key string to property name. |
| 213 | // Remove other then char, dash, give related prefix and hyphen and prefix. |
| 214 | $newName = preg_replace('/[^a-zA-Z0-9_\-]/', '', $key); |
| 215 | $newName = preg_replace('/(-|_)?give(-|_)?/', '', $newName); |
| 216 | $keyParts = preg_split('/(-|_)/', $newName); |
| 217 | $keyParts = array_map('ucfirst', array_filter($keyParts)); |
| 218 | $newName = lcfirst(implode('', $keyParts)); |
| 219 | |
| 220 | // Remove old key/value pair if renamed. |
| 221 | if ($key !== $newName) { |
| 222 | unset($data[$key]); |
| 223 | } |
| 224 | |
| 225 | if (is_array($value)) { |
| 226 | // Process array. |
| 227 | $data[$newName] = $this->renameArrayKeysToPropertyNames($value); |
| 228 | continue; |
| 229 | } |
| 230 | |
| 231 | $data[$newName] = $value; |
| 232 | } |
| 233 | |
| 234 | return $data; |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Validate data. |
| 239 | * |
| 240 | * @since 2.7.0 |
| 241 | * |
| 242 | * @param mixed $data |
| 243 | * |
| 244 | */ |
| 245 | protected function validateData($data) |
| 246 | { |
| 247 | if (is_array($data) && isset($data[0])) { |
| 248 | throw new InvalidArgumentException('Invalid value. Please pass an associative array'); |
| 249 | } |
| 250 | } |
| 251 | } |
| 252 |