give / src / Session / Accessor.php

Accessor.php in GiveWP – Donation Plugin and Fundraising Platform 2.12.0, at src/Session/Accessor.php

235 lines 4.4 KB

Raw Download Zip

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