Repository navigation
Expand file tree
/
Copy pathModel.php
More file actions
192 lines (177 loc) · 5.21 KB
/
Copy pathModel.php
File metadata and controls
192 lines (177 loc) · 5.21 KB
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<?php
namespace JustCoded\WP\Framework\Objects;
/**
* Model is the base class for data models.
* Model should implement data get/set operations.
*
* Base Model class implements basic "property" features for clean usage in views.
*
* A property is defined by a getter method (e.g. `getLabel`), and/or a setter method (e.g. `setLabel`). For example,
* the following getter and setter methods define a property named `label`:
*
* ~~~
* private $_label;
*
* public function getLabel()
* {
* return $this->_label;
* }
*
* public function setLabel($value)
* {
* $this->_label = $value;
* }
* ~~~
*
* Property names are *case-insensitive*.
*
* A property can be accessed like a member variable of an object. Reading or writing a property will cause the invocation
* of the corresponding getter or setter method. For example,
*
* ~~~
* // equivalent to $label = $object->getLabel();
* $label = $object->label;
* // equivalent to $object->setLabel('abc');
* $object->label = 'abc';
* ~~~
*
* If a property has only a getter method and has no setter method, it is considered as *read-only*. In this case, trying
* to modify the property value will cause an exception.
*/
class Model {
/**
* Internal cache of wp queries
*
* @var \WP_Query[]
*/
private $_queries = [];
/**
* Model constructor.
*/
public function __construct() {
}
/**
* Returns the value of an object property.
*
* Do not call this method directly as it is a PHP magic method that
* will be implicitly called when executing `$value = $object->property;`.
*
* @param string $name The property name.
*
* @return mixed the property value
* @throws \Exception Property is not defined.
* @see __set()
*/
public function __get( $name ) {
// trying to find get_{property} method.
$getter = 'get_' . $name;
if ( method_exists( $this, $getter ) ) {
return $this->$getter();
} else {
throw new \Exception( 'Getting unknown property: ' . get_class( $this ) . '::' . $name );
}
}
/**
* Sets value of an object property.
*
* Do not call this method directly as it is a PHP magic method that
* will be implicitly called when executing `$object->property = $value;`.
*
* @param string $name The property name or the event name.
* @param mixed $value The property value.
*
* @throws \Exception Property is not defined or read-only.
* @see __get()
*/
public function __set( $name, $value ) {
$setter = 'set_' . $name;
if ( method_exists( $this, $setter ) ) {
$this->$setter( $value );
} elseif ( method_exists( $this, 'get_' . $name ) ) {
throw new \Exception( 'Setting read-only property: ' . get_class( $this ) . '::' . $name );
} else {
throw new \Exception( 'Setting unknown property: ' . get_class( $this ) . '::' . $name );
}
}
/**
* Checks if the named property is set (not null).
*
* Do not call this method directly as it is a PHP magic method that
* will be implicitly called when executing `isset($object->property)`.
*
* Note that if the property is not defined, false will be returned.
*
* @param string $name The property name or the event name.
*
* @return boolean Whether the named property is set (not null).
*/
public function __isset( $name ) {
$getter = 'get_' . $name;
if ( method_exists( $this, $getter ) ) {
return $this->$getter() !== null;
} else {
return false;
}
}
/**
* Sets an object property to null.
*
* Do not call this method directly as it is a PHP magic method that
* will be implicitly called when executing `unset($object->property)`.
*
* Note that if the property is not defined, this method will do nothing.
* If the property is read-only, it will throw an exception.
*
* @param string $name The property name.
*
* @throws \Exception The property is read only.
*/
public function __unset( $name ) {
$setter = 'set_' . $name;
if ( method_exists( $this, $setter ) ) {
$this->$setter( null );
} elseif ( method_exists( $this, 'get_' . $name ) ) {
throw new \Exception( 'Setting read-only property: ' . get_class( $this ) . '::' . $name );
}
}
/**
* Run query and remember it to cache
* In this way you can use magic getter without query reset
*
* @param array $params Usual WP_Query params array.
* @param string $method Cache key.
*
* @return \WP_Query
*/
public function wp_query( $params, $method ) {
if ( ! isset( $this->_queries[ $method ] ) ) {
$this->_queries[ $method ] = new \WP_Query( $params );
}
return $this->_queries[ $method ];
}
/**
* Run query and remember it to cache
* In this way you can use magic getter withour reseting query
*
* @param array $params Usual WP_Query params array.
* @param string $method Cache key.
*
* @return \WP_Query
*/
public function archive_query( $params, $method ) {
if ( ! isset( $this->_queries[ $method ] ) ) {
global $wp_query;
$wp_query->is_single = false;
$paged = ( get_query_var( 'paged' ) ) ? get_query_var( 'paged' ) : 1;
$params['paged'] = $paged;
$this->_queries[ $method ] = new \WP_Query( $params );
}
return $this->_queries[ $method ];
}
/**
* Clean up queries cache in case you need to run new query
*/
public function reset_queries() {
$this->_queries = [];
}
}