@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | 11 | if ( ! defined( 'ABSPATH' ) ) { |
| 12 | - exit; |
|
| 12 | + exit; |
|
| 13 | 13 | } |
| 14 | 14 | |
| 15 | 15 | /** |
@@ -21,356 +21,356 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | abstract class GetPaid_Data { |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * ID for this object. |
|
| 26 | - * |
|
| 27 | - * @since 1.0.19 |
|
| 28 | - * @var int |
|
| 29 | - */ |
|
| 30 | - protected $id = 0; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Core data for this object. Name value pairs (name + default value). |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Core data changes for this object. |
|
| 42 | - * |
|
| 43 | - * @since 1.0.19 |
|
| 44 | - * @var array |
|
| 45 | - */ |
|
| 46 | - protected $changes = array(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * This is false until the object is read from the DB. |
|
| 50 | - * |
|
| 51 | - * @since 1.0.19 |
|
| 52 | - * @var bool |
|
| 53 | - */ |
|
| 54 | - protected $object_read = false; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * This is the name of this object type. |
|
| 58 | - * |
|
| 59 | - * @since 1.0.19 |
|
| 60 | - * @var string |
|
| 61 | - */ |
|
| 62 | - protected $object_type = 'data'; |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Extra data for this object. Name value pairs (name + default value). |
|
| 66 | - * Used as a standard way for sub classes (like item types) to add |
|
| 67 | - * additional information to an inherited class. |
|
| 68 | - * |
|
| 69 | - * @since 1.0.19 |
|
| 70 | - * @var array |
|
| 71 | - */ |
|
| 72 | - protected $extra_data = array(); |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Set to _data on construct so we can track and reset data if needed. |
|
| 76 | - * |
|
| 77 | - * @since 1.0.19 |
|
| 78 | - * @var array |
|
| 79 | - */ |
|
| 80 | - protected $default_data = array(); |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Contains a reference to the data store for this class. |
|
| 84 | - * |
|
| 85 | - * @since 1.0.19 |
|
| 86 | - * @var GetPaid_Data_Store |
|
| 87 | - */ |
|
| 88 | - protected $data_store; |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Stores meta in cache for future reads. |
|
| 92 | - * A group must be set to to enable caching. |
|
| 93 | - * |
|
| 94 | - * @since 1.0.19 |
|
| 95 | - * @var string |
|
| 96 | - */ |
|
| 97 | - protected $cache_group = ''; |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * Stores the last error. |
|
| 101 | - * |
|
| 102 | - * @since 1.0.19 |
|
| 103 | - * @var string |
|
| 104 | - */ |
|
| 105 | - public $last_error = ''; |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Stores additional meta data. |
|
| 109 | - * |
|
| 110 | - * @since 1.0.19 |
|
| 111 | - * @var array |
|
| 112 | - */ |
|
| 113 | - protected $meta_data = null; |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Default constructor. |
|
| 117 | - * |
|
| 118 | - * @param int|object|array $read ID to load from the DB (optional) or already queried data. |
|
| 119 | - */ |
|
| 120 | - public function __construct( $read = 0 ) { |
|
| 121 | - $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 122 | - $this->default_data = $this->data; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Only store the object ID to avoid serializing the data object instance. |
|
| 127 | - * |
|
| 128 | - * @return array |
|
| 129 | - */ |
|
| 130 | - public function __sleep() { |
|
| 131 | - return array( 'id' ); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * Re-run the constructor with the object ID. |
|
| 136 | - * |
|
| 137 | - * If the object no longer exists, remove the ID. |
|
| 138 | - */ |
|
| 139 | - public function __wakeup() { |
|
| 140 | - $this->__construct( absint( $this->id ) ); |
|
| 141 | - |
|
| 142 | - if ( ! empty( $this->last_error ) ) { |
|
| 143 | - $this->set_id( 0 ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * When the object is cloned, make sure meta is duplicated correctly. |
|
| 150 | - * |
|
| 151 | - * @since 1.0.19 |
|
| 152 | - */ |
|
| 153 | - public function __clone() { |
|
| 154 | - $this->maybe_read_meta_data(); |
|
| 155 | - if ( ! empty( $this->meta_data ) ) { |
|
| 156 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | - $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | - if ( ! empty( $meta->id ) ) { |
|
| 159 | - $this->meta_data[ $array_key ]->id = null; |
|
| 160 | - } |
|
| 161 | - } |
|
| 162 | - } |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Get the data store. |
|
| 167 | - * |
|
| 168 | - * @since 1.0.19 |
|
| 169 | - * @return object |
|
| 170 | - */ |
|
| 171 | - public function get_data_store() { |
|
| 172 | - return $this->data_store; |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Get the object type. |
|
| 177 | - * |
|
| 178 | - * @since 1.0.19 |
|
| 179 | - * @return string |
|
| 180 | - */ |
|
| 181 | - public function get_object_type() { |
|
| 182 | - return $this->object_type; |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * Returns the unique ID for this object. |
|
| 187 | - * |
|
| 188 | - * @since 1.0.19 |
|
| 189 | - * @return int |
|
| 190 | - */ |
|
| 191 | - public function get_id() { |
|
| 192 | - return $this->id; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * Get form status. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_status( $context = 'view' ) { |
|
| 203 | - return $this->get_prop( 'status', $context ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * Delete an object, set the ID to 0, and return result. |
|
| 208 | - * |
|
| 209 | - * @since 1.0.19 |
|
| 210 | - * @param bool $force_delete Should the data be deleted permanently. |
|
| 211 | - * @return bool result |
|
| 212 | - */ |
|
| 213 | - public function delete( $force_delete = false ) { |
|
| 214 | - if ( $this->data_store && $this->get_id() ) { |
|
| 215 | - $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | - $this->set_id( 0 ); |
|
| 217 | - return true; |
|
| 218 | - } |
|
| 219 | - return false; |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Save should create or update based on object existence. |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @return int |
|
| 227 | - */ |
|
| 228 | - public function save() { |
|
| 229 | - if ( ! $this->data_store ) { |
|
| 230 | - return $this->get_id(); |
|
| 231 | - } |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
| 235 | - * |
|
| 236 | - * @param GetPaid_Data $this The object being saved. |
|
| 237 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 238 | - */ |
|
| 239 | - do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 240 | - |
|
| 241 | - if ( $this->get_id() ) { |
|
| 242 | - $this->data_store->update( $this ); |
|
| 243 | - } else { |
|
| 244 | - $this->data_store->create( $this ); |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * Trigger action after saving to the DB. |
|
| 249 | - * |
|
| 250 | - * @param GetPaid_Data $this The object being saved. |
|
| 251 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 252 | - */ |
|
| 253 | - do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 254 | - |
|
| 255 | - return $this->get_id(); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Change data to JSON format. |
|
| 260 | - * |
|
| 261 | - * @since 1.0.19 |
|
| 262 | - * @return string Data in JSON format. |
|
| 263 | - */ |
|
| 264 | - public function __toString() { |
|
| 265 | - return wp_json_encode( $this->get_data() ); |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Returns all data for this object. |
|
| 270 | - * |
|
| 271 | - * @since 1.0.19 |
|
| 272 | - * @return array |
|
| 273 | - */ |
|
| 274 | - public function get_data() { |
|
| 275 | - return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * Returns array of expected data keys for this object. |
|
| 280 | - * |
|
| 281 | - * @since 1.0.19 |
|
| 282 | - * @return array |
|
| 283 | - */ |
|
| 284 | - public function get_data_keys() { |
|
| 285 | - return array_keys( $this->data ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Returns all "extra" data keys for an object (for sub objects like item types). |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @return array |
|
| 293 | - */ |
|
| 294 | - public function get_extra_data_keys() { |
|
| 295 | - return array_keys( $this->extra_data ); |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * Filter null meta values from array. |
|
| 300 | - * |
|
| 301 | - * @since 1.0.19 |
|
| 302 | - * @param mixed $meta Meta value to check. |
|
| 303 | - * @return bool |
|
| 304 | - */ |
|
| 305 | - protected function filter_null_meta( $meta ) { |
|
| 306 | - return ! is_null( $meta->value ); |
|
| 307 | - } |
|
| 308 | - |
|
| 309 | - /** |
|
| 310 | - * Get All Meta Data. |
|
| 311 | - * |
|
| 312 | - * @since 1.0.19 |
|
| 313 | - * @return array of objects. |
|
| 314 | - */ |
|
| 315 | - public function get_meta_data() { |
|
| 316 | - $this->maybe_read_meta_data(); |
|
| 317 | - return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * Check if the key is an internal one. |
|
| 322 | - * |
|
| 323 | - * @since 1.0.19 |
|
| 324 | - * @param string $key Key to check. |
|
| 325 | - * @return bool true if it's an internal key, false otherwise |
|
| 326 | - */ |
|
| 327 | - protected function is_internal_meta_key( $key ) { |
|
| 328 | - $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 329 | - |
|
| 330 | - if ( ! $internal_meta_key ) { |
|
| 331 | - return false; |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 335 | - |
|
| 336 | - if ( ! $has_setter_or_getter ) { |
|
| 337 | - return false; |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /* translators: %s: $key Key to check */ |
|
| 341 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 342 | - |
|
| 343 | - return true; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * Magic method for setting data fields. |
|
| 348 | - * |
|
| 349 | - * This method does not update custom fields in the database. |
|
| 350 | - * |
|
| 351 | - * @since 1.0.19 |
|
| 352 | - * @access public |
|
| 353 | - * |
|
| 354 | - */ |
|
| 355 | - public function __set( $key, $value ) { |
|
| 356 | - |
|
| 357 | - if ( 'id' == strtolower( $key ) ) { |
|
| 358 | - return $this->set_id( $value ); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - if ( method_exists( $this, "set_$key") ) { |
|
| 362 | - |
|
| 363 | - /* translators: %s: $key Key to set */ |
|
| 364 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 365 | - |
|
| 366 | - call_user_func( array( $this, "set_$key" ), $value ); |
|
| 367 | - } else { |
|
| 368 | - $this->set_prop( $key, $value ); |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 24 | + /** |
|
| 25 | + * ID for this object. |
|
| 26 | + * |
|
| 27 | + * @since 1.0.19 |
|
| 28 | + * @var int |
|
| 29 | + */ |
|
| 30 | + protected $id = 0; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Core data for this object. Name value pairs (name + default value). |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Core data changes for this object. |
|
| 42 | + * |
|
| 43 | + * @since 1.0.19 |
|
| 44 | + * @var array |
|
| 45 | + */ |
|
| 46 | + protected $changes = array(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * This is false until the object is read from the DB. |
|
| 50 | + * |
|
| 51 | + * @since 1.0.19 |
|
| 52 | + * @var bool |
|
| 53 | + */ |
|
| 54 | + protected $object_read = false; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * This is the name of this object type. |
|
| 58 | + * |
|
| 59 | + * @since 1.0.19 |
|
| 60 | + * @var string |
|
| 61 | + */ |
|
| 62 | + protected $object_type = 'data'; |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Extra data for this object. Name value pairs (name + default value). |
|
| 66 | + * Used as a standard way for sub classes (like item types) to add |
|
| 67 | + * additional information to an inherited class. |
|
| 68 | + * |
|
| 69 | + * @since 1.0.19 |
|
| 70 | + * @var array |
|
| 71 | + */ |
|
| 72 | + protected $extra_data = array(); |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Set to _data on construct so we can track and reset data if needed. |
|
| 76 | + * |
|
| 77 | + * @since 1.0.19 |
|
| 78 | + * @var array |
|
| 79 | + */ |
|
| 80 | + protected $default_data = array(); |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Contains a reference to the data store for this class. |
|
| 84 | + * |
|
| 85 | + * @since 1.0.19 |
|
| 86 | + * @var GetPaid_Data_Store |
|
| 87 | + */ |
|
| 88 | + protected $data_store; |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Stores meta in cache for future reads. |
|
| 92 | + * A group must be set to to enable caching. |
|
| 93 | + * |
|
| 94 | + * @since 1.0.19 |
|
| 95 | + * @var string |
|
| 96 | + */ |
|
| 97 | + protected $cache_group = ''; |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * Stores the last error. |
|
| 101 | + * |
|
| 102 | + * @since 1.0.19 |
|
| 103 | + * @var string |
|
| 104 | + */ |
|
| 105 | + public $last_error = ''; |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Stores additional meta data. |
|
| 109 | + * |
|
| 110 | + * @since 1.0.19 |
|
| 111 | + * @var array |
|
| 112 | + */ |
|
| 113 | + protected $meta_data = null; |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Default constructor. |
|
| 117 | + * |
|
| 118 | + * @param int|object|array $read ID to load from the DB (optional) or already queried data. |
|
| 119 | + */ |
|
| 120 | + public function __construct( $read = 0 ) { |
|
| 121 | + $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 122 | + $this->default_data = $this->data; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Only store the object ID to avoid serializing the data object instance. |
|
| 127 | + * |
|
| 128 | + * @return array |
|
| 129 | + */ |
|
| 130 | + public function __sleep() { |
|
| 131 | + return array( 'id' ); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * Re-run the constructor with the object ID. |
|
| 136 | + * |
|
| 137 | + * If the object no longer exists, remove the ID. |
|
| 138 | + */ |
|
| 139 | + public function __wakeup() { |
|
| 140 | + $this->__construct( absint( $this->id ) ); |
|
| 141 | + |
|
| 142 | + if ( ! empty( $this->last_error ) ) { |
|
| 143 | + $this->set_id( 0 ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * When the object is cloned, make sure meta is duplicated correctly. |
|
| 150 | + * |
|
| 151 | + * @since 1.0.19 |
|
| 152 | + */ |
|
| 153 | + public function __clone() { |
|
| 154 | + $this->maybe_read_meta_data(); |
|
| 155 | + if ( ! empty( $this->meta_data ) ) { |
|
| 156 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | + $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | + if ( ! empty( $meta->id ) ) { |
|
| 159 | + $this->meta_data[ $array_key ]->id = null; |
|
| 160 | + } |
|
| 161 | + } |
|
| 162 | + } |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Get the data store. |
|
| 167 | + * |
|
| 168 | + * @since 1.0.19 |
|
| 169 | + * @return object |
|
| 170 | + */ |
|
| 171 | + public function get_data_store() { |
|
| 172 | + return $this->data_store; |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Get the object type. |
|
| 177 | + * |
|
| 178 | + * @since 1.0.19 |
|
| 179 | + * @return string |
|
| 180 | + */ |
|
| 181 | + public function get_object_type() { |
|
| 182 | + return $this->object_type; |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * Returns the unique ID for this object. |
|
| 187 | + * |
|
| 188 | + * @since 1.0.19 |
|
| 189 | + * @return int |
|
| 190 | + */ |
|
| 191 | + public function get_id() { |
|
| 192 | + return $this->id; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * Get form status. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_status( $context = 'view' ) { |
|
| 203 | + return $this->get_prop( 'status', $context ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * Delete an object, set the ID to 0, and return result. |
|
| 208 | + * |
|
| 209 | + * @since 1.0.19 |
|
| 210 | + * @param bool $force_delete Should the data be deleted permanently. |
|
| 211 | + * @return bool result |
|
| 212 | + */ |
|
| 213 | + public function delete( $force_delete = false ) { |
|
| 214 | + if ( $this->data_store && $this->get_id() ) { |
|
| 215 | + $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | + $this->set_id( 0 ); |
|
| 217 | + return true; |
|
| 218 | + } |
|
| 219 | + return false; |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Save should create or update based on object existence. |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @return int |
|
| 227 | + */ |
|
| 228 | + public function save() { |
|
| 229 | + if ( ! $this->data_store ) { |
|
| 230 | + return $this->get_id(); |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
| 235 | + * |
|
| 236 | + * @param GetPaid_Data $this The object being saved. |
|
| 237 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 238 | + */ |
|
| 239 | + do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 240 | + |
|
| 241 | + if ( $this->get_id() ) { |
|
| 242 | + $this->data_store->update( $this ); |
|
| 243 | + } else { |
|
| 244 | + $this->data_store->create( $this ); |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * Trigger action after saving to the DB. |
|
| 249 | + * |
|
| 250 | + * @param GetPaid_Data $this The object being saved. |
|
| 251 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 252 | + */ |
|
| 253 | + do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 254 | + |
|
| 255 | + return $this->get_id(); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Change data to JSON format. |
|
| 260 | + * |
|
| 261 | + * @since 1.0.19 |
|
| 262 | + * @return string Data in JSON format. |
|
| 263 | + */ |
|
| 264 | + public function __toString() { |
|
| 265 | + return wp_json_encode( $this->get_data() ); |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Returns all data for this object. |
|
| 270 | + * |
|
| 271 | + * @since 1.0.19 |
|
| 272 | + * @return array |
|
| 273 | + */ |
|
| 274 | + public function get_data() { |
|
| 275 | + return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * Returns array of expected data keys for this object. |
|
| 280 | + * |
|
| 281 | + * @since 1.0.19 |
|
| 282 | + * @return array |
|
| 283 | + */ |
|
| 284 | + public function get_data_keys() { |
|
| 285 | + return array_keys( $this->data ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Returns all "extra" data keys for an object (for sub objects like item types). |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @return array |
|
| 293 | + */ |
|
| 294 | + public function get_extra_data_keys() { |
|
| 295 | + return array_keys( $this->extra_data ); |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * Filter null meta values from array. |
|
| 300 | + * |
|
| 301 | + * @since 1.0.19 |
|
| 302 | + * @param mixed $meta Meta value to check. |
|
| 303 | + * @return bool |
|
| 304 | + */ |
|
| 305 | + protected function filter_null_meta( $meta ) { |
|
| 306 | + return ! is_null( $meta->value ); |
|
| 307 | + } |
|
| 308 | + |
|
| 309 | + /** |
|
| 310 | + * Get All Meta Data. |
|
| 311 | + * |
|
| 312 | + * @since 1.0.19 |
|
| 313 | + * @return array of objects. |
|
| 314 | + */ |
|
| 315 | + public function get_meta_data() { |
|
| 316 | + $this->maybe_read_meta_data(); |
|
| 317 | + return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * Check if the key is an internal one. |
|
| 322 | + * |
|
| 323 | + * @since 1.0.19 |
|
| 324 | + * @param string $key Key to check. |
|
| 325 | + * @return bool true if it's an internal key, false otherwise |
|
| 326 | + */ |
|
| 327 | + protected function is_internal_meta_key( $key ) { |
|
| 328 | + $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 329 | + |
|
| 330 | + if ( ! $internal_meta_key ) { |
|
| 331 | + return false; |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 335 | + |
|
| 336 | + if ( ! $has_setter_or_getter ) { |
|
| 337 | + return false; |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /* translators: %s: $key Key to check */ |
|
| 341 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 342 | + |
|
| 343 | + return true; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * Magic method for setting data fields. |
|
| 348 | + * |
|
| 349 | + * This method does not update custom fields in the database. |
|
| 350 | + * |
|
| 351 | + * @since 1.0.19 |
|
| 352 | + * @access public |
|
| 353 | + * |
|
| 354 | + */ |
|
| 355 | + public function __set( $key, $value ) { |
|
| 356 | + |
|
| 357 | + if ( 'id' == strtolower( $key ) ) { |
|
| 358 | + return $this->set_id( $value ); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + if ( method_exists( $this, "set_$key") ) { |
|
| 362 | + |
|
| 363 | + /* translators: %s: $key Key to set */ |
|
| 364 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 365 | + |
|
| 366 | + call_user_func( array( $this, "set_$key" ), $value ); |
|
| 367 | + } else { |
|
| 368 | + $this->set_prop( $key, $value ); |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | 374 | * Margic method for retrieving a property. |
| 375 | 375 | */ |
| 376 | 376 | public function __get( $key ) { |
@@ -378,10 +378,10 @@ discard block |
||
| 378 | 378 | // Check if we have a helper method for that. |
| 379 | 379 | if ( method_exists( $this, 'get_' . $key ) ) { |
| 380 | 380 | |
| 381 | - if ( 'post_type' != $key ) { |
|
| 382 | - /* translators: %s: $key Key to set */ |
|
| 383 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 384 | - } |
|
| 381 | + if ( 'post_type' != $key ) { |
|
| 382 | + /* translators: %s: $key Key to set */ |
|
| 383 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 384 | + } |
|
| 385 | 385 | |
| 386 | 386 | return call_user_func( array( $this, 'get_' . $key ) ); |
| 387 | 387 | } |
@@ -391,512 +391,512 @@ discard block |
||
| 391 | 391 | return $this->post->$key; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | - return $this->get_prop( $key ); |
|
| 395 | - |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - /** |
|
| 399 | - * Get Meta Data by Key. |
|
| 400 | - * |
|
| 401 | - * @since 1.0.19 |
|
| 402 | - * @param string $key Meta Key. |
|
| 403 | - * @param bool $single return first found meta with key, or all with $key. |
|
| 404 | - * @param string $context What the value is for. Valid values are view and edit. |
|
| 405 | - * @return mixed |
|
| 406 | - */ |
|
| 407 | - public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 408 | - |
|
| 409 | - // Check if this is an internal meta key. |
|
| 410 | - $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | - $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | - if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 413 | - $function = 'get_' . $_key; |
|
| 414 | - |
|
| 415 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 416 | - return $this->{$function}(); |
|
| 417 | - } |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - // Read the meta data if not yet read. |
|
| 421 | - $this->maybe_read_meta_data(); |
|
| 422 | - $meta_data = $this->get_meta_data(); |
|
| 423 | - $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 424 | - $value = $single ? '' : array(); |
|
| 425 | - |
|
| 426 | - if ( ! empty( $array_keys ) ) { |
|
| 427 | - // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
| 428 | - if ( $single ) { |
|
| 429 | - $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 430 | - } else { |
|
| 431 | - $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 432 | - } |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - if ( 'view' === $context ) { |
|
| 436 | - $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - return $value; |
|
| 440 | - } |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * See if meta data exists, since get_meta always returns a '' or array(). |
|
| 444 | - * |
|
| 445 | - * @since 1.0.19 |
|
| 446 | - * @param string $key Meta Key. |
|
| 447 | - * @return boolean |
|
| 448 | - */ |
|
| 449 | - public function meta_exists( $key = '' ) { |
|
| 450 | - $this->maybe_read_meta_data(); |
|
| 451 | - $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | - return in_array( $key, $array_keys, true ); |
|
| 453 | - } |
|
| 454 | - |
|
| 455 | - /** |
|
| 456 | - * Set all meta data from array. |
|
| 457 | - * |
|
| 458 | - * @since 1.0.19 |
|
| 459 | - * @param array $data Key/Value pairs. |
|
| 460 | - */ |
|
| 461 | - public function set_meta_data( $data ) { |
|
| 462 | - if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 463 | - $this->maybe_read_meta_data(); |
|
| 464 | - foreach ( $data as $meta ) { |
|
| 465 | - $meta = (array) $meta; |
|
| 466 | - if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 467 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 468 | - array( |
|
| 469 | - 'id' => $meta['id'], |
|
| 470 | - 'key' => $meta['key'], |
|
| 471 | - 'value' => $meta['value'], |
|
| 472 | - ) |
|
| 473 | - ); |
|
| 474 | - } |
|
| 475 | - } |
|
| 476 | - } |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * Add meta data. |
|
| 481 | - * |
|
| 482 | - * @since 1.0.19 |
|
| 483 | - * |
|
| 484 | - * @param string $key Meta key. |
|
| 485 | - * @param string|array $value Meta value. |
|
| 486 | - * @param bool $unique Should this be a unique key?. |
|
| 487 | - */ |
|
| 488 | - public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 490 | - $function = 'set_' . $key; |
|
| 491 | - |
|
| 492 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | - return $this->{$function}( $value ); |
|
| 494 | - } |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - $this->maybe_read_meta_data(); |
|
| 498 | - if ( $unique ) { |
|
| 499 | - $this->delete_meta_data( $key ); |
|
| 500 | - } |
|
| 501 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 502 | - array( |
|
| 503 | - 'key' => $key, |
|
| 504 | - 'value' => $value, |
|
| 505 | - ) |
|
| 506 | - ); |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * Update meta data by key or ID, if provided. |
|
| 511 | - * |
|
| 512 | - * @since 1.0.19 |
|
| 513 | - * |
|
| 514 | - * @param string $key Meta key. |
|
| 515 | - * @param string|array $value Meta value. |
|
| 516 | - * @param int $meta_id Meta ID. |
|
| 517 | - */ |
|
| 518 | - public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 520 | - $function = 'set_' . $key; |
|
| 521 | - |
|
| 522 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | - return $this->{$function}( $value ); |
|
| 524 | - } |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - $this->maybe_read_meta_data(); |
|
| 528 | - |
|
| 529 | - $array_key = false; |
|
| 530 | - |
|
| 531 | - if ( $meta_id ) { |
|
| 532 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | - $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 534 | - } else { |
|
| 535 | - // Find matches by key. |
|
| 536 | - $matches = array(); |
|
| 537 | - foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | - if ( $meta->key === $key ) { |
|
| 539 | - $matches[] = $meta_data_array_key; |
|
| 540 | - } |
|
| 541 | - } |
|
| 542 | - |
|
| 543 | - if ( ! empty( $matches ) ) { |
|
| 544 | - // Set matches to null so only one key gets the new value. |
|
| 545 | - foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | - $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 547 | - } |
|
| 548 | - $array_key = current( $matches ); |
|
| 549 | - } |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - if ( false !== $array_key ) { |
|
| 553 | - $meta = $this->meta_data[ $array_key ]; |
|
| 554 | - $meta->key = $key; |
|
| 555 | - $meta->value = $value; |
|
| 556 | - } else { |
|
| 557 | - $this->add_meta_data( $key, $value, true ); |
|
| 558 | - } |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * Delete meta data. |
|
| 563 | - * |
|
| 564 | - * @since 1.0.19 |
|
| 565 | - * @param string $key Meta key. |
|
| 566 | - */ |
|
| 567 | - public function delete_meta_data( $key ) { |
|
| 568 | - $this->maybe_read_meta_data(); |
|
| 569 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 570 | - |
|
| 571 | - if ( $array_keys ) { |
|
| 572 | - foreach ( $array_keys as $array_key ) { |
|
| 573 | - $this->meta_data[ $array_key ]->value = null; |
|
| 574 | - } |
|
| 575 | - } |
|
| 576 | - } |
|
| 577 | - |
|
| 578 | - /** |
|
| 579 | - * Delete meta data. |
|
| 580 | - * |
|
| 581 | - * @since 1.0.19 |
|
| 582 | - * @param int $mid Meta ID. |
|
| 583 | - */ |
|
| 584 | - public function delete_meta_data_by_mid( $mid ) { |
|
| 585 | - $this->maybe_read_meta_data(); |
|
| 586 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 587 | - |
|
| 588 | - if ( $array_keys ) { |
|
| 589 | - foreach ( $array_keys as $array_key ) { |
|
| 590 | - $this->meta_data[ $array_key ]->value = null; |
|
| 591 | - } |
|
| 592 | - } |
|
| 593 | - } |
|
| 594 | - |
|
| 595 | - /** |
|
| 596 | - * Read meta data if null. |
|
| 597 | - * |
|
| 598 | - * @since 1.0.19 |
|
| 599 | - */ |
|
| 600 | - protected function maybe_read_meta_data() { |
|
| 601 | - if ( is_null( $this->meta_data ) ) { |
|
| 602 | - $this->read_meta_data(); |
|
| 603 | - } |
|
| 604 | - } |
|
| 605 | - |
|
| 606 | - /** |
|
| 607 | - * Read Meta Data from the database. Ignore any internal properties. |
|
| 608 | - * Uses it's own caches because get_metadata does not provide meta_ids. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @param bool $force_read True to force a new DB read (and update cache). |
|
| 612 | - */ |
|
| 613 | - public function read_meta_data( $force_read = false ) { |
|
| 614 | - |
|
| 615 | - // Reset meta data. |
|
| 616 | - $this->meta_data = array(); |
|
| 617 | - |
|
| 618 | - // Maybe abort early. |
|
| 619 | - if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 620 | - return; |
|
| 621 | - } |
|
| 622 | - |
|
| 623 | - // Only read from cache if the cache key is set. |
|
| 624 | - $cache_key = null; |
|
| 625 | - if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | - $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - // Should we force read? |
|
| 631 | - if ( empty( $raw_meta_data ) ) { |
|
| 632 | - $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 633 | - |
|
| 634 | - if ( ! empty( $cache_key ) ) { |
|
| 635 | - wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - } |
|
| 639 | - |
|
| 640 | - // Set meta data. |
|
| 641 | - if ( is_array( $raw_meta_data ) ) { |
|
| 642 | - |
|
| 643 | - foreach ( $raw_meta_data as $meta ) { |
|
| 644 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 645 | - array( |
|
| 646 | - 'id' => (int) $meta->meta_id, |
|
| 647 | - 'key' => $meta->meta_key, |
|
| 648 | - 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 649 | - ) |
|
| 650 | - ); |
|
| 651 | - } |
|
| 652 | - |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * Update Meta Data in the database. |
|
| 659 | - * |
|
| 660 | - * @since 1.0.19 |
|
| 661 | - */ |
|
| 662 | - public function save_meta_data() { |
|
| 663 | - if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 664 | - return; |
|
| 665 | - } |
|
| 666 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | - if ( is_null( $meta->value ) ) { |
|
| 668 | - if ( ! empty( $meta->id ) ) { |
|
| 669 | - $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | - unset( $this->meta_data[ $array_key ] ); |
|
| 671 | - } |
|
| 672 | - } elseif ( empty( $meta->id ) ) { |
|
| 673 | - $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 674 | - $meta->apply_changes(); |
|
| 675 | - } else { |
|
| 676 | - if ( $meta->get_changes() ) { |
|
| 677 | - $this->data_store->update_meta( $this, $meta ); |
|
| 678 | - $meta->apply_changes(); |
|
| 679 | - } |
|
| 680 | - } |
|
| 681 | - } |
|
| 682 | - if ( ! empty( $this->cache_group ) ) { |
|
| 683 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | - wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 685 | - } |
|
| 686 | - } |
|
| 687 | - |
|
| 688 | - /** |
|
| 689 | - * Set ID. |
|
| 690 | - * |
|
| 691 | - * @since 1.0.19 |
|
| 692 | - * @param int $id ID. |
|
| 693 | - */ |
|
| 694 | - public function set_id( $id ) { |
|
| 695 | - $this->id = absint( $id ); |
|
| 696 | - } |
|
| 697 | - |
|
| 698 | - /** |
|
| 699 | - * Sets item status. |
|
| 700 | - * |
|
| 701 | - * @since 1.0.19 |
|
| 702 | - * @param string $status New status. |
|
| 703 | - * @return array details of change. |
|
| 704 | - */ |
|
| 705 | - public function set_status( $status ) { |
|
| 394 | + return $this->get_prop( $key ); |
|
| 395 | + |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + /** |
|
| 399 | + * Get Meta Data by Key. |
|
| 400 | + * |
|
| 401 | + * @since 1.0.19 |
|
| 402 | + * @param string $key Meta Key. |
|
| 403 | + * @param bool $single return first found meta with key, or all with $key. |
|
| 404 | + * @param string $context What the value is for. Valid values are view and edit. |
|
| 405 | + * @return mixed |
|
| 406 | + */ |
|
| 407 | + public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 408 | + |
|
| 409 | + // Check if this is an internal meta key. |
|
| 410 | + $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | + $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | + if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 413 | + $function = 'get_' . $_key; |
|
| 414 | + |
|
| 415 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 416 | + return $this->{$function}(); |
|
| 417 | + } |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + // Read the meta data if not yet read. |
|
| 421 | + $this->maybe_read_meta_data(); |
|
| 422 | + $meta_data = $this->get_meta_data(); |
|
| 423 | + $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 424 | + $value = $single ? '' : array(); |
|
| 425 | + |
|
| 426 | + if ( ! empty( $array_keys ) ) { |
|
| 427 | + // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
| 428 | + if ( $single ) { |
|
| 429 | + $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 430 | + } else { |
|
| 431 | + $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 432 | + } |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + if ( 'view' === $context ) { |
|
| 436 | + $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + return $value; |
|
| 440 | + } |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * See if meta data exists, since get_meta always returns a '' or array(). |
|
| 444 | + * |
|
| 445 | + * @since 1.0.19 |
|
| 446 | + * @param string $key Meta Key. |
|
| 447 | + * @return boolean |
|
| 448 | + */ |
|
| 449 | + public function meta_exists( $key = '' ) { |
|
| 450 | + $this->maybe_read_meta_data(); |
|
| 451 | + $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | + return in_array( $key, $array_keys, true ); |
|
| 453 | + } |
|
| 454 | + |
|
| 455 | + /** |
|
| 456 | + * Set all meta data from array. |
|
| 457 | + * |
|
| 458 | + * @since 1.0.19 |
|
| 459 | + * @param array $data Key/Value pairs. |
|
| 460 | + */ |
|
| 461 | + public function set_meta_data( $data ) { |
|
| 462 | + if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 463 | + $this->maybe_read_meta_data(); |
|
| 464 | + foreach ( $data as $meta ) { |
|
| 465 | + $meta = (array) $meta; |
|
| 466 | + if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 467 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 468 | + array( |
|
| 469 | + 'id' => $meta['id'], |
|
| 470 | + 'key' => $meta['key'], |
|
| 471 | + 'value' => $meta['value'], |
|
| 472 | + ) |
|
| 473 | + ); |
|
| 474 | + } |
|
| 475 | + } |
|
| 476 | + } |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * Add meta data. |
|
| 481 | + * |
|
| 482 | + * @since 1.0.19 |
|
| 483 | + * |
|
| 484 | + * @param string $key Meta key. |
|
| 485 | + * @param string|array $value Meta value. |
|
| 486 | + * @param bool $unique Should this be a unique key?. |
|
| 487 | + */ |
|
| 488 | + public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
| 490 | + $function = 'set_' . $key; |
|
| 491 | + |
|
| 492 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | + return $this->{$function}( $value ); |
|
| 494 | + } |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + $this->maybe_read_meta_data(); |
|
| 498 | + if ( $unique ) { |
|
| 499 | + $this->delete_meta_data( $key ); |
|
| 500 | + } |
|
| 501 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 502 | + array( |
|
| 503 | + 'key' => $key, |
|
| 504 | + 'value' => $value, |
|
| 505 | + ) |
|
| 506 | + ); |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * Update meta data by key or ID, if provided. |
|
| 511 | + * |
|
| 512 | + * @since 1.0.19 |
|
| 513 | + * |
|
| 514 | + * @param string $key Meta key. |
|
| 515 | + * @param string|array $value Meta value. |
|
| 516 | + * @param int $meta_id Meta ID. |
|
| 517 | + */ |
|
| 518 | + public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
| 520 | + $function = 'set_' . $key; |
|
| 521 | + |
|
| 522 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | + return $this->{$function}( $value ); |
|
| 524 | + } |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + $this->maybe_read_meta_data(); |
|
| 528 | + |
|
| 529 | + $array_key = false; |
|
| 530 | + |
|
| 531 | + if ( $meta_id ) { |
|
| 532 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | + $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 534 | + } else { |
|
| 535 | + // Find matches by key. |
|
| 536 | + $matches = array(); |
|
| 537 | + foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | + if ( $meta->key === $key ) { |
|
| 539 | + $matches[] = $meta_data_array_key; |
|
| 540 | + } |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + if ( ! empty( $matches ) ) { |
|
| 544 | + // Set matches to null so only one key gets the new value. |
|
| 545 | + foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | + $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 547 | + } |
|
| 548 | + $array_key = current( $matches ); |
|
| 549 | + } |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + if ( false !== $array_key ) { |
|
| 553 | + $meta = $this->meta_data[ $array_key ]; |
|
| 554 | + $meta->key = $key; |
|
| 555 | + $meta->value = $value; |
|
| 556 | + } else { |
|
| 557 | + $this->add_meta_data( $key, $value, true ); |
|
| 558 | + } |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * Delete meta data. |
|
| 563 | + * |
|
| 564 | + * @since 1.0.19 |
|
| 565 | + * @param string $key Meta key. |
|
| 566 | + */ |
|
| 567 | + public function delete_meta_data( $key ) { |
|
| 568 | + $this->maybe_read_meta_data(); |
|
| 569 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 570 | + |
|
| 571 | + if ( $array_keys ) { |
|
| 572 | + foreach ( $array_keys as $array_key ) { |
|
| 573 | + $this->meta_data[ $array_key ]->value = null; |
|
| 574 | + } |
|
| 575 | + } |
|
| 576 | + } |
|
| 577 | + |
|
| 578 | + /** |
|
| 579 | + * Delete meta data. |
|
| 580 | + * |
|
| 581 | + * @since 1.0.19 |
|
| 582 | + * @param int $mid Meta ID. |
|
| 583 | + */ |
|
| 584 | + public function delete_meta_data_by_mid( $mid ) { |
|
| 585 | + $this->maybe_read_meta_data(); |
|
| 586 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 587 | + |
|
| 588 | + if ( $array_keys ) { |
|
| 589 | + foreach ( $array_keys as $array_key ) { |
|
| 590 | + $this->meta_data[ $array_key ]->value = null; |
|
| 591 | + } |
|
| 592 | + } |
|
| 593 | + } |
|
| 594 | + |
|
| 595 | + /** |
|
| 596 | + * Read meta data if null. |
|
| 597 | + * |
|
| 598 | + * @since 1.0.19 |
|
| 599 | + */ |
|
| 600 | + protected function maybe_read_meta_data() { |
|
| 601 | + if ( is_null( $this->meta_data ) ) { |
|
| 602 | + $this->read_meta_data(); |
|
| 603 | + } |
|
| 604 | + } |
|
| 605 | + |
|
| 606 | + /** |
|
| 607 | + * Read Meta Data from the database. Ignore any internal properties. |
|
| 608 | + * Uses it's own caches because get_metadata does not provide meta_ids. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @param bool $force_read True to force a new DB read (and update cache). |
|
| 612 | + */ |
|
| 613 | + public function read_meta_data( $force_read = false ) { |
|
| 614 | + |
|
| 615 | + // Reset meta data. |
|
| 616 | + $this->meta_data = array(); |
|
| 617 | + |
|
| 618 | + // Maybe abort early. |
|
| 619 | + if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 620 | + return; |
|
| 621 | + } |
|
| 622 | + |
|
| 623 | + // Only read from cache if the cache key is set. |
|
| 624 | + $cache_key = null; |
|
| 625 | + if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | + $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + // Should we force read? |
|
| 631 | + if ( empty( $raw_meta_data ) ) { |
|
| 632 | + $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 633 | + |
|
| 634 | + if ( ! empty( $cache_key ) ) { |
|
| 635 | + wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + } |
|
| 639 | + |
|
| 640 | + // Set meta data. |
|
| 641 | + if ( is_array( $raw_meta_data ) ) { |
|
| 642 | + |
|
| 643 | + foreach ( $raw_meta_data as $meta ) { |
|
| 644 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 645 | + array( |
|
| 646 | + 'id' => (int) $meta->meta_id, |
|
| 647 | + 'key' => $meta->meta_key, |
|
| 648 | + 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 649 | + ) |
|
| 650 | + ); |
|
| 651 | + } |
|
| 652 | + |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * Update Meta Data in the database. |
|
| 659 | + * |
|
| 660 | + * @since 1.0.19 |
|
| 661 | + */ |
|
| 662 | + public function save_meta_data() { |
|
| 663 | + if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 664 | + return; |
|
| 665 | + } |
|
| 666 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | + if ( is_null( $meta->value ) ) { |
|
| 668 | + if ( ! empty( $meta->id ) ) { |
|
| 669 | + $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | + unset( $this->meta_data[ $array_key ] ); |
|
| 671 | + } |
|
| 672 | + } elseif ( empty( $meta->id ) ) { |
|
| 673 | + $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 674 | + $meta->apply_changes(); |
|
| 675 | + } else { |
|
| 676 | + if ( $meta->get_changes() ) { |
|
| 677 | + $this->data_store->update_meta( $this, $meta ); |
|
| 678 | + $meta->apply_changes(); |
|
| 679 | + } |
|
| 680 | + } |
|
| 681 | + } |
|
| 682 | + if ( ! empty( $this->cache_group ) ) { |
|
| 683 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | + wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 685 | + } |
|
| 686 | + } |
|
| 687 | + |
|
| 688 | + /** |
|
| 689 | + * Set ID. |
|
| 690 | + * |
|
| 691 | + * @since 1.0.19 |
|
| 692 | + * @param int $id ID. |
|
| 693 | + */ |
|
| 694 | + public function set_id( $id ) { |
|
| 695 | + $this->id = absint( $id ); |
|
| 696 | + } |
|
| 697 | + |
|
| 698 | + /** |
|
| 699 | + * Sets item status. |
|
| 700 | + * |
|
| 701 | + * @since 1.0.19 |
|
| 702 | + * @param string $status New status. |
|
| 703 | + * @return array details of change. |
|
| 704 | + */ |
|
| 705 | + public function set_status( $status ) { |
|
| 706 | 706 | $old_status = $this->get_status(); |
| 707 | 707 | |
| 708 | - $this->set_prop( 'status', $status ); |
|
| 709 | - |
|
| 710 | - return array( |
|
| 711 | - 'from' => $old_status, |
|
| 712 | - 'to' => $status, |
|
| 713 | - ); |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - /** |
|
| 717 | - * Set all props to default values. |
|
| 718 | - * |
|
| 719 | - * @since 1.0.19 |
|
| 720 | - */ |
|
| 721 | - public function set_defaults() { |
|
| 722 | - $this->data = $this->default_data; |
|
| 723 | - $this->changes = array(); |
|
| 724 | - $this->set_object_read( false ); |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - /** |
|
| 728 | - * Set object read property. |
|
| 729 | - * |
|
| 730 | - * @since 1.0.19 |
|
| 731 | - * @param boolean $read Should read?. |
|
| 732 | - */ |
|
| 733 | - public function set_object_read( $read = true ) { |
|
| 734 | - $this->object_read = (bool) $read; |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - /** |
|
| 738 | - * Get object read property. |
|
| 739 | - * |
|
| 740 | - * @since 1.0.19 |
|
| 741 | - * @return boolean |
|
| 742 | - */ |
|
| 743 | - public function get_object_read() { |
|
| 744 | - return (bool) $this->object_read; |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - /** |
|
| 748 | - * Set a collection of props in one go, collect any errors, and return the result. |
|
| 749 | - * Only sets using public methods. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - * |
|
| 753 | - * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
| 754 | - * @param string $context In what context to run this. |
|
| 755 | - * |
|
| 756 | - * @return bool|WP_Error |
|
| 757 | - */ |
|
| 758 | - public function set_props( $props, $context = 'set' ) { |
|
| 759 | - $errors = false; |
|
| 760 | - |
|
| 761 | - foreach ( $props as $prop => $value ) { |
|
| 762 | - try { |
|
| 763 | - /** |
|
| 764 | - * Checks if the prop being set is allowed, and the value is not null. |
|
| 765 | - */ |
|
| 766 | - if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 767 | - continue; |
|
| 768 | - } |
|
| 769 | - $setter = "set_$prop"; |
|
| 770 | - |
|
| 771 | - if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | - $this->{$setter}( $value ); |
|
| 773 | - } |
|
| 774 | - } catch ( Exception $e ) { |
|
| 775 | - if ( ! $errors ) { |
|
| 776 | - $errors = new WP_Error(); |
|
| 777 | - } |
|
| 778 | - $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 779 | - $this->last_error = $e->getMessage(); |
|
| 780 | - } |
|
| 781 | - } |
|
| 782 | - |
|
| 783 | - return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - /** |
|
| 787 | - * Sets a prop for a setter method. |
|
| 788 | - * |
|
| 789 | - * This stores changes in a special array so we can track what needs saving |
|
| 790 | - * the the DB later. |
|
| 791 | - * |
|
| 792 | - * @since 1.0.19 |
|
| 793 | - * @param string $prop Name of prop to set. |
|
| 794 | - * @param mixed $value Value of the prop. |
|
| 795 | - */ |
|
| 796 | - protected function set_prop( $prop, $value ) { |
|
| 797 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | - if ( true === $this->object_read ) { |
|
| 799 | - if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | - $this->changes[ $prop ] = $value; |
|
| 801 | - } |
|
| 802 | - } else { |
|
| 803 | - $this->data[ $prop ] = $value; |
|
| 804 | - } |
|
| 805 | - } |
|
| 806 | - } |
|
| 807 | - |
|
| 808 | - /** |
|
| 809 | - * Return data changes only. |
|
| 810 | - * |
|
| 811 | - * @since 1.0.19 |
|
| 812 | - * @return array |
|
| 813 | - */ |
|
| 814 | - public function get_changes() { |
|
| 815 | - return $this->changes; |
|
| 816 | - } |
|
| 817 | - |
|
| 818 | - /** |
|
| 819 | - * Merge changes with data and clear. |
|
| 820 | - * |
|
| 821 | - * @since 1.0.19 |
|
| 822 | - */ |
|
| 823 | - public function apply_changes() { |
|
| 824 | - $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 825 | - $this->changes = array(); |
|
| 826 | - } |
|
| 827 | - |
|
| 828 | - /** |
|
| 829 | - * Prefix for action and filter hooks on data. |
|
| 830 | - * |
|
| 831 | - * @since 1.0.19 |
|
| 832 | - * @return string |
|
| 833 | - */ |
|
| 834 | - protected function get_hook_prefix() { |
|
| 835 | - return 'wpinv_get_' . $this->object_type . '_'; |
|
| 836 | - } |
|
| 837 | - |
|
| 838 | - /** |
|
| 839 | - * Gets a prop for a getter method. |
|
| 840 | - * |
|
| 841 | - * Gets the value from either current pending changes, or the data itself. |
|
| 842 | - * Context controls what happens to the value before it's returned. |
|
| 843 | - * |
|
| 844 | - * @since 1.0.19 |
|
| 845 | - * @param string $prop Name of prop to get. |
|
| 846 | - * @param string $context What the value is for. Valid values are view and edit. |
|
| 847 | - * @return mixed |
|
| 848 | - */ |
|
| 849 | - protected function get_prop( $prop, $context = 'view' ) { |
|
| 850 | - $value = null; |
|
| 851 | - |
|
| 852 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | - $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 854 | - |
|
| 855 | - if ( 'view' === $context ) { |
|
| 856 | - $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 857 | - } |
|
| 858 | - } |
|
| 859 | - |
|
| 860 | - return $value; |
|
| 861 | - } |
|
| 862 | - |
|
| 863 | - /** |
|
| 864 | - * Sets a date prop whilst handling formatting and datetime objects. |
|
| 865 | - * |
|
| 866 | - * @since 1.0.19 |
|
| 867 | - * @param string $prop Name of prop to set. |
|
| 868 | - * @param string|integer $value Value of the prop. |
|
| 869 | - */ |
|
| 870 | - protected function set_date_prop( $prop, $value ) { |
|
| 871 | - |
|
| 872 | - if ( empty( $value ) ) { |
|
| 873 | - $this->set_prop( $prop, null ); |
|
| 874 | - return; |
|
| 875 | - } |
|
| 876 | - $this->set_prop( $prop, $value ); |
|
| 877 | - |
|
| 878 | - } |
|
| 879 | - |
|
| 880 | - /** |
|
| 881 | - * When invalid data is found, throw an exception unless reading from the DB. |
|
| 882 | - * |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @param string $code Error code. |
|
| 885 | - * @param string $message Error message. |
|
| 886 | - */ |
|
| 887 | - protected function error( $code, $message ) { |
|
| 888 | - $this->last_error = $message; |
|
| 889 | - } |
|
| 890 | - |
|
| 891 | - /** |
|
| 892 | - * Checks if the object is saved in the database |
|
| 893 | - * |
|
| 894 | - * @since 1.0.19 |
|
| 895 | - * @return bool |
|
| 896 | - */ |
|
| 897 | - public function exists() { |
|
| 898 | - $id = $this->get_id(); |
|
| 899 | - return ! empty( $id ); |
|
| 900 | - } |
|
| 708 | + $this->set_prop( 'status', $status ); |
|
| 709 | + |
|
| 710 | + return array( |
|
| 711 | + 'from' => $old_status, |
|
| 712 | + 'to' => $status, |
|
| 713 | + ); |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + /** |
|
| 717 | + * Set all props to default values. |
|
| 718 | + * |
|
| 719 | + * @since 1.0.19 |
|
| 720 | + */ |
|
| 721 | + public function set_defaults() { |
|
| 722 | + $this->data = $this->default_data; |
|
| 723 | + $this->changes = array(); |
|
| 724 | + $this->set_object_read( false ); |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + /** |
|
| 728 | + * Set object read property. |
|
| 729 | + * |
|
| 730 | + * @since 1.0.19 |
|
| 731 | + * @param boolean $read Should read?. |
|
| 732 | + */ |
|
| 733 | + public function set_object_read( $read = true ) { |
|
| 734 | + $this->object_read = (bool) $read; |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + /** |
|
| 738 | + * Get object read property. |
|
| 739 | + * |
|
| 740 | + * @since 1.0.19 |
|
| 741 | + * @return boolean |
|
| 742 | + */ |
|
| 743 | + public function get_object_read() { |
|
| 744 | + return (bool) $this->object_read; |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + /** |
|
| 748 | + * Set a collection of props in one go, collect any errors, and return the result. |
|
| 749 | + * Only sets using public methods. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + * |
|
| 753 | + * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
| 754 | + * @param string $context In what context to run this. |
|
| 755 | + * |
|
| 756 | + * @return bool|WP_Error |
|
| 757 | + */ |
|
| 758 | + public function set_props( $props, $context = 'set' ) { |
|
| 759 | + $errors = false; |
|
| 760 | + |
|
| 761 | + foreach ( $props as $prop => $value ) { |
|
| 762 | + try { |
|
| 763 | + /** |
|
| 764 | + * Checks if the prop being set is allowed, and the value is not null. |
|
| 765 | + */ |
|
| 766 | + if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 767 | + continue; |
|
| 768 | + } |
|
| 769 | + $setter = "set_$prop"; |
|
| 770 | + |
|
| 771 | + if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | + $this->{$setter}( $value ); |
|
| 773 | + } |
|
| 774 | + } catch ( Exception $e ) { |
|
| 775 | + if ( ! $errors ) { |
|
| 776 | + $errors = new WP_Error(); |
|
| 777 | + } |
|
| 778 | + $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 779 | + $this->last_error = $e->getMessage(); |
|
| 780 | + } |
|
| 781 | + } |
|
| 782 | + |
|
| 783 | + return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + /** |
|
| 787 | + * Sets a prop for a setter method. |
|
| 788 | + * |
|
| 789 | + * This stores changes in a special array so we can track what needs saving |
|
| 790 | + * the the DB later. |
|
| 791 | + * |
|
| 792 | + * @since 1.0.19 |
|
| 793 | + * @param string $prop Name of prop to set. |
|
| 794 | + * @param mixed $value Value of the prop. |
|
| 795 | + */ |
|
| 796 | + protected function set_prop( $prop, $value ) { |
|
| 797 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | + if ( true === $this->object_read ) { |
|
| 799 | + if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | + $this->changes[ $prop ] = $value; |
|
| 801 | + } |
|
| 802 | + } else { |
|
| 803 | + $this->data[ $prop ] = $value; |
|
| 804 | + } |
|
| 805 | + } |
|
| 806 | + } |
|
| 807 | + |
|
| 808 | + /** |
|
| 809 | + * Return data changes only. |
|
| 810 | + * |
|
| 811 | + * @since 1.0.19 |
|
| 812 | + * @return array |
|
| 813 | + */ |
|
| 814 | + public function get_changes() { |
|
| 815 | + return $this->changes; |
|
| 816 | + } |
|
| 817 | + |
|
| 818 | + /** |
|
| 819 | + * Merge changes with data and clear. |
|
| 820 | + * |
|
| 821 | + * @since 1.0.19 |
|
| 822 | + */ |
|
| 823 | + public function apply_changes() { |
|
| 824 | + $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 825 | + $this->changes = array(); |
|
| 826 | + } |
|
| 827 | + |
|
| 828 | + /** |
|
| 829 | + * Prefix for action and filter hooks on data. |
|
| 830 | + * |
|
| 831 | + * @since 1.0.19 |
|
| 832 | + * @return string |
|
| 833 | + */ |
|
| 834 | + protected function get_hook_prefix() { |
|
| 835 | + return 'wpinv_get_' . $this->object_type . '_'; |
|
| 836 | + } |
|
| 837 | + |
|
| 838 | + /** |
|
| 839 | + * Gets a prop for a getter method. |
|
| 840 | + * |
|
| 841 | + * Gets the value from either current pending changes, or the data itself. |
|
| 842 | + * Context controls what happens to the value before it's returned. |
|
| 843 | + * |
|
| 844 | + * @since 1.0.19 |
|
| 845 | + * @param string $prop Name of prop to get. |
|
| 846 | + * @param string $context What the value is for. Valid values are view and edit. |
|
| 847 | + * @return mixed |
|
| 848 | + */ |
|
| 849 | + protected function get_prop( $prop, $context = 'view' ) { |
|
| 850 | + $value = null; |
|
| 851 | + |
|
| 852 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | + $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 854 | + |
|
| 855 | + if ( 'view' === $context ) { |
|
| 856 | + $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 857 | + } |
|
| 858 | + } |
|
| 859 | + |
|
| 860 | + return $value; |
|
| 861 | + } |
|
| 862 | + |
|
| 863 | + /** |
|
| 864 | + * Sets a date prop whilst handling formatting and datetime objects. |
|
| 865 | + * |
|
| 866 | + * @since 1.0.19 |
|
| 867 | + * @param string $prop Name of prop to set. |
|
| 868 | + * @param string|integer $value Value of the prop. |
|
| 869 | + */ |
|
| 870 | + protected function set_date_prop( $prop, $value ) { |
|
| 871 | + |
|
| 872 | + if ( empty( $value ) ) { |
|
| 873 | + $this->set_prop( $prop, null ); |
|
| 874 | + return; |
|
| 875 | + } |
|
| 876 | + $this->set_prop( $prop, $value ); |
|
| 877 | + |
|
| 878 | + } |
|
| 879 | + |
|
| 880 | + /** |
|
| 881 | + * When invalid data is found, throw an exception unless reading from the DB. |
|
| 882 | + * |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @param string $code Error code. |
|
| 885 | + * @param string $message Error message. |
|
| 886 | + */ |
|
| 887 | + protected function error( $code, $message ) { |
|
| 888 | + $this->last_error = $message; |
|
| 889 | + } |
|
| 890 | + |
|
| 891 | + /** |
|
| 892 | + * Checks if the object is saved in the database |
|
| 893 | + * |
|
| 894 | + * @since 1.0.19 |
|
| 895 | + * @return bool |
|
| 896 | + */ |
|
| 897 | + public function exists() { |
|
| 898 | + $id = $this->get_id(); |
|
| 899 | + return ! empty( $id ); |
|
| 900 | + } |
|
| 901 | 901 | |
| 902 | 902 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 11 | +if (!defined('ABSPATH')) { |
|
| 12 | 12 | exit; |
| 13 | 13 | } |
| 14 | 14 | |
@@ -117,8 +117,8 @@ discard block |
||
| 117 | 117 | * |
| 118 | 118 | * @param int|object|array $read ID to load from the DB (optional) or already queried data. |
| 119 | 119 | */ |
| 120 | - public function __construct( $read = 0 ) { |
|
| 121 | - $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 120 | + public function __construct($read = 0) { |
|
| 121 | + $this->data = array_merge($this->data, $this->extra_data); |
|
| 122 | 122 | $this->default_data = $this->data; |
| 123 | 123 | } |
| 124 | 124 | |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | * @return array |
| 129 | 129 | */ |
| 130 | 130 | public function __sleep() { |
| 131 | - return array( 'id' ); |
|
| 131 | + return array('id'); |
|
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | /** |
@@ -137,10 +137,10 @@ discard block |
||
| 137 | 137 | * If the object no longer exists, remove the ID. |
| 138 | 138 | */ |
| 139 | 139 | public function __wakeup() { |
| 140 | - $this->__construct( absint( $this->id ) ); |
|
| 140 | + $this->__construct(absint($this->id)); |
|
| 141 | 141 | |
| 142 | - if ( ! empty( $this->last_error ) ) { |
|
| 143 | - $this->set_id( 0 ); |
|
| 142 | + if (!empty($this->last_error)) { |
|
| 143 | + $this->set_id(0); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | } |
@@ -152,11 +152,11 @@ discard block |
||
| 152 | 152 | */ |
| 153 | 153 | public function __clone() { |
| 154 | 154 | $this->maybe_read_meta_data(); |
| 155 | - if ( ! empty( $this->meta_data ) ) { |
|
| 156 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | - $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | - if ( ! empty( $meta->id ) ) { |
|
| 159 | - $this->meta_data[ $array_key ]->id = null; |
|
| 155 | + if (!empty($this->meta_data)) { |
|
| 156 | + foreach ($this->meta_data as $array_key => $meta) { |
|
| 157 | + $this->meta_data[$array_key] = clone $meta; |
|
| 158 | + if (!empty($meta->id)) { |
|
| 159 | + $this->meta_data[$array_key]->id = null; |
|
| 160 | 160 | } |
| 161 | 161 | } |
| 162 | 162 | } |
@@ -199,8 +199,8 @@ discard block |
||
| 199 | 199 | * @param string $context View or edit context. |
| 200 | 200 | * @return string |
| 201 | 201 | */ |
| 202 | - public function get_status( $context = 'view' ) { |
|
| 203 | - return $this->get_prop( 'status', $context ); |
|
| 202 | + public function get_status($context = 'view') { |
|
| 203 | + return $this->get_prop('status', $context); |
|
| 204 | 204 | } |
| 205 | 205 | |
| 206 | 206 | /** |
@@ -210,10 +210,10 @@ discard block |
||
| 210 | 210 | * @param bool $force_delete Should the data be deleted permanently. |
| 211 | 211 | * @return bool result |
| 212 | 212 | */ |
| 213 | - public function delete( $force_delete = false ) { |
|
| 214 | - if ( $this->data_store && $this->get_id() ) { |
|
| 215 | - $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | - $this->set_id( 0 ); |
|
| 213 | + public function delete($force_delete = false) { |
|
| 214 | + if ($this->data_store && $this->get_id()) { |
|
| 215 | + $this->data_store->delete($this, array('force_delete' => $force_delete)); |
|
| 216 | + $this->set_id(0); |
|
| 217 | 217 | return true; |
| 218 | 218 | } |
| 219 | 219 | return false; |
@@ -226,7 +226,7 @@ discard block |
||
| 226 | 226 | * @return int |
| 227 | 227 | */ |
| 228 | 228 | public function save() { |
| 229 | - if ( ! $this->data_store ) { |
|
| 229 | + if (!$this->data_store) { |
|
| 230 | 230 | return $this->get_id(); |
| 231 | 231 | } |
| 232 | 232 | |
@@ -236,12 +236,12 @@ discard block |
||
| 236 | 236 | * @param GetPaid_Data $this The object being saved. |
| 237 | 237 | * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
| 238 | 238 | */ |
| 239 | - do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 239 | + do_action('getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store); |
|
| 240 | 240 | |
| 241 | - if ( $this->get_id() ) { |
|
| 242 | - $this->data_store->update( $this ); |
|
| 241 | + if ($this->get_id()) { |
|
| 242 | + $this->data_store->update($this); |
|
| 243 | 243 | } else { |
| 244 | - $this->data_store->create( $this ); |
|
| 244 | + $this->data_store->create($this); |
|
| 245 | 245 | } |
| 246 | 246 | |
| 247 | 247 | /** |
@@ -250,7 +250,7 @@ discard block |
||
| 250 | 250 | * @param GetPaid_Data $this The object being saved. |
| 251 | 251 | * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
| 252 | 252 | */ |
| 253 | - do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 253 | + do_action('getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store); |
|
| 254 | 254 | |
| 255 | 255 | return $this->get_id(); |
| 256 | 256 | } |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | * @return string Data in JSON format. |
| 263 | 263 | */ |
| 264 | 264 | public function __toString() { |
| 265 | - return wp_json_encode( $this->get_data() ); |
|
| 265 | + return wp_json_encode($this->get_data()); |
|
| 266 | 266 | } |
| 267 | 267 | |
| 268 | 268 | /** |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | * @return array |
| 273 | 273 | */ |
| 274 | 274 | public function get_data() { |
| 275 | - return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 275 | + return array_merge(array('id' => $this->get_id()), $this->data, array('meta_data' => $this->get_meta_data())); |
|
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | /** |
@@ -282,7 +282,7 @@ discard block |
||
| 282 | 282 | * @return array |
| 283 | 283 | */ |
| 284 | 284 | public function get_data_keys() { |
| 285 | - return array_keys( $this->data ); |
|
| 285 | + return array_keys($this->data); |
|
| 286 | 286 | } |
| 287 | 287 | |
| 288 | 288 | /** |
@@ -292,7 +292,7 @@ discard block |
||
| 292 | 292 | * @return array |
| 293 | 293 | */ |
| 294 | 294 | public function get_extra_data_keys() { |
| 295 | - return array_keys( $this->extra_data ); |
|
| 295 | + return array_keys($this->extra_data); |
|
| 296 | 296 | } |
| 297 | 297 | |
| 298 | 298 | /** |
@@ -302,8 +302,8 @@ discard block |
||
| 302 | 302 | * @param mixed $meta Meta value to check. |
| 303 | 303 | * @return bool |
| 304 | 304 | */ |
| 305 | - protected function filter_null_meta( $meta ) { |
|
| 306 | - return ! is_null( $meta->value ); |
|
| 305 | + protected function filter_null_meta($meta) { |
|
| 306 | + return !is_null($meta->value); |
|
| 307 | 307 | } |
| 308 | 308 | |
| 309 | 309 | /** |
@@ -314,7 +314,7 @@ discard block |
||
| 314 | 314 | */ |
| 315 | 315 | public function get_meta_data() { |
| 316 | 316 | $this->maybe_read_meta_data(); |
| 317 | - return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 317 | + return array_values(array_filter($this->meta_data, array($this, 'filter_null_meta'))); |
|
| 318 | 318 | } |
| 319 | 319 | |
| 320 | 320 | /** |
@@ -324,21 +324,21 @@ discard block |
||
| 324 | 324 | * @param string $key Key to check. |
| 325 | 325 | * @return bool true if it's an internal key, false otherwise |
| 326 | 326 | */ |
| 327 | - protected function is_internal_meta_key( $key ) { |
|
| 328 | - $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 327 | + protected function is_internal_meta_key($key) { |
|
| 328 | + $internal_meta_key = !empty($key) && $this->data_store && in_array($key, $this->data_store->get_internal_meta_keys(), true); |
|
| 329 | 329 | |
| 330 | - if ( ! $internal_meta_key ) { |
|
| 330 | + if (!$internal_meta_key) { |
|
| 331 | 331 | return false; |
| 332 | 332 | } |
| 333 | 333 | |
| 334 | - $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 334 | + $has_setter_or_getter = is_callable(array($this, 'set_' . $key)) || is_callable(array($this, 'get_' . $key)); |
|
| 335 | 335 | |
| 336 | - if ( ! $has_setter_or_getter ) { |
|
| 336 | + if (!$has_setter_or_getter) { |
|
| 337 | 337 | return false; |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | 340 | /* translators: %s: $key Key to check */ |
| 341 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 341 | + getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid'), $key), '1.0.19'); |
|
| 342 | 342 | |
| 343 | 343 | return true; |
| 344 | 344 | } |
@@ -352,20 +352,20 @@ discard block |
||
| 352 | 352 | * @access public |
| 353 | 353 | * |
| 354 | 354 | */ |
| 355 | - public function __set( $key, $value ) { |
|
| 355 | + public function __set($key, $value) { |
|
| 356 | 356 | |
| 357 | - if ( 'id' == strtolower( $key ) ) { |
|
| 358 | - return $this->set_id( $value ); |
|
| 357 | + if ('id' == strtolower($key)) { |
|
| 358 | + return $this->set_id($value); |
|
| 359 | 359 | } |
| 360 | 360 | |
| 361 | - if ( method_exists( $this, "set_$key") ) { |
|
| 361 | + if (method_exists($this, "set_$key")) { |
|
| 362 | 362 | |
| 363 | 363 | /* translators: %s: $key Key to set */ |
| 364 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 364 | + getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid'), $key), '1.0.19'); |
|
| 365 | 365 | |
| 366 | - call_user_func( array( $this, "set_$key" ), $value ); |
|
| 366 | + call_user_func(array($this, "set_$key"), $value); |
|
| 367 | 367 | } else { |
| 368 | - $this->set_prop( $key, $value ); |
|
| 368 | + $this->set_prop($key, $value); |
|
| 369 | 369 | } |
| 370 | 370 | |
| 371 | 371 | } |
@@ -373,25 +373,25 @@ discard block |
||
| 373 | 373 | /** |
| 374 | 374 | * Margic method for retrieving a property. |
| 375 | 375 | */ |
| 376 | - public function __get( $key ) { |
|
| 376 | + public function __get($key) { |
|
| 377 | 377 | |
| 378 | 378 | // Check if we have a helper method for that. |
| 379 | - if ( method_exists( $this, 'get_' . $key ) ) { |
|
| 379 | + if (method_exists($this, 'get_' . $key)) { |
|
| 380 | 380 | |
| 381 | - if ( 'post_type' != $key ) { |
|
| 381 | + if ('post_type' != $key) { |
|
| 382 | 382 | /* translators: %s: $key Key to set */ |
| 383 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 383 | + getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid'), $key), '1.0.19'); |
|
| 384 | 384 | } |
| 385 | 385 | |
| 386 | - return call_user_func( array( $this, 'get_' . $key ) ); |
|
| 386 | + return call_user_func(array($this, 'get_' . $key)); |
|
| 387 | 387 | } |
| 388 | 388 | |
| 389 | 389 | // Check if the key is in the associated $post object. |
| 390 | - if ( ! empty( $this->post ) && isset( $this->post->$key ) ) { |
|
| 390 | + if (!empty($this->post) && isset($this->post->$key)) { |
|
| 391 | 391 | return $this->post->$key; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | - return $this->get_prop( $key ); |
|
| 394 | + return $this->get_prop($key); |
|
| 395 | 395 | |
| 396 | 396 | } |
| 397 | 397 | |
@@ -404,15 +404,15 @@ discard block |
||
| 404 | 404 | * @param string $context What the value is for. Valid values are view and edit. |
| 405 | 405 | * @return mixed |
| 406 | 406 | */ |
| 407 | - public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 407 | + public function get_meta($key = '', $single = true, $context = 'view') { |
|
| 408 | 408 | |
| 409 | 409 | // Check if this is an internal meta key. |
| 410 | - $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | - $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | - if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 410 | + $_key = str_replace('_wpinv', '', $key); |
|
| 411 | + $_key = str_replace('wpinv', '', $_key); |
|
| 412 | + if ($this->is_internal_meta_key($_key)) { |
|
| 413 | 413 | $function = 'get_' . $_key; |
| 414 | 414 | |
| 415 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 415 | + if (is_callable(array($this, $function))) { |
|
| 416 | 416 | return $this->{$function}(); |
| 417 | 417 | } |
| 418 | 418 | } |
@@ -420,20 +420,20 @@ discard block |
||
| 420 | 420 | // Read the meta data if not yet read. |
| 421 | 421 | $this->maybe_read_meta_data(); |
| 422 | 422 | $meta_data = $this->get_meta_data(); |
| 423 | - $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 423 | + $array_keys = array_keys(wp_list_pluck($meta_data, 'key'), $key, true); |
|
| 424 | 424 | $value = $single ? '' : array(); |
| 425 | 425 | |
| 426 | - if ( ! empty( $array_keys ) ) { |
|
| 426 | + if (!empty($array_keys)) { |
|
| 427 | 427 | // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
| 428 | - if ( $single ) { |
|
| 429 | - $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 428 | + if ($single) { |
|
| 429 | + $value = $meta_data[current($array_keys)]->value; |
|
| 430 | 430 | } else { |
| 431 | - $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 431 | + $value = array_intersect_key($meta_data, array_flip($array_keys)); |
|
| 432 | 432 | } |
| 433 | 433 | } |
| 434 | 434 | |
| 435 | - if ( 'view' === $context ) { |
|
| 436 | - $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 435 | + if ('view' === $context) { |
|
| 436 | + $value = apply_filters($this->get_hook_prefix() . $key, $value, $this); |
|
| 437 | 437 | } |
| 438 | 438 | |
| 439 | 439 | return $value; |
@@ -446,10 +446,10 @@ discard block |
||
| 446 | 446 | * @param string $key Meta Key. |
| 447 | 447 | * @return boolean |
| 448 | 448 | */ |
| 449 | - public function meta_exists( $key = '' ) { |
|
| 449 | + public function meta_exists($key = '') { |
|
| 450 | 450 | $this->maybe_read_meta_data(); |
| 451 | - $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | - return in_array( $key, $array_keys, true ); |
|
| 451 | + $array_keys = wp_list_pluck($this->get_meta_data(), 'key'); |
|
| 452 | + return in_array($key, $array_keys, true); |
|
| 453 | 453 | } |
| 454 | 454 | |
| 455 | 455 | /** |
@@ -458,12 +458,12 @@ discard block |
||
| 458 | 458 | * @since 1.0.19 |
| 459 | 459 | * @param array $data Key/Value pairs. |
| 460 | 460 | */ |
| 461 | - public function set_meta_data( $data ) { |
|
| 462 | - if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 461 | + public function set_meta_data($data) { |
|
| 462 | + if (!empty($data) && is_array($data)) { |
|
| 463 | 463 | $this->maybe_read_meta_data(); |
| 464 | - foreach ( $data as $meta ) { |
|
| 464 | + foreach ($data as $meta) { |
|
| 465 | 465 | $meta = (array) $meta; |
| 466 | - if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 466 | + if (isset($meta['key'], $meta['value'], $meta['id'])) { |
|
| 467 | 467 | $this->meta_data[] = new GetPaid_Meta_Data( |
| 468 | 468 | array( |
| 469 | 469 | 'id' => $meta['id'], |
@@ -485,18 +485,18 @@ discard block |
||
| 485 | 485 | * @param string|array $value Meta value. |
| 486 | 486 | * @param bool $unique Should this be a unique key?. |
| 487 | 487 | */ |
| 488 | - public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 488 | + public function add_meta_data($key, $value, $unique = false) { |
|
| 489 | + if ($this->is_internal_meta_key($key)) { |
|
| 490 | 490 | $function = 'set_' . $key; |
| 491 | 491 | |
| 492 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | - return $this->{$function}( $value ); |
|
| 492 | + if (is_callable(array($this, $function))) { |
|
| 493 | + return $this->{$function}($value); |
|
| 494 | 494 | } |
| 495 | 495 | } |
| 496 | 496 | |
| 497 | 497 | $this->maybe_read_meta_data(); |
| 498 | - if ( $unique ) { |
|
| 499 | - $this->delete_meta_data( $key ); |
|
| 498 | + if ($unique) { |
|
| 499 | + $this->delete_meta_data($key); |
|
| 500 | 500 | } |
| 501 | 501 | $this->meta_data[] = new GetPaid_Meta_Data( |
| 502 | 502 | array( |
@@ -515,12 +515,12 @@ discard block |
||
| 515 | 515 | * @param string|array $value Meta value. |
| 516 | 516 | * @param int $meta_id Meta ID. |
| 517 | 517 | */ |
| 518 | - public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 518 | + public function update_meta_data($key, $value, $meta_id = 0) { |
|
| 519 | + if ($this->is_internal_meta_key($key)) { |
|
| 520 | 520 | $function = 'set_' . $key; |
| 521 | 521 | |
| 522 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | - return $this->{$function}( $value ); |
|
| 522 | + if (is_callable(array($this, $function))) { |
|
| 523 | + return $this->{$function}($value); |
|
| 524 | 524 | } |
| 525 | 525 | } |
| 526 | 526 | |
@@ -528,33 +528,33 @@ discard block |
||
| 528 | 528 | |
| 529 | 529 | $array_key = false; |
| 530 | 530 | |
| 531 | - if ( $meta_id ) { |
|
| 532 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | - $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 531 | + if ($meta_id) { |
|
| 532 | + $array_keys = array_keys(wp_list_pluck($this->meta_data, 'id'), $meta_id, true); |
|
| 533 | + $array_key = $array_keys ? current($array_keys) : false; |
|
| 534 | 534 | } else { |
| 535 | 535 | // Find matches by key. |
| 536 | 536 | $matches = array(); |
| 537 | - foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | - if ( $meta->key === $key ) { |
|
| 537 | + foreach ($this->meta_data as $meta_data_array_key => $meta) { |
|
| 538 | + if ($meta->key === $key) { |
|
| 539 | 539 | $matches[] = $meta_data_array_key; |
| 540 | 540 | } |
| 541 | 541 | } |
| 542 | 542 | |
| 543 | - if ( ! empty( $matches ) ) { |
|
| 543 | + if (!empty($matches)) { |
|
| 544 | 544 | // Set matches to null so only one key gets the new value. |
| 545 | - foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | - $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 545 | + foreach ($matches as $meta_data_array_key) { |
|
| 546 | + $this->meta_data[$meta_data_array_key]->value = null; |
|
| 547 | 547 | } |
| 548 | - $array_key = current( $matches ); |
|
| 548 | + $array_key = current($matches); |
|
| 549 | 549 | } |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | - if ( false !== $array_key ) { |
|
| 553 | - $meta = $this->meta_data[ $array_key ]; |
|
| 552 | + if (false !== $array_key) { |
|
| 553 | + $meta = $this->meta_data[$array_key]; |
|
| 554 | 554 | $meta->key = $key; |
| 555 | 555 | $meta->value = $value; |
| 556 | 556 | } else { |
| 557 | - $this->add_meta_data( $key, $value, true ); |
|
| 557 | + $this->add_meta_data($key, $value, true); |
|
| 558 | 558 | } |
| 559 | 559 | } |
| 560 | 560 | |
@@ -564,13 +564,13 @@ discard block |
||
| 564 | 564 | * @since 1.0.19 |
| 565 | 565 | * @param string $key Meta key. |
| 566 | 566 | */ |
| 567 | - public function delete_meta_data( $key ) { |
|
| 567 | + public function delete_meta_data($key) { |
|
| 568 | 568 | $this->maybe_read_meta_data(); |
| 569 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 569 | + $array_keys = array_keys(wp_list_pluck($this->meta_data, 'key'), $key, true); |
|
| 570 | 570 | |
| 571 | - if ( $array_keys ) { |
|
| 572 | - foreach ( $array_keys as $array_key ) { |
|
| 573 | - $this->meta_data[ $array_key ]->value = null; |
|
| 571 | + if ($array_keys) { |
|
| 572 | + foreach ($array_keys as $array_key) { |
|
| 573 | + $this->meta_data[$array_key]->value = null; |
|
| 574 | 574 | } |
| 575 | 575 | } |
| 576 | 576 | } |
@@ -581,13 +581,13 @@ discard block |
||
| 581 | 581 | * @since 1.0.19 |
| 582 | 582 | * @param int $mid Meta ID. |
| 583 | 583 | */ |
| 584 | - public function delete_meta_data_by_mid( $mid ) { |
|
| 584 | + public function delete_meta_data_by_mid($mid) { |
|
| 585 | 585 | $this->maybe_read_meta_data(); |
| 586 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 586 | + $array_keys = array_keys(wp_list_pluck($this->meta_data, 'id'), (int) $mid, true); |
|
| 587 | 587 | |
| 588 | - if ( $array_keys ) { |
|
| 589 | - foreach ( $array_keys as $array_key ) { |
|
| 590 | - $this->meta_data[ $array_key ]->value = null; |
|
| 588 | + if ($array_keys) { |
|
| 589 | + foreach ($array_keys as $array_key) { |
|
| 590 | + $this->meta_data[$array_key]->value = null; |
|
| 591 | 591 | } |
| 592 | 592 | } |
| 593 | 593 | } |
@@ -598,7 +598,7 @@ discard block |
||
| 598 | 598 | * @since 1.0.19 |
| 599 | 599 | */ |
| 600 | 600 | protected function maybe_read_meta_data() { |
| 601 | - if ( is_null( $this->meta_data ) ) { |
|
| 601 | + if (is_null($this->meta_data)) { |
|
| 602 | 602 | $this->read_meta_data(); |
| 603 | 603 | } |
| 604 | 604 | } |
@@ -610,42 +610,42 @@ discard block |
||
| 610 | 610 | * @since 1.0.19 |
| 611 | 611 | * @param bool $force_read True to force a new DB read (and update cache). |
| 612 | 612 | */ |
| 613 | - public function read_meta_data( $force_read = false ) { |
|
| 613 | + public function read_meta_data($force_read = false) { |
|
| 614 | 614 | |
| 615 | 615 | // Reset meta data. |
| 616 | 616 | $this->meta_data = array(); |
| 617 | 617 | |
| 618 | 618 | // Maybe abort early. |
| 619 | - if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 619 | + if (!$this->get_id() || !$this->data_store) { |
|
| 620 | 620 | return; |
| 621 | 621 | } |
| 622 | 622 | |
| 623 | 623 | // Only read from cache if the cache key is set. |
| 624 | 624 | $cache_key = null; |
| 625 | - if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | - $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 625 | + if (!$force_read && !empty($this->cache_group)) { |
|
| 626 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix($this->cache_group) . GetPaid_Cache_Helper::get_cache_prefix('object_' . $this->get_id()) . 'object_meta_' . $this->get_id(); |
|
| 627 | + $raw_meta_data = wp_cache_get($cache_key, $this->cache_group); |
|
| 628 | 628 | } |
| 629 | 629 | |
| 630 | 630 | // Should we force read? |
| 631 | - if ( empty( $raw_meta_data ) ) { |
|
| 632 | - $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 631 | + if (empty($raw_meta_data)) { |
|
| 632 | + $raw_meta_data = $this->data_store->read_meta($this); |
|
| 633 | 633 | |
| 634 | - if ( ! empty( $cache_key ) ) { |
|
| 635 | - wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 634 | + if (!empty($cache_key)) { |
|
| 635 | + wp_cache_set($cache_key, $raw_meta_data, $this->cache_group); |
|
| 636 | 636 | } |
| 637 | 637 | |
| 638 | 638 | } |
| 639 | 639 | |
| 640 | 640 | // Set meta data. |
| 641 | - if ( is_array( $raw_meta_data ) ) { |
|
| 641 | + if (is_array($raw_meta_data)) { |
|
| 642 | 642 | |
| 643 | - foreach ( $raw_meta_data as $meta ) { |
|
| 643 | + foreach ($raw_meta_data as $meta) { |
|
| 644 | 644 | $this->meta_data[] = new GetPaid_Meta_Data( |
| 645 | 645 | array( |
| 646 | 646 | 'id' => (int) $meta->meta_id, |
| 647 | 647 | 'key' => $meta->meta_key, |
| 648 | - 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 648 | + 'value' => maybe_unserialize($meta->meta_value), |
|
| 649 | 649 | ) |
| 650 | 650 | ); |
| 651 | 651 | } |
@@ -660,28 +660,28 @@ discard block |
||
| 660 | 660 | * @since 1.0.19 |
| 661 | 661 | */ |
| 662 | 662 | public function save_meta_data() { |
| 663 | - if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 663 | + if (!$this->data_store || is_null($this->meta_data)) { |
|
| 664 | 664 | return; |
| 665 | 665 | } |
| 666 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | - if ( is_null( $meta->value ) ) { |
|
| 668 | - if ( ! empty( $meta->id ) ) { |
|
| 669 | - $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | - unset( $this->meta_data[ $array_key ] ); |
|
| 666 | + foreach ($this->meta_data as $array_key => $meta) { |
|
| 667 | + if (is_null($meta->value)) { |
|
| 668 | + if (!empty($meta->id)) { |
|
| 669 | + $this->data_store->delete_meta($this, $meta); |
|
| 670 | + unset($this->meta_data[$array_key]); |
|
| 671 | 671 | } |
| 672 | - } elseif ( empty( $meta->id ) ) { |
|
| 673 | - $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 672 | + } elseif (empty($meta->id)) { |
|
| 673 | + $meta->id = $this->data_store->add_meta($this, $meta); |
|
| 674 | 674 | $meta->apply_changes(); |
| 675 | 675 | } else { |
| 676 | - if ( $meta->get_changes() ) { |
|
| 677 | - $this->data_store->update_meta( $this, $meta ); |
|
| 676 | + if ($meta->get_changes()) { |
|
| 677 | + $this->data_store->update_meta($this, $meta); |
|
| 678 | 678 | $meta->apply_changes(); |
| 679 | 679 | } |
| 680 | 680 | } |
| 681 | 681 | } |
| 682 | - if ( ! empty( $this->cache_group ) ) { |
|
| 683 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | - wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 682 | + if (!empty($this->cache_group)) { |
|
| 683 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix($this->cache_group) . GetPaid_Cache_Helper::get_cache_prefix('object_' . $this->get_id()) . 'object_meta_' . $this->get_id(); |
|
| 684 | + wp_cache_delete($cache_key, $this->cache_group); |
|
| 685 | 685 | } |
| 686 | 686 | } |
| 687 | 687 | |
@@ -691,8 +691,8 @@ discard block |
||
| 691 | 691 | * @since 1.0.19 |
| 692 | 692 | * @param int $id ID. |
| 693 | 693 | */ |
| 694 | - public function set_id( $id ) { |
|
| 695 | - $this->id = absint( $id ); |
|
| 694 | + public function set_id($id) { |
|
| 695 | + $this->id = absint($id); |
|
| 696 | 696 | } |
| 697 | 697 | |
| 698 | 698 | /** |
@@ -702,10 +702,10 @@ discard block |
||
| 702 | 702 | * @param string $status New status. |
| 703 | 703 | * @return array details of change. |
| 704 | 704 | */ |
| 705 | - public function set_status( $status ) { |
|
| 705 | + public function set_status($status) { |
|
| 706 | 706 | $old_status = $this->get_status(); |
| 707 | 707 | |
| 708 | - $this->set_prop( 'status', $status ); |
|
| 708 | + $this->set_prop('status', $status); |
|
| 709 | 709 | |
| 710 | 710 | return array( |
| 711 | 711 | 'from' => $old_status, |
@@ -721,7 +721,7 @@ discard block |
||
| 721 | 721 | public function set_defaults() { |
| 722 | 722 | $this->data = $this->default_data; |
| 723 | 723 | $this->changes = array(); |
| 724 | - $this->set_object_read( false ); |
|
| 724 | + $this->set_object_read(false); |
|
| 725 | 725 | } |
| 726 | 726 | |
| 727 | 727 | /** |
@@ -730,7 +730,7 @@ discard block |
||
| 730 | 730 | * @since 1.0.19 |
| 731 | 731 | * @param boolean $read Should read?. |
| 732 | 732 | */ |
| 733 | - public function set_object_read( $read = true ) { |
|
| 733 | + public function set_object_read($read = true) { |
|
| 734 | 734 | $this->object_read = (bool) $read; |
| 735 | 735 | } |
| 736 | 736 | |
@@ -755,32 +755,32 @@ discard block |
||
| 755 | 755 | * |
| 756 | 756 | * @return bool|WP_Error |
| 757 | 757 | */ |
| 758 | - public function set_props( $props, $context = 'set' ) { |
|
| 758 | + public function set_props($props, $context = 'set') { |
|
| 759 | 759 | $errors = false; |
| 760 | 760 | |
| 761 | - foreach ( $props as $prop => $value ) { |
|
| 761 | + foreach ($props as $prop => $value) { |
|
| 762 | 762 | try { |
| 763 | 763 | /** |
| 764 | 764 | * Checks if the prop being set is allowed, and the value is not null. |
| 765 | 765 | */ |
| 766 | - if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 766 | + if (is_null($value) || in_array($prop, array('prop', 'date_prop', 'meta_data'), true)) { |
|
| 767 | 767 | continue; |
| 768 | 768 | } |
| 769 | 769 | $setter = "set_$prop"; |
| 770 | 770 | |
| 771 | - if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | - $this->{$setter}( $value ); |
|
| 771 | + if (is_callable(array($this, $setter))) { |
|
| 772 | + $this->{$setter}($value); |
|
| 773 | 773 | } |
| 774 | - } catch ( Exception $e ) { |
|
| 775 | - if ( ! $errors ) { |
|
| 774 | + } catch (Exception $e) { |
|
| 775 | + if (!$errors) { |
|
| 776 | 776 | $errors = new WP_Error(); |
| 777 | 777 | } |
| 778 | - $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 778 | + $errors->add($e->getCode(), $e->getMessage()); |
|
| 779 | 779 | $this->last_error = $e->getMessage(); |
| 780 | 780 | } |
| 781 | 781 | } |
| 782 | 782 | |
| 783 | - return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 783 | + return $errors && count($errors->get_error_codes()) ? $errors : true; |
|
| 784 | 784 | } |
| 785 | 785 | |
| 786 | 786 | /** |
@@ -793,14 +793,14 @@ discard block |
||
| 793 | 793 | * @param string $prop Name of prop to set. |
| 794 | 794 | * @param mixed $value Value of the prop. |
| 795 | 795 | */ |
| 796 | - protected function set_prop( $prop, $value ) { |
|
| 797 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | - if ( true === $this->object_read ) { |
|
| 799 | - if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | - $this->changes[ $prop ] = $value; |
|
| 796 | + protected function set_prop($prop, $value) { |
|
| 797 | + if (array_key_exists($prop, $this->data)) { |
|
| 798 | + if (true === $this->object_read) { |
|
| 799 | + if ($value !== $this->data[$prop] || array_key_exists($prop, $this->changes)) { |
|
| 800 | + $this->changes[$prop] = $value; |
|
| 801 | 801 | } |
| 802 | 802 | } else { |
| 803 | - $this->data[ $prop ] = $value; |
|
| 803 | + $this->data[$prop] = $value; |
|
| 804 | 804 | } |
| 805 | 805 | } |
| 806 | 806 | } |
@@ -821,7 +821,7 @@ discard block |
||
| 821 | 821 | * @since 1.0.19 |
| 822 | 822 | */ |
| 823 | 823 | public function apply_changes() { |
| 824 | - $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 824 | + $this->data = array_replace_recursive($this->data, $this->changes); |
|
| 825 | 825 | $this->changes = array(); |
| 826 | 826 | } |
| 827 | 827 | |
@@ -846,14 +846,14 @@ discard block |
||
| 846 | 846 | * @param string $context What the value is for. Valid values are view and edit. |
| 847 | 847 | * @return mixed |
| 848 | 848 | */ |
| 849 | - protected function get_prop( $prop, $context = 'view' ) { |
|
| 849 | + protected function get_prop($prop, $context = 'view') { |
|
| 850 | 850 | $value = null; |
| 851 | 851 | |
| 852 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | - $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 852 | + if (array_key_exists($prop, $this->data)) { |
|
| 853 | + $value = array_key_exists($prop, $this->changes) ? $this->changes[$prop] : $this->data[$prop]; |
|
| 854 | 854 | |
| 855 | - if ( 'view' === $context ) { |
|
| 856 | - $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 855 | + if ('view' === $context) { |
|
| 856 | + $value = apply_filters($this->get_hook_prefix() . $prop, $value, $this); |
|
| 857 | 857 | } |
| 858 | 858 | } |
| 859 | 859 | |
@@ -867,13 +867,13 @@ discard block |
||
| 867 | 867 | * @param string $prop Name of prop to set. |
| 868 | 868 | * @param string|integer $value Value of the prop. |
| 869 | 869 | */ |
| 870 | - protected function set_date_prop( $prop, $value ) { |
|
| 870 | + protected function set_date_prop($prop, $value) { |
|
| 871 | 871 | |
| 872 | - if ( empty( $value ) ) { |
|
| 873 | - $this->set_prop( $prop, null ); |
|
| 872 | + if (empty($value)) { |
|
| 873 | + $this->set_prop($prop, null); |
|
| 874 | 874 | return; |
| 875 | 875 | } |
| 876 | - $this->set_prop( $prop, $value ); |
|
| 876 | + $this->set_prop($prop, $value); |
|
| 877 | 877 | |
| 878 | 878 | } |
| 879 | 879 | |
@@ -884,7 +884,7 @@ discard block |
||
| 884 | 884 | * @param string $code Error code. |
| 885 | 885 | * @param string $message Error message. |
| 886 | 886 | */ |
| 887 | - protected function error( $code, $message ) { |
|
| 887 | + protected function error($code, $message) { |
|
| 888 | 888 | $this->last_error = $message; |
| 889 | 889 | } |
| 890 | 890 | |
@@ -896,7 +896,7 @@ discard block |
||
| 896 | 896 | */ |
| 897 | 897 | public function exists() { |
| 898 | 898 | $id = $this->get_id(); |
| 899 | - return ! empty( $id ); |
|
| 899 | + return !empty($id); |
|
| 900 | 900 | } |
| 901 | 901 | |
| 902 | 902 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | 7 | if ( ! defined( 'ABSPATH' ) ) { |
| 8 | - exit; |
|
| 8 | + exit; |
|
| 9 | 9 | } |
| 10 | 10 | |
| 11 | 11 | /** |
@@ -15,196 +15,196 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class GetPaid_Subscription_Data_Store { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * A map of database fields to data types. |
|
| 20 | - * |
|
| 21 | - * @since 1.0.19 |
|
| 22 | - * @var array |
|
| 23 | - */ |
|
| 24 | - protected $database_fields_to_data_type = array( |
|
| 25 | - 'id' => '%d', |
|
| 26 | - 'customer_id' => '%d', |
|
| 27 | - 'frequency' => '%d', |
|
| 28 | - 'period' => '%s', |
|
| 29 | - 'initial_amount' => '%s', |
|
| 30 | - 'recurring_amount' => '%s', |
|
| 31 | - 'bill_times' => '%d', |
|
| 32 | - 'transaction_id' => '%s', |
|
| 33 | - 'parent_payment_id' => '%d', |
|
| 34 | - 'product_id' => '%d', |
|
| 35 | - 'created' => '%s', |
|
| 36 | - 'expiration' => '%s', |
|
| 37 | - 'trial_period' => '%s', |
|
| 38 | - 'status' => '%s', |
|
| 39 | - 'profile_id' => '%s', |
|
| 40 | - ); |
|
| 41 | - |
|
| 42 | - /* |
|
| 18 | + /** |
|
| 19 | + * A map of database fields to data types. |
|
| 20 | + * |
|
| 21 | + * @since 1.0.19 |
|
| 22 | + * @var array |
|
| 23 | + */ |
|
| 24 | + protected $database_fields_to_data_type = array( |
|
| 25 | + 'id' => '%d', |
|
| 26 | + 'customer_id' => '%d', |
|
| 27 | + 'frequency' => '%d', |
|
| 28 | + 'period' => '%s', |
|
| 29 | + 'initial_amount' => '%s', |
|
| 30 | + 'recurring_amount' => '%s', |
|
| 31 | + 'bill_times' => '%d', |
|
| 32 | + 'transaction_id' => '%s', |
|
| 33 | + 'parent_payment_id' => '%d', |
|
| 34 | + 'product_id' => '%d', |
|
| 35 | + 'created' => '%s', |
|
| 36 | + 'expiration' => '%s', |
|
| 37 | + 'trial_period' => '%s', |
|
| 38 | + 'status' => '%s', |
|
| 39 | + 'profile_id' => '%s', |
|
| 40 | + ); |
|
| 41 | + |
|
| 42 | + /* |
|
| 43 | 43 | |-------------------------------------------------------------------------- |
| 44 | 44 | | CRUD Methods |
| 45 | 45 | |-------------------------------------------------------------------------- |
| 46 | 46 | */ |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Method to create a new subscription in the database. |
|
| 50 | - * |
|
| 51 | - * @param WPInv_Subscription $subscription Subscription object. |
|
| 52 | - */ |
|
| 53 | - public function create( &$subscription ) { |
|
| 54 | - global $wpdb; |
|
| 55 | - |
|
| 56 | - $values = array(); |
|
| 57 | - $formats = array(); |
|
| 58 | - |
|
| 59 | - $fields = $this->database_fields_to_data_type; |
|
| 60 | - unset( $fields['id'] ); |
|
| 61 | - |
|
| 62 | - foreach ( $fields as $key => $format ) { |
|
| 63 | - $method = "get_$key"; |
|
| 64 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 65 | - $formats[] = $format; |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats ); |
|
| 69 | - |
|
| 70 | - if ( $result ) { |
|
| 71 | - $subscription->set_id( $wpdb->insert_id ); |
|
| 72 | - $subscription->apply_changes(); |
|
| 73 | - $subscription->clear_cache(); |
|
| 74 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 75 | - do_action( 'getpaid_new_subscription', $subscription ); |
|
| 76 | - return true; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - return false; |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Method to read a subscription from the database. |
|
| 84 | - * |
|
| 85 | - * @param WPInv_Subscription $subscription Subscription object. |
|
| 86 | - * |
|
| 87 | - */ |
|
| 88 | - public function read( &$subscription ) { |
|
| 89 | - global $wpdb; |
|
| 90 | - |
|
| 91 | - $subscription->set_defaults(); |
|
| 92 | - |
|
| 93 | - if ( ! $subscription->get_id() ) { |
|
| 94 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 95 | - $subscription->set_id( 0 ); |
|
| 96 | - return false; |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - // Maybe retrieve from the cache. |
|
| 100 | - $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' ); |
|
| 101 | - |
|
| 102 | - // If not found, retrieve from the db. |
|
| 103 | - if ( false === $raw_subscription ) { |
|
| 104 | - |
|
| 105 | - $raw_subscription = $wpdb->get_row( |
|
| 106 | - $wpdb->prepare( |
|
| 107 | - "SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d", |
|
| 108 | - $subscription->get_id() |
|
| 109 | - ) |
|
| 110 | - ); |
|
| 111 | - |
|
| 112 | - // Update the cache with our data |
|
| 113 | - wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' ); |
|
| 114 | - |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - if ( ! $raw_subscription ) { |
|
| 118 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 119 | - return false; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) { |
|
| 123 | - $method = "set_$key"; |
|
| 124 | - $subscription->$method( $raw_subscription->$key ); |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - $subscription->set_object_read( true ); |
|
| 128 | - do_action( 'getpaid_read_subscription', $subscription ); |
|
| 129 | - |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * Method to update a subscription in the database. |
|
| 134 | - * |
|
| 135 | - * @param WPInv_Subscription $subscription Subscription object. |
|
| 136 | - */ |
|
| 137 | - public function update( &$subscription ) { |
|
| 138 | - global $wpdb; |
|
| 139 | - |
|
| 140 | - $changes = $subscription->get_changes(); |
|
| 141 | - $values = array(); |
|
| 142 | - $format = array(); |
|
| 143 | - |
|
| 144 | - foreach ( $this->database_fields_to_data_type as $key => $format ) { |
|
| 145 | - if ( array_key_exists( $key, $changes ) ) { |
|
| 146 | - $method = "get_$key"; |
|
| 147 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 148 | - $formats[] = $format; |
|
| 149 | - } |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - if ( empty( $values ) ) { |
|
| 153 | - return; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - $wpdb->update( |
|
| 157 | - $wpdb->prefix . 'wpinv_subscriptions', |
|
| 158 | - $values, |
|
| 159 | - array( |
|
| 160 | - 'id' => $subscription->get_id(), |
|
| 161 | - ), |
|
| 162 | - $formats, |
|
| 163 | - '%d' |
|
| 164 | - ); |
|
| 165 | - |
|
| 166 | - // Apply the changes. |
|
| 167 | - $subscription->apply_changes(); |
|
| 168 | - |
|
| 169 | - // Delete cache. |
|
| 170 | - $subscription->clear_cache(); |
|
| 171 | - |
|
| 172 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() ); |
|
| 173 | - |
|
| 174 | - // Fire a hook. |
|
| 175 | - do_action( 'getpaid_update_subscription', $subscription ); |
|
| 176 | - |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - /** |
|
| 180 | - * Method to delete a subscription from the database. |
|
| 181 | - * |
|
| 182 | - * @param WPInv_Subscription $subscription |
|
| 183 | - */ |
|
| 184 | - public function delete( &$subscription ) { |
|
| 185 | - global $wpdb; |
|
| 186 | - |
|
| 187 | - $wpdb->query( |
|
| 188 | - $wpdb->prepare( |
|
| 189 | - "DELETE FROM {$wpdb->prefix}getpaid_subscriptions |
|
| 48 | + /** |
|
| 49 | + * Method to create a new subscription in the database. |
|
| 50 | + * |
|
| 51 | + * @param WPInv_Subscription $subscription Subscription object. |
|
| 52 | + */ |
|
| 53 | + public function create( &$subscription ) { |
|
| 54 | + global $wpdb; |
|
| 55 | + |
|
| 56 | + $values = array(); |
|
| 57 | + $formats = array(); |
|
| 58 | + |
|
| 59 | + $fields = $this->database_fields_to_data_type; |
|
| 60 | + unset( $fields['id'] ); |
|
| 61 | + |
|
| 62 | + foreach ( $fields as $key => $format ) { |
|
| 63 | + $method = "get_$key"; |
|
| 64 | + $values[$key] = $subscription->$method( 'edit' ); |
|
| 65 | + $formats[] = $format; |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats ); |
|
| 69 | + |
|
| 70 | + if ( $result ) { |
|
| 71 | + $subscription->set_id( $wpdb->insert_id ); |
|
| 72 | + $subscription->apply_changes(); |
|
| 73 | + $subscription->clear_cache(); |
|
| 74 | + update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 75 | + do_action( 'getpaid_new_subscription', $subscription ); |
|
| 76 | + return true; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + return false; |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Method to read a subscription from the database. |
|
| 84 | + * |
|
| 85 | + * @param WPInv_Subscription $subscription Subscription object. |
|
| 86 | + * |
|
| 87 | + */ |
|
| 88 | + public function read( &$subscription ) { |
|
| 89 | + global $wpdb; |
|
| 90 | + |
|
| 91 | + $subscription->set_defaults(); |
|
| 92 | + |
|
| 93 | + if ( ! $subscription->get_id() ) { |
|
| 94 | + $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 95 | + $subscription->set_id( 0 ); |
|
| 96 | + return false; |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + // Maybe retrieve from the cache. |
|
| 100 | + $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' ); |
|
| 101 | + |
|
| 102 | + // If not found, retrieve from the db. |
|
| 103 | + if ( false === $raw_subscription ) { |
|
| 104 | + |
|
| 105 | + $raw_subscription = $wpdb->get_row( |
|
| 106 | + $wpdb->prepare( |
|
| 107 | + "SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d", |
|
| 108 | + $subscription->get_id() |
|
| 109 | + ) |
|
| 110 | + ); |
|
| 111 | + |
|
| 112 | + // Update the cache with our data |
|
| 113 | + wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' ); |
|
| 114 | + |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + if ( ! $raw_subscription ) { |
|
| 118 | + $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 119 | + return false; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) { |
|
| 123 | + $method = "set_$key"; |
|
| 124 | + $subscription->$method( $raw_subscription->$key ); |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + $subscription->set_object_read( true ); |
|
| 128 | + do_action( 'getpaid_read_subscription', $subscription ); |
|
| 129 | + |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * Method to update a subscription in the database. |
|
| 134 | + * |
|
| 135 | + * @param WPInv_Subscription $subscription Subscription object. |
|
| 136 | + */ |
|
| 137 | + public function update( &$subscription ) { |
|
| 138 | + global $wpdb; |
|
| 139 | + |
|
| 140 | + $changes = $subscription->get_changes(); |
|
| 141 | + $values = array(); |
|
| 142 | + $format = array(); |
|
| 143 | + |
|
| 144 | + foreach ( $this->database_fields_to_data_type as $key => $format ) { |
|
| 145 | + if ( array_key_exists( $key, $changes ) ) { |
|
| 146 | + $method = "get_$key"; |
|
| 147 | + $values[$key] = $subscription->$method( 'edit' ); |
|
| 148 | + $formats[] = $format; |
|
| 149 | + } |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + if ( empty( $values ) ) { |
|
| 153 | + return; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + $wpdb->update( |
|
| 157 | + $wpdb->prefix . 'wpinv_subscriptions', |
|
| 158 | + $values, |
|
| 159 | + array( |
|
| 160 | + 'id' => $subscription->get_id(), |
|
| 161 | + ), |
|
| 162 | + $formats, |
|
| 163 | + '%d' |
|
| 164 | + ); |
|
| 165 | + |
|
| 166 | + // Apply the changes. |
|
| 167 | + $subscription->apply_changes(); |
|
| 168 | + |
|
| 169 | + // Delete cache. |
|
| 170 | + $subscription->clear_cache(); |
|
| 171 | + |
|
| 172 | + update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() ); |
|
| 173 | + |
|
| 174 | + // Fire a hook. |
|
| 175 | + do_action( 'getpaid_update_subscription', $subscription ); |
|
| 176 | + |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + /** |
|
| 180 | + * Method to delete a subscription from the database. |
|
| 181 | + * |
|
| 182 | + * @param WPInv_Subscription $subscription |
|
| 183 | + */ |
|
| 184 | + public function delete( &$subscription ) { |
|
| 185 | + global $wpdb; |
|
| 186 | + |
|
| 187 | + $wpdb->query( |
|
| 188 | + $wpdb->prepare( |
|
| 189 | + "DELETE FROM {$wpdb->prefix}getpaid_subscriptions |
|
| 190 | 190 | WHERE id = %d", |
| 191 | - $subscription->get_id() |
|
| 192 | - ) |
|
| 193 | - ); |
|
| 191 | + $subscription->get_id() |
|
| 192 | + ) |
|
| 193 | + ); |
|
| 194 | 194 | |
| 195 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' ); |
|
| 196 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' ); |
|
| 195 | + delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' ); |
|
| 196 | + delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' ); |
|
| 197 | 197 | |
| 198 | - // Delete cache. |
|
| 199 | - $subscription->clear_cache(); |
|
| 198 | + // Delete cache. |
|
| 199 | + $subscription->clear_cache(); |
|
| 200 | 200 | |
| 201 | - // Fire a hook. |
|
| 202 | - do_action( 'getpaid_delete_subscription', $subscription ); |
|
| 201 | + // Fire a hook. |
|
| 202 | + do_action( 'getpaid_delete_subscription', $subscription ); |
|
| 203 | 203 | |
| 204 | - $subscription->set_id( 0 ); |
|
| 205 | - } |
|
| 204 | + $subscription->set_id( 0 ); |
|
| 205 | + } |
|
| 206 | 206 | |
| 207 | - /* |
|
| 207 | + /* |
|
| 208 | 208 | |-------------------------------------------------------------------------- |
| 209 | 209 | | Additional Methods |
| 210 | 210 | |-------------------------------------------------------------------------- |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | * GetPaid_Subscription_Data_Store class file. |
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 7 | +if (!defined('ABSPATH')) { |
|
| 8 | 8 | exit; |
| 9 | 9 | } |
| 10 | 10 | |
@@ -50,29 +50,29 @@ discard block |
||
| 50 | 50 | * |
| 51 | 51 | * @param WPInv_Subscription $subscription Subscription object. |
| 52 | 52 | */ |
| 53 | - public function create( &$subscription ) { |
|
| 53 | + public function create(&$subscription) { |
|
| 54 | 54 | global $wpdb; |
| 55 | 55 | |
| 56 | 56 | $values = array(); |
| 57 | 57 | $formats = array(); |
| 58 | 58 | |
| 59 | 59 | $fields = $this->database_fields_to_data_type; |
| 60 | - unset( $fields['id'] ); |
|
| 60 | + unset($fields['id']); |
|
| 61 | 61 | |
| 62 | - foreach ( $fields as $key => $format ) { |
|
| 62 | + foreach ($fields as $key => $format) { |
|
| 63 | 63 | $method = "get_$key"; |
| 64 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 64 | + $values[$key] = $subscription->$method('edit'); |
|
| 65 | 65 | $formats[] = $format; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats ); |
|
| 68 | + $result = $wpdb->insert($wpdb->prefix . 'wpinv_subscriptions', $values, $formats); |
|
| 69 | 69 | |
| 70 | - if ( $result ) { |
|
| 71 | - $subscription->set_id( $wpdb->insert_id ); |
|
| 70 | + if ($result) { |
|
| 71 | + $subscription->set_id($wpdb->insert_id); |
|
| 72 | 72 | $subscription->apply_changes(); |
| 73 | 73 | $subscription->clear_cache(); |
| 74 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 75 | - do_action( 'getpaid_new_subscription', $subscription ); |
|
| 74 | + update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id()); |
|
| 75 | + do_action('getpaid_new_subscription', $subscription); |
|
| 76 | 76 | return true; |
| 77 | 77 | } |
| 78 | 78 | |
@@ -85,22 +85,22 @@ discard block |
||
| 85 | 85 | * @param WPInv_Subscription $subscription Subscription object. |
| 86 | 86 | * |
| 87 | 87 | */ |
| 88 | - public function read( &$subscription ) { |
|
| 88 | + public function read(&$subscription) { |
|
| 89 | 89 | global $wpdb; |
| 90 | 90 | |
| 91 | 91 | $subscription->set_defaults(); |
| 92 | 92 | |
| 93 | - if ( ! $subscription->get_id() ) { |
|
| 94 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 95 | - $subscription->set_id( 0 ); |
|
| 93 | + if (!$subscription->get_id()) { |
|
| 94 | + $subscription->last_error = __('Invalid subscription ID.', 'invoicing'); |
|
| 95 | + $subscription->set_id(0); |
|
| 96 | 96 | return false; |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | 99 | // Maybe retrieve from the cache. |
| 100 | - $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' ); |
|
| 100 | + $raw_subscription = wp_cache_get($subscription->get_id(), 'getpaid_subscriptions'); |
|
| 101 | 101 | |
| 102 | 102 | // If not found, retrieve from the db. |
| 103 | - if ( false === $raw_subscription ) { |
|
| 103 | + if (false === $raw_subscription) { |
|
| 104 | 104 | |
| 105 | 105 | $raw_subscription = $wpdb->get_row( |
| 106 | 106 | $wpdb->prepare( |
@@ -110,22 +110,22 @@ discard block |
||
| 110 | 110 | ); |
| 111 | 111 | |
| 112 | 112 | // Update the cache with our data |
| 113 | - wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' ); |
|
| 113 | + wp_cache_set($subscription->get_id(), $raw_subscription, 'getpaid_subscriptions'); |
|
| 114 | 114 | |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - if ( ! $raw_subscription ) { |
|
| 118 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 117 | + if (!$raw_subscription) { |
|
| 118 | + $subscription->last_error = __('Invalid subscription ID.', 'invoicing'); |
|
| 119 | 119 | return false; |
| 120 | 120 | } |
| 121 | 121 | |
| 122 | - foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) { |
|
| 123 | - $method = "set_$key"; |
|
| 124 | - $subscription->$method( $raw_subscription->$key ); |
|
| 122 | + foreach (array_keys($this->database_fields_to_data_type) as $key) { |
|
| 123 | + $method = "set_$key"; |
|
| 124 | + $subscription->$method($raw_subscription->$key); |
|
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - $subscription->set_object_read( true ); |
|
| 128 | - do_action( 'getpaid_read_subscription', $subscription ); |
|
| 127 | + $subscription->set_object_read(true); |
|
| 128 | + do_action('getpaid_read_subscription', $subscription); |
|
| 129 | 129 | |
| 130 | 130 | } |
| 131 | 131 | |
@@ -134,22 +134,22 @@ discard block |
||
| 134 | 134 | * |
| 135 | 135 | * @param WPInv_Subscription $subscription Subscription object. |
| 136 | 136 | */ |
| 137 | - public function update( &$subscription ) { |
|
| 137 | + public function update(&$subscription) { |
|
| 138 | 138 | global $wpdb; |
| 139 | 139 | |
| 140 | 140 | $changes = $subscription->get_changes(); |
| 141 | 141 | $values = array(); |
| 142 | 142 | $format = array(); |
| 143 | 143 | |
| 144 | - foreach ( $this->database_fields_to_data_type as $key => $format ) { |
|
| 145 | - if ( array_key_exists( $key, $changes ) ) { |
|
| 144 | + foreach ($this->database_fields_to_data_type as $key => $format) { |
|
| 145 | + if (array_key_exists($key, $changes)) { |
|
| 146 | 146 | $method = "get_$key"; |
| 147 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 147 | + $values[$key] = $subscription->$method('edit'); |
|
| 148 | 148 | $formats[] = $format; |
| 149 | 149 | } |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | - if ( empty( $values ) ) { |
|
| 152 | + if (empty($values)) { |
|
| 153 | 153 | return; |
| 154 | 154 | } |
| 155 | 155 | |
@@ -169,10 +169,10 @@ discard block |
||
| 169 | 169 | // Delete cache. |
| 170 | 170 | $subscription->clear_cache(); |
| 171 | 171 | |
| 172 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() ); |
|
| 172 | + update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id()); |
|
| 173 | 173 | |
| 174 | 174 | // Fire a hook. |
| 175 | - do_action( 'getpaid_update_subscription', $subscription ); |
|
| 175 | + do_action('getpaid_update_subscription', $subscription); |
|
| 176 | 176 | |
| 177 | 177 | } |
| 178 | 178 | |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | * |
| 182 | 182 | * @param WPInv_Subscription $subscription |
| 183 | 183 | */ |
| 184 | - public function delete( &$subscription ) { |
|
| 184 | + public function delete(&$subscription) { |
|
| 185 | 185 | global $wpdb; |
| 186 | 186 | |
| 187 | 187 | $wpdb->query( |
@@ -192,16 +192,16 @@ discard block |
||
| 192 | 192 | ) |
| 193 | 193 | ); |
| 194 | 194 | |
| 195 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' ); |
|
| 196 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' ); |
|
| 195 | + delete_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id'); |
|
| 196 | + delete_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id'); |
|
| 197 | 197 | |
| 198 | 198 | // Delete cache. |
| 199 | 199 | $subscription->clear_cache(); |
| 200 | 200 | |
| 201 | 201 | // Fire a hook. |
| 202 | - do_action( 'getpaid_delete_subscription', $subscription ); |
|
| 202 | + do_action('getpaid_delete_subscription', $subscription); |
|
| 203 | 203 | |
| 204 | - $subscription->set_id( 0 ); |
|
| 204 | + $subscription->set_id(0); |
|
| 205 | 205 | } |
| 206 | 206 | |
| 207 | 207 | /* |
@@ -17,476 +17,476 @@ |
||
| 17 | 17 | */ |
| 18 | 18 | class GetPaid_REST_CRUD_Controller extends GetPaid_REST_Controller { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Contains this controller's class name. |
|
| 22 | - * |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 25 | - public $crud_class; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Contains the current CRUD object. |
|
| 29 | - * |
|
| 30 | - * @var GetPaid_Data |
|
| 31 | - */ |
|
| 32 | - protected $data_object; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * Registers the routes for the objects of the controller. |
|
| 36 | - * |
|
| 37 | - * @since 1.0.19 |
|
| 38 | - * |
|
| 39 | - * @see register_rest_route() |
|
| 40 | - */ |
|
| 41 | - public function register_namespace_routes( $namespace ) { |
|
| 42 | - |
|
| 43 | - register_rest_route( |
|
| 44 | - $namespace, |
|
| 45 | - '/' . $this->rest_base, |
|
| 46 | - array( |
|
| 47 | - array( |
|
| 48 | - 'methods' => WP_REST_Server::READABLE, |
|
| 49 | - 'callback' => array( $this, 'get_items' ), |
|
| 50 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 51 | - 'args' => $this->get_collection_params(), |
|
| 52 | - ), |
|
| 53 | - array( |
|
| 54 | - 'methods' => WP_REST_Server::CREATABLE, |
|
| 55 | - 'callback' => array( $this, 'create_item' ), |
|
| 56 | - 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
| 57 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
| 58 | - ), |
|
| 59 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 60 | - ) |
|
| 61 | - ); |
|
| 62 | - |
|
| 63 | - $get_item_args = array( |
|
| 64 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 65 | - ); |
|
| 66 | - |
|
| 67 | - register_rest_route( |
|
| 68 | - $namespace, |
|
| 69 | - '/' . $this->rest_base . '/(?P<id>[\d]+)', |
|
| 70 | - array( |
|
| 71 | - 'args' => array( |
|
| 72 | - 'id' => array( |
|
| 73 | - 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
| 74 | - 'type' => 'integer', |
|
| 75 | - ), |
|
| 76 | - ), |
|
| 77 | - array( |
|
| 78 | - 'methods' => WP_REST_Server::READABLE, |
|
| 79 | - 'callback' => array( $this, 'get_item' ), |
|
| 80 | - 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
| 81 | - 'args' => $get_item_args, |
|
| 82 | - ), |
|
| 83 | - array( |
|
| 84 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 85 | - 'callback' => array( $this, 'update_item' ), |
|
| 86 | - 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
| 87 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 88 | - ), |
|
| 89 | - array( |
|
| 90 | - 'methods' => WP_REST_Server::DELETABLE, |
|
| 91 | - 'callback' => array( $this, 'delete_item' ), |
|
| 92 | - 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
| 93 | - 'args' => array( |
|
| 94 | - 'force' => array( |
|
| 95 | - 'type' => 'boolean', |
|
| 96 | - 'default' => false, |
|
| 97 | - 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
| 98 | - ), |
|
| 99 | - ), |
|
| 100 | - ), |
|
| 101 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 102 | - ) |
|
| 103 | - ); |
|
| 104 | - |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Saves a single object. |
|
| 109 | - * |
|
| 110 | - * @param GetPaid_Data $object Object to save. |
|
| 111 | - * @return WP_Error|GetPaid_Data |
|
| 112 | - */ |
|
| 113 | - protected function save_object( $object ) { |
|
| 114 | - $object->save(); |
|
| 115 | - |
|
| 116 | - if ( ! empty( $object->last_error ) ) { |
|
| 117 | - return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - return new $this->crud_class( $object->get_id() ); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Retrieves a single object. |
|
| 125 | - * |
|
| 126 | - * @since 1.0.13 |
|
| 127 | - * |
|
| 128 | - * @param int|WP_Post $object_id Supplied ID. |
|
| 129 | - * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
|
| 130 | - */ |
|
| 131 | - protected function get_object( $object_id ) { |
|
| 132 | - |
|
| 133 | - // Do we have an object? |
|
| 134 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 135 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - // Fetch the object. |
|
| 139 | - $object = new $this->crud_class( $object_id ); |
|
| 140 | - if ( ! empty( $object->last_error ) ) { |
|
| 141 | - return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - $this->data_object = $object; |
|
| 145 | - return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * Get a single object. |
|
| 151 | - * |
|
| 152 | - * @param WP_REST_Request $request Full details about the request. |
|
| 153 | - * @return WP_Error|WP_REST_Response |
|
| 154 | - */ |
|
| 155 | - public function get_item( $request ) { |
|
| 156 | - |
|
| 157 | - // Fetch the item. |
|
| 158 | - $object = $this->get_object( $request['id'] ); |
|
| 159 | - |
|
| 160 | - if ( is_wp_error( $object ) ) { |
|
| 161 | - return $object; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - // Generate a response. |
|
| 165 | - return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
| 166 | - |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Create a single object. |
|
| 171 | - * |
|
| 172 | - * @param WP_REST_Request $request Full details about the request. |
|
| 173 | - * @return WP_Error|WP_REST_Response |
|
| 174 | - */ |
|
| 175 | - public function create_item( $request ) { |
|
| 176 | - |
|
| 177 | - // Can not create an existing item. |
|
| 178 | - if ( ! empty( $request['id'] ) ) { |
|
| 179 | - /* translators: %s: post type */ |
|
| 180 | - return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - // Generate a GetPaid_Data object from the request. |
|
| 184 | - $object = $this->prepare_item_for_database( $request ); |
|
| 185 | - if ( is_wp_error( $object ) ) { |
|
| 186 | - return $object; |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - // Save the object. |
|
| 190 | - $object = $this->save_object( $object ); |
|
| 191 | - if ( is_wp_error( $object ) ) { |
|
| 192 | - return $object; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - // Save special fields. |
|
| 196 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 197 | - if ( is_wp_error( $save_special ) ) { |
|
| 198 | - $object->delete( true ); |
|
| 199 | - return $save_special; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - $request->set_param( 'context', 'edit' ); |
|
| 203 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 204 | - $response = rest_ensure_response( $response ); |
|
| 205 | - $response->set_status( 201 ); |
|
| 206 | - $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
| 207 | - |
|
| 208 | - return $response; |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * Update a single object. |
|
| 213 | - * |
|
| 214 | - * @param WP_REST_Request $request Full details about the request. |
|
| 215 | - * @return WP_Error|WP_REST_Response |
|
| 216 | - */ |
|
| 217 | - public function update_item( $request ) { |
|
| 218 | - |
|
| 219 | - // Fetch the item. |
|
| 220 | - $object = $this->get_object( $request['id'] ); |
|
| 221 | - if ( is_wp_error( $object ) ) { |
|
| 222 | - return $object; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - // Prepare the item for saving. |
|
| 226 | - $object = $this->prepare_item_for_database( $request ); |
|
| 227 | - if ( is_wp_error( $object ) ) { |
|
| 228 | - return $object; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - // Save the item. |
|
| 232 | - $object = $this->save_object( $object ); |
|
| 233 | - if ( is_wp_error( $object ) ) { |
|
| 234 | - return $object; |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - // Save special fields (those added via hooks). |
|
| 238 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 239 | - if ( is_wp_error( $save_special ) ) { |
|
| 240 | - return $save_special; |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - $request->set_param( 'context', 'edit' ); |
|
| 244 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 245 | - return rest_ensure_response( $response ); |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * Prepare links for the request. |
|
| 250 | - * |
|
| 251 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
| 252 | - * @return array Links for the given object. |
|
| 253 | - */ |
|
| 254 | - protected function prepare_links( $object ) { |
|
| 255 | - |
|
| 256 | - $links = array( |
|
| 257 | - 'self' => array( |
|
| 258 | - 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
| 259 | - ), |
|
| 260 | - 'collection' => array( |
|
| 261 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 262 | - ), |
|
| 263 | - ); |
|
| 264 | - |
|
| 265 | - return $links; |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Get the query params for collections of attachments. |
|
| 270 | - * |
|
| 271 | - * @return array |
|
| 272 | - */ |
|
| 273 | - public function get_collection_params() { |
|
| 274 | - $params = parent::get_collection_params(); |
|
| 275 | - $params['context']['default'] = 'view'; |
|
| 276 | - return $params; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Only return writable props from schema. |
|
| 281 | - * |
|
| 282 | - * @param array $schema Schema. |
|
| 283 | - * @return bool |
|
| 284 | - */ |
|
| 285 | - public function filter_writable_props( $schema ) { |
|
| 286 | - return empty( $schema['readonly'] ); |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * Prepare a single object for create or update. |
|
| 291 | - * |
|
| 292 | - * @since 1.0.19 |
|
| 293 | - * @param WP_REST_Request $request Request object. |
|
| 294 | - * @return GetPaid_Data|WP_Error Data object or WP_Error. |
|
| 295 | - */ |
|
| 296 | - protected function prepare_item_for_database( $request ) { |
|
| 297 | - |
|
| 298 | - // Do we have an object? |
|
| 299 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 300 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - // Prepare the object. |
|
| 304 | - $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
| 305 | - $object = new $this->crud_class( $id ); |
|
| 306 | - |
|
| 307 | - // Abort if an error exists. |
|
| 308 | - if ( ! empty( $object->last_error ) ) { |
|
| 309 | - return new WP_Error( 'invalid_item', $object->last_error ); |
|
| 310 | - } |
|
| 311 | - |
|
| 312 | - $schema = $this->get_item_schema(); |
|
| 313 | - $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
| 314 | - |
|
| 315 | - // Handle all writable props. |
|
| 316 | - foreach ( $data_keys as $key ) { |
|
| 317 | - $value = $request[ $key ]; |
|
| 318 | - |
|
| 319 | - if ( ! is_null( $value ) ) { |
|
| 320 | - switch ( $key ) { |
|
| 321 | - |
|
| 322 | - case 'meta_data': |
|
| 323 | - if ( is_array( $value ) ) { |
|
| 324 | - foreach ( $value as $meta ) { |
|
| 325 | - $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
| 326 | - } |
|
| 327 | - } |
|
| 328 | - break; |
|
| 329 | - |
|
| 330 | - default: |
|
| 331 | - if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
| 332 | - $object->{"set_{$key}"}( $value ); |
|
| 333 | - } |
|
| 334 | - break; |
|
| 335 | - } |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - // Filters an object before it is inserted via the REST API.. |
|
| 341 | - return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * Retrieves data from a GetPaid class. |
|
| 346 | - * |
|
| 347 | - * @since 1.0.19 |
|
| 348 | - * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
|
| 349 | - * @return array |
|
| 350 | - */ |
|
| 351 | - protected function prepare_object_meta_data( $meta_data ) { |
|
| 352 | - $meta = array(); |
|
| 353 | - |
|
| 354 | - foreach( $meta_data as $object ) { |
|
| 355 | - $meta[] = $object->get_data(); |
|
| 356 | - } |
|
| 357 | - |
|
| 358 | - return $meta; |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - /** |
|
| 362 | - * Retrieves invoice items. |
|
| 363 | - * |
|
| 364 | - * @since 1.0.19 |
|
| 365 | - * @param WPInv_Invoice $invoice Invoice items. |
|
| 366 | - * @param array $fields Fields to include. |
|
| 367 | - * @return array |
|
| 368 | - */ |
|
| 369 | - protected function prepare_invoice_items( $invoice ) { |
|
| 370 | - $items = array(); |
|
| 371 | - |
|
| 372 | - foreach( $invoice->get_items() as $item ) { |
|
| 373 | - |
|
| 374 | - $item_data = $item->prepare_data_for_saving(); |
|
| 375 | - |
|
| 376 | - if ( 'amount' == $invoice->get_template() ) { |
|
| 377 | - $item_data['quantity'] = 1; |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - $items[] = $item_data; |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - return $items; |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - /** |
|
| 387 | - * Retrieves data from a GetPaid class. |
|
| 388 | - * |
|
| 389 | - * @since 1.0.19 |
|
| 390 | - * @param GetPaid_Data $object Data object. |
|
| 391 | - * @param array $fields Fields to include. |
|
| 392 | - * @param string $context either view or edit. |
|
| 393 | - * @return array |
|
| 394 | - */ |
|
| 395 | - protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
| 396 | - |
|
| 397 | - $data = array(); |
|
| 398 | - |
|
| 399 | - // Handle all writable props. |
|
| 400 | - foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
| 401 | - |
|
| 402 | - // Abort if it is not included. |
|
| 403 | - if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
| 404 | - continue; |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - // Or this current object does not support the field. |
|
| 408 | - if ( ! $this->object_supports_field( $object, $key ) ) { |
|
| 409 | - continue; |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - // Handle meta data. |
|
| 413 | - if ( $key == 'meta_data' ) { |
|
| 414 | - $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
| 415 | - continue; |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - // Handle items. |
|
| 419 | - if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 420 | - $data['items'] = $this->prepare_invoice_items( $object ); |
|
| 421 | - continue; |
|
| 422 | - } |
|
| 423 | - |
|
| 424 | - // Booleans. |
|
| 425 | - if ( is_callable( array( $object, $key ) ) ) { |
|
| 426 | - $data[ $key ] = $object->$key( $context ); |
|
| 427 | - continue; |
|
| 428 | - } |
|
| 429 | - |
|
| 430 | - // Get object value. |
|
| 431 | - if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
| 432 | - $value = $object->{"get_{$key}"}( $context ); |
|
| 433 | - |
|
| 434 | - // If the value is an instance of GetPaid_Data... |
|
| 435 | - if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
| 436 | - $value = $value->get_data( $context ); |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - // For objects, retrieves it's properties. |
|
| 440 | - $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value ; |
|
| 441 | - continue; |
|
| 442 | - } |
|
| 443 | - |
|
| 444 | - } |
|
| 445 | - |
|
| 446 | - return $data; |
|
| 447 | - } |
|
| 448 | - |
|
| 449 | - /** |
|
| 450 | - * Checks if a key should be included in a response. |
|
| 451 | - * |
|
| 452 | - * @since 1.0.19 |
|
| 453 | - * @param GetPaid_Data $object Data object. |
|
| 454 | - * @param string $field_key The key to check for. |
|
| 455 | - * @return bool |
|
| 456 | - */ |
|
| 457 | - public function object_supports_field( $object, $field_key ) { |
|
| 458 | - return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - /** |
|
| 462 | - * Prepare a single object output for response. |
|
| 463 | - * |
|
| 464 | - * @since 1.0.19 |
|
| 465 | - * @param GetPaid_Data $object Data object. |
|
| 466 | - * @param WP_REST_Request $request Request object. |
|
| 467 | - * @return WP_REST_Response |
|
| 468 | - */ |
|
| 469 | - public function prepare_item_for_response( $object, $request ) { |
|
| 470 | - remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
| 471 | - |
|
| 472 | - $this->data_object = $object; |
|
| 473 | - |
|
| 474 | - // Fetch the fields to include in this response. |
|
| 475 | - $fields = $this->get_fields_for_response( $request ); |
|
| 476 | - |
|
| 477 | - // Prepare object data. |
|
| 478 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 479 | - $data = $this->prepare_object_data( $object, $fields, $context ); |
|
| 480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 481 | - $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
| 482 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 483 | - |
|
| 484 | - // Prepare the response. |
|
| 485 | - $response = rest_ensure_response( $data ); |
|
| 486 | - $response->add_links( $this->prepare_links( $object, $request ) ); |
|
| 487 | - |
|
| 488 | - // Filter item response. |
|
| 489 | - return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
| 490 | - } |
|
| 20 | + /** |
|
| 21 | + * Contains this controller's class name. |
|
| 22 | + * |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | + public $crud_class; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Contains the current CRUD object. |
|
| 29 | + * |
|
| 30 | + * @var GetPaid_Data |
|
| 31 | + */ |
|
| 32 | + protected $data_object; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * Registers the routes for the objects of the controller. |
|
| 36 | + * |
|
| 37 | + * @since 1.0.19 |
|
| 38 | + * |
|
| 39 | + * @see register_rest_route() |
|
| 40 | + */ |
|
| 41 | + public function register_namespace_routes( $namespace ) { |
|
| 42 | + |
|
| 43 | + register_rest_route( |
|
| 44 | + $namespace, |
|
| 45 | + '/' . $this->rest_base, |
|
| 46 | + array( |
|
| 47 | + array( |
|
| 48 | + 'methods' => WP_REST_Server::READABLE, |
|
| 49 | + 'callback' => array( $this, 'get_items' ), |
|
| 50 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 51 | + 'args' => $this->get_collection_params(), |
|
| 52 | + ), |
|
| 53 | + array( |
|
| 54 | + 'methods' => WP_REST_Server::CREATABLE, |
|
| 55 | + 'callback' => array( $this, 'create_item' ), |
|
| 56 | + 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
| 57 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
| 58 | + ), |
|
| 59 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 60 | + ) |
|
| 61 | + ); |
|
| 62 | + |
|
| 63 | + $get_item_args = array( |
|
| 64 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 65 | + ); |
|
| 66 | + |
|
| 67 | + register_rest_route( |
|
| 68 | + $namespace, |
|
| 69 | + '/' . $this->rest_base . '/(?P<id>[\d]+)', |
|
| 70 | + array( |
|
| 71 | + 'args' => array( |
|
| 72 | + 'id' => array( |
|
| 73 | + 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
| 74 | + 'type' => 'integer', |
|
| 75 | + ), |
|
| 76 | + ), |
|
| 77 | + array( |
|
| 78 | + 'methods' => WP_REST_Server::READABLE, |
|
| 79 | + 'callback' => array( $this, 'get_item' ), |
|
| 80 | + 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
| 81 | + 'args' => $get_item_args, |
|
| 82 | + ), |
|
| 83 | + array( |
|
| 84 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 85 | + 'callback' => array( $this, 'update_item' ), |
|
| 86 | + 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
| 87 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 88 | + ), |
|
| 89 | + array( |
|
| 90 | + 'methods' => WP_REST_Server::DELETABLE, |
|
| 91 | + 'callback' => array( $this, 'delete_item' ), |
|
| 92 | + 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
| 93 | + 'args' => array( |
|
| 94 | + 'force' => array( |
|
| 95 | + 'type' => 'boolean', |
|
| 96 | + 'default' => false, |
|
| 97 | + 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
| 98 | + ), |
|
| 99 | + ), |
|
| 100 | + ), |
|
| 101 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 102 | + ) |
|
| 103 | + ); |
|
| 104 | + |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Saves a single object. |
|
| 109 | + * |
|
| 110 | + * @param GetPaid_Data $object Object to save. |
|
| 111 | + * @return WP_Error|GetPaid_Data |
|
| 112 | + */ |
|
| 113 | + protected function save_object( $object ) { |
|
| 114 | + $object->save(); |
|
| 115 | + |
|
| 116 | + if ( ! empty( $object->last_error ) ) { |
|
| 117 | + return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + return new $this->crud_class( $object->get_id() ); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Retrieves a single object. |
|
| 125 | + * |
|
| 126 | + * @since 1.0.13 |
|
| 127 | + * |
|
| 128 | + * @param int|WP_Post $object_id Supplied ID. |
|
| 129 | + * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
|
| 130 | + */ |
|
| 131 | + protected function get_object( $object_id ) { |
|
| 132 | + |
|
| 133 | + // Do we have an object? |
|
| 134 | + if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 135 | + return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + // Fetch the object. |
|
| 139 | + $object = new $this->crud_class( $object_id ); |
|
| 140 | + if ( ! empty( $object->last_error ) ) { |
|
| 141 | + return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + $this->data_object = $object; |
|
| 145 | + return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * Get a single object. |
|
| 151 | + * |
|
| 152 | + * @param WP_REST_Request $request Full details about the request. |
|
| 153 | + * @return WP_Error|WP_REST_Response |
|
| 154 | + */ |
|
| 155 | + public function get_item( $request ) { |
|
| 156 | + |
|
| 157 | + // Fetch the item. |
|
| 158 | + $object = $this->get_object( $request['id'] ); |
|
| 159 | + |
|
| 160 | + if ( is_wp_error( $object ) ) { |
|
| 161 | + return $object; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + // Generate a response. |
|
| 165 | + return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
| 166 | + |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Create a single object. |
|
| 171 | + * |
|
| 172 | + * @param WP_REST_Request $request Full details about the request. |
|
| 173 | + * @return WP_Error|WP_REST_Response |
|
| 174 | + */ |
|
| 175 | + public function create_item( $request ) { |
|
| 176 | + |
|
| 177 | + // Can not create an existing item. |
|
| 178 | + if ( ! empty( $request['id'] ) ) { |
|
| 179 | + /* translators: %s: post type */ |
|
| 180 | + return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + // Generate a GetPaid_Data object from the request. |
|
| 184 | + $object = $this->prepare_item_for_database( $request ); |
|
| 185 | + if ( is_wp_error( $object ) ) { |
|
| 186 | + return $object; |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + // Save the object. |
|
| 190 | + $object = $this->save_object( $object ); |
|
| 191 | + if ( is_wp_error( $object ) ) { |
|
| 192 | + return $object; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + // Save special fields. |
|
| 196 | + $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 197 | + if ( is_wp_error( $save_special ) ) { |
|
| 198 | + $object->delete( true ); |
|
| 199 | + return $save_special; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + $request->set_param( 'context', 'edit' ); |
|
| 203 | + $response = $this->prepare_item_for_response( $object, $request ); |
|
| 204 | + $response = rest_ensure_response( $response ); |
|
| 205 | + $response->set_status( 201 ); |
|
| 206 | + $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
| 207 | + |
|
| 208 | + return $response; |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * Update a single object. |
|
| 213 | + * |
|
| 214 | + * @param WP_REST_Request $request Full details about the request. |
|
| 215 | + * @return WP_Error|WP_REST_Response |
|
| 216 | + */ |
|
| 217 | + public function update_item( $request ) { |
|
| 218 | + |
|
| 219 | + // Fetch the item. |
|
| 220 | + $object = $this->get_object( $request['id'] ); |
|
| 221 | + if ( is_wp_error( $object ) ) { |
|
| 222 | + return $object; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + // Prepare the item for saving. |
|
| 226 | + $object = $this->prepare_item_for_database( $request ); |
|
| 227 | + if ( is_wp_error( $object ) ) { |
|
| 228 | + return $object; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + // Save the item. |
|
| 232 | + $object = $this->save_object( $object ); |
|
| 233 | + if ( is_wp_error( $object ) ) { |
|
| 234 | + return $object; |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + // Save special fields (those added via hooks). |
|
| 238 | + $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 239 | + if ( is_wp_error( $save_special ) ) { |
|
| 240 | + return $save_special; |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + $request->set_param( 'context', 'edit' ); |
|
| 244 | + $response = $this->prepare_item_for_response( $object, $request ); |
|
| 245 | + return rest_ensure_response( $response ); |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * Prepare links for the request. |
|
| 250 | + * |
|
| 251 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
| 252 | + * @return array Links for the given object. |
|
| 253 | + */ |
|
| 254 | + protected function prepare_links( $object ) { |
|
| 255 | + |
|
| 256 | + $links = array( |
|
| 257 | + 'self' => array( |
|
| 258 | + 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
| 259 | + ), |
|
| 260 | + 'collection' => array( |
|
| 261 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 262 | + ), |
|
| 263 | + ); |
|
| 264 | + |
|
| 265 | + return $links; |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Get the query params for collections of attachments. |
|
| 270 | + * |
|
| 271 | + * @return array |
|
| 272 | + */ |
|
| 273 | + public function get_collection_params() { |
|
| 274 | + $params = parent::get_collection_params(); |
|
| 275 | + $params['context']['default'] = 'view'; |
|
| 276 | + return $params; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Only return writable props from schema. |
|
| 281 | + * |
|
| 282 | + * @param array $schema Schema. |
|
| 283 | + * @return bool |
|
| 284 | + */ |
|
| 285 | + public function filter_writable_props( $schema ) { |
|
| 286 | + return empty( $schema['readonly'] ); |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * Prepare a single object for create or update. |
|
| 291 | + * |
|
| 292 | + * @since 1.0.19 |
|
| 293 | + * @param WP_REST_Request $request Request object. |
|
| 294 | + * @return GetPaid_Data|WP_Error Data object or WP_Error. |
|
| 295 | + */ |
|
| 296 | + protected function prepare_item_for_database( $request ) { |
|
| 297 | + |
|
| 298 | + // Do we have an object? |
|
| 299 | + if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 300 | + return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + // Prepare the object. |
|
| 304 | + $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
| 305 | + $object = new $this->crud_class( $id ); |
|
| 306 | + |
|
| 307 | + // Abort if an error exists. |
|
| 308 | + if ( ! empty( $object->last_error ) ) { |
|
| 309 | + return new WP_Error( 'invalid_item', $object->last_error ); |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + $schema = $this->get_item_schema(); |
|
| 313 | + $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
| 314 | + |
|
| 315 | + // Handle all writable props. |
|
| 316 | + foreach ( $data_keys as $key ) { |
|
| 317 | + $value = $request[ $key ]; |
|
| 318 | + |
|
| 319 | + if ( ! is_null( $value ) ) { |
|
| 320 | + switch ( $key ) { |
|
| 321 | + |
|
| 322 | + case 'meta_data': |
|
| 323 | + if ( is_array( $value ) ) { |
|
| 324 | + foreach ( $value as $meta ) { |
|
| 325 | + $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
| 326 | + } |
|
| 327 | + } |
|
| 328 | + break; |
|
| 329 | + |
|
| 330 | + default: |
|
| 331 | + if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
| 332 | + $object->{"set_{$key}"}( $value ); |
|
| 333 | + } |
|
| 334 | + break; |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + // Filters an object before it is inserted via the REST API.. |
|
| 341 | + return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * Retrieves data from a GetPaid class. |
|
| 346 | + * |
|
| 347 | + * @since 1.0.19 |
|
| 348 | + * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
|
| 349 | + * @return array |
|
| 350 | + */ |
|
| 351 | + protected function prepare_object_meta_data( $meta_data ) { |
|
| 352 | + $meta = array(); |
|
| 353 | + |
|
| 354 | + foreach( $meta_data as $object ) { |
|
| 355 | + $meta[] = $object->get_data(); |
|
| 356 | + } |
|
| 357 | + |
|
| 358 | + return $meta; |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + /** |
|
| 362 | + * Retrieves invoice items. |
|
| 363 | + * |
|
| 364 | + * @since 1.0.19 |
|
| 365 | + * @param WPInv_Invoice $invoice Invoice items. |
|
| 366 | + * @param array $fields Fields to include. |
|
| 367 | + * @return array |
|
| 368 | + */ |
|
| 369 | + protected function prepare_invoice_items( $invoice ) { |
|
| 370 | + $items = array(); |
|
| 371 | + |
|
| 372 | + foreach( $invoice->get_items() as $item ) { |
|
| 373 | + |
|
| 374 | + $item_data = $item->prepare_data_for_saving(); |
|
| 375 | + |
|
| 376 | + if ( 'amount' == $invoice->get_template() ) { |
|
| 377 | + $item_data['quantity'] = 1; |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + $items[] = $item_data; |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + return $items; |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + /** |
|
| 387 | + * Retrieves data from a GetPaid class. |
|
| 388 | + * |
|
| 389 | + * @since 1.0.19 |
|
| 390 | + * @param GetPaid_Data $object Data object. |
|
| 391 | + * @param array $fields Fields to include. |
|
| 392 | + * @param string $context either view or edit. |
|
| 393 | + * @return array |
|
| 394 | + */ |
|
| 395 | + protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
| 396 | + |
|
| 397 | + $data = array(); |
|
| 398 | + |
|
| 399 | + // Handle all writable props. |
|
| 400 | + foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
| 401 | + |
|
| 402 | + // Abort if it is not included. |
|
| 403 | + if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
| 404 | + continue; |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + // Or this current object does not support the field. |
|
| 408 | + if ( ! $this->object_supports_field( $object, $key ) ) { |
|
| 409 | + continue; |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + // Handle meta data. |
|
| 413 | + if ( $key == 'meta_data' ) { |
|
| 414 | + $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
| 415 | + continue; |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + // Handle items. |
|
| 419 | + if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 420 | + $data['items'] = $this->prepare_invoice_items( $object ); |
|
| 421 | + continue; |
|
| 422 | + } |
|
| 423 | + |
|
| 424 | + // Booleans. |
|
| 425 | + if ( is_callable( array( $object, $key ) ) ) { |
|
| 426 | + $data[ $key ] = $object->$key( $context ); |
|
| 427 | + continue; |
|
| 428 | + } |
|
| 429 | + |
|
| 430 | + // Get object value. |
|
| 431 | + if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
| 432 | + $value = $object->{"get_{$key}"}( $context ); |
|
| 433 | + |
|
| 434 | + // If the value is an instance of GetPaid_Data... |
|
| 435 | + if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
| 436 | + $value = $value->get_data( $context ); |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + // For objects, retrieves it's properties. |
|
| 440 | + $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value ; |
|
| 441 | + continue; |
|
| 442 | + } |
|
| 443 | + |
|
| 444 | + } |
|
| 445 | + |
|
| 446 | + return $data; |
|
| 447 | + } |
|
| 448 | + |
|
| 449 | + /** |
|
| 450 | + * Checks if a key should be included in a response. |
|
| 451 | + * |
|
| 452 | + * @since 1.0.19 |
|
| 453 | + * @param GetPaid_Data $object Data object. |
|
| 454 | + * @param string $field_key The key to check for. |
|
| 455 | + * @return bool |
|
| 456 | + */ |
|
| 457 | + public function object_supports_field( $object, $field_key ) { |
|
| 458 | + return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + /** |
|
| 462 | + * Prepare a single object output for response. |
|
| 463 | + * |
|
| 464 | + * @since 1.0.19 |
|
| 465 | + * @param GetPaid_Data $object Data object. |
|
| 466 | + * @param WP_REST_Request $request Request object. |
|
| 467 | + * @return WP_REST_Response |
|
| 468 | + */ |
|
| 469 | + public function prepare_item_for_response( $object, $request ) { |
|
| 470 | + remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
| 471 | + |
|
| 472 | + $this->data_object = $object; |
|
| 473 | + |
|
| 474 | + // Fetch the fields to include in this response. |
|
| 475 | + $fields = $this->get_fields_for_response( $request ); |
|
| 476 | + |
|
| 477 | + // Prepare object data. |
|
| 478 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 479 | + $data = $this->prepare_object_data( $object, $fields, $context ); |
|
| 480 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 481 | + $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
| 482 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 483 | + |
|
| 484 | + // Prepare the response. |
|
| 485 | + $response = rest_ensure_response( $data ); |
|
| 486 | + $response->add_links( $this->prepare_links( $object, $request ) ); |
|
| 487 | + |
|
| 488 | + // Filter item response. |
|
| 489 | + return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
| 490 | + } |
|
| 491 | 491 | |
| 492 | 492 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * @version 1.0.19 |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -defined( 'ABSPATH' ) || exit; |
|
| 11 | +defined('ABSPATH') || exit; |
|
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | 14 | * GetPaid REST CRUD controller class. |
@@ -38,7 +38,7 @@ discard block |
||
| 38 | 38 | * |
| 39 | 39 | * @see register_rest_route() |
| 40 | 40 | */ |
| 41 | - public function register_namespace_routes( $namespace ) { |
|
| 41 | + public function register_namespace_routes($namespace) { |
|
| 42 | 42 | |
| 43 | 43 | register_rest_route( |
| 44 | 44 | $namespace, |
@@ -46,22 +46,22 @@ discard block |
||
| 46 | 46 | array( |
| 47 | 47 | array( |
| 48 | 48 | 'methods' => WP_REST_Server::READABLE, |
| 49 | - 'callback' => array( $this, 'get_items' ), |
|
| 50 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 49 | + 'callback' => array($this, 'get_items'), |
|
| 50 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 51 | 51 | 'args' => $this->get_collection_params(), |
| 52 | 52 | ), |
| 53 | 53 | array( |
| 54 | 54 | 'methods' => WP_REST_Server::CREATABLE, |
| 55 | - 'callback' => array( $this, 'create_item' ), |
|
| 56 | - 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
| 57 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
| 55 | + 'callback' => array($this, 'create_item'), |
|
| 56 | + 'permission_callback' => array($this, 'create_item_permissions_check'), |
|
| 57 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::CREATABLE), |
|
| 58 | 58 | ), |
| 59 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 59 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 60 | 60 | ) |
| 61 | 61 | ); |
| 62 | 62 | |
| 63 | 63 | $get_item_args = array( |
| 64 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 64 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
| 65 | 65 | ); |
| 66 | 66 | |
| 67 | 67 | register_rest_route( |
@@ -70,35 +70,35 @@ discard block |
||
| 70 | 70 | array( |
| 71 | 71 | 'args' => array( |
| 72 | 72 | 'id' => array( |
| 73 | - 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
| 73 | + 'description' => __('Unique identifier for the object.', 'invoicing'), |
|
| 74 | 74 | 'type' => 'integer', |
| 75 | 75 | ), |
| 76 | 76 | ), |
| 77 | 77 | array( |
| 78 | 78 | 'methods' => WP_REST_Server::READABLE, |
| 79 | - 'callback' => array( $this, 'get_item' ), |
|
| 80 | - 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
| 79 | + 'callback' => array($this, 'get_item'), |
|
| 80 | + 'permission_callback' => array($this, 'get_item_permissions_check'), |
|
| 81 | 81 | 'args' => $get_item_args, |
| 82 | 82 | ), |
| 83 | 83 | array( |
| 84 | 84 | 'methods' => WP_REST_Server::EDITABLE, |
| 85 | - 'callback' => array( $this, 'update_item' ), |
|
| 86 | - 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
| 87 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 85 | + 'callback' => array($this, 'update_item'), |
|
| 86 | + 'permission_callback' => array($this, 'update_item_permissions_check'), |
|
| 87 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE), |
|
| 88 | 88 | ), |
| 89 | 89 | array( |
| 90 | 90 | 'methods' => WP_REST_Server::DELETABLE, |
| 91 | - 'callback' => array( $this, 'delete_item' ), |
|
| 92 | - 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
| 91 | + 'callback' => array($this, 'delete_item'), |
|
| 92 | + 'permission_callback' => array($this, 'delete_item_permissions_check'), |
|
| 93 | 93 | 'args' => array( |
| 94 | 94 | 'force' => array( |
| 95 | 95 | 'type' => 'boolean', |
| 96 | 96 | 'default' => false, |
| 97 | - 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
| 97 | + 'description' => __('Whether to bypass Trash and force deletion.', 'invoicing'), |
|
| 98 | 98 | ), |
| 99 | 99 | ), |
| 100 | 100 | ), |
| 101 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 101 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 102 | 102 | ) |
| 103 | 103 | ); |
| 104 | 104 | |
@@ -110,14 +110,14 @@ discard block |
||
| 110 | 110 | * @param GetPaid_Data $object Object to save. |
| 111 | 111 | * @return WP_Error|GetPaid_Data |
| 112 | 112 | */ |
| 113 | - protected function save_object( $object ) { |
|
| 113 | + protected function save_object($object) { |
|
| 114 | 114 | $object->save(); |
| 115 | 115 | |
| 116 | - if ( ! empty( $object->last_error ) ) { |
|
| 117 | - return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
| 116 | + if (!empty($object->last_error)) { |
|
| 117 | + return new WP_Error('rest_cannot_save', $object->last_error, array('status' => 400)); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | - return new $this->crud_class( $object->get_id() ); |
|
| 120 | + return new $this->crud_class($object->get_id()); |
|
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | /** |
@@ -128,21 +128,21 @@ discard block |
||
| 128 | 128 | * @param int|WP_Post $object_id Supplied ID. |
| 129 | 129 | * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
| 130 | 130 | */ |
| 131 | - protected function get_object( $object_id ) { |
|
| 131 | + protected function get_object($object_id) { |
|
| 132 | 132 | |
| 133 | 133 | // Do we have an object? |
| 134 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 135 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 134 | + if (empty($this->crud_class) || !class_exists($this->crud_class)) { |
|
| 135 | + return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing')); |
|
| 136 | 136 | } |
| 137 | 137 | |
| 138 | 138 | // Fetch the object. |
| 139 | - $object = new $this->crud_class( $object_id ); |
|
| 140 | - if ( ! empty( $object->last_error ) ) { |
|
| 141 | - return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
| 139 | + $object = new $this->crud_class($object_id); |
|
| 140 | + if (!empty($object->last_error)) { |
|
| 141 | + return new WP_Error('rest_object_invalid_id', $object->last_error, array('status' => 404)); |
|
| 142 | 142 | } |
| 143 | 143 | |
| 144 | 144 | $this->data_object = $object; |
| 145 | - return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 145 | + return $object->get_id() ? $object : new WP_Error('rest_object_invalid_id', __('Invalid ID.', 'invoicing'), array('status' => 404)); |
|
| 146 | 146 | |
| 147 | 147 | } |
| 148 | 148 | |
@@ -152,17 +152,17 @@ discard block |
||
| 152 | 152 | * @param WP_REST_Request $request Full details about the request. |
| 153 | 153 | * @return WP_Error|WP_REST_Response |
| 154 | 154 | */ |
| 155 | - public function get_item( $request ) { |
|
| 155 | + public function get_item($request) { |
|
| 156 | 156 | |
| 157 | 157 | // Fetch the item. |
| 158 | - $object = $this->get_object( $request['id'] ); |
|
| 158 | + $object = $this->get_object($request['id']); |
|
| 159 | 159 | |
| 160 | - if ( is_wp_error( $object ) ) { |
|
| 160 | + if (is_wp_error($object)) { |
|
| 161 | 161 | return $object; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | 164 | // Generate a response. |
| 165 | - return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
| 165 | + return rest_ensure_response($this->prepare_item_for_response($object, $request)); |
|
| 166 | 166 | |
| 167 | 167 | } |
| 168 | 168 | |
@@ -172,38 +172,38 @@ discard block |
||
| 172 | 172 | * @param WP_REST_Request $request Full details about the request. |
| 173 | 173 | * @return WP_Error|WP_REST_Response |
| 174 | 174 | */ |
| 175 | - public function create_item( $request ) { |
|
| 175 | + public function create_item($request) { |
|
| 176 | 176 | |
| 177 | 177 | // Can not create an existing item. |
| 178 | - if ( ! empty( $request['id'] ) ) { |
|
| 178 | + if (!empty($request['id'])) { |
|
| 179 | 179 | /* translators: %s: post type */ |
| 180 | - return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 180 | + return new WP_Error("getpaid_rest_{$this->rest_base}_exists", __('Cannot create existing resource.', 'invoicing'), array('status' => 400)); |
|
| 181 | 181 | } |
| 182 | 182 | |
| 183 | 183 | // Generate a GetPaid_Data object from the request. |
| 184 | - $object = $this->prepare_item_for_database( $request ); |
|
| 185 | - if ( is_wp_error( $object ) ) { |
|
| 184 | + $object = $this->prepare_item_for_database($request); |
|
| 185 | + if (is_wp_error($object)) { |
|
| 186 | 186 | return $object; |
| 187 | 187 | } |
| 188 | 188 | |
| 189 | 189 | // Save the object. |
| 190 | - $object = $this->save_object( $object ); |
|
| 191 | - if ( is_wp_error( $object ) ) { |
|
| 190 | + $object = $this->save_object($object); |
|
| 191 | + if (is_wp_error($object)) { |
|
| 192 | 192 | return $object; |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | 195 | // Save special fields. |
| 196 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 197 | - if ( is_wp_error( $save_special ) ) { |
|
| 198 | - $object->delete( true ); |
|
| 196 | + $save_special = $this->update_additional_fields_for_object($object, $request); |
|
| 197 | + if (is_wp_error($save_special)) { |
|
| 198 | + $object->delete(true); |
|
| 199 | 199 | return $save_special; |
| 200 | 200 | } |
| 201 | 201 | |
| 202 | - $request->set_param( 'context', 'edit' ); |
|
| 203 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 204 | - $response = rest_ensure_response( $response ); |
|
| 205 | - $response->set_status( 201 ); |
|
| 206 | - $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
| 202 | + $request->set_param('context', 'edit'); |
|
| 203 | + $response = $this->prepare_item_for_response($object, $request); |
|
| 204 | + $response = rest_ensure_response($response); |
|
| 205 | + $response->set_status(201); |
|
| 206 | + $response->header('Location', rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id()))); |
|
| 207 | 207 | |
| 208 | 208 | return $response; |
| 209 | 209 | } |
@@ -214,35 +214,35 @@ discard block |
||
| 214 | 214 | * @param WP_REST_Request $request Full details about the request. |
| 215 | 215 | * @return WP_Error|WP_REST_Response |
| 216 | 216 | */ |
| 217 | - public function update_item( $request ) { |
|
| 217 | + public function update_item($request) { |
|
| 218 | 218 | |
| 219 | 219 | // Fetch the item. |
| 220 | - $object = $this->get_object( $request['id'] ); |
|
| 221 | - if ( is_wp_error( $object ) ) { |
|
| 220 | + $object = $this->get_object($request['id']); |
|
| 221 | + if (is_wp_error($object)) { |
|
| 222 | 222 | return $object; |
| 223 | 223 | } |
| 224 | 224 | |
| 225 | 225 | // Prepare the item for saving. |
| 226 | - $object = $this->prepare_item_for_database( $request ); |
|
| 227 | - if ( is_wp_error( $object ) ) { |
|
| 226 | + $object = $this->prepare_item_for_database($request); |
|
| 227 | + if (is_wp_error($object)) { |
|
| 228 | 228 | return $object; |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | 231 | // Save the item. |
| 232 | - $object = $this->save_object( $object ); |
|
| 233 | - if ( is_wp_error( $object ) ) { |
|
| 232 | + $object = $this->save_object($object); |
|
| 233 | + if (is_wp_error($object)) { |
|
| 234 | 234 | return $object; |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | 237 | // Save special fields (those added via hooks). |
| 238 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
| 239 | - if ( is_wp_error( $save_special ) ) { |
|
| 238 | + $save_special = $this->update_additional_fields_for_object($object, $request); |
|
| 239 | + if (is_wp_error($save_special)) { |
|
| 240 | 240 | return $save_special; |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - $request->set_param( 'context', 'edit' ); |
|
| 244 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
| 245 | - return rest_ensure_response( $response ); |
|
| 243 | + $request->set_param('context', 'edit'); |
|
| 244 | + $response = $this->prepare_item_for_response($object, $request); |
|
| 245 | + return rest_ensure_response($response); |
|
| 246 | 246 | } |
| 247 | 247 | |
| 248 | 248 | /** |
@@ -251,14 +251,14 @@ discard block |
||
| 251 | 251 | * @param GetPaid_Data $object GetPaid_Data object. |
| 252 | 252 | * @return array Links for the given object. |
| 253 | 253 | */ |
| 254 | - protected function prepare_links( $object ) { |
|
| 254 | + protected function prepare_links($object) { |
|
| 255 | 255 | |
| 256 | 256 | $links = array( |
| 257 | 257 | 'self' => array( |
| 258 | - 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
| 258 | + 'href' => rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())), |
|
| 259 | 259 | ), |
| 260 | 260 | 'collection' => array( |
| 261 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 261 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 262 | 262 | ), |
| 263 | 263 | ); |
| 264 | 264 | |
@@ -282,8 +282,8 @@ discard block |
||
| 282 | 282 | * @param array $schema Schema. |
| 283 | 283 | * @return bool |
| 284 | 284 | */ |
| 285 | - public function filter_writable_props( $schema ) { |
|
| 286 | - return empty( $schema['readonly'] ); |
|
| 285 | + public function filter_writable_props($schema) { |
|
| 286 | + return empty($schema['readonly']); |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | 289 | /** |
@@ -293,43 +293,43 @@ discard block |
||
| 293 | 293 | * @param WP_REST_Request $request Request object. |
| 294 | 294 | * @return GetPaid_Data|WP_Error Data object or WP_Error. |
| 295 | 295 | */ |
| 296 | - protected function prepare_item_for_database( $request ) { |
|
| 296 | + protected function prepare_item_for_database($request) { |
|
| 297 | 297 | |
| 298 | 298 | // Do we have an object? |
| 299 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
| 300 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
| 299 | + if (empty($this->crud_class) || !class_exists($this->crud_class)) { |
|
| 300 | + return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing')); |
|
| 301 | 301 | } |
| 302 | 302 | |
| 303 | 303 | // Prepare the object. |
| 304 | - $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
| 305 | - $object = new $this->crud_class( $id ); |
|
| 304 | + $id = isset($request['id']) ? absint($request['id']) : 0; |
|
| 305 | + $object = new $this->crud_class($id); |
|
| 306 | 306 | |
| 307 | 307 | // Abort if an error exists. |
| 308 | - if ( ! empty( $object->last_error ) ) { |
|
| 309 | - return new WP_Error( 'invalid_item', $object->last_error ); |
|
| 308 | + if (!empty($object->last_error)) { |
|
| 309 | + return new WP_Error('invalid_item', $object->last_error); |
|
| 310 | 310 | } |
| 311 | 311 | |
| 312 | 312 | $schema = $this->get_item_schema(); |
| 313 | - $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
| 313 | + $data_keys = array_keys(array_filter($schema['properties'], array($this, 'filter_writable_props'))); |
|
| 314 | 314 | |
| 315 | 315 | // Handle all writable props. |
| 316 | - foreach ( $data_keys as $key ) { |
|
| 317 | - $value = $request[ $key ]; |
|
| 316 | + foreach ($data_keys as $key) { |
|
| 317 | + $value = $request[$key]; |
|
| 318 | 318 | |
| 319 | - if ( ! is_null( $value ) ) { |
|
| 320 | - switch ( $key ) { |
|
| 319 | + if (!is_null($value)) { |
|
| 320 | + switch ($key) { |
|
| 321 | 321 | |
| 322 | 322 | case 'meta_data': |
| 323 | - if ( is_array( $value ) ) { |
|
| 324 | - foreach ( $value as $meta ) { |
|
| 325 | - $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
| 323 | + if (is_array($value)) { |
|
| 324 | + foreach ($value as $meta) { |
|
| 325 | + $object->update_meta_data($meta['key'], $meta['value'], isset($meta['id']) ? $meta['id'] : ''); |
|
| 326 | 326 | } |
| 327 | 327 | } |
| 328 | 328 | break; |
| 329 | 329 | |
| 330 | 330 | default: |
| 331 | - if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
| 332 | - $object->{"set_{$key}"}( $value ); |
|
| 331 | + if (is_callable(array($object, "set_{$key}"))) { |
|
| 332 | + $object->{"set_{$key}"}($value); |
|
| 333 | 333 | } |
| 334 | 334 | break; |
| 335 | 335 | } |
@@ -338,7 +338,7 @@ discard block |
||
| 338 | 338 | } |
| 339 | 339 | |
| 340 | 340 | // Filters an object before it is inserted via the REST API.. |
| 341 | - return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
| 341 | + return apply_filters("getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request); |
|
| 342 | 342 | } |
| 343 | 343 | |
| 344 | 344 | /** |
@@ -348,10 +348,10 @@ discard block |
||
| 348 | 348 | * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
| 349 | 349 | * @return array |
| 350 | 350 | */ |
| 351 | - protected function prepare_object_meta_data( $meta_data ) { |
|
| 351 | + protected function prepare_object_meta_data($meta_data) { |
|
| 352 | 352 | $meta = array(); |
| 353 | 353 | |
| 354 | - foreach( $meta_data as $object ) { |
|
| 354 | + foreach ($meta_data as $object) { |
|
| 355 | 355 | $meta[] = $object->get_data(); |
| 356 | 356 | } |
| 357 | 357 | |
@@ -366,14 +366,14 @@ discard block |
||
| 366 | 366 | * @param array $fields Fields to include. |
| 367 | 367 | * @return array |
| 368 | 368 | */ |
| 369 | - protected function prepare_invoice_items( $invoice ) { |
|
| 369 | + protected function prepare_invoice_items($invoice) { |
|
| 370 | 370 | $items = array(); |
| 371 | 371 | |
| 372 | - foreach( $invoice->get_items() as $item ) { |
|
| 372 | + foreach ($invoice->get_items() as $item) { |
|
| 373 | 373 | |
| 374 | 374 | $item_data = $item->prepare_data_for_saving(); |
| 375 | 375 | |
| 376 | - if ( 'amount' == $invoice->get_template() ) { |
|
| 376 | + if ('amount' == $invoice->get_template()) { |
|
| 377 | 377 | $item_data['quantity'] = 1; |
| 378 | 378 | } |
| 379 | 379 | |
@@ -392,52 +392,52 @@ discard block |
||
| 392 | 392 | * @param string $context either view or edit. |
| 393 | 393 | * @return array |
| 394 | 394 | */ |
| 395 | - protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
| 395 | + protected function prepare_object_data($object, $fields, $context = 'view') { |
|
| 396 | 396 | |
| 397 | 397 | $data = array(); |
| 398 | 398 | |
| 399 | 399 | // Handle all writable props. |
| 400 | - foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
| 400 | + foreach (array_keys($this->get_schema_properties()) as $key) { |
|
| 401 | 401 | |
| 402 | 402 | // Abort if it is not included. |
| 403 | - if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
| 403 | + if (!empty($fields) && !$this->is_field_included($key, $fields)) { |
|
| 404 | 404 | continue; |
| 405 | 405 | } |
| 406 | 406 | |
| 407 | 407 | // Or this current object does not support the field. |
| 408 | - if ( ! $this->object_supports_field( $object, $key ) ) { |
|
| 408 | + if (!$this->object_supports_field($object, $key)) { |
|
| 409 | 409 | continue; |
| 410 | 410 | } |
| 411 | 411 | |
| 412 | 412 | // Handle meta data. |
| 413 | - if ( $key == 'meta_data' ) { |
|
| 414 | - $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
| 413 | + if ($key == 'meta_data') { |
|
| 414 | + $data['meta_data'] = $this->prepare_object_meta_data($object->get_meta_data()); |
|
| 415 | 415 | continue; |
| 416 | 416 | } |
| 417 | 417 | |
| 418 | 418 | // Handle items. |
| 419 | - if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 420 | - $data['items'] = $this->prepare_invoice_items( $object ); |
|
| 419 | + if ($key == 'items' && is_a($object, 'WPInv_Invoice')) { |
|
| 420 | + $data['items'] = $this->prepare_invoice_items($object); |
|
| 421 | 421 | continue; |
| 422 | 422 | } |
| 423 | 423 | |
| 424 | 424 | // Booleans. |
| 425 | - if ( is_callable( array( $object, $key ) ) ) { |
|
| 426 | - $data[ $key ] = $object->$key( $context ); |
|
| 425 | + if (is_callable(array($object, $key))) { |
|
| 426 | + $data[$key] = $object->$key($context); |
|
| 427 | 427 | continue; |
| 428 | 428 | } |
| 429 | 429 | |
| 430 | 430 | // Get object value. |
| 431 | - if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
| 432 | - $value = $object->{"get_{$key}"}( $context ); |
|
| 431 | + if (is_callable(array($object, "get_{$key}"))) { |
|
| 432 | + $value = $object->{"get_{$key}"}($context); |
|
| 433 | 433 | |
| 434 | 434 | // If the value is an instance of GetPaid_Data... |
| 435 | - if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
| 436 | - $value = $value->get_data( $context ); |
|
| 435 | + if (is_a($value, 'GetPaid_Data')) { |
|
| 436 | + $value = $value->get_data($context); |
|
| 437 | 437 | } |
| 438 | 438 | |
| 439 | 439 | // For objects, retrieves it's properties. |
| 440 | - $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value ; |
|
| 440 | + $data[$key] = is_object($value) ? get_object_vars($value) : $value; |
|
| 441 | 441 | continue; |
| 442 | 442 | } |
| 443 | 443 | |
@@ -454,8 +454,8 @@ discard block |
||
| 454 | 454 | * @param string $field_key The key to check for. |
| 455 | 455 | * @return bool |
| 456 | 456 | */ |
| 457 | - public function object_supports_field( $object, $field_key ) { |
|
| 458 | - return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
| 457 | + public function object_supports_field($object, $field_key) { |
|
| 458 | + return apply_filters('getpaid_rest_object_supports_key', true, $object, $field_key); |
|
| 459 | 459 | } |
| 460 | 460 | |
| 461 | 461 | /** |
@@ -466,27 +466,27 @@ discard block |
||
| 466 | 466 | * @param WP_REST_Request $request Request object. |
| 467 | 467 | * @return WP_REST_Response |
| 468 | 468 | */ |
| 469 | - public function prepare_item_for_response( $object, $request ) { |
|
| 470 | - remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
| 469 | + public function prepare_item_for_response($object, $request) { |
|
| 470 | + remove_filter('rest_post_dispatch', 'rest_filter_response_fields', 10); |
|
| 471 | 471 | |
| 472 | 472 | $this->data_object = $object; |
| 473 | 473 | |
| 474 | 474 | // Fetch the fields to include in this response. |
| 475 | - $fields = $this->get_fields_for_response( $request ); |
|
| 475 | + $fields = $this->get_fields_for_response($request); |
|
| 476 | 476 | |
| 477 | 477 | // Prepare object data. |
| 478 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 479 | - $data = $this->prepare_object_data( $object, $fields, $context ); |
|
| 480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 481 | - $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
| 482 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 478 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
| 479 | + $data = $this->prepare_object_data($object, $fields, $context); |
|
| 480 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 481 | + $data = $this->limit_object_to_requested_fields($data, $fields); |
|
| 482 | + $data = $this->filter_response_by_context($data, $context); |
|
| 483 | 483 | |
| 484 | 484 | // Prepare the response. |
| 485 | - $response = rest_ensure_response( $data ); |
|
| 486 | - $response->add_links( $this->prepare_links( $object, $request ) ); |
|
| 485 | + $response = rest_ensure_response($data); |
|
| 486 | + $response->add_links($this->prepare_links($object, $request)); |
|
| 487 | 487 | |
| 488 | 488 | // Filter item response. |
| 489 | - return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
| 489 | + return apply_filters("getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request); |
|
| 490 | 490 | } |
| 491 | 491 | |
| 492 | 492 | } |
@@ -16,495 +16,495 @@ |
||
| 16 | 16 | */ |
| 17 | 17 | class GetPaid_Subscriptions_Query { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Query vars, after parsing |
|
| 21 | - * |
|
| 22 | - * @since 1.0.19 |
|
| 23 | - * @var array |
|
| 24 | - */ |
|
| 25 | - public $query_vars = array(); |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * List of found subscriptions. |
|
| 29 | - * |
|
| 30 | - * @since 1.0.19 |
|
| 31 | - * @var array |
|
| 32 | - */ |
|
| 33 | - private $results; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Total number of found subscriptions for the current query |
|
| 37 | - * |
|
| 38 | - * @since 1.0.19 |
|
| 39 | - * @var int |
|
| 40 | - */ |
|
| 41 | - private $total_subscriptions = 0; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * The SQL query used to fetch matching subscriptions. |
|
| 45 | - * |
|
| 46 | - * @since 1.0.19 |
|
| 47 | - * @var string |
|
| 48 | - */ |
|
| 49 | - public $request; |
|
| 50 | - |
|
| 51 | - // SQL clauses |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Contains the 'FIELDS' sql clause |
|
| 55 | - * |
|
| 56 | - * @since 1.0.19 |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 59 | - public $query_fields; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Contains the 'FROM' sql clause |
|
| 63 | - * |
|
| 64 | - * @since 1.0.19 |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - public $query_from; |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * Contains the 'WHERE' sql clause |
|
| 71 | - * |
|
| 72 | - * @since 1.0.19 |
|
| 73 | - * @var string |
|
| 74 | - */ |
|
| 75 | - public $query_where; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Contains the 'ORDER BY' sql clause |
|
| 79 | - * |
|
| 80 | - * @since 1.0.19 |
|
| 81 | - * @var string |
|
| 82 | - */ |
|
| 83 | - public $query_orderby; |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Contains the 'LIMIT' sql clause |
|
| 87 | - * |
|
| 88 | - * @since 1.0.19 |
|
| 89 | - * @var string |
|
| 90 | - */ |
|
| 91 | - public $query_limit; |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * Class constructor. |
|
| 95 | - * |
|
| 96 | - * @since 1.0.19 |
|
| 97 | - * |
|
| 98 | - * @param null|string|array $query Optional. The query variables. |
|
| 99 | - */ |
|
| 100 | - public function __construct( $query = null ) { |
|
| 101 | - if ( ! is_null( $query ) ) { |
|
| 102 | - $this->prepare_query( $query ); |
|
| 103 | - $this->query(); |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Fills in missing query variables with default values. |
|
| 109 | - * |
|
| 110 | - * @since 1.0.19 |
|
| 111 | - * |
|
| 112 | - * @param string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`. |
|
| 113 | - * @return array Complete query variables with undefined ones filled in with defaults. |
|
| 114 | - */ |
|
| 115 | - public static function fill_query_vars( $args ) { |
|
| 116 | - $defaults = array( |
|
| 117 | - 'status' => 'all', |
|
| 118 | - 'customer_in' => array(), |
|
| 119 | - 'customer_not_in' => array(), |
|
| 120 | - 'product_in' => array(), |
|
| 121 | - 'product_not_in' => array(), |
|
| 122 | - 'include' => array(), |
|
| 123 | - 'exclude' => array(), |
|
| 124 | - 'orderby' => 'id', |
|
| 125 | - 'order' => 'DESC', |
|
| 126 | - 'offset' => '', |
|
| 127 | - 'number' => 10, |
|
| 128 | - 'paged' => 1, |
|
| 129 | - 'count_total' => true, |
|
| 130 | - 'fields' => 'all', |
|
| 131 | - ); |
|
| 132 | - |
|
| 133 | - return wp_parse_args( $args, $defaults ); |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Prepare the query variables. |
|
| 138 | - * |
|
| 139 | - * @since 1.0.19 |
|
| 140 | - * |
|
| 141 | - * @global wpdb $wpdb WordPress database abstraction object. |
|
| 142 | - * |
|
| 143 | - * @param string|array $query { |
|
| 144 | - * Optional. Array or string of Query parameters. |
|
| 145 | - * |
|
| 146 | - * @type string|array $status The subscription status to filter by. Can either be a single status or an array of statuses. |
|
| 147 | - * Default is all. |
|
| 148 | - * @type int[] $customer_in An array of customer ids to filter by. |
|
| 149 | - * @type int[] $customer_not_in An array of customer ids whose subscriptions should be excluded. |
|
| 150 | - * @type int[] $invoice_in An array of invoice ids to filter by. |
|
| 151 | - * @type int[] $invoice_not_in An array of invoice ids whose subscriptions should be excluded. |
|
| 152 | - * @type int[] $product_in An array of product ids to filter by. |
|
| 153 | - * @type int[] $product_not_in An array of product ids whose subscriptions should be excluded. |
|
| 154 | - * @type array $date_created_query A WP_Date_Query compatible array use to filter subscriptions by their date of creation. |
|
| 155 | - * @type array $date_expires_query A WP_Date_Query compatible array use to filter subscriptions by their expiration date. |
|
| 156 | - * @type array $include An array of subscription IDs to include. Default empty array. |
|
| 157 | - * @type array $exclude An array of subscription IDs to exclude. Default empty array. |
|
| 158 | - * @type string|array $orderby Field(s) to sort the retrieved subscription by. May be a single value, |
|
| 159 | - * an array of values, or a multi-dimensional array with fields as |
|
| 160 | - * keys and orders ('ASC' or 'DESC') as values. Accepted values are |
|
| 161 | - * 'id', 'customer_id', 'frequency', 'period', 'initial_amount, |
|
| 162 | - * 'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration' |
|
| 163 | - * 'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ). |
|
| 164 | - * @type string $order Designates ascending or descending order of subscriptions. Order values |
|
| 165 | - * passed as part of an `$orderby` array take precedence over this |
|
| 166 | - * parameter. Accepts 'ASC', 'DESC'. Default 'DESC'. |
|
| 167 | - * @type int $offset Number of subscriptions to offset in retrieved results. Can be used in |
|
| 168 | - * conjunction with pagination. Default 0. |
|
| 169 | - * @type int $number Number of subscriptions to limit the query for. Can be used in |
|
| 170 | - * conjunction with pagination. Value -1 (all) is supported, but |
|
| 171 | - * should be used with caution on larger sites. |
|
| 172 | - * Default 10. |
|
| 173 | - * @type int $paged When used with number, defines the page of results to return. |
|
| 174 | - * Default 1. |
|
| 175 | - * @type bool $count_total Whether to count the total number of subscriptions found. If pagination |
|
| 176 | - * is not needed, setting this to false can improve performance. |
|
| 177 | - * Default true. |
|
| 178 | - * @type string|array $fields Which fields to return. Single or all fields (string), or array |
|
| 179 | - * of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount, |
|
| 180 | - * 'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration' |
|
| 181 | - * 'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'. |
|
| 182 | - * Use 'all' for all fields. Default 'all'. |
|
| 183 | - * } |
|
| 184 | - */ |
|
| 185 | - public function prepare_query( $query = array() ) { |
|
| 186 | - global $wpdb; |
|
| 187 | - |
|
| 188 | - if ( empty( $this->query_vars ) || ! empty( $query ) ) { |
|
| 189 | - $this->query_limit = null; |
|
| 190 | - $this->query_vars = $this->fill_query_vars( $query ); |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) { |
|
| 194 | - $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] ); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - do_action( 'getpaid_pre_get_subscriptions', array( &$this ) ); |
|
| 198 | - |
|
| 199 | - // Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'. |
|
| 200 | - $qv =& $this->query_vars; |
|
| 201 | - $qv = $this->fill_query_vars( $qv ); |
|
| 202 | - $table = $wpdb->prefix . 'wpinv_subscriptions'; |
|
| 203 | - $this->query_from = "FROM $table"; |
|
| 204 | - |
|
| 205 | - // Prepare query fields. |
|
| 206 | - $this->prepare_query_fields( $qv, $table ); |
|
| 207 | - |
|
| 208 | - // Prepare query where. |
|
| 209 | - $this->prepare_query_where( $qv, $table ); |
|
| 210 | - |
|
| 211 | - // Prepare query order. |
|
| 212 | - $this->prepare_query_order( $qv, $table ); |
|
| 213 | - |
|
| 214 | - // limit |
|
| 215 | - if ( isset( $qv['number'] ) && $qv['number'] > 0 ) { |
|
| 216 | - if ( $qv['offset'] ) { |
|
| 217 | - $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] ); |
|
| 218 | - } else { |
|
| 219 | - $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] ); |
|
| 220 | - } |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) ); |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - /** |
|
| 227 | - * Prepares the query fields. |
|
| 228 | - * |
|
| 229 | - * @since 1.0.19 |
|
| 230 | - * |
|
| 231 | - * @param array $qv Query vars. |
|
| 232 | - * @param string $table Table name. |
|
| 233 | - */ |
|
| 234 | - protected function prepare_query_fields( &$qv, $table ) { |
|
| 235 | - |
|
| 236 | - if ( is_array( $qv['fields'] ) ) { |
|
| 237 | - $qv['fields'] = array_unique( $qv['fields'] ); |
|
| 238 | - |
|
| 239 | - $query_fields = array(); |
|
| 240 | - foreach ( $qv['fields'] as $field ) { |
|
| 241 | - $field = sanitize_key( $field ); |
|
| 242 | - $query_fields[] = "$table.`$field`"; |
|
| 243 | - } |
|
| 244 | - $this->query_fields = implode( ',', $query_fields ); |
|
| 245 | - } else { |
|
| 246 | - $this->query_fields = "$table.*"; |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 250 | - $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - /** |
|
| 256 | - * Prepares the query where. |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * |
|
| 260 | - * @param array $qv Query vars. |
|
| 261 | - * @param string $table Table name. |
|
| 262 | - */ |
|
| 263 | - protected function prepare_query_where( &$qv, $table ) { |
|
| 264 | - global $wpdb; |
|
| 265 | - $this->query_where = 'WHERE 1=1'; |
|
| 266 | - |
|
| 267 | - // Status. |
|
| 268 | - if ( 'all' !== $qv['status'] ) { |
|
| 269 | - $statuses = wpinv_clean( wpinv_parse_list( $qv['status'] ) ); |
|
| 270 | - $prepared_statuses = join( ',', array_fill( 0, count( $statuses ), '%s' ) ); |
|
| 271 | - $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses ); |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - if ( ! empty( $qv['customer_in'] ) ) { |
|
| 275 | - $customer_in = implode( ',', wp_parse_id_list( $qv['customer_in'] ) ); |
|
| 276 | - $this->query_where .= " AND $table.`customer_id` IN ($customer_in)"; |
|
| 277 | - } elseif ( ! empty( $qv['customer_not_in'] ) ) { |
|
| 278 | - $customer_not_in = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) ); |
|
| 279 | - $this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)"; |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - if ( ! empty( $qv['product_in'] ) ) { |
|
| 283 | - $product_in = implode( ',', wp_parse_id_list( $qv['product_in'] ) ); |
|
| 284 | - $this->query_where .= " AND $table.`product_id` IN ($product_in)"; |
|
| 285 | - } elseif ( ! empty( $qv['product_not_in'] ) ) { |
|
| 286 | - $product_not_in = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) ); |
|
| 287 | - $this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)"; |
|
| 288 | - } |
|
| 289 | - |
|
| 290 | - if ( ! empty( $qv['invoice_in'] ) ) { |
|
| 291 | - $invoice_in = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) ); |
|
| 292 | - $this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)"; |
|
| 293 | - } elseif ( ! empty( $qv['invoice_not_in'] ) ) { |
|
| 294 | - $invoice_not_in = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) ); |
|
| 295 | - $this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)"; |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - if ( ! empty( $qv['include'] ) ) { |
|
| 299 | - $include = implode( ',', wp_parse_id_list( $qv['include'] ) ); |
|
| 300 | - $this->query_where .= " AND $table.`id` IN ($include)"; |
|
| 301 | - } elseif ( ! empty( $qv['exclude'] ) ) { |
|
| 302 | - $exclude = implode( ',', wp_parse_id_list( $qv['exclude'] ) ); |
|
| 303 | - $this->query_where .= " AND $table.`id` NOT IN ($exclude)"; |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - // Date queries are allowed for the subscription creation date. |
|
| 307 | - if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) { |
|
| 308 | - $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" ); |
|
| 309 | - $this->query_where .= $date_created_query->get_sql(); |
|
| 310 | - } |
|
| 311 | - |
|
| 312 | - // Date queries are also allowed for the subscription expiration date. |
|
| 313 | - if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) { |
|
| 314 | - $date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" ); |
|
| 315 | - $this->query_where .= $date_expires_query->get_sql(); |
|
| 316 | - } |
|
| 317 | - |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * Prepares the query order. |
|
| 322 | - * |
|
| 323 | - * @since 1.0.19 |
|
| 324 | - * |
|
| 325 | - * @param array $qv Query vars. |
|
| 326 | - * @param string $table Table name. |
|
| 327 | - */ |
|
| 328 | - protected function prepare_query_order( &$qv, $table ) { |
|
| 329 | - |
|
| 330 | - // sorting. |
|
| 331 | - $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : ''; |
|
| 332 | - $order = $this->parse_order( $qv['order'] ); |
|
| 333 | - |
|
| 334 | - // Default order is by 'id' (latest subscriptions). |
|
| 335 | - if ( empty( $qv['orderby'] ) ) { |
|
| 336 | - $qv['orderby'] = array( 'id' ); |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - // 'orderby' values may be an array, comma- or space-separated list. |
|
| 340 | - $ordersby = array_filter( wpinv_parse_list( $qv['orderby'] ) ); |
|
| 341 | - |
|
| 342 | - $orderby_array = array(); |
|
| 343 | - foreach ( $ordersby as $_key => $_value ) { |
|
| 344 | - |
|
| 345 | - if ( is_int( $_key ) ) { |
|
| 346 | - // Integer key means this is a flat array of 'orderby' fields. |
|
| 347 | - $_orderby = $_value; |
|
| 348 | - $_order = $order; |
|
| 349 | - } else { |
|
| 350 | - // Non-integer key means that the key is the field and the value is ASC/DESC. |
|
| 351 | - $_orderby = $_key; |
|
| 352 | - $_order = $_value; |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - $parsed = $this->parse_orderby( $_orderby, $table ); |
|
| 356 | - |
|
| 357 | - if ( $parsed ) { |
|
| 358 | - $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order ); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - // If no valid clauses were found, order by id. |
|
| 364 | - if ( empty( $orderby_array ) ) { |
|
| 365 | - $orderby_array[] = "id $order"; |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array ); |
|
| 369 | - |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - /** |
|
| 373 | - * Execute the query, with the current variables. |
|
| 374 | - * |
|
| 375 | - * @since 1.0.19 |
|
| 376 | - * |
|
| 377 | - * @global wpdb $wpdb WordPress database abstraction object. |
|
| 378 | - */ |
|
| 379 | - public function query() { |
|
| 380 | - global $wpdb; |
|
| 381 | - |
|
| 382 | - $qv =& $this->query_vars; |
|
| 383 | - |
|
| 384 | - // Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the |
|
| 385 | - // total_subscriptions property. |
|
| 386 | - $this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) ); |
|
| 387 | - |
|
| 388 | - if ( null === $this->results ) { |
|
| 389 | - $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"; |
|
| 390 | - |
|
| 391 | - if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) { |
|
| 392 | - $this->results = $wpdb->get_results( $this->request ); |
|
| 393 | - } else { |
|
| 394 | - $this->results = $wpdb->get_col( $this->request ); |
|
| 395 | - } |
|
| 396 | - |
|
| 397 | - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 398 | - $found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this ); |
|
| 399 | - $this->total_subscriptions = (int) $wpdb->get_var( $found_subscriptions_query ); |
|
| 400 | - } |
|
| 401 | - } |
|
| 402 | - |
|
| 403 | - if ( 'all' == $qv['fields'] ) { |
|
| 404 | - foreach ( $this->results as $key => $subscription ) { |
|
| 405 | - wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' ); |
|
| 406 | - wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 407 | - wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 408 | - wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 409 | - $this->results[ $key ] = new WPInv_Subscription( $subscription ); |
|
| 410 | - } |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - /** |
|
| 416 | - * Retrieve query variable. |
|
| 417 | - * |
|
| 418 | - * @since 1.0.19 |
|
| 419 | - * |
|
| 420 | - * @param string $query_var Query variable key. |
|
| 421 | - * @return mixed |
|
| 422 | - */ |
|
| 423 | - public function get( $query_var ) { |
|
| 424 | - if ( isset( $this->query_vars[ $query_var ] ) ) { |
|
| 425 | - return $this->query_vars[ $query_var ]; |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - return null; |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - /** |
|
| 432 | - * Set query variable. |
|
| 433 | - * |
|
| 434 | - * @since 1.0.19 |
|
| 435 | - * |
|
| 436 | - * @param string $query_var Query variable key. |
|
| 437 | - * @param mixed $value Query variable value. |
|
| 438 | - */ |
|
| 439 | - public function set( $query_var, $value ) { |
|
| 440 | - $this->query_vars[ $query_var ] = $value; |
|
| 441 | - } |
|
| 442 | - |
|
| 443 | - /** |
|
| 444 | - * Return the list of subscriptions. |
|
| 445 | - * |
|
| 446 | - * @since 1.0.19 |
|
| 447 | - * |
|
| 448 | - * @return WPInv_Subscription[]|array Found subscriptions. |
|
| 449 | - */ |
|
| 450 | - public function get_results() { |
|
| 451 | - return $this->results; |
|
| 452 | - } |
|
| 453 | - |
|
| 454 | - /** |
|
| 455 | - * Return the total number of subscriptions for the current query. |
|
| 456 | - * |
|
| 457 | - * @since 1.0.19 |
|
| 458 | - * |
|
| 459 | - * @return int Number of total subscriptions. |
|
| 460 | - */ |
|
| 461 | - public function get_total() { |
|
| 462 | - return $this->total_subscriptions; |
|
| 463 | - } |
|
| 464 | - |
|
| 465 | - /** |
|
| 466 | - * Parse and sanitize 'orderby' keys passed to the subscriptions query. |
|
| 467 | - * |
|
| 468 | - * @since 1.0.19 |
|
| 469 | - * |
|
| 470 | - * @param string $orderby Alias for the field to order by. |
|
| 471 | - * @param string $table The current table. |
|
| 472 | - * @return string Value to use in the ORDER clause, if `$orderby` is valid. |
|
| 473 | - */ |
|
| 474 | - protected function parse_orderby( $orderby, $table ) { |
|
| 475 | - |
|
| 476 | - $_orderby = ''; |
|
| 477 | - if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) { |
|
| 478 | - $_orderby = "$table.`$orderby`"; |
|
| 479 | - } elseif ( 'id' === strtolower( $orderby ) ) { |
|
| 480 | - $_orderby = "$table.id"; |
|
| 481 | - } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) { |
|
| 482 | - $include = wp_parse_id_list( $this->query_vars['include'] ); |
|
| 483 | - $include_sql = implode( ',', $include ); |
|
| 484 | - $_orderby = "FIELD( $table.id, $include_sql )"; |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - return $_orderby; |
|
| 488 | - } |
|
| 489 | - |
|
| 490 | - /** |
|
| 491 | - * Parse an 'order' query variable and cast it to ASC or DESC as necessary. |
|
| 492 | - * |
|
| 493 | - * @since 1.0.19 |
|
| 494 | - * |
|
| 495 | - * @param string $order The 'order' query variable. |
|
| 496 | - * @return string The sanitized 'order' query variable. |
|
| 497 | - */ |
|
| 498 | - protected function parse_order( $order ) { |
|
| 499 | - if ( ! is_string( $order ) || empty( $order ) ) { |
|
| 500 | - return 'DESC'; |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - if ( 'ASC' === strtoupper( $order ) ) { |
|
| 504 | - return 'ASC'; |
|
| 505 | - } else { |
|
| 506 | - return 'DESC'; |
|
| 507 | - } |
|
| 508 | - } |
|
| 19 | + /** |
|
| 20 | + * Query vars, after parsing |
|
| 21 | + * |
|
| 22 | + * @since 1.0.19 |
|
| 23 | + * @var array |
|
| 24 | + */ |
|
| 25 | + public $query_vars = array(); |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * List of found subscriptions. |
|
| 29 | + * |
|
| 30 | + * @since 1.0.19 |
|
| 31 | + * @var array |
|
| 32 | + */ |
|
| 33 | + private $results; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Total number of found subscriptions for the current query |
|
| 37 | + * |
|
| 38 | + * @since 1.0.19 |
|
| 39 | + * @var int |
|
| 40 | + */ |
|
| 41 | + private $total_subscriptions = 0; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * The SQL query used to fetch matching subscriptions. |
|
| 45 | + * |
|
| 46 | + * @since 1.0.19 |
|
| 47 | + * @var string |
|
| 48 | + */ |
|
| 49 | + public $request; |
|
| 50 | + |
|
| 51 | + // SQL clauses |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * Contains the 'FIELDS' sql clause |
|
| 55 | + * |
|
| 56 | + * @since 1.0.19 |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | + public $query_fields; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Contains the 'FROM' sql clause |
|
| 63 | + * |
|
| 64 | + * @since 1.0.19 |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + public $query_from; |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * Contains the 'WHERE' sql clause |
|
| 71 | + * |
|
| 72 | + * @since 1.0.19 |
|
| 73 | + * @var string |
|
| 74 | + */ |
|
| 75 | + public $query_where; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Contains the 'ORDER BY' sql clause |
|
| 79 | + * |
|
| 80 | + * @since 1.0.19 |
|
| 81 | + * @var string |
|
| 82 | + */ |
|
| 83 | + public $query_orderby; |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Contains the 'LIMIT' sql clause |
|
| 87 | + * |
|
| 88 | + * @since 1.0.19 |
|
| 89 | + * @var string |
|
| 90 | + */ |
|
| 91 | + public $query_limit; |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * Class constructor. |
|
| 95 | + * |
|
| 96 | + * @since 1.0.19 |
|
| 97 | + * |
|
| 98 | + * @param null|string|array $query Optional. The query variables. |
|
| 99 | + */ |
|
| 100 | + public function __construct( $query = null ) { |
|
| 101 | + if ( ! is_null( $query ) ) { |
|
| 102 | + $this->prepare_query( $query ); |
|
| 103 | + $this->query(); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Fills in missing query variables with default values. |
|
| 109 | + * |
|
| 110 | + * @since 1.0.19 |
|
| 111 | + * |
|
| 112 | + * @param string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`. |
|
| 113 | + * @return array Complete query variables with undefined ones filled in with defaults. |
|
| 114 | + */ |
|
| 115 | + public static function fill_query_vars( $args ) { |
|
| 116 | + $defaults = array( |
|
| 117 | + 'status' => 'all', |
|
| 118 | + 'customer_in' => array(), |
|
| 119 | + 'customer_not_in' => array(), |
|
| 120 | + 'product_in' => array(), |
|
| 121 | + 'product_not_in' => array(), |
|
| 122 | + 'include' => array(), |
|
| 123 | + 'exclude' => array(), |
|
| 124 | + 'orderby' => 'id', |
|
| 125 | + 'order' => 'DESC', |
|
| 126 | + 'offset' => '', |
|
| 127 | + 'number' => 10, |
|
| 128 | + 'paged' => 1, |
|
| 129 | + 'count_total' => true, |
|
| 130 | + 'fields' => 'all', |
|
| 131 | + ); |
|
| 132 | + |
|
| 133 | + return wp_parse_args( $args, $defaults ); |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Prepare the query variables. |
|
| 138 | + * |
|
| 139 | + * @since 1.0.19 |
|
| 140 | + * |
|
| 141 | + * @global wpdb $wpdb WordPress database abstraction object. |
|
| 142 | + * |
|
| 143 | + * @param string|array $query { |
|
| 144 | + * Optional. Array or string of Query parameters. |
|
| 145 | + * |
|
| 146 | + * @type string|array $status The subscription status to filter by. Can either be a single status or an array of statuses. |
|
| 147 | + * Default is all. |
|
| 148 | + * @type int[] $customer_in An array of customer ids to filter by. |
|
| 149 | + * @type int[] $customer_not_in An array of customer ids whose subscriptions should be excluded. |
|
| 150 | + * @type int[] $invoice_in An array of invoice ids to filter by. |
|
| 151 | + * @type int[] $invoice_not_in An array of invoice ids whose subscriptions should be excluded. |
|
| 152 | + * @type int[] $product_in An array of product ids to filter by. |
|
| 153 | + * @type int[] $product_not_in An array of product ids whose subscriptions should be excluded. |
|
| 154 | + * @type array $date_created_query A WP_Date_Query compatible array use to filter subscriptions by their date of creation. |
|
| 155 | + * @type array $date_expires_query A WP_Date_Query compatible array use to filter subscriptions by their expiration date. |
|
| 156 | + * @type array $include An array of subscription IDs to include. Default empty array. |
|
| 157 | + * @type array $exclude An array of subscription IDs to exclude. Default empty array. |
|
| 158 | + * @type string|array $orderby Field(s) to sort the retrieved subscription by. May be a single value, |
|
| 159 | + * an array of values, or a multi-dimensional array with fields as |
|
| 160 | + * keys and orders ('ASC' or 'DESC') as values. Accepted values are |
|
| 161 | + * 'id', 'customer_id', 'frequency', 'period', 'initial_amount, |
|
| 162 | + * 'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration' |
|
| 163 | + * 'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ). |
|
| 164 | + * @type string $order Designates ascending or descending order of subscriptions. Order values |
|
| 165 | + * passed as part of an `$orderby` array take precedence over this |
|
| 166 | + * parameter. Accepts 'ASC', 'DESC'. Default 'DESC'. |
|
| 167 | + * @type int $offset Number of subscriptions to offset in retrieved results. Can be used in |
|
| 168 | + * conjunction with pagination. Default 0. |
|
| 169 | + * @type int $number Number of subscriptions to limit the query for. Can be used in |
|
| 170 | + * conjunction with pagination. Value -1 (all) is supported, but |
|
| 171 | + * should be used with caution on larger sites. |
|
| 172 | + * Default 10. |
|
| 173 | + * @type int $paged When used with number, defines the page of results to return. |
|
| 174 | + * Default 1. |
|
| 175 | + * @type bool $count_total Whether to count the total number of subscriptions found. If pagination |
|
| 176 | + * is not needed, setting this to false can improve performance. |
|
| 177 | + * Default true. |
|
| 178 | + * @type string|array $fields Which fields to return. Single or all fields (string), or array |
|
| 179 | + * of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount, |
|
| 180 | + * 'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration' |
|
| 181 | + * 'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'. |
|
| 182 | + * Use 'all' for all fields. Default 'all'. |
|
| 183 | + * } |
|
| 184 | + */ |
|
| 185 | + public function prepare_query( $query = array() ) { |
|
| 186 | + global $wpdb; |
|
| 187 | + |
|
| 188 | + if ( empty( $this->query_vars ) || ! empty( $query ) ) { |
|
| 189 | + $this->query_limit = null; |
|
| 190 | + $this->query_vars = $this->fill_query_vars( $query ); |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) { |
|
| 194 | + $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] ); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + do_action( 'getpaid_pre_get_subscriptions', array( &$this ) ); |
|
| 198 | + |
|
| 199 | + // Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'. |
|
| 200 | + $qv =& $this->query_vars; |
|
| 201 | + $qv = $this->fill_query_vars( $qv ); |
|
| 202 | + $table = $wpdb->prefix . 'wpinv_subscriptions'; |
|
| 203 | + $this->query_from = "FROM $table"; |
|
| 204 | + |
|
| 205 | + // Prepare query fields. |
|
| 206 | + $this->prepare_query_fields( $qv, $table ); |
|
| 207 | + |
|
| 208 | + // Prepare query where. |
|
| 209 | + $this->prepare_query_where( $qv, $table ); |
|
| 210 | + |
|
| 211 | + // Prepare query order. |
|
| 212 | + $this->prepare_query_order( $qv, $table ); |
|
| 213 | + |
|
| 214 | + // limit |
|
| 215 | + if ( isset( $qv['number'] ) && $qv['number'] > 0 ) { |
|
| 216 | + if ( $qv['offset'] ) { |
|
| 217 | + $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] ); |
|
| 218 | + } else { |
|
| 219 | + $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] ); |
|
| 220 | + } |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) ); |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + /** |
|
| 227 | + * Prepares the query fields. |
|
| 228 | + * |
|
| 229 | + * @since 1.0.19 |
|
| 230 | + * |
|
| 231 | + * @param array $qv Query vars. |
|
| 232 | + * @param string $table Table name. |
|
| 233 | + */ |
|
| 234 | + protected function prepare_query_fields( &$qv, $table ) { |
|
| 235 | + |
|
| 236 | + if ( is_array( $qv['fields'] ) ) { |
|
| 237 | + $qv['fields'] = array_unique( $qv['fields'] ); |
|
| 238 | + |
|
| 239 | + $query_fields = array(); |
|
| 240 | + foreach ( $qv['fields'] as $field ) { |
|
| 241 | + $field = sanitize_key( $field ); |
|
| 242 | + $query_fields[] = "$table.`$field`"; |
|
| 243 | + } |
|
| 244 | + $this->query_fields = implode( ',', $query_fields ); |
|
| 245 | + } else { |
|
| 246 | + $this->query_fields = "$table.*"; |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 250 | + $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + /** |
|
| 256 | + * Prepares the query where. |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * |
|
| 260 | + * @param array $qv Query vars. |
|
| 261 | + * @param string $table Table name. |
|
| 262 | + */ |
|
| 263 | + protected function prepare_query_where( &$qv, $table ) { |
|
| 264 | + global $wpdb; |
|
| 265 | + $this->query_where = 'WHERE 1=1'; |
|
| 266 | + |
|
| 267 | + // Status. |
|
| 268 | + if ( 'all' !== $qv['status'] ) { |
|
| 269 | + $statuses = wpinv_clean( wpinv_parse_list( $qv['status'] ) ); |
|
| 270 | + $prepared_statuses = join( ',', array_fill( 0, count( $statuses ), '%s' ) ); |
|
| 271 | + $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses ); |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + if ( ! empty( $qv['customer_in'] ) ) { |
|
| 275 | + $customer_in = implode( ',', wp_parse_id_list( $qv['customer_in'] ) ); |
|
| 276 | + $this->query_where .= " AND $table.`customer_id` IN ($customer_in)"; |
|
| 277 | + } elseif ( ! empty( $qv['customer_not_in'] ) ) { |
|
| 278 | + $customer_not_in = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) ); |
|
| 279 | + $this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)"; |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + if ( ! empty( $qv['product_in'] ) ) { |
|
| 283 | + $product_in = implode( ',', wp_parse_id_list( $qv['product_in'] ) ); |
|
| 284 | + $this->query_where .= " AND $table.`product_id` IN ($product_in)"; |
|
| 285 | + } elseif ( ! empty( $qv['product_not_in'] ) ) { |
|
| 286 | + $product_not_in = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) ); |
|
| 287 | + $this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)"; |
|
| 288 | + } |
|
| 289 | + |
|
| 290 | + if ( ! empty( $qv['invoice_in'] ) ) { |
|
| 291 | + $invoice_in = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) ); |
|
| 292 | + $this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)"; |
|
| 293 | + } elseif ( ! empty( $qv['invoice_not_in'] ) ) { |
|
| 294 | + $invoice_not_in = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) ); |
|
| 295 | + $this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)"; |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + if ( ! empty( $qv['include'] ) ) { |
|
| 299 | + $include = implode( ',', wp_parse_id_list( $qv['include'] ) ); |
|
| 300 | + $this->query_where .= " AND $table.`id` IN ($include)"; |
|
| 301 | + } elseif ( ! empty( $qv['exclude'] ) ) { |
|
| 302 | + $exclude = implode( ',', wp_parse_id_list( $qv['exclude'] ) ); |
|
| 303 | + $this->query_where .= " AND $table.`id` NOT IN ($exclude)"; |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + // Date queries are allowed for the subscription creation date. |
|
| 307 | + if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) { |
|
| 308 | + $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" ); |
|
| 309 | + $this->query_where .= $date_created_query->get_sql(); |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + // Date queries are also allowed for the subscription expiration date. |
|
| 313 | + if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) { |
|
| 314 | + $date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" ); |
|
| 315 | + $this->query_where .= $date_expires_query->get_sql(); |
|
| 316 | + } |
|
| 317 | + |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * Prepares the query order. |
|
| 322 | + * |
|
| 323 | + * @since 1.0.19 |
|
| 324 | + * |
|
| 325 | + * @param array $qv Query vars. |
|
| 326 | + * @param string $table Table name. |
|
| 327 | + */ |
|
| 328 | + protected function prepare_query_order( &$qv, $table ) { |
|
| 329 | + |
|
| 330 | + // sorting. |
|
| 331 | + $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : ''; |
|
| 332 | + $order = $this->parse_order( $qv['order'] ); |
|
| 333 | + |
|
| 334 | + // Default order is by 'id' (latest subscriptions). |
|
| 335 | + if ( empty( $qv['orderby'] ) ) { |
|
| 336 | + $qv['orderby'] = array( 'id' ); |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + // 'orderby' values may be an array, comma- or space-separated list. |
|
| 340 | + $ordersby = array_filter( wpinv_parse_list( $qv['orderby'] ) ); |
|
| 341 | + |
|
| 342 | + $orderby_array = array(); |
|
| 343 | + foreach ( $ordersby as $_key => $_value ) { |
|
| 344 | + |
|
| 345 | + if ( is_int( $_key ) ) { |
|
| 346 | + // Integer key means this is a flat array of 'orderby' fields. |
|
| 347 | + $_orderby = $_value; |
|
| 348 | + $_order = $order; |
|
| 349 | + } else { |
|
| 350 | + // Non-integer key means that the key is the field and the value is ASC/DESC. |
|
| 351 | + $_orderby = $_key; |
|
| 352 | + $_order = $_value; |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + $parsed = $this->parse_orderby( $_orderby, $table ); |
|
| 356 | + |
|
| 357 | + if ( $parsed ) { |
|
| 358 | + $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order ); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + // If no valid clauses were found, order by id. |
|
| 364 | + if ( empty( $orderby_array ) ) { |
|
| 365 | + $orderby_array[] = "id $order"; |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array ); |
|
| 369 | + |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + /** |
|
| 373 | + * Execute the query, with the current variables. |
|
| 374 | + * |
|
| 375 | + * @since 1.0.19 |
|
| 376 | + * |
|
| 377 | + * @global wpdb $wpdb WordPress database abstraction object. |
|
| 378 | + */ |
|
| 379 | + public function query() { |
|
| 380 | + global $wpdb; |
|
| 381 | + |
|
| 382 | + $qv =& $this->query_vars; |
|
| 383 | + |
|
| 384 | + // Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the |
|
| 385 | + // total_subscriptions property. |
|
| 386 | + $this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) ); |
|
| 387 | + |
|
| 388 | + if ( null === $this->results ) { |
|
| 389 | + $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"; |
|
| 390 | + |
|
| 391 | + if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) { |
|
| 392 | + $this->results = $wpdb->get_results( $this->request ); |
|
| 393 | + } else { |
|
| 394 | + $this->results = $wpdb->get_col( $this->request ); |
|
| 395 | + } |
|
| 396 | + |
|
| 397 | + if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 398 | + $found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this ); |
|
| 399 | + $this->total_subscriptions = (int) $wpdb->get_var( $found_subscriptions_query ); |
|
| 400 | + } |
|
| 401 | + } |
|
| 402 | + |
|
| 403 | + if ( 'all' == $qv['fields'] ) { |
|
| 404 | + foreach ( $this->results as $key => $subscription ) { |
|
| 405 | + wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' ); |
|
| 406 | + wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 407 | + wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 408 | + wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 409 | + $this->results[ $key ] = new WPInv_Subscription( $subscription ); |
|
| 410 | + } |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + /** |
|
| 416 | + * Retrieve query variable. |
|
| 417 | + * |
|
| 418 | + * @since 1.0.19 |
|
| 419 | + * |
|
| 420 | + * @param string $query_var Query variable key. |
|
| 421 | + * @return mixed |
|
| 422 | + */ |
|
| 423 | + public function get( $query_var ) { |
|
| 424 | + if ( isset( $this->query_vars[ $query_var ] ) ) { |
|
| 425 | + return $this->query_vars[ $query_var ]; |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + return null; |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + /** |
|
| 432 | + * Set query variable. |
|
| 433 | + * |
|
| 434 | + * @since 1.0.19 |
|
| 435 | + * |
|
| 436 | + * @param string $query_var Query variable key. |
|
| 437 | + * @param mixed $value Query variable value. |
|
| 438 | + */ |
|
| 439 | + public function set( $query_var, $value ) { |
|
| 440 | + $this->query_vars[ $query_var ] = $value; |
|
| 441 | + } |
|
| 442 | + |
|
| 443 | + /** |
|
| 444 | + * Return the list of subscriptions. |
|
| 445 | + * |
|
| 446 | + * @since 1.0.19 |
|
| 447 | + * |
|
| 448 | + * @return WPInv_Subscription[]|array Found subscriptions. |
|
| 449 | + */ |
|
| 450 | + public function get_results() { |
|
| 451 | + return $this->results; |
|
| 452 | + } |
|
| 453 | + |
|
| 454 | + /** |
|
| 455 | + * Return the total number of subscriptions for the current query. |
|
| 456 | + * |
|
| 457 | + * @since 1.0.19 |
|
| 458 | + * |
|
| 459 | + * @return int Number of total subscriptions. |
|
| 460 | + */ |
|
| 461 | + public function get_total() { |
|
| 462 | + return $this->total_subscriptions; |
|
| 463 | + } |
|
| 464 | + |
|
| 465 | + /** |
|
| 466 | + * Parse and sanitize 'orderby' keys passed to the subscriptions query. |
|
| 467 | + * |
|
| 468 | + * @since 1.0.19 |
|
| 469 | + * |
|
| 470 | + * @param string $orderby Alias for the field to order by. |
|
| 471 | + * @param string $table The current table. |
|
| 472 | + * @return string Value to use in the ORDER clause, if `$orderby` is valid. |
|
| 473 | + */ |
|
| 474 | + protected function parse_orderby( $orderby, $table ) { |
|
| 475 | + |
|
| 476 | + $_orderby = ''; |
|
| 477 | + if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) { |
|
| 478 | + $_orderby = "$table.`$orderby`"; |
|
| 479 | + } elseif ( 'id' === strtolower( $orderby ) ) { |
|
| 480 | + $_orderby = "$table.id"; |
|
| 481 | + } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) { |
|
| 482 | + $include = wp_parse_id_list( $this->query_vars['include'] ); |
|
| 483 | + $include_sql = implode( ',', $include ); |
|
| 484 | + $_orderby = "FIELD( $table.id, $include_sql )"; |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + return $_orderby; |
|
| 488 | + } |
|
| 489 | + |
|
| 490 | + /** |
|
| 491 | + * Parse an 'order' query variable and cast it to ASC or DESC as necessary. |
|
| 492 | + * |
|
| 493 | + * @since 1.0.19 |
|
| 494 | + * |
|
| 495 | + * @param string $order The 'order' query variable. |
|
| 496 | + * @return string The sanitized 'order' query variable. |
|
| 497 | + */ |
|
| 498 | + protected function parse_order( $order ) { |
|
| 499 | + if ( ! is_string( $order ) || empty( $order ) ) { |
|
| 500 | + return 'DESC'; |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + if ( 'ASC' === strtoupper( $order ) ) { |
|
| 504 | + return 'ASC'; |
|
| 505 | + } else { |
|
| 506 | + return 'DESC'; |
|
| 507 | + } |
|
| 508 | + } |
|
| 509 | 509 | |
| 510 | 510 | } |
@@ -97,9 +97,9 @@ discard block |
||
| 97 | 97 | * |
| 98 | 98 | * @param null|string|array $query Optional. The query variables. |
| 99 | 99 | */ |
| 100 | - public function __construct( $query = null ) { |
|
| 101 | - if ( ! is_null( $query ) ) { |
|
| 102 | - $this->prepare_query( $query ); |
|
| 100 | + public function __construct($query = null) { |
|
| 101 | + if (!is_null($query)) { |
|
| 102 | + $this->prepare_query($query); |
|
| 103 | 103 | $this->query(); |
| 104 | 104 | } |
| 105 | 105 | } |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | * @param string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`. |
| 113 | 113 | * @return array Complete query variables with undefined ones filled in with defaults. |
| 114 | 114 | */ |
| 115 | - public static function fill_query_vars( $args ) { |
|
| 115 | + public static function fill_query_vars($args) { |
|
| 116 | 116 | $defaults = array( |
| 117 | 117 | 'status' => 'all', |
| 118 | 118 | 'customer_in' => array(), |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | 'fields' => 'all', |
| 131 | 131 | ); |
| 132 | 132 | |
| 133 | - return wp_parse_args( $args, $defaults ); |
|
| 133 | + return wp_parse_args($args, $defaults); |
|
| 134 | 134 | } |
| 135 | 135 | |
| 136 | 136 | /** |
@@ -182,45 +182,45 @@ discard block |
||
| 182 | 182 | * Use 'all' for all fields. Default 'all'. |
| 183 | 183 | * } |
| 184 | 184 | */ |
| 185 | - public function prepare_query( $query = array() ) { |
|
| 185 | + public function prepare_query($query = array()) { |
|
| 186 | 186 | global $wpdb; |
| 187 | 187 | |
| 188 | - if ( empty( $this->query_vars ) || ! empty( $query ) ) { |
|
| 188 | + if (empty($this->query_vars) || !empty($query)) { |
|
| 189 | 189 | $this->query_limit = null; |
| 190 | - $this->query_vars = $this->fill_query_vars( $query ); |
|
| 190 | + $this->query_vars = $this->fill_query_vars($query); |
|
| 191 | 191 | } |
| 192 | 192 | |
| 193 | - if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) { |
|
| 194 | - $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] ); |
|
| 193 | + if (!empty($this->query_vars['fields']) && 'all' !== $this->query_vars['fields']) { |
|
| 194 | + $this->query_vars['fields'] = wpinv_parse_list($this->query_vars['fields']); |
|
| 195 | 195 | } |
| 196 | 196 | |
| 197 | - do_action( 'getpaid_pre_get_subscriptions', array( &$this ) ); |
|
| 197 | + do_action('getpaid_pre_get_subscriptions', array(&$this)); |
|
| 198 | 198 | |
| 199 | 199 | // Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'. |
| 200 | - $qv =& $this->query_vars; |
|
| 201 | - $qv = $this->fill_query_vars( $qv ); |
|
| 200 | + $qv = & $this->query_vars; |
|
| 201 | + $qv = $this->fill_query_vars($qv); |
|
| 202 | 202 | $table = $wpdb->prefix . 'wpinv_subscriptions'; |
| 203 | 203 | $this->query_from = "FROM $table"; |
| 204 | 204 | |
| 205 | 205 | // Prepare query fields. |
| 206 | - $this->prepare_query_fields( $qv, $table ); |
|
| 206 | + $this->prepare_query_fields($qv, $table); |
|
| 207 | 207 | |
| 208 | 208 | // Prepare query where. |
| 209 | - $this->prepare_query_where( $qv, $table ); |
|
| 209 | + $this->prepare_query_where($qv, $table); |
|
| 210 | 210 | |
| 211 | 211 | // Prepare query order. |
| 212 | - $this->prepare_query_order( $qv, $table ); |
|
| 212 | + $this->prepare_query_order($qv, $table); |
|
| 213 | 213 | |
| 214 | 214 | // limit |
| 215 | - if ( isset( $qv['number'] ) && $qv['number'] > 0 ) { |
|
| 216 | - if ( $qv['offset'] ) { |
|
| 217 | - $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] ); |
|
| 215 | + if (isset($qv['number']) && $qv['number'] > 0) { |
|
| 216 | + if ($qv['offset']) { |
|
| 217 | + $this->query_limit = $wpdb->prepare('LIMIT %d, %d', $qv['offset'], $qv['number']); |
|
| 218 | 218 | } else { |
| 219 | - $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] ); |
|
| 219 | + $this->query_limit = $wpdb->prepare('LIMIT %d, %d', $qv['number'] * ($qv['paged'] - 1), $qv['number']); |
|
| 220 | 220 | } |
| 221 | 221 | } |
| 222 | 222 | |
| 223 | - do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) ); |
|
| 223 | + do_action_ref_array('getpaid_after_subscriptions_query', array(&$this)); |
|
| 224 | 224 | } |
| 225 | 225 | |
| 226 | 226 | /** |
@@ -231,22 +231,22 @@ discard block |
||
| 231 | 231 | * @param array $qv Query vars. |
| 232 | 232 | * @param string $table Table name. |
| 233 | 233 | */ |
| 234 | - protected function prepare_query_fields( &$qv, $table ) { |
|
| 234 | + protected function prepare_query_fields(&$qv, $table) { |
|
| 235 | 235 | |
| 236 | - if ( is_array( $qv['fields'] ) ) { |
|
| 237 | - $qv['fields'] = array_unique( $qv['fields'] ); |
|
| 236 | + if (is_array($qv['fields'])) { |
|
| 237 | + $qv['fields'] = array_unique($qv['fields']); |
|
| 238 | 238 | |
| 239 | 239 | $query_fields = array(); |
| 240 | - foreach ( $qv['fields'] as $field ) { |
|
| 241 | - $field = sanitize_key( $field ); |
|
| 240 | + foreach ($qv['fields'] as $field) { |
|
| 241 | + $field = sanitize_key($field); |
|
| 242 | 242 | $query_fields[] = "$table.`$field`"; |
| 243 | 243 | } |
| 244 | - $this->query_fields = implode( ',', $query_fields ); |
|
| 244 | + $this->query_fields = implode(',', $query_fields); |
|
| 245 | 245 | } else { |
| 246 | 246 | $this->query_fields = "$table.*"; |
| 247 | 247 | } |
| 248 | 248 | |
| 249 | - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 249 | + if (isset($qv['count_total']) && $qv['count_total']) { |
|
| 250 | 250 | $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; |
| 251 | 251 | } |
| 252 | 252 | |
@@ -260,58 +260,58 @@ discard block |
||
| 260 | 260 | * @param array $qv Query vars. |
| 261 | 261 | * @param string $table Table name. |
| 262 | 262 | */ |
| 263 | - protected function prepare_query_where( &$qv, $table ) { |
|
| 263 | + protected function prepare_query_where(&$qv, $table) { |
|
| 264 | 264 | global $wpdb; |
| 265 | 265 | $this->query_where = 'WHERE 1=1'; |
| 266 | 266 | |
| 267 | 267 | // Status. |
| 268 | - if ( 'all' !== $qv['status'] ) { |
|
| 269 | - $statuses = wpinv_clean( wpinv_parse_list( $qv['status'] ) ); |
|
| 270 | - $prepared_statuses = join( ',', array_fill( 0, count( $statuses ), '%s' ) ); |
|
| 271 | - $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses ); |
|
| 268 | + if ('all' !== $qv['status']) { |
|
| 269 | + $statuses = wpinv_clean(wpinv_parse_list($qv['status'])); |
|
| 270 | + $prepared_statuses = join(',', array_fill(0, count($statuses), '%s')); |
|
| 271 | + $this->query_where .= $wpdb->prepare(" AND $table.`status` IN ( $prepared_statuses )", $statuses); |
|
| 272 | 272 | } |
| 273 | 273 | |
| 274 | - if ( ! empty( $qv['customer_in'] ) ) { |
|
| 275 | - $customer_in = implode( ',', wp_parse_id_list( $qv['customer_in'] ) ); |
|
| 274 | + if (!empty($qv['customer_in'])) { |
|
| 275 | + $customer_in = implode(',', wp_parse_id_list($qv['customer_in'])); |
|
| 276 | 276 | $this->query_where .= " AND $table.`customer_id` IN ($customer_in)"; |
| 277 | - } elseif ( ! empty( $qv['customer_not_in'] ) ) { |
|
| 278 | - $customer_not_in = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) ); |
|
| 277 | + } elseif (!empty($qv['customer_not_in'])) { |
|
| 278 | + $customer_not_in = implode(',', wp_parse_id_list($qv['customer_not_in'])); |
|
| 279 | 279 | $this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)"; |
| 280 | 280 | } |
| 281 | 281 | |
| 282 | - if ( ! empty( $qv['product_in'] ) ) { |
|
| 283 | - $product_in = implode( ',', wp_parse_id_list( $qv['product_in'] ) ); |
|
| 282 | + if (!empty($qv['product_in'])) { |
|
| 283 | + $product_in = implode(',', wp_parse_id_list($qv['product_in'])); |
|
| 284 | 284 | $this->query_where .= " AND $table.`product_id` IN ($product_in)"; |
| 285 | - } elseif ( ! empty( $qv['product_not_in'] ) ) { |
|
| 286 | - $product_not_in = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) ); |
|
| 285 | + } elseif (!empty($qv['product_not_in'])) { |
|
| 286 | + $product_not_in = implode(',', wp_parse_id_list($qv['product_not_in'])); |
|
| 287 | 287 | $this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)"; |
| 288 | 288 | } |
| 289 | 289 | |
| 290 | - if ( ! empty( $qv['invoice_in'] ) ) { |
|
| 291 | - $invoice_in = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) ); |
|
| 290 | + if (!empty($qv['invoice_in'])) { |
|
| 291 | + $invoice_in = implode(',', wp_parse_id_list($qv['invoice_in'])); |
|
| 292 | 292 | $this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)"; |
| 293 | - } elseif ( ! empty( $qv['invoice_not_in'] ) ) { |
|
| 294 | - $invoice_not_in = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) ); |
|
| 293 | + } elseif (!empty($qv['invoice_not_in'])) { |
|
| 294 | + $invoice_not_in = implode(',', wp_parse_id_list($qv['invoice_not_in'])); |
|
| 295 | 295 | $this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)"; |
| 296 | 296 | } |
| 297 | 297 | |
| 298 | - if ( ! empty( $qv['include'] ) ) { |
|
| 299 | - $include = implode( ',', wp_parse_id_list( $qv['include'] ) ); |
|
| 298 | + if (!empty($qv['include'])) { |
|
| 299 | + $include = implode(',', wp_parse_id_list($qv['include'])); |
|
| 300 | 300 | $this->query_where .= " AND $table.`id` IN ($include)"; |
| 301 | - } elseif ( ! empty( $qv['exclude'] ) ) { |
|
| 302 | - $exclude = implode( ',', wp_parse_id_list( $qv['exclude'] ) ); |
|
| 301 | + } elseif (!empty($qv['exclude'])) { |
|
| 302 | + $exclude = implode(',', wp_parse_id_list($qv['exclude'])); |
|
| 303 | 303 | $this->query_where .= " AND $table.`id` NOT IN ($exclude)"; |
| 304 | 304 | } |
| 305 | 305 | |
| 306 | 306 | // Date queries are allowed for the subscription creation date. |
| 307 | - if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) { |
|
| 308 | - $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" ); |
|
| 307 | + if (!empty($qv['date_created_query']) && is_array($qv['date_created_query'])) { |
|
| 308 | + $date_created_query = new WP_Date_Query($qv['date_created_query'], "$table.created"); |
|
| 309 | 309 | $this->query_where .= $date_created_query->get_sql(); |
| 310 | 310 | } |
| 311 | 311 | |
| 312 | 312 | // Date queries are also allowed for the subscription expiration date. |
| 313 | - if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) { |
|
| 314 | - $date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" ); |
|
| 313 | + if (!empty($qv['date_expires_query']) && is_array($qv['date_expires_query'])) { |
|
| 314 | + $date_expires_query = new WP_Date_Query($qv['date_expires_query'], "$table.expiration"); |
|
| 315 | 315 | $this->query_where .= $date_expires_query->get_sql(); |
| 316 | 316 | } |
| 317 | 317 | |
@@ -325,24 +325,24 @@ discard block |
||
| 325 | 325 | * @param array $qv Query vars. |
| 326 | 326 | * @param string $table Table name. |
| 327 | 327 | */ |
| 328 | - protected function prepare_query_order( &$qv, $table ) { |
|
| 328 | + protected function prepare_query_order(&$qv, $table) { |
|
| 329 | 329 | |
| 330 | 330 | // sorting. |
| 331 | - $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : ''; |
|
| 332 | - $order = $this->parse_order( $qv['order'] ); |
|
| 331 | + $qv['order'] = isset($qv['order']) ? strtoupper($qv['order']) : ''; |
|
| 332 | + $order = $this->parse_order($qv['order']); |
|
| 333 | 333 | |
| 334 | 334 | // Default order is by 'id' (latest subscriptions). |
| 335 | - if ( empty( $qv['orderby'] ) ) { |
|
| 336 | - $qv['orderby'] = array( 'id' ); |
|
| 335 | + if (empty($qv['orderby'])) { |
|
| 336 | + $qv['orderby'] = array('id'); |
|
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | // 'orderby' values may be an array, comma- or space-separated list. |
| 340 | - $ordersby = array_filter( wpinv_parse_list( $qv['orderby'] ) ); |
|
| 340 | + $ordersby = array_filter(wpinv_parse_list($qv['orderby'])); |
|
| 341 | 341 | |
| 342 | 342 | $orderby_array = array(); |
| 343 | - foreach ( $ordersby as $_key => $_value ) { |
|
| 343 | + foreach ($ordersby as $_key => $_value) { |
|
| 344 | 344 | |
| 345 | - if ( is_int( $_key ) ) { |
|
| 345 | + if (is_int($_key)) { |
|
| 346 | 346 | // Integer key means this is a flat array of 'orderby' fields. |
| 347 | 347 | $_orderby = $_value; |
| 348 | 348 | $_order = $order; |
@@ -352,20 +352,20 @@ discard block |
||
| 352 | 352 | $_order = $_value; |
| 353 | 353 | } |
| 354 | 354 | |
| 355 | - $parsed = $this->parse_orderby( $_orderby, $table ); |
|
| 355 | + $parsed = $this->parse_orderby($_orderby, $table); |
|
| 356 | 356 | |
| 357 | - if ( $parsed ) { |
|
| 358 | - $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order ); |
|
| 357 | + if ($parsed) { |
|
| 358 | + $orderby_array[] = $parsed . ' ' . $this->parse_order($_order); |
|
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | } |
| 362 | 362 | |
| 363 | 363 | // If no valid clauses were found, order by id. |
| 364 | - if ( empty( $orderby_array ) ) { |
|
| 364 | + if (empty($orderby_array)) { |
|
| 365 | 365 | $orderby_array[] = "id $order"; |
| 366 | 366 | } |
| 367 | 367 | |
| 368 | - $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array ); |
|
| 368 | + $this->query_orderby = 'ORDER BY ' . implode(', ', $orderby_array); |
|
| 369 | 369 | |
| 370 | 370 | } |
| 371 | 371 | |
@@ -379,34 +379,34 @@ discard block |
||
| 379 | 379 | public function query() { |
| 380 | 380 | global $wpdb; |
| 381 | 381 | |
| 382 | - $qv =& $this->query_vars; |
|
| 382 | + $qv = & $this->query_vars; |
|
| 383 | 383 | |
| 384 | 384 | // Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the |
| 385 | 385 | // total_subscriptions property. |
| 386 | - $this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) ); |
|
| 386 | + $this->results = apply_filters_ref_array('getpaid_subscriptions_pre_query', array(null, &$this)); |
|
| 387 | 387 | |
| 388 | - if ( null === $this->results ) { |
|
| 388 | + if (null === $this->results) { |
|
| 389 | 389 | $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"; |
| 390 | 390 | |
| 391 | - if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) { |
|
| 392 | - $this->results = $wpdb->get_results( $this->request ); |
|
| 391 | + if ((is_array($qv['fields']) && 1 != count($qv['fields'])) || 'all' == $qv['fields']) { |
|
| 392 | + $this->results = $wpdb->get_results($this->request); |
|
| 393 | 393 | } else { |
| 394 | - $this->results = $wpdb->get_col( $this->request ); |
|
| 394 | + $this->results = $wpdb->get_col($this->request); |
|
| 395 | 395 | } |
| 396 | 396 | |
| 397 | - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 398 | - $found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this ); |
|
| 399 | - $this->total_subscriptions = (int) $wpdb->get_var( $found_subscriptions_query ); |
|
| 397 | + if (isset($qv['count_total']) && $qv['count_total']) { |
|
| 398 | + $found_subscriptions_query = apply_filters('getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this); |
|
| 399 | + $this->total_subscriptions = (int) $wpdb->get_var($found_subscriptions_query); |
|
| 400 | 400 | } |
| 401 | 401 | } |
| 402 | 402 | |
| 403 | - if ( 'all' == $qv['fields'] ) { |
|
| 404 | - foreach ( $this->results as $key => $subscription ) { |
|
| 405 | - wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' ); |
|
| 406 | - wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 407 | - wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 408 | - wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 409 | - $this->results[ $key ] = new WPInv_Subscription( $subscription ); |
|
| 403 | + if ('all' == $qv['fields']) { |
|
| 404 | + foreach ($this->results as $key => $subscription) { |
|
| 405 | + wp_cache_set($subscription->id, $subscription, 'getpaid_subscriptions'); |
|
| 406 | + wp_cache_set($subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids'); |
|
| 407 | + wp_cache_set($subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids'); |
|
| 408 | + wp_cache_set($subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids'); |
|
| 409 | + $this->results[$key] = new WPInv_Subscription($subscription); |
|
| 410 | 410 | } |
| 411 | 411 | } |
| 412 | 412 | |
@@ -420,9 +420,9 @@ discard block |
||
| 420 | 420 | * @param string $query_var Query variable key. |
| 421 | 421 | * @return mixed |
| 422 | 422 | */ |
| 423 | - public function get( $query_var ) { |
|
| 424 | - if ( isset( $this->query_vars[ $query_var ] ) ) { |
|
| 425 | - return $this->query_vars[ $query_var ]; |
|
| 423 | + public function get($query_var) { |
|
| 424 | + if (isset($this->query_vars[$query_var])) { |
|
| 425 | + return $this->query_vars[$query_var]; |
|
| 426 | 426 | } |
| 427 | 427 | |
| 428 | 428 | return null; |
@@ -436,8 +436,8 @@ discard block |
||
| 436 | 436 | * @param string $query_var Query variable key. |
| 437 | 437 | * @param mixed $value Query variable value. |
| 438 | 438 | */ |
| 439 | - public function set( $query_var, $value ) { |
|
| 440 | - $this->query_vars[ $query_var ] = $value; |
|
| 439 | + public function set($query_var, $value) { |
|
| 440 | + $this->query_vars[$query_var] = $value; |
|
| 441 | 441 | } |
| 442 | 442 | |
| 443 | 443 | /** |
@@ -471,16 +471,16 @@ discard block |
||
| 471 | 471 | * @param string $table The current table. |
| 472 | 472 | * @return string Value to use in the ORDER clause, if `$orderby` is valid. |
| 473 | 473 | */ |
| 474 | - protected function parse_orderby( $orderby, $table ) { |
|
| 474 | + protected function parse_orderby($orderby, $table) { |
|
| 475 | 475 | |
| 476 | 476 | $_orderby = ''; |
| 477 | - if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) { |
|
| 477 | + if (in_array($orderby, array('customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id'))) { |
|
| 478 | 478 | $_orderby = "$table.`$orderby`"; |
| 479 | - } elseif ( 'id' === strtolower( $orderby ) ) { |
|
| 479 | + } elseif ('id' === strtolower($orderby)) { |
|
| 480 | 480 | $_orderby = "$table.id"; |
| 481 | - } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) { |
|
| 482 | - $include = wp_parse_id_list( $this->query_vars['include'] ); |
|
| 483 | - $include_sql = implode( ',', $include ); |
|
| 481 | + } elseif ('include' === $orderby && !empty($this->query_vars['include'])) { |
|
| 482 | + $include = wp_parse_id_list($this->query_vars['include']); |
|
| 483 | + $include_sql = implode(',', $include); |
|
| 484 | 484 | $_orderby = "FIELD( $table.id, $include_sql )"; |
| 485 | 485 | } |
| 486 | 486 | |
@@ -495,12 +495,12 @@ discard block |
||
| 495 | 495 | * @param string $order The 'order' query variable. |
| 496 | 496 | * @return string The sanitized 'order' query variable. |
| 497 | 497 | */ |
| 498 | - protected function parse_order( $order ) { |
|
| 499 | - if ( ! is_string( $order ) || empty( $order ) ) { |
|
| 498 | + protected function parse_order($order) { |
|
| 499 | + if (!is_string($order) || empty($order)) { |
|
| 500 | 500 | return 'DESC'; |
| 501 | 501 | } |
| 502 | 502 | |
| 503 | - if ( 'ASC' === strtoupper( $order ) ) { |
|
| 503 | + if ('ASC' === strtoupper($order)) { |
|
| 504 | 504 | return 'ASC'; |
| 505 | 505 | } else { |
| 506 | 506 | return 'DESC'; |
@@ -14,144 +14,144 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | class WPInv_Subscriptions_Widget extends WP_Super_Duper { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Register the widget with WordPress. |
|
| 19 | - * |
|
| 20 | - */ |
|
| 21 | - public function __construct() { |
|
| 22 | - |
|
| 23 | - $options = array( |
|
| 24 | - 'textdomain' => 'invoicing', |
|
| 25 | - 'block-icon' => 'controls-repeat', |
|
| 26 | - 'block-category'=> 'widgets', |
|
| 27 | - 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
|
| 28 | - 'class_name' => __CLASS__, |
|
| 29 | - 'base_id' => 'wpinv_subscriptions', |
|
| 30 | - 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
| 31 | - 'widget_ops' => array( |
|
| 32 | - 'classname' => 'getpaid-subscriptions bsui', |
|
| 33 | - 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
| 34 | - ), |
|
| 35 | - 'arguments' => array( |
|
| 36 | - 'title' => array( |
|
| 37 | - 'title' => __( 'Widget title', 'invoicing' ), |
|
| 38 | - 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
| 39 | - 'type' => 'text', |
|
| 40 | - 'desc_tip' => true, |
|
| 41 | - 'default' => '', |
|
| 42 | - 'advanced' => false |
|
| 43 | - ), |
|
| 44 | - ) |
|
| 45 | - |
|
| 46 | - ); |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - parent::__construct( $options ); |
|
| 50 | - } |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Retrieves current user's subscriptions. |
|
| 54 | - * |
|
| 55 | - * @return GetPaid_Subscriptions_Query |
|
| 56 | - */ |
|
| 57 | - public function get_subscriptions() { |
|
| 58 | - |
|
| 59 | - // Prepare license args. |
|
| 60 | - $args = array( |
|
| 61 | - 'customer_in' => get_current_user_id(), |
|
| 62 | - 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
| 63 | - ); |
|
| 64 | - |
|
| 65 | - return new GetPaid_Subscriptions_Query( $args ); |
|
| 66 | - |
|
| 67 | - } |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * The Super block output function. |
|
| 71 | - * |
|
| 72 | - * @param array $args |
|
| 73 | - * @param array $widget_args |
|
| 74 | - * @param string $content |
|
| 75 | - * |
|
| 76 | - * @return mixed|string|bool |
|
| 77 | - */ |
|
| 78 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 79 | - |
|
| 80 | - // Ensure that the user is logged in. |
|
| 81 | - if ( ! is_user_logged_in() ) { |
|
| 82 | - |
|
| 83 | - return aui()->alert( |
|
| 84 | - array( |
|
| 85 | - 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
| 86 | - 'type' => 'error', |
|
| 87 | - ) |
|
| 88 | - ); |
|
| 89 | - |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - // Are we displaying a single subscription? |
|
| 93 | - if ( isset( $_GET['subscription'] ) ) { |
|
| 94 | - return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - // Retrieve the user's subscriptions. |
|
| 98 | - $subscriptions = $this->get_subscriptions(); |
|
| 99 | - |
|
| 100 | - // Start the output buffer. |
|
| 101 | - ob_start(); |
|
| 102 | - |
|
| 103 | - // Backwards compatibility. |
|
| 104 | - do_action( 'wpinv_before_user_subscriptions' ); |
|
| 105 | - |
|
| 106 | - // Display errors and notices. |
|
| 107 | - wpinv_print_errors(); |
|
| 108 | - |
|
| 109 | - do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
| 110 | - |
|
| 111 | - // Print the table header. |
|
| 112 | - $this->print_table_header(); |
|
| 113 | - |
|
| 114 | - // Print table body. |
|
| 115 | - $this->print_table_body( $subscriptions->get_results() ); |
|
| 116 | - |
|
| 117 | - // Print table footer. |
|
| 118 | - $this->print_table_footer(); |
|
| 119 | - |
|
| 120 | - // Print the navigation. |
|
| 121 | - $this->print_navigation( $subscriptions->get_total() ); |
|
| 122 | - |
|
| 123 | - // Backwards compatibility. |
|
| 124 | - do_action( 'wpinv_after_user_subscriptions' ); |
|
| 125 | - |
|
| 126 | - // Return the output. |
|
| 127 | - return ob_get_clean(); |
|
| 128 | - |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * Retrieves the subscription columns. |
|
| 133 | - * |
|
| 134 | - * @return array |
|
| 135 | - */ |
|
| 136 | - public function get_subscriptions_table_columns() { |
|
| 17 | + /** |
|
| 18 | + * Register the widget with WordPress. |
|
| 19 | + * |
|
| 20 | + */ |
|
| 21 | + public function __construct() { |
|
| 22 | + |
|
| 23 | + $options = array( |
|
| 24 | + 'textdomain' => 'invoicing', |
|
| 25 | + 'block-icon' => 'controls-repeat', |
|
| 26 | + 'block-category'=> 'widgets', |
|
| 27 | + 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
|
| 28 | + 'class_name' => __CLASS__, |
|
| 29 | + 'base_id' => 'wpinv_subscriptions', |
|
| 30 | + 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
| 31 | + 'widget_ops' => array( |
|
| 32 | + 'classname' => 'getpaid-subscriptions bsui', |
|
| 33 | + 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
| 34 | + ), |
|
| 35 | + 'arguments' => array( |
|
| 36 | + 'title' => array( |
|
| 37 | + 'title' => __( 'Widget title', 'invoicing' ), |
|
| 38 | + 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
| 39 | + 'type' => 'text', |
|
| 40 | + 'desc_tip' => true, |
|
| 41 | + 'default' => '', |
|
| 42 | + 'advanced' => false |
|
| 43 | + ), |
|
| 44 | + ) |
|
| 45 | + |
|
| 46 | + ); |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + parent::__construct( $options ); |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Retrieves current user's subscriptions. |
|
| 54 | + * |
|
| 55 | + * @return GetPaid_Subscriptions_Query |
|
| 56 | + */ |
|
| 57 | + public function get_subscriptions() { |
|
| 58 | + |
|
| 59 | + // Prepare license args. |
|
| 60 | + $args = array( |
|
| 61 | + 'customer_in' => get_current_user_id(), |
|
| 62 | + 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
| 63 | + ); |
|
| 64 | + |
|
| 65 | + return new GetPaid_Subscriptions_Query( $args ); |
|
| 66 | + |
|
| 67 | + } |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * The Super block output function. |
|
| 71 | + * |
|
| 72 | + * @param array $args |
|
| 73 | + * @param array $widget_args |
|
| 74 | + * @param string $content |
|
| 75 | + * |
|
| 76 | + * @return mixed|string|bool |
|
| 77 | + */ |
|
| 78 | + public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 79 | + |
|
| 80 | + // Ensure that the user is logged in. |
|
| 81 | + if ( ! is_user_logged_in() ) { |
|
| 82 | + |
|
| 83 | + return aui()->alert( |
|
| 84 | + array( |
|
| 85 | + 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
| 86 | + 'type' => 'error', |
|
| 87 | + ) |
|
| 88 | + ); |
|
| 89 | + |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + // Are we displaying a single subscription? |
|
| 93 | + if ( isset( $_GET['subscription'] ) ) { |
|
| 94 | + return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + // Retrieve the user's subscriptions. |
|
| 98 | + $subscriptions = $this->get_subscriptions(); |
|
| 99 | + |
|
| 100 | + // Start the output buffer. |
|
| 101 | + ob_start(); |
|
| 102 | + |
|
| 103 | + // Backwards compatibility. |
|
| 104 | + do_action( 'wpinv_before_user_subscriptions' ); |
|
| 105 | + |
|
| 106 | + // Display errors and notices. |
|
| 107 | + wpinv_print_errors(); |
|
| 108 | + |
|
| 109 | + do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
| 110 | + |
|
| 111 | + // Print the table header. |
|
| 112 | + $this->print_table_header(); |
|
| 113 | + |
|
| 114 | + // Print table body. |
|
| 115 | + $this->print_table_body( $subscriptions->get_results() ); |
|
| 116 | + |
|
| 117 | + // Print table footer. |
|
| 118 | + $this->print_table_footer(); |
|
| 119 | + |
|
| 120 | + // Print the navigation. |
|
| 121 | + $this->print_navigation( $subscriptions->get_total() ); |
|
| 122 | + |
|
| 123 | + // Backwards compatibility. |
|
| 124 | + do_action( 'wpinv_after_user_subscriptions' ); |
|
| 125 | + |
|
| 126 | + // Return the output. |
|
| 127 | + return ob_get_clean(); |
|
| 128 | + |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * Retrieves the subscription columns. |
|
| 133 | + * |
|
| 134 | + * @return array |
|
| 135 | + */ |
|
| 136 | + public function get_subscriptions_table_columns() { |
|
| 137 | 137 | |
| 138 | - $columns = array( |
|
| 139 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 140 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
| 141 | - 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
| 142 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 143 | - ); |
|
| 138 | + $columns = array( |
|
| 139 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 140 | + 'amount' => __( 'Amount', 'invoicing' ), |
|
| 141 | + 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
| 142 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 143 | + ); |
|
| 144 | 144 | |
| 145 | - return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
| 146 | - } |
|
| 145 | + return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Displays the table header. |
|
| 150 | - * |
|
| 151 | - */ |
|
| 152 | - public function print_table_header() { |
|
| 148 | + /** |
|
| 149 | + * Displays the table header. |
|
| 150 | + * |
|
| 151 | + */ |
|
| 152 | + public function print_table_header() { |
|
| 153 | 153 | |
| 154 | - ?> |
|
| 154 | + ?> |
|
| 155 | 155 | |
| 156 | 156 | <table class="table table-bordered table-striped"> |
| 157 | 157 | |
@@ -167,120 +167,120 @@ discard block |
||
| 167 | 167 | |
| 168 | 168 | <?php |
| 169 | 169 | |
| 170 | - } |
|
| 170 | + } |
|
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * Displays the table body. |
|
| 174 | - * |
|
| 175 | - * @param WPInv_Subscription[] $subscriptions |
|
| 176 | - */ |
|
| 177 | - public function print_table_body( $subscriptions ) { |
|
| 172 | + /** |
|
| 173 | + * Displays the table body. |
|
| 174 | + * |
|
| 175 | + * @param WPInv_Subscription[] $subscriptions |
|
| 176 | + */ |
|
| 177 | + public function print_table_body( $subscriptions ) { |
|
| 178 | 178 | |
| 179 | - if ( empty( $subscriptions ) ) { |
|
| 180 | - $this->print_table_body_no_subscriptions(); |
|
| 181 | - } else { |
|
| 182 | - $this->print_table_body_subscriptions( $subscriptions ); |
|
| 183 | - } |
|
| 179 | + if ( empty( $subscriptions ) ) { |
|
| 180 | + $this->print_table_body_no_subscriptions(); |
|
| 181 | + } else { |
|
| 182 | + $this->print_table_body_subscriptions( $subscriptions ); |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | - } |
|
| 185 | + } |
|
| 186 | 186 | |
| 187 | - /** |
|
| 188 | - * Displays the table body if no subscriptions were found. |
|
| 189 | - * |
|
| 190 | - */ |
|
| 191 | - public function print_table_body_no_subscriptions() { |
|
| 187 | + /** |
|
| 188 | + * Displays the table body if no subscriptions were found. |
|
| 189 | + * |
|
| 190 | + */ |
|
| 191 | + public function print_table_body_no_subscriptions() { |
|
| 192 | 192 | |
| 193 | - ?> |
|
| 193 | + ?> |
|
| 194 | 194 | <tbody> |
| 195 | 195 | |
| 196 | 196 | <tr> |
| 197 | 197 | <td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>"> |
| 198 | 198 | |
| 199 | 199 | <?php |
| 200 | - echo aui()->alert( |
|
| 201 | - array( |
|
| 202 | - 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
| 203 | - 'type' => 'warning', |
|
| 204 | - ) |
|
| 205 | - ); |
|
| 206 | - ?> |
|
| 200 | + echo aui()->alert( |
|
| 201 | + array( |
|
| 202 | + 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
| 203 | + 'type' => 'warning', |
|
| 204 | + ) |
|
| 205 | + ); |
|
| 206 | + ?> |
|
| 207 | 207 | |
| 208 | 208 | </td> |
| 209 | 209 | </tr> |
| 210 | 210 | |
| 211 | 211 | </tbody> |
| 212 | 212 | <?php |
| 213 | - } |
|
| 213 | + } |
|
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * Displays the table body if subscriptions were found. |
|
| 217 | - * |
|
| 218 | - * @param WPInv_Subscription[] $subscriptions |
|
| 219 | - */ |
|
| 220 | - public function print_table_body_subscriptions( $subscriptions ) { |
|
| 215 | + /** |
|
| 216 | + * Displays the table body if subscriptions were found. |
|
| 217 | + * |
|
| 218 | + * @param WPInv_Subscription[] $subscriptions |
|
| 219 | + */ |
|
| 220 | + public function print_table_body_subscriptions( $subscriptions ) { |
|
| 221 | 221 | |
| 222 | - ?> |
|
| 222 | + ?> |
|
| 223 | 223 | <tbody> |
| 224 | 224 | |
| 225 | 225 | <?php foreach ( $subscriptions as $subscription ) : ?> |
| 226 | 226 | <tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>"> |
| 227 | 227 | <?php |
| 228 | - wpinv_get_template( |
|
| 229 | - 'subscriptions/subscriptions-table-row.php', |
|
| 230 | - array( |
|
| 231 | - 'subscription' => $subscription, |
|
| 232 | - 'widget' => $this |
|
| 233 | - ) |
|
| 234 | - ); |
|
| 235 | - ?> |
|
| 228 | + wpinv_get_template( |
|
| 229 | + 'subscriptions/subscriptions-table-row.php', |
|
| 230 | + array( |
|
| 231 | + 'subscription' => $subscription, |
|
| 232 | + 'widget' => $this |
|
| 233 | + ) |
|
| 234 | + ); |
|
| 235 | + ?> |
|
| 236 | 236 | </tr> |
| 237 | 237 | <?php endforeach; ?> |
| 238 | 238 | |
| 239 | 239 | </tbody> |
| 240 | 240 | <?php |
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Adds row actions to a column |
|
| 245 | - * |
|
| 246 | - * @param string $content column content |
|
| 247 | - * @param WPInv_Subscription $subscription |
|
| 248 | - * @since 1.0.0 |
|
| 249 | - * @return string |
|
| 250 | - */ |
|
| 251 | - public function add_row_actions( $content, $subscription ) { |
|
| 252 | - |
|
| 253 | - // Prepare row actions. |
|
| 254 | - $actions = array(); |
|
| 255 | - |
|
| 256 | - // View subscription action. |
|
| 257 | - $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); |
|
| 258 | - $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
| 259 | - |
|
| 260 | - // Filter the actions. |
|
| 261 | - $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
| 262 | - |
|
| 263 | - $sanitized = array(); |
|
| 264 | - foreach ( $actions as $key => $action ) { |
|
| 265 | - $key = sanitize_html_class( $key ); |
|
| 266 | - $action = wp_kses_post( $action ); |
|
| 267 | - $sanitized[] = "<span class='$key'>$action</span>"; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
|
| 271 | - $row_actions .= implode( ' | ', $sanitized ); |
|
| 272 | - $row_actions .= '</small>'; |
|
| 273 | - |
|
| 274 | - return $content . $row_actions; |
|
| 275 | - } |
|
| 276 | - |
|
| 277 | - /** |
|
| 278 | - * Displays the table footer. |
|
| 279 | - * |
|
| 280 | - */ |
|
| 281 | - public function print_table_footer() { |
|
| 282 | - |
|
| 283 | - ?> |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Adds row actions to a column |
|
| 245 | + * |
|
| 246 | + * @param string $content column content |
|
| 247 | + * @param WPInv_Subscription $subscription |
|
| 248 | + * @since 1.0.0 |
|
| 249 | + * @return string |
|
| 250 | + */ |
|
| 251 | + public function add_row_actions( $content, $subscription ) { |
|
| 252 | + |
|
| 253 | + // Prepare row actions. |
|
| 254 | + $actions = array(); |
|
| 255 | + |
|
| 256 | + // View subscription action. |
|
| 257 | + $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); |
|
| 258 | + $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
| 259 | + |
|
| 260 | + // Filter the actions. |
|
| 261 | + $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
| 262 | + |
|
| 263 | + $sanitized = array(); |
|
| 264 | + foreach ( $actions as $key => $action ) { |
|
| 265 | + $key = sanitize_html_class( $key ); |
|
| 266 | + $action = wp_kses_post( $action ); |
|
| 267 | + $sanitized[] = "<span class='$key'>$action</span>"; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
|
| 271 | + $row_actions .= implode( ' | ', $sanitized ); |
|
| 272 | + $row_actions .= '</small>'; |
|
| 273 | + |
|
| 274 | + return $content . $row_actions; |
|
| 275 | + } |
|
| 276 | + |
|
| 277 | + /** |
|
| 278 | + * Displays the table footer. |
|
| 279 | + * |
|
| 280 | + */ |
|
| 281 | + public function print_table_footer() { |
|
| 282 | + |
|
| 283 | + ?> |
|
| 284 | 284 | |
| 285 | 285 | <tfoot> |
| 286 | 286 | <tr> |
@@ -295,129 +295,129 @@ discard block |
||
| 295 | 295 | </table> |
| 296 | 296 | <?php |
| 297 | 297 | |
| 298 | - } |
|
| 298 | + } |
|
| 299 | 299 | |
| 300 | - /** |
|
| 301 | - * Displays the navigation. |
|
| 302 | - * |
|
| 303 | - * @param int $total |
|
| 304 | - */ |
|
| 305 | - public function print_navigation( $total ) { |
|
| 300 | + /** |
|
| 301 | + * Displays the navigation. |
|
| 302 | + * |
|
| 303 | + * @param int $total |
|
| 304 | + */ |
|
| 305 | + public function print_navigation( $total ) { |
|
| 306 | 306 | |
| 307 | - if ( $total < 1 ) { |
|
| 307 | + if ( $total < 1 ) { |
|
| 308 | 308 | |
| 309 | - // Out-of-bounds, run the query again without LIMIT for total count. |
|
| 310 | - $args = array( |
|
| 311 | - 'customer_in' => get_current_user_id(), |
|
| 312 | - 'fields' => 'id', |
|
| 313 | - ); |
|
| 309 | + // Out-of-bounds, run the query again without LIMIT for total count. |
|
| 310 | + $args = array( |
|
| 311 | + 'customer_in' => get_current_user_id(), |
|
| 312 | + 'fields' => 'id', |
|
| 313 | + ); |
|
| 314 | 314 | |
| 315 | - $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
| 316 | - $total = $count_query->get_total(); |
|
| 317 | - } |
|
| 315 | + $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
| 316 | + $total = $count_query->get_total(); |
|
| 317 | + } |
|
| 318 | 318 | |
| 319 | - // Abort if we do not have pages. |
|
| 320 | - if ( 2 > $total ) { |
|
| 321 | - return; |
|
| 322 | - } |
|
| 319 | + // Abort if we do not have pages. |
|
| 320 | + if ( 2 > $total ) { |
|
| 321 | + return; |
|
| 322 | + } |
|
| 323 | 323 | |
| 324 | - ?> |
|
| 324 | + ?> |
|
| 325 | 325 | |
| 326 | 326 | <div class="getpaid-subscriptions-pagination"> |
| 327 | 327 | <?php |
| 328 | - $big = 999999; |
|
| 329 | - |
|
| 330 | - echo getpaid_paginate_links( |
|
| 331 | - array( |
|
| 332 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 333 | - 'format' => '?paged=%#%', |
|
| 334 | - 'total' => (int) ceil( $total / 10 ), |
|
| 335 | - ) |
|
| 336 | - ); |
|
| 337 | - ?> |
|
| 328 | + $big = 999999; |
|
| 329 | + |
|
| 330 | + echo getpaid_paginate_links( |
|
| 331 | + array( |
|
| 332 | + 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 333 | + 'format' => '?paged=%#%', |
|
| 334 | + 'total' => (int) ceil( $total / 10 ), |
|
| 335 | + ) |
|
| 336 | + ); |
|
| 337 | + ?> |
|
| 338 | 338 | </div> |
| 339 | 339 | |
| 340 | 340 | <?php |
| 341 | - } |
|
| 342 | - |
|
| 343 | - /** |
|
| 344 | - * Returns a single subscription's columns. |
|
| 345 | - * |
|
| 346 | - * @param WPInv_Subscription $subscription |
|
| 347 | - * |
|
| 348 | - * @return array |
|
| 349 | - */ |
|
| 350 | - public function get_single_subscription_columns( $subscription ) { |
|
| 351 | - |
|
| 352 | - // Prepare subscription detail columns. |
|
| 353 | - $fields = apply_filters( |
|
| 354 | - 'getpaid_single_subscription_details_fields', |
|
| 355 | - array( |
|
| 356 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 357 | - 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
| 358 | - 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
| 359 | - 'start_date' => __( 'Start date', 'invoicing' ), |
|
| 360 | - 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
| 361 | - 'payments' => __( 'Payments', 'invoicing' ), |
|
| 362 | - 'item' => __( 'Item', 'invoicing' ), |
|
| 363 | - ), |
|
| 364 | - $subscription |
|
| 365 | - ); |
|
| 366 | - |
|
| 367 | - if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
| 368 | - $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
| 372 | - unset( $fields['initial_amount'] ); |
|
| 373 | - } |
|
| 374 | - |
|
| 375 | - return $fields; |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - /** |
|
| 379 | - * Displays a single subscription. |
|
| 380 | - * |
|
| 381 | - * @param string $subscription |
|
| 382 | - * |
|
| 383 | - * @return string |
|
| 384 | - */ |
|
| 385 | - public function display_single_subscription( $subscription ) { |
|
| 386 | - |
|
| 387 | - // Fetch the subscription. |
|
| 388 | - $subscription = new WPInv_Subscription( (int) $subscription ); |
|
| 389 | - |
|
| 390 | - if ( ! $subscription->get_id() ) { |
|
| 391 | - |
|
| 392 | - return aui()->alert( |
|
| 393 | - array( |
|
| 394 | - 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
| 395 | - 'type' => 'error', |
|
| 396 | - ) |
|
| 397 | - ); |
|
| 398 | - |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - // Ensure that the user owns this subscription key. |
|
| 402 | - if ( get_current_user_id() != $subscription->get_customer_id() ) { |
|
| 403 | - |
|
| 404 | - return aui()->alert( |
|
| 405 | - array( |
|
| 406 | - 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
| 407 | - 'type' => 'error', |
|
| 408 | - ) |
|
| 409 | - ); |
|
| 410 | - |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - return wpinv_get_template_html( |
|
| 414 | - 'subscriptions/subscription-details.php', |
|
| 415 | - array( |
|
| 416 | - 'subscription' => $subscription, |
|
| 417 | - 'widget' => $this |
|
| 418 | - ) |
|
| 419 | - ); |
|
| 420 | - |
|
| 421 | - } |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + /** |
|
| 344 | + * Returns a single subscription's columns. |
|
| 345 | + * |
|
| 346 | + * @param WPInv_Subscription $subscription |
|
| 347 | + * |
|
| 348 | + * @return array |
|
| 349 | + */ |
|
| 350 | + public function get_single_subscription_columns( $subscription ) { |
|
| 351 | + |
|
| 352 | + // Prepare subscription detail columns. |
|
| 353 | + $fields = apply_filters( |
|
| 354 | + 'getpaid_single_subscription_details_fields', |
|
| 355 | + array( |
|
| 356 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 357 | + 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
| 358 | + 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
| 359 | + 'start_date' => __( 'Start date', 'invoicing' ), |
|
| 360 | + 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
| 361 | + 'payments' => __( 'Payments', 'invoicing' ), |
|
| 362 | + 'item' => __( 'Item', 'invoicing' ), |
|
| 363 | + ), |
|
| 364 | + $subscription |
|
| 365 | + ); |
|
| 366 | + |
|
| 367 | + if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
| 368 | + $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
| 372 | + unset( $fields['initial_amount'] ); |
|
| 373 | + } |
|
| 374 | + |
|
| 375 | + return $fields; |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + /** |
|
| 379 | + * Displays a single subscription. |
|
| 380 | + * |
|
| 381 | + * @param string $subscription |
|
| 382 | + * |
|
| 383 | + * @return string |
|
| 384 | + */ |
|
| 385 | + public function display_single_subscription( $subscription ) { |
|
| 386 | + |
|
| 387 | + // Fetch the subscription. |
|
| 388 | + $subscription = new WPInv_Subscription( (int) $subscription ); |
|
| 389 | + |
|
| 390 | + if ( ! $subscription->get_id() ) { |
|
| 391 | + |
|
| 392 | + return aui()->alert( |
|
| 393 | + array( |
|
| 394 | + 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
| 395 | + 'type' => 'error', |
|
| 396 | + ) |
|
| 397 | + ); |
|
| 398 | + |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + // Ensure that the user owns this subscription key. |
|
| 402 | + if ( get_current_user_id() != $subscription->get_customer_id() ) { |
|
| 403 | + |
|
| 404 | + return aui()->alert( |
|
| 405 | + array( |
|
| 406 | + 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
| 407 | + 'type' => 'error', |
|
| 408 | + ) |
|
| 409 | + ); |
|
| 410 | + |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + return wpinv_get_template_html( |
|
| 414 | + 'subscriptions/subscription-details.php', |
|
| 415 | + array( |
|
| 416 | + 'subscription' => $subscription, |
|
| 417 | + 'widget' => $this |
|
| 418 | + ) |
|
| 419 | + ); |
|
| 420 | + |
|
| 421 | + } |
|
| 422 | 422 | |
| 423 | 423 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * @version 1.0.0 |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | -defined( 'ABSPATH' ) || exit; |
|
| 8 | +defined('ABSPATH') || exit; |
|
| 9 | 9 | |
| 10 | 10 | /** |
| 11 | 11 | * Contains the subscriptions widget. |
@@ -27,15 +27,15 @@ discard block |
||
| 27 | 27 | 'block-keywords'=> "['invoicing','subscriptions', 'getpaid']", |
| 28 | 28 | 'class_name' => __CLASS__, |
| 29 | 29 | 'base_id' => 'wpinv_subscriptions', |
| 30 | - 'name' => __( 'GetPaid > Subscriptions', 'invoicing' ), |
|
| 30 | + 'name' => __('GetPaid > Subscriptions', 'invoicing'), |
|
| 31 | 31 | 'widget_ops' => array( |
| 32 | 32 | 'classname' => 'getpaid-subscriptions bsui', |
| 33 | - 'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ), |
|
| 33 | + 'description' => esc_html__("Displays the current user's subscriptions.", 'invoicing'), |
|
| 34 | 34 | ), |
| 35 | 35 | 'arguments' => array( |
| 36 | 36 | 'title' => array( |
| 37 | - 'title' => __( 'Widget title', 'invoicing' ), |
|
| 38 | - 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
| 37 | + 'title' => __('Widget title', 'invoicing'), |
|
| 38 | + 'desc' => __('Enter widget title.', 'invoicing'), |
|
| 39 | 39 | 'type' => 'text', |
| 40 | 40 | 'desc_tip' => true, |
| 41 | 41 | 'default' => '', |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | ); |
| 47 | 47 | |
| 48 | 48 | |
| 49 | - parent::__construct( $options ); |
|
| 49 | + parent::__construct($options); |
|
| 50 | 50 | } |
| 51 | 51 | |
| 52 | 52 | /** |
@@ -57,12 +57,12 @@ discard block |
||
| 57 | 57 | public function get_subscriptions() { |
| 58 | 58 | |
| 59 | 59 | // Prepare license args. |
| 60 | - $args = array( |
|
| 60 | + $args = array( |
|
| 61 | 61 | 'customer_in' => get_current_user_id(), |
| 62 | - 'paged' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
| 62 | + 'paged' => (get_query_var('paged')) ? absint(get_query_var('paged')) : 1, |
|
| 63 | 63 | ); |
| 64 | 64 | |
| 65 | - return new GetPaid_Subscriptions_Query( $args ); |
|
| 65 | + return new GetPaid_Subscriptions_Query($args); |
|
| 66 | 66 | |
| 67 | 67 | } |
| 68 | 68 | |
@@ -75,14 +75,14 @@ discard block |
||
| 75 | 75 | * |
| 76 | 76 | * @return mixed|string|bool |
| 77 | 77 | */ |
| 78 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 78 | + public function output($args = array(), $widget_args = array(), $content = '') { |
|
| 79 | 79 | |
| 80 | 80 | // Ensure that the user is logged in. |
| 81 | - if ( ! is_user_logged_in() ) { |
|
| 81 | + if (!is_user_logged_in()) { |
|
| 82 | 82 | |
| 83 | 83 | return aui()->alert( |
| 84 | 84 | array( |
| 85 | - 'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ), |
|
| 85 | + 'content' => wp_kses_post(__('You need to log-in or create an account to view this section.', 'invoicing')), |
|
| 86 | 86 | 'type' => 'error', |
| 87 | 87 | ) |
| 88 | 88 | ); |
@@ -90,8 +90,8 @@ discard block |
||
| 90 | 90 | } |
| 91 | 91 | |
| 92 | 92 | // Are we displaying a single subscription? |
| 93 | - if ( isset( $_GET['subscription'] ) ) { |
|
| 94 | - return $this->display_single_subscription( trim( $_GET['subscription'] ) ); |
|
| 93 | + if (isset($_GET['subscription'])) { |
|
| 94 | + return $this->display_single_subscription(trim($_GET['subscription'])); |
|
| 95 | 95 | } |
| 96 | 96 | |
| 97 | 97 | // Retrieve the user's subscriptions. |
@@ -101,27 +101,27 @@ discard block |
||
| 101 | 101 | ob_start(); |
| 102 | 102 | |
| 103 | 103 | // Backwards compatibility. |
| 104 | - do_action( 'wpinv_before_user_subscriptions' ); |
|
| 104 | + do_action('wpinv_before_user_subscriptions'); |
|
| 105 | 105 | |
| 106 | 106 | // Display errors and notices. |
| 107 | 107 | wpinv_print_errors(); |
| 108 | 108 | |
| 109 | - do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions ); |
|
| 109 | + do_action('getpaid_license_manager_before_subscriptions', $subscriptions); |
|
| 110 | 110 | |
| 111 | 111 | // Print the table header. |
| 112 | 112 | $this->print_table_header(); |
| 113 | 113 | |
| 114 | 114 | // Print table body. |
| 115 | - $this->print_table_body( $subscriptions->get_results() ); |
|
| 115 | + $this->print_table_body($subscriptions->get_results()); |
|
| 116 | 116 | |
| 117 | 117 | // Print table footer. |
| 118 | 118 | $this->print_table_footer(); |
| 119 | 119 | |
| 120 | 120 | // Print the navigation. |
| 121 | - $this->print_navigation( $subscriptions->get_total() ); |
|
| 121 | + $this->print_navigation($subscriptions->get_total()); |
|
| 122 | 122 | |
| 123 | 123 | // Backwards compatibility. |
| 124 | - do_action( 'wpinv_after_user_subscriptions' ); |
|
| 124 | + do_action('wpinv_after_user_subscriptions'); |
|
| 125 | 125 | |
| 126 | 126 | // Return the output. |
| 127 | 127 | return ob_get_clean(); |
@@ -136,13 +136,13 @@ discard block |
||
| 136 | 136 | public function get_subscriptions_table_columns() { |
| 137 | 137 | |
| 138 | 138 | $columns = array( |
| 139 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 140 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
| 141 | - 'renewal-date' => __( 'Next payment', 'invoicing' ), |
|
| 142 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 139 | + 'subscription' => __('Subscription', 'invoicing'), |
|
| 140 | + 'amount' => __('Amount', 'invoicing'), |
|
| 141 | + 'renewal-date' => __('Next payment', 'invoicing'), |
|
| 142 | + 'status' => __('Status', 'invoicing'), |
|
| 143 | 143 | ); |
| 144 | 144 | |
| 145 | - return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns ); |
|
| 145 | + return apply_filters('getpaid_frontend_subscriptions_table_columns', $columns); |
|
| 146 | 146 | } |
| 147 | 147 | |
| 148 | 148 | /** |
@@ -157,9 +157,9 @@ discard block |
||
| 157 | 157 | |
| 158 | 158 | <thead> |
| 159 | 159 | <tr> |
| 160 | - <?php foreach ( $this->get_subscriptions_table_columns() as $key => $label ) : ?> |
|
| 161 | - <th scope="col" class="getpaid-subscriptions-table-<?php echo sanitize_html_class( $key ); ?>"> |
|
| 162 | - <?php echo sanitize_text_field( $label ); ?> |
|
| 160 | + <?php foreach ($this->get_subscriptions_table_columns() as $key => $label) : ?> |
|
| 161 | + <th scope="col" class="getpaid-subscriptions-table-<?php echo sanitize_html_class($key); ?>"> |
|
| 162 | + <?php echo sanitize_text_field($label); ?> |
|
| 163 | 163 | </th> |
| 164 | 164 | <?php endforeach; ?> |
| 165 | 165 | </tr> |
@@ -174,12 +174,12 @@ discard block |
||
| 174 | 174 | * |
| 175 | 175 | * @param WPInv_Subscription[] $subscriptions |
| 176 | 176 | */ |
| 177 | - public function print_table_body( $subscriptions ) { |
|
| 177 | + public function print_table_body($subscriptions) { |
|
| 178 | 178 | |
| 179 | - if ( empty( $subscriptions ) ) { |
|
| 179 | + if (empty($subscriptions)) { |
|
| 180 | 180 | $this->print_table_body_no_subscriptions(); |
| 181 | 181 | } else { |
| 182 | - $this->print_table_body_subscriptions( $subscriptions ); |
|
| 182 | + $this->print_table_body_subscriptions($subscriptions); |
|
| 183 | 183 | } |
| 184 | 184 | |
| 185 | 185 | } |
@@ -194,12 +194,12 @@ discard block |
||
| 194 | 194 | <tbody> |
| 195 | 195 | |
| 196 | 196 | <tr> |
| 197 | - <td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>"> |
|
| 197 | + <td colspan="<?php echo count($this->get_subscriptions_table_columns()); ?>"> |
|
| 198 | 198 | |
| 199 | 199 | <?php |
| 200 | 200 | echo aui()->alert( |
| 201 | 201 | array( |
| 202 | - 'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ), |
|
| 202 | + 'content' => wp_kses_post(__('No subscriptions found.', 'invoicing')), |
|
| 203 | 203 | 'type' => 'warning', |
| 204 | 204 | ) |
| 205 | 205 | ); |
@@ -217,12 +217,12 @@ discard block |
||
| 217 | 217 | * |
| 218 | 218 | * @param WPInv_Subscription[] $subscriptions |
| 219 | 219 | */ |
| 220 | - public function print_table_body_subscriptions( $subscriptions ) { |
|
| 220 | + public function print_table_body_subscriptions($subscriptions) { |
|
| 221 | 221 | |
| 222 | 222 | ?> |
| 223 | 223 | <tbody> |
| 224 | 224 | |
| 225 | - <?php foreach ( $subscriptions as $subscription ) : ?> |
|
| 225 | + <?php foreach ($subscriptions as $subscription) : ?> |
|
| 226 | 226 | <tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>"> |
| 227 | 227 | <?php |
| 228 | 228 | wpinv_get_template( |
@@ -248,27 +248,27 @@ discard block |
||
| 248 | 248 | * @since 1.0.0 |
| 249 | 249 | * @return string |
| 250 | 250 | */ |
| 251 | - public function add_row_actions( $content, $subscription ) { |
|
| 251 | + public function add_row_actions($content, $subscription) { |
|
| 252 | 252 | |
| 253 | 253 | // Prepare row actions. |
| 254 | 254 | $actions = array(); |
| 255 | 255 | |
| 256 | 256 | // View subscription action. |
| 257 | - $view_url = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); |
|
| 258 | - $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>'; |
|
| 257 | + $view_url = esc_url(add_query_arg('subscription', (int) $subscription->get_id(), get_permalink((int) wpinv_get_option('invoice_subscription_page')))); |
|
| 258 | + $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __('Manage Subscription', 'invoicing') . '</a>'; |
|
| 259 | 259 | |
| 260 | 260 | // Filter the actions. |
| 261 | - $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription ); |
|
| 261 | + $actions = apply_filters('getpaid_subscriptions_table_subscription_actions', $actions, $subscription); |
|
| 262 | 262 | |
| 263 | - $sanitized = array(); |
|
| 264 | - foreach ( $actions as $key => $action ) { |
|
| 265 | - $key = sanitize_html_class( $key ); |
|
| 266 | - $action = wp_kses_post( $action ); |
|
| 263 | + $sanitized = array(); |
|
| 264 | + foreach ($actions as $key => $action) { |
|
| 265 | + $key = sanitize_html_class($key); |
|
| 266 | + $action = wp_kses_post($action); |
|
| 267 | 267 | $sanitized[] = "<span class='$key'>$action</span>"; |
| 268 | 268 | } |
| 269 | 269 | |
| 270 | 270 | $row_actions = "<small class='form-text getpaid-subscription-item-actions'>"; |
| 271 | - $row_actions .= implode( ' | ', $sanitized ); |
|
| 271 | + $row_actions .= implode(' | ', $sanitized); |
|
| 272 | 272 | $row_actions .= '</small>'; |
| 273 | 273 | |
| 274 | 274 | return $content . $row_actions; |
@@ -284,9 +284,9 @@ discard block |
||
| 284 | 284 | |
| 285 | 285 | <tfoot> |
| 286 | 286 | <tr> |
| 287 | - <?php foreach ( $this->get_subscriptions_table_columns() as $key => $label ) : ?> |
|
| 288 | - <th class="getpaid-subscriptions-<?php echo sanitize_html_class( $key ); ?>"> |
|
| 289 | - <?php echo sanitize_text_field( $label ); ?> |
|
| 287 | + <?php foreach ($this->get_subscriptions_table_columns() as $key => $label) : ?> |
|
| 288 | + <th class="getpaid-subscriptions-<?php echo sanitize_html_class($key); ?>"> |
|
| 289 | + <?php echo sanitize_text_field($label); ?> |
|
| 290 | 290 | </th> |
| 291 | 291 | <?php endforeach; ?> |
| 292 | 292 | </tr> |
@@ -302,22 +302,22 @@ discard block |
||
| 302 | 302 | * |
| 303 | 303 | * @param int $total |
| 304 | 304 | */ |
| 305 | - public function print_navigation( $total ) { |
|
| 305 | + public function print_navigation($total) { |
|
| 306 | 306 | |
| 307 | - if ( $total < 1 ) { |
|
| 307 | + if ($total < 1) { |
|
| 308 | 308 | |
| 309 | 309 | // Out-of-bounds, run the query again without LIMIT for total count. |
| 310 | - $args = array( |
|
| 310 | + $args = array( |
|
| 311 | 311 | 'customer_in' => get_current_user_id(), |
| 312 | 312 | 'fields' => 'id', |
| 313 | 313 | ); |
| 314 | 314 | |
| 315 | - $count_query = new GetPaid_Subscriptions_Query( $args ); |
|
| 315 | + $count_query = new GetPaid_Subscriptions_Query($args); |
|
| 316 | 316 | $total = $count_query->get_total(); |
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | // Abort if we do not have pages. |
| 320 | - if ( 2 > $total ) { |
|
| 320 | + if (2 > $total) { |
|
| 321 | 321 | return; |
| 322 | 322 | } |
| 323 | 323 | |
@@ -329,9 +329,9 @@ discard block |
||
| 329 | 329 | |
| 330 | 330 | echo getpaid_paginate_links( |
| 331 | 331 | array( |
| 332 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 332 | + 'base' => str_replace($big, '%#%', esc_url(get_pagenum_link($big))), |
|
| 333 | 333 | 'format' => '?paged=%#%', |
| 334 | - 'total' => (int) ceil( $total / 10 ), |
|
| 334 | + 'total' => (int) ceil($total / 10), |
|
| 335 | 335 | ) |
| 336 | 336 | ); |
| 337 | 337 | ?> |
@@ -347,29 +347,29 @@ discard block |
||
| 347 | 347 | * |
| 348 | 348 | * @return array |
| 349 | 349 | */ |
| 350 | - public function get_single_subscription_columns( $subscription ) { |
|
| 350 | + public function get_single_subscription_columns($subscription) { |
|
| 351 | 351 | |
| 352 | 352 | // Prepare subscription detail columns. |
| 353 | 353 | $fields = apply_filters( |
| 354 | 354 | 'getpaid_single_subscription_details_fields', |
| 355 | 355 | array( |
| 356 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 357 | - 'initial_amount' => __( 'Initial amount', 'invoicing' ), |
|
| 358 | - 'recurring_amount' => __( 'Recurring amount', 'invoicing' ), |
|
| 359 | - 'start_date' => __( 'Start date', 'invoicing' ), |
|
| 360 | - 'expiry_date' => __( 'Next payment', 'invoicing' ), |
|
| 361 | - 'payments' => __( 'Payments', 'invoicing' ), |
|
| 362 | - 'item' => __( 'Item', 'invoicing' ), |
|
| 356 | + 'status' => __('Status', 'invoicing'), |
|
| 357 | + 'initial_amount' => __('Initial amount', 'invoicing'), |
|
| 358 | + 'recurring_amount' => __('Recurring amount', 'invoicing'), |
|
| 359 | + 'start_date' => __('Start date', 'invoicing'), |
|
| 360 | + 'expiry_date' => __('Next payment', 'invoicing'), |
|
| 361 | + 'payments' => __('Payments', 'invoicing'), |
|
| 362 | + 'item' => __('Item', 'invoicing'), |
|
| 363 | 363 | ), |
| 364 | 364 | $subscription |
| 365 | 365 | ); |
| 366 | 366 | |
| 367 | - if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) { |
|
| 368 | - $fields['expiry_date'] = __( 'End date', 'invoicing' ); |
|
| 367 | + if (!$subscription->is_active() || $subscription->is_last_renewal()) { |
|
| 368 | + $fields['expiry_date'] = __('End date', 'invoicing'); |
|
| 369 | 369 | } |
| 370 | 370 | |
| 371 | - if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) { |
|
| 372 | - unset( $fields['initial_amount'] ); |
|
| 371 | + if ($subscription->get_initial_amount() == $subscription->get_recurring_amount()) { |
|
| 372 | + unset($fields['initial_amount']); |
|
| 373 | 373 | } |
| 374 | 374 | |
| 375 | 375 | return $fields; |
@@ -382,16 +382,16 @@ discard block |
||
| 382 | 382 | * |
| 383 | 383 | * @return string |
| 384 | 384 | */ |
| 385 | - public function display_single_subscription( $subscription ) { |
|
| 385 | + public function display_single_subscription($subscription) { |
|
| 386 | 386 | |
| 387 | 387 | // Fetch the subscription. |
| 388 | - $subscription = new WPInv_Subscription( (int) $subscription ); |
|
| 388 | + $subscription = new WPInv_Subscription((int) $subscription); |
|
| 389 | 389 | |
| 390 | - if ( ! $subscription->get_id() ) { |
|
| 390 | + if (!$subscription->get_id()) { |
|
| 391 | 391 | |
| 392 | 392 | return aui()->alert( |
| 393 | 393 | array( |
| 394 | - 'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ), |
|
| 394 | + 'content' => wp_kses_post(__('Subscription not found.', 'invoicing')), |
|
| 395 | 395 | 'type' => 'error', |
| 396 | 396 | ) |
| 397 | 397 | ); |
@@ -399,11 +399,11 @@ discard block |
||
| 399 | 399 | } |
| 400 | 400 | |
| 401 | 401 | // Ensure that the user owns this subscription key. |
| 402 | - if ( get_current_user_id() != $subscription->get_customer_id() ) { |
|
| 402 | + if (get_current_user_id() != $subscription->get_customer_id()) { |
|
| 403 | 403 | |
| 404 | 404 | return aui()->alert( |
| 405 | 405 | array( |
| 406 | - 'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ), |
|
| 406 | + 'content' => wp_kses_post(__('You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing')), |
|
| 407 | 407 | 'type' => 'error', |
| 408 | 408 | ) |
| 409 | 409 | ); |
@@ -6,7 +6,7 @@ discard block |
||
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | if ( ! defined( 'ABSPATH' ) ) { |
| 9 | - exit; // Exit if accessed directly |
|
| 9 | + exit; // Exit if accessed directly |
|
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | /** |
@@ -15,10 +15,10 @@ discard block |
||
| 15 | 15 | class GetPaid_Meta_Box_Invoice_Subscription { |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | - * Output the subscription metabox. |
|
| 19 | - * |
|
| 20 | - * @param WP_Post $post |
|
| 21 | - */ |
|
| 18 | + * Output the subscription metabox. |
|
| 19 | + * |
|
| 20 | + * @param WP_Post $post |
|
| 21 | + */ |
|
| 22 | 22 | public static function output( $post ) { |
| 23 | 23 | |
| 24 | 24 | // Fetch the invoice. |
@@ -34,10 +34,10 @@ discard block |
||
| 34 | 34 | } |
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | - * Output the subscription invoices. |
|
| 38 | - * |
|
| 39 | - * @param WP_Post $post |
|
| 40 | - */ |
|
| 37 | + * Output the subscription invoices. |
|
| 38 | + * |
|
| 39 | + * @param WP_Post $post |
|
| 40 | + */ |
|
| 41 | 41 | public static function output_invoices( $post ) { |
| 42 | 42 | |
| 43 | 43 | // Fetch the invoice. |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 8 | +if (!defined('ABSPATH')) { |
|
| 9 | 9 | exit; // Exit if accessed directly |
| 10 | 10 | } |
| 11 | 11 | |
@@ -19,16 +19,16 @@ discard block |
||
| 19 | 19 | * |
| 20 | 20 | * @param WP_Post $post |
| 21 | 21 | */ |
| 22 | - public static function output( $post ) { |
|
| 22 | + public static function output($post) { |
|
| 23 | 23 | |
| 24 | 24 | // Fetch the invoice. |
| 25 | - $invoice = new WPInv_Invoice( $post ); |
|
| 25 | + $invoice = new WPInv_Invoice($post); |
|
| 26 | 26 | |
| 27 | 27 | // Fetch the subscription. |
| 28 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
| 28 | + $subscription = getpaid_get_invoice_subscription($invoice); |
|
| 29 | 29 | |
| 30 | 30 | echo '<div class="bsui">'; |
| 31 | - getpaid_admin_subscription_details_metabox( /** @scrutinizer ignore-type */$subscription ); |
|
| 31 | + getpaid_admin_subscription_details_metabox(/** @scrutinizer ignore-type */$subscription); |
|
| 32 | 32 | echo '</div>'; |
| 33 | 33 | |
| 34 | 34 | } |
@@ -38,16 +38,16 @@ discard block |
||
| 38 | 38 | * |
| 39 | 39 | * @param WP_Post $post |
| 40 | 40 | */ |
| 41 | - public static function output_invoices( $post ) { |
|
| 41 | + public static function output_invoices($post) { |
|
| 42 | 42 | |
| 43 | 43 | // Fetch the invoice. |
| 44 | - $invoice = new WPInv_Invoice( $post ); |
|
| 44 | + $invoice = new WPInv_Invoice($post); |
|
| 45 | 45 | |
| 46 | 46 | // Fetch the subscription. |
| 47 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
| 47 | + $subscription = getpaid_get_invoice_subscription($invoice); |
|
| 48 | 48 | |
| 49 | 49 | echo '<div class="bsui">'; |
| 50 | - getpaid_admin_subscription_invoice_details_metabox( /** @scrutinizer ignore-type */$subscription ); |
|
| 50 | + getpaid_admin_subscription_invoice_details_metabox(/** @scrutinizer ignore-type */$subscription); |
|
| 51 | 51 | echo '</div>'; |
| 52 | 52 | |
| 53 | 53 | } |
@@ -40,86 +40,86 @@ discard block |
||
| 40 | 40 | <tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>"> |
| 41 | 41 | <?php |
| 42 | 42 | |
| 43 | - foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) : |
|
| 43 | + foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) : |
|
| 44 | 44 | |
| 45 | - $column_id = sanitize_html_class( $column_id ); |
|
| 46 | - $class = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] ); |
|
| 45 | + $column_id = sanitize_html_class( $column_id ); |
|
| 46 | + $class = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] ); |
|
| 47 | 47 | |
| 48 | - echo "<td class='$column_id $class'>"; |
|
| 49 | - switch ( $column_id ) { |
|
| 48 | + echo "<td class='$column_id $class'>"; |
|
| 49 | + switch ( $column_id ) { |
|
| 50 | 50 | |
| 51 | - case 'invoice-number': |
|
| 52 | - echo wpinv_invoice_link( $invoice ); |
|
| 53 | - break; |
|
| 51 | + case 'invoice-number': |
|
| 52 | + echo wpinv_invoice_link( $invoice ); |
|
| 53 | + break; |
|
| 54 | 54 | |
| 55 | - case 'created-date': |
|
| 56 | - echo getpaid_format_date_value( $invoice->get_date_created() ); |
|
| 57 | - break; |
|
| 55 | + case 'created-date': |
|
| 56 | + echo getpaid_format_date_value( $invoice->get_date_created() ); |
|
| 57 | + break; |
|
| 58 | 58 | |
| 59 | - case 'payment-date': |
|
| 59 | + case 'payment-date': |
|
| 60 | 60 | |
| 61 | - if ( $invoice->needs_payment() ) { |
|
| 62 | - echo "—"; |
|
| 63 | - } else { |
|
| 64 | - echo getpaid_format_date_value( $invoice->get_date_completed() ); |
|
| 65 | - } |
|
| 61 | + if ( $invoice->needs_payment() ) { |
|
| 62 | + echo "—"; |
|
| 63 | + } else { |
|
| 64 | + echo getpaid_format_date_value( $invoice->get_date_completed() ); |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - break; |
|
| 67 | + break; |
|
| 68 | 68 | |
| 69 | - case 'invoice-status': |
|
| 70 | - echo $invoice->get_status_label_html(); |
|
| 69 | + case 'invoice-status': |
|
| 70 | + echo $invoice->get_status_label_html(); |
|
| 71 | 71 | |
| 72 | - break; |
|
| 72 | + break; |
|
| 73 | 73 | |
| 74 | - case 'invoice-total': |
|
| 75 | - echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) ); |
|
| 74 | + case 'invoice-total': |
|
| 75 | + echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) ); |
|
| 76 | 76 | |
| 77 | - break; |
|
| 77 | + break; |
|
| 78 | 78 | |
| 79 | - case 'invoice-actions': |
|
| 79 | + case 'invoice-actions': |
|
| 80 | 80 | |
| 81 | - $actions = array( |
|
| 81 | + $actions = array( |
|
| 82 | 82 | |
| 83 | - 'pay' => array( |
|
| 84 | - 'url' => $invoice->get_checkout_payment_url(), |
|
| 85 | - 'name' => __( 'Pay Now', 'invoicing' ), |
|
| 83 | + 'pay' => array( |
|
| 84 | + 'url' => $invoice->get_checkout_payment_url(), |
|
| 85 | + 'name' => __( 'Pay Now', 'invoicing' ), |
|
| 86 | 86 | 'class' => 'btn-success' |
| 87 | - ), |
|
| 87 | + ), |
|
| 88 | 88 | |
| 89 | 89 | 'print' => array( |
| 90 | - 'url' => $invoice->get_view_url(), |
|
| 91 | - 'name' => __( 'View Invoice', 'invoicing' ), |
|
| 90 | + 'url' => $invoice->get_view_url(), |
|
| 91 | + 'name' => __( 'View Invoice', 'invoicing' ), |
|
| 92 | 92 | 'class' => 'btn-secondary', |
| 93 | 93 | 'attrs' => 'target="_blank"' |
| 94 | - ) |
|
| 95 | - ); |
|
| 94 | + ) |
|
| 95 | + ); |
|
| 96 | 96 | |
| 97 | - if ( ! $invoice->needs_payment() ) { |
|
| 98 | - unset( $actions['pay'] ); |
|
| 99 | - } |
|
| 97 | + if ( ! $invoice->needs_payment() ) { |
|
| 98 | + unset( $actions['pay'] ); |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | - $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice ); |
|
| 101 | + $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice ); |
|
| 102 | 102 | |
| 103 | - foreach ( $actions as $key => $action ) { |
|
| 104 | - $class = !empty($action['class']) ? sanitize_html_class($action['class']) : ''; |
|
| 105 | - echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>'; |
|
| 106 | - } |
|
| 103 | + foreach ( $actions as $key => $action ) { |
|
| 104 | + $class = !empty($action['class']) ? sanitize_html_class($action['class']) : ''; |
|
| 105 | + echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>'; |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - break; |
|
| 108 | + break; |
|
| 109 | 109 | |
| 110 | - default: |
|
| 111 | - do_action( "wpinv_user_invoices_column_$column_id", $invoice ); |
|
| 112 | - break; |
|
| 110 | + default: |
|
| 111 | + do_action( "wpinv_user_invoices_column_$column_id", $invoice ); |
|
| 112 | + break; |
|
| 113 | 113 | |
| 114 | 114 | |
| 115 | - } |
|
| 115 | + } |
|
| 116 | 116 | |
| 117 | - do_action( "wpinv_user_invoices_column_after_$column_id", $invoice ); |
|
| 117 | + do_action( "wpinv_user_invoices_column_after_$column_id", $invoice ); |
|
| 118 | 118 | |
| 119 | - echo '</td>'; |
|
| 119 | + echo '</td>'; |
|
| 120 | 120 | |
| 121 | - endforeach; |
|
| 122 | - ?> |
|
| 121 | + endforeach; |
|
| 122 | + ?> |
|
| 123 | 123 | </tr> |
| 124 | 124 | |
| 125 | 125 | <?php endforeach; ?> |
@@ -132,14 +132,14 @@ discard block |
||
| 132 | 132 | <?php if ( 1 < $invoices->max_num_pages ) : ?> |
| 133 | 133 | <div class="invoicing-Pagination"> |
| 134 | 134 | <?php |
| 135 | - $big = 999999; |
|
| 136 | - |
|
| 137 | - echo paginate_links( array( |
|
| 138 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 139 | - 'format' => '?paged=%#%', |
|
| 140 | - 'total' => $invoices->max_num_pages, |
|
| 141 | - ) ); |
|
| 142 | - ?> |
|
| 135 | + $big = 999999; |
|
| 136 | + |
|
| 137 | + echo paginate_links( array( |
|
| 138 | + 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 139 | + 'format' => '?paged=%#%', |
|
| 140 | + 'total' => $invoices->max_num_pages, |
|
| 141 | + ) ); |
|
| 142 | + ?> |
|
| 143 | 143 | </div> |
| 144 | 144 | <?php endif; ?> |
| 145 | 145 | |
@@ -7,13 +7,13 @@ discard block |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | // Current page. |
| 13 | -$current_page = empty( $_GET[ 'page' ] ) ? 1 : absint( $_GET[ 'page' ] ); |
|
| 13 | +$current_page = empty($_GET['page']) ? 1 : absint($_GET['page']); |
|
| 14 | 14 | |
| 15 | 15 | // Fires before displaying user invoices. |
| 16 | -do_action( 'wpinv_before_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages ); |
|
| 16 | +do_action('wpinv_before_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages); |
|
| 17 | 17 | |
| 18 | 18 | ?> |
| 19 | 19 | |
@@ -23,9 +23,9 @@ discard block |
||
| 23 | 23 | <thead> |
| 24 | 24 | <tr> |
| 25 | 25 | |
| 26 | - <?php foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) : ?> |
|
| 27 | - <th class="<?php echo sanitize_html_class( $column_id ); ?> <?php echo ( ! empty( $column_name['class'] ) ? sanitize_html_class( $column_name['class'] ) : '');?> border-bottom-0"> |
|
| 28 | - <span class="nobr"><?php echo esc_html( $column_name['title'] ); ?></span> |
|
| 26 | + <?php foreach (wpinv_get_user_invoices_columns() as $column_id => $column_name) : ?> |
|
| 27 | + <th class="<?php echo sanitize_html_class($column_id); ?> <?php echo (!empty($column_name['class']) ? sanitize_html_class($column_name['class']) : ''); ?> border-bottom-0"> |
|
| 28 | + <span class="nobr"><?php echo esc_html($column_name['title']); ?></span> |
|
| 29 | 29 | </th> |
| 30 | 30 | <?php endforeach; ?> |
| 31 | 31 | |
@@ -35,33 +35,33 @@ discard block |
||
| 35 | 35 | |
| 36 | 36 | |
| 37 | 37 | <tbody> |
| 38 | - <?php foreach ( $invoices->invoices as $invoice ) : ?> |
|
| 38 | + <?php foreach ($invoices->invoices as $invoice) : ?> |
|
| 39 | 39 | |
| 40 | 40 | <tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>"> |
| 41 | 41 | <?php |
| 42 | 42 | |
| 43 | - foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) : |
|
| 43 | + foreach (wpinv_get_user_invoices_columns() as $column_id => $column_name) : |
|
| 44 | 44 | |
| 45 | - $column_id = sanitize_html_class( $column_id ); |
|
| 46 | - $class = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] ); |
|
| 45 | + $column_id = sanitize_html_class($column_id); |
|
| 46 | + $class = empty($column_name['class']) ? '' : sanitize_html_class($column_name['class']); |
|
| 47 | 47 | |
| 48 | 48 | echo "<td class='$column_id $class'>"; |
| 49 | - switch ( $column_id ) { |
|
| 49 | + switch ($column_id) { |
|
| 50 | 50 | |
| 51 | 51 | case 'invoice-number': |
| 52 | - echo wpinv_invoice_link( $invoice ); |
|
| 52 | + echo wpinv_invoice_link($invoice); |
|
| 53 | 53 | break; |
| 54 | 54 | |
| 55 | 55 | case 'created-date': |
| 56 | - echo getpaid_format_date_value( $invoice->get_date_created() ); |
|
| 56 | + echo getpaid_format_date_value($invoice->get_date_created()); |
|
| 57 | 57 | break; |
| 58 | 58 | |
| 59 | 59 | case 'payment-date': |
| 60 | 60 | |
| 61 | - if ( $invoice->needs_payment() ) { |
|
| 61 | + if ($invoice->needs_payment()) { |
|
| 62 | 62 | echo "—"; |
| 63 | 63 | } else { |
| 64 | - echo getpaid_format_date_value( $invoice->get_date_completed() ); |
|
| 64 | + echo getpaid_format_date_value($invoice->get_date_completed()); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | break; |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | break; |
| 73 | 73 | |
| 74 | 74 | case 'invoice-total': |
| 75 | - echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) ); |
|
| 75 | + echo wpinv_price(wpinv_format_amount($invoice->get_total())); |
|
| 76 | 76 | |
| 77 | 77 | break; |
| 78 | 78 | |
@@ -82,39 +82,39 @@ discard block |
||
| 82 | 82 | |
| 83 | 83 | 'pay' => array( |
| 84 | 84 | 'url' => $invoice->get_checkout_payment_url(), |
| 85 | - 'name' => __( 'Pay Now', 'invoicing' ), |
|
| 85 | + 'name' => __('Pay Now', 'invoicing'), |
|
| 86 | 86 | 'class' => 'btn-success' |
| 87 | 87 | ), |
| 88 | 88 | |
| 89 | 89 | 'print' => array( |
| 90 | 90 | 'url' => $invoice->get_view_url(), |
| 91 | - 'name' => __( 'View Invoice', 'invoicing' ), |
|
| 91 | + 'name' => __('View Invoice', 'invoicing'), |
|
| 92 | 92 | 'class' => 'btn-secondary', |
| 93 | 93 | 'attrs' => 'target="_blank"' |
| 94 | 94 | ) |
| 95 | 95 | ); |
| 96 | 96 | |
| 97 | - if ( ! $invoice->needs_payment() ) { |
|
| 98 | - unset( $actions['pay'] ); |
|
| 97 | + if (!$invoice->needs_payment()) { |
|
| 98 | + unset($actions['pay']); |
|
| 99 | 99 | } |
| 100 | 100 | |
| 101 | - $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice ); |
|
| 101 | + $actions = apply_filters('wpinv_user_invoices_actions', $actions, $invoice); |
|
| 102 | 102 | |
| 103 | - foreach ( $actions as $key => $action ) { |
|
| 103 | + foreach ($actions as $key => $action) { |
|
| 104 | 104 | $class = !empty($action['class']) ? sanitize_html_class($action['class']) : ''; |
| 105 | - echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>'; |
|
| 105 | + echo '<a href="' . esc_url($action['url']) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class($key) . '" ' . (!empty($action['attrs']) ? $action['attrs'] : '') . '>' . $action['name'] . '</a>'; |
|
| 106 | 106 | } |
| 107 | 107 | |
| 108 | 108 | break; |
| 109 | 109 | |
| 110 | 110 | default: |
| 111 | - do_action( "wpinv_user_invoices_column_$column_id", $invoice ); |
|
| 111 | + do_action("wpinv_user_invoices_column_$column_id", $invoice); |
|
| 112 | 112 | break; |
| 113 | 113 | |
| 114 | 114 | |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - do_action( "wpinv_user_invoices_column_after_$column_id", $invoice ); |
|
| 117 | + do_action("wpinv_user_invoices_column_after_$column_id", $invoice); |
|
| 118 | 118 | |
| 119 | 119 | echo '</td>'; |
| 120 | 120 | |
@@ -127,20 +127,20 @@ discard block |
||
| 127 | 127 | </tbody> |
| 128 | 128 | </table> |
| 129 | 129 | |
| 130 | - <?php do_action( 'wpinv_before_user_invoices_pagination' ); ?> |
|
| 130 | + <?php do_action('wpinv_before_user_invoices_pagination'); ?> |
|
| 131 | 131 | |
| 132 | - <?php if ( 1 < $invoices->max_num_pages ) : ?> |
|
| 132 | + <?php if (1 < $invoices->max_num_pages) : ?> |
|
| 133 | 133 | <div class="invoicing-Pagination"> |
| 134 | 134 | <?php |
| 135 | 135 | $big = 999999; |
| 136 | 136 | |
| 137 | - echo paginate_links( array( |
|
| 138 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 137 | + echo paginate_links(array( |
|
| 138 | + 'base' => str_replace($big, '%#%', esc_url(get_pagenum_link($big))), |
|
| 139 | 139 | 'format' => '?paged=%#%', |
| 140 | 140 | 'total' => $invoices->max_num_pages, |
| 141 | - ) ); |
|
| 141 | + )); |
|
| 142 | 142 | ?> |
| 143 | 143 | </div> |
| 144 | 144 | <?php endif; ?> |
| 145 | 145 | |
| 146 | -<?php do_action( 'wpinv_after_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages ); ?> |
|
| 146 | +<?php do_action('wpinv_after_user_invoices', $invoices->invoices, $invoices->total, $invoices->max_num_pages); ?> |
|
@@ -7,54 +7,54 @@ discard block |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | // Fetch the invoice. |
| 13 | -$invoice = new WPInv_Invoice( $invoice ); |
|
| 13 | +$invoice = new WPInv_Invoice($invoice); |
|
| 14 | 14 | |
| 15 | 15 | // @deprecated |
| 16 | -do_action( 'wpinv_success_content_before', $invoice ); |
|
| 17 | -do_action( 'wpinv_before_receipt', $invoice ); |
|
| 16 | +do_action('wpinv_success_content_before', $invoice); |
|
| 17 | +do_action('wpinv_before_receipt', $invoice); |
|
| 18 | 18 | |
| 19 | 19 | |
| 20 | 20 | // Prepare header text. |
| 21 | -if ( $invoice->is_paid() ) { |
|
| 21 | +if ($invoice->is_paid()) { |
|
| 22 | 22 | |
| 23 | 23 | $alert = aui()->alert( |
| 24 | 24 | array( |
| 25 | 25 | 'type' => 'success', |
| 26 | - 'content' => __( 'Thank you for your payment!', 'invoicing' ), |
|
| 26 | + 'content' => __('Thank you for your payment!', 'invoicing'), |
|
| 27 | 27 | ) |
| 28 | 28 | ); |
| 29 | 29 | |
| 30 | -} else if ( $invoice->is_refunded() ) { |
|
| 30 | +} else if ($invoice->is_refunded()) { |
|
| 31 | 31 | |
| 32 | 32 | $alert = aui()->alert( |
| 33 | 33 | array( |
| 34 | 34 | 'type' => 'info', |
| 35 | - 'content' => __( 'This invoice was refunded.', 'invoicing' ), |
|
| 35 | + 'content' => __('This invoice was refunded.', 'invoicing'), |
|
| 36 | 36 | ) |
| 37 | 37 | ); |
| 38 | 38 | |
| 39 | -} else if ( $invoice->is_held() ) { |
|
| 39 | +} else if ($invoice->is_held()) { |
|
| 40 | 40 | |
| 41 | 41 | $alert = aui()->alert( |
| 42 | 42 | array( |
| 43 | 43 | 'type' => 'info', |
| 44 | - 'content' => __( 'This invoice will be processed as soon we verify your payment.', 'invoicing' ), |
|
| 44 | + 'content' => __('This invoice will be processed as soon we verify your payment.', 'invoicing'), |
|
| 45 | 45 | ) |
| 46 | 46 | ); |
| 47 | 47 | |
| 48 | -} else if ( $invoice->needs_payment() ) { |
|
| 48 | +} else if ($invoice->needs_payment()) { |
|
| 49 | 49 | |
| 50 | - if ( $invoice->is_due() ) { |
|
| 50 | + if ($invoice->is_due()) { |
|
| 51 | 51 | |
| 52 | 52 | $alert = aui()->alert( |
| 53 | 53 | array( |
| 54 | 54 | 'type' => 'danger', |
| 55 | 55 | 'content' => sprintf( |
| 56 | - __( 'This invoice was due on %.', 'invoicing' ), |
|
| 57 | - getpaid_format_date_value( $invoice->get_due_date() ) |
|
| 56 | + __('This invoice was due on %.', 'invoicing'), |
|
| 57 | + getpaid_format_date_value($invoice->get_due_date()) |
|
| 58 | 58 | ), |
| 59 | 59 | ) |
| 60 | 60 | ); |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | $alert = aui()->alert( |
| 65 | 65 | array( |
| 66 | 66 | 'type' => 'warning', |
| 67 | - 'content' => __( 'This invoice needs payment.', 'invoicing' ), |
|
| 67 | + 'content' => __('This invoice needs payment.', 'invoicing'), |
|
| 68 | 68 | ) |
| 69 | 69 | ); |
| 70 | 70 | |
@@ -79,19 +79,19 @@ discard block |
||
| 79 | 79 | |
| 80 | 80 | 'pay' => array( |
| 81 | 81 | 'url' => $invoice->get_checkout_payment_url(), |
| 82 | - 'name' => __( 'Pay For Invoice', 'invoicing' ), |
|
| 82 | + 'name' => __('Pay For Invoice', 'invoicing'), |
|
| 83 | 83 | 'class' => 'btn-success', |
| 84 | 84 | ), |
| 85 | 85 | |
| 86 | 86 | 'view' => array( |
| 87 | 87 | 'url' => $invoice->get_view_url(), |
| 88 | - 'name' => __( 'View Invoice', 'invoicing' ), |
|
| 88 | + 'name' => __('View Invoice', 'invoicing'), |
|
| 89 | 89 | 'class' => 'btn-primary', |
| 90 | 90 | ), |
| 91 | 91 | |
| 92 | 92 | 'history' => array( |
| 93 | 93 | 'url' => wpinv_get_history_page_uri(), |
| 94 | - 'name' => __( 'Invoice History', 'invoicing' ), |
|
| 94 | + 'name' => __('Invoice History', 'invoicing'), |
|
| 95 | 95 | 'class' => 'btn-warning', |
| 96 | 96 | ), |
| 97 | 97 | |
@@ -100,12 +100,12 @@ discard block |
||
| 100 | 100 | |
| 101 | 101 | ); |
| 102 | 102 | |
| 103 | -if ( ( ! $invoice->needs_payment() || $invoice->is_held() ) && isset( $actions['pay'] ) ) { |
|
| 104 | - unset( $actions['pay'] ); |
|
| 103 | +if ((!$invoice->needs_payment() || $invoice->is_held()) && isset($actions['pay'])) { |
|
| 104 | + unset($actions['pay']); |
|
| 105 | 105 | } |
| 106 | 106 | |
| 107 | -if ( ! is_user_logged_in() && isset( $actions['history'] ) ) { |
|
| 108 | - unset( $actions['history'] ); |
|
| 107 | +if (!is_user_logged_in() && isset($actions['history'])) { |
|
| 108 | + unset($actions['history']); |
|
| 109 | 109 | } |
| 110 | 110 | |
| 111 | 111 | ?> |
@@ -114,19 +114,19 @@ discard block |
||
| 114 | 114 | |
| 115 | 115 | <?php |
| 116 | 116 | |
| 117 | - do_action( 'wpinv_receipt_start', $invoice ); |
|
| 117 | + do_action('wpinv_receipt_start', $invoice); |
|
| 118 | 118 | |
| 119 | - if ( ! empty( $actions ) ) { |
|
| 119 | + if (!empty($actions)) { |
|
| 120 | 120 | |
| 121 | 121 | echo '<div class="wpinv-receipt-actions text-right mt-1 mb-4">'; |
| 122 | 122 | |
| 123 | - foreach ( $actions as $key => $action ) { |
|
| 123 | + foreach ($actions as $key => $action) { |
|
| 124 | 124 | |
| 125 | - $key = sanitize_html_class( $key ); |
|
| 126 | - $class = empty( $action['class'] ) ? 'btn-dark' : sanitize_html_class( $action['class'] ); |
|
| 127 | - $url = empty( $action['url'] ) ? '#' : esc_url( $action['url'] ); |
|
| 128 | - $attrs = empty( $action['attrs'] ) ? '' : $action['attrs']; |
|
| 129 | - $anchor = sanitize_text_field( $action['name'] ); |
|
| 125 | + $key = sanitize_html_class($key); |
|
| 126 | + $class = empty($action['class']) ? 'btn-dark' : sanitize_html_class($action['class']); |
|
| 127 | + $url = empty($action['url']) ? '#' : esc_url($action['url']); |
|
| 128 | + $attrs = empty($action['attrs']) ? '' : $action['attrs']; |
|
| 129 | + $anchor = sanitize_text_field($action['name']); |
|
| 130 | 130 | |
| 131 | 131 | echo "<a href='$url' class='btn btn-sm ml-1 $class $key' $attrs>$anchor</a>"; |
| 132 | 132 | } |
@@ -142,20 +142,20 @@ discard block |
||
| 142 | 142 | <div class="wpinv-receipt-details"> |
| 143 | 143 | |
| 144 | 144 | <h4 class="wpinv-details-t mb-3 mt-3"> |
| 145 | - <?php echo apply_filters( 'wpinv_receipt_details_title', __( 'Invoice Details', 'invoicing' ), $invoice ); ?> |
|
| 145 | + <?php echo apply_filters('wpinv_receipt_details_title', __('Invoice Details', 'invoicing'), $invoice); ?> |
|
| 146 | 146 | </h4> |
| 147 | 147 | |
| 148 | - <?php getpaid_invoice_meta( $invoice ); ?> |
|
| 148 | + <?php getpaid_invoice_meta($invoice); ?> |
|
| 149 | 149 | |
| 150 | 150 | </div> |
| 151 | 151 | |
| 152 | 152 | |
| 153 | - <?php do_action( 'wpinv_receipt_end', $invoice ); ?> |
|
| 153 | + <?php do_action('wpinv_receipt_end', $invoice); ?> |
|
| 154 | 154 | |
| 155 | 155 | </div> |
| 156 | 156 | |
| 157 | 157 | <?php |
| 158 | 158 | |
| 159 | 159 | // @deprecated |
| 160 | -do_action( 'wpinv_success_content_after', $invoice ); |
|
| 161 | -do_action( 'wpinv_after_receipt', $invoice ); |
|
| 160 | +do_action('wpinv_success_content_after', $invoice); |
|
| 161 | +do_action('wpinv_after_receipt', $invoice); |
|
@@ -79,10 +79,10 @@ discard block |
||
| 79 | 79 | if($type=='file' ){ |
| 80 | 80 | $label_after = true; // if type file we need the label after |
| 81 | 81 | $args['class'] .= ' custom-file-input '; |
| 82 | - }elseif($type=='checkbox'){ |
|
| 82 | + } elseif($type=='checkbox'){ |
|
| 83 | 83 | $label_after = true; // if type file we need the label after |
| 84 | 84 | $args['class'] .= ' custom-control-input '; |
| 85 | - }elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 85 | + } elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 86 | 86 | $type = 'text'; |
| 87 | 87 | //$args['class'] .= ' aui-flatpickr bg-initial '; |
| 88 | 88 | $args['class'] .= ' bg-initial '; |
@@ -166,8 +166,7 @@ discard block |
||
| 166 | 166 | |
| 167 | 167 | // label |
| 168 | 168 | if(!empty($args['label'])){ |
| 169 | - if($type == 'file'){$label_args['class'] .= 'custom-file-label';} |
|
| 170 | - elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 169 | + if($type == 'file'){$label_args['class'] .= 'custom-file-label';} elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 171 | 170 | $label = self::label( $label_args, $type ); |
| 172 | 171 | } |
| 173 | 172 | |
@@ -188,7 +187,7 @@ discard block |
||
| 188 | 187 | 'content' => $output, |
| 189 | 188 | 'class' => 'form-group custom-file' |
| 190 | 189 | ) ); |
| 191 | - }elseif($type == 'checkbox'){ |
|
| 190 | + } elseif($type == 'checkbox'){ |
|
| 192 | 191 | $wrap_class = $args['switch'] ? 'custom-switch' : 'custom-checkbox'; |
| 193 | 192 | $output = self::wrap( array( |
| 194 | 193 | 'content' => $output, |
@@ -198,7 +197,7 @@ discard block |
||
| 198 | 197 | if($args['label_type']=='horizontal'){ |
| 199 | 198 | $output = '<div class="col-sm-2 col-form-label"></div><div class="col-sm-10">' . $output . '</div>'; |
| 200 | 199 | } |
| 201 | - }elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 200 | + } elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 202 | 201 | |
| 203 | 202 | |
| 204 | 203 | // allow password field to toggle view |
@@ -322,7 +321,7 @@ discard block |
||
| 322 | 321 | |
| 323 | 322 | // label |
| 324 | 323 | if(!empty($args['label']) && is_array($args['label'])){ |
| 325 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 324 | + } elseif(!empty($args['label']) && !$label_after){ |
|
| 326 | 325 | $label_args = array( |
| 327 | 326 | 'title'=> $args['label'], |
| 328 | 327 | 'for'=> $args['id'], |
@@ -357,7 +356,7 @@ discard block |
||
| 357 | 356 | |
| 358 | 357 | wp_editor( $content, $editor_id, $settings ); |
| 359 | 358 | $output .= ob_get_clean(); |
| 360 | - }else{ |
|
| 359 | + } else{ |
|
| 361 | 360 | |
| 362 | 361 | // open |
| 363 | 362 | $output .= '<textarea '; |
@@ -479,7 +478,7 @@ discard block |
||
| 479 | 478 | // maybe hide labels //@todo set a global option for visibility class |
| 480 | 479 | if($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type']) ){ |
| 481 | 480 | $class = $args['class']; |
| 482 | - }else{ |
|
| 481 | + } else{ |
|
| 483 | 482 | $class = 'sr-only '.$args['class']; |
| 484 | 483 | } |
| 485 | 484 | |
@@ -582,7 +581,7 @@ discard block |
||
| 582 | 581 | $output .= '</'.sanitize_html_class($args['type']).'>'; |
| 583 | 582 | |
| 584 | 583 | |
| 585 | - }else{ |
|
| 584 | + } else{ |
|
| 586 | 585 | $output = $args['content']; |
| 587 | 586 | } |
| 588 | 587 | |
@@ -644,7 +643,7 @@ discard block |
||
| 644 | 643 | if(!empty($args['select2'])){ |
| 645 | 644 | $args['class'] .= ' aui-select2'; |
| 646 | 645 | $is_select2 = true; |
| 647 | - }elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 646 | + } elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 648 | 647 | $is_select2 = true; |
| 649 | 648 | } |
| 650 | 649 | |
@@ -663,7 +662,7 @@ discard block |
||
| 663 | 662 | |
| 664 | 663 | // label |
| 665 | 664 | if(!empty($args['label']) && is_array($args['label'])){ |
| 666 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 665 | + } elseif(!empty($args['label']) && !$label_after){ |
|
| 667 | 666 | $label_args = array( |
| 668 | 667 | 'title'=> $args['label'], |
| 669 | 668 | 'for'=> $args['id'], |
@@ -738,7 +737,7 @@ discard block |
||
| 738 | 737 | // placeholder |
| 739 | 738 | if(!empty($args['placeholder']) && !$is_select2){ |
| 740 | 739 | $output .= '<option value="" disabled selected hidden>'.esc_attr($args['placeholder']).'</option>'; |
| 741 | - }elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 740 | + } elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 742 | 741 | $output .= "<option></option>"; // select2 needs an empty select to fill the placeholder |
| 743 | 742 | } |
| 744 | 743 | |
@@ -747,7 +746,7 @@ discard block |
||
| 747 | 746 | |
| 748 | 747 | if(!is_array($args['options'])){ |
| 749 | 748 | $output .= $args['options']; // not the preferred way but an option |
| 750 | - }else{ |
|
| 749 | + } else{ |
|
| 751 | 750 | foreach($args['options'] as $val => $name){ |
| 752 | 751 | $selected = ''; |
| 753 | 752 | if(is_array($name)){ |
@@ -766,7 +765,7 @@ discard block |
||
| 766 | 765 | |
| 767 | 766 | $output .= '<option value="' . esc_attr($option_value) . '" ' . $selected . '>' . $option_label . '</option>'; |
| 768 | 767 | } |
| 769 | - }else{ |
|
| 768 | + } else{ |
|
| 770 | 769 | if(!empty($args['value'])){ |
| 771 | 770 | if(is_array($args['value'])){ |
| 772 | 771 | $selected = in_array($val,$args['value']) ? 'selected="selected"' : ''; |
@@ -986,7 +985,7 @@ discard block |
||
| 986 | 985 | |
| 987 | 986 | // label |
| 988 | 987 | if(!empty($args['label']) && is_array($args['label'])){ |
| 989 | - }elseif(!empty($args['label'])){ |
|
| 988 | + } elseif(!empty($args['label'])){ |
|
| 990 | 989 | $output .= self::label(array('title'=>$args['label'],'for'=>$args['id'].$count,'class'=>'form-check-label'),'radio'); |
| 991 | 990 | } |
| 992 | 991 | |
@@ -1,7 +1,7 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if ( ! defined( 'ABSPATH' ) ) { |
| 4 | - exit; // Exit if accessed directly |
|
| 4 | + exit; // Exit if accessed directly |
|
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | /** |
@@ -11,1012 +11,1012 @@ discard block |
||
| 11 | 11 | */ |
| 12 | 12 | class AUI_Component_Input { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * Build the component. |
|
| 16 | - * |
|
| 17 | - * @param array $args |
|
| 18 | - * |
|
| 19 | - * @return string The rendered component. |
|
| 20 | - */ |
|
| 21 | - public static function input($args = array()){ |
|
| 22 | - $defaults = array( |
|
| 23 | - 'type' => 'text', |
|
| 24 | - 'name' => '', |
|
| 25 | - 'class' => '', |
|
| 26 | - 'wrap_class' => '', |
|
| 27 | - 'id' => '', |
|
| 28 | - 'placeholder'=> '', |
|
| 29 | - 'title' => '', |
|
| 30 | - 'value' => '', |
|
| 31 | - 'required' => false, |
|
| 32 | - 'label' => '', |
|
| 33 | - 'label_after'=> false, |
|
| 34 | - 'label_class'=> '', |
|
| 35 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 36 | - 'help_text' => '', |
|
| 37 | - 'validation_text' => '', |
|
| 38 | - 'validation_pattern' => '', |
|
| 39 | - 'no_wrap' => false, |
|
| 40 | - 'input_group_right' => '', |
|
| 41 | - 'input_group_left' => '', |
|
| 42 | - 'input_group_right_inside' => false, // forces the input group inside the input |
|
| 43 | - 'input_group_left_inside' => false, // forces the input group inside the input |
|
| 44 | - 'step' => '', |
|
| 45 | - 'switch' => false, // to show checkbox as a switch |
|
| 46 | - 'checked' => false, // set a checkbox or radio as selected |
|
| 47 | - 'password_toggle' => true, // toggle view/hide password |
|
| 48 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 49 | - 'extra_attributes' => array() // an array of extra attributes |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 54 | - */ |
|
| 55 | - $args = wp_parse_args( $args, $defaults ); |
|
| 56 | - $output = ''; |
|
| 57 | - if ( ! empty( $args['type'] ) ) { |
|
| 58 | - // hidden label option needs to be empty |
|
| 59 | - $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 60 | - |
|
| 61 | - $type = sanitize_html_class( $args['type'] ); |
|
| 62 | - |
|
| 63 | - $help_text = ''; |
|
| 64 | - $label = ''; |
|
| 65 | - $label_after = $args['label_after']; |
|
| 66 | - $label_args = array( |
|
| 67 | - 'title'=> $args['label'], |
|
| 68 | - 'for'=> $args['id'], |
|
| 69 | - 'class' => $args['label_class']." ", |
|
| 70 | - 'label_type' => $args['label_type'] |
|
| 71 | - ); |
|
| 72 | - |
|
| 73 | - // floating labels need label after |
|
| 74 | - if( $args['label_type'] == 'floating' && $type != 'checkbox' ){ |
|
| 75 | - $label_after = true; |
|
| 76 | - $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - // Some special sauce for files |
|
| 80 | - if($type=='file' ){ |
|
| 81 | - $label_after = true; // if type file we need the label after |
|
| 82 | - $args['class'] .= ' custom-file-input '; |
|
| 83 | - }elseif($type=='checkbox'){ |
|
| 84 | - $label_after = true; // if type file we need the label after |
|
| 85 | - $args['class'] .= ' custom-control-input '; |
|
| 86 | - }elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 87 | - $type = 'text'; |
|
| 88 | - //$args['class'] .= ' aui-flatpickr bg-initial '; |
|
| 89 | - $args['class'] .= ' bg-initial '; |
|
| 90 | - |
|
| 91 | - $args['extra_attributes']['data-aui-init'] = 'flatpickr'; |
|
| 92 | - // enqueue the script |
|
| 93 | - $aui_settings = AyeCode_UI_Settings::instance(); |
|
| 94 | - $aui_settings->enqueue_flatpickr(); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - |
|
| 98 | - // open/type |
|
| 99 | - $output .= '<input type="' . $type . '" '; |
|
| 100 | - |
|
| 101 | - // name |
|
| 102 | - if(!empty($args['name'])){ |
|
| 103 | - $output .= ' name="'.esc_attr($args['name']).'" '; |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - // id |
|
| 107 | - if(!empty($args['id'])){ |
|
| 108 | - $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - // placeholder |
|
| 112 | - if(!empty($args['placeholder'])){ |
|
| 113 | - $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - // title |
|
| 117 | - if(!empty($args['title'])){ |
|
| 118 | - $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - // value |
|
| 122 | - if(!empty($args['value'])){ |
|
| 123 | - $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - // checked, for radio and checkboxes |
|
| 127 | - if( ( $type == 'checkbox' || $type == 'radio' ) && $args['checked'] ){ |
|
| 128 | - $output .= ' checked '; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - // validation text |
|
| 132 | - if(!empty($args['validation_text'])){ |
|
| 133 | - $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 134 | - $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - // validation_pattern |
|
| 138 | - if(!empty($args['validation_pattern'])){ |
|
| 139 | - $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - // step (for numbers) |
|
| 143 | - if(!empty($args['step'])){ |
|
| 144 | - $output .= ' step="'.$args['step'].'" '; |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - // required |
|
| 148 | - if(!empty($args['required'])){ |
|
| 149 | - $output .= ' required '; |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - // class |
|
| 153 | - $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 154 | - $output .= ' class="form-control '.$class.'" '; |
|
| 155 | - |
|
| 156 | - // data-attributes |
|
| 157 | - $output .= AUI_Component_Helper::data_attributes($args); |
|
| 158 | - |
|
| 159 | - // extra attributes |
|
| 160 | - if(!empty($args['extra_attributes'])){ |
|
| 161 | - $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - // close |
|
| 165 | - $output .= ' >'; |
|
| 166 | - |
|
| 167 | - |
|
| 168 | - // label |
|
| 169 | - if(!empty($args['label'])){ |
|
| 170 | - if($type == 'file'){$label_args['class'] .= 'custom-file-label';} |
|
| 171 | - elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 172 | - $label = self::label( $label_args, $type ); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - // help text |
|
| 176 | - if(!empty($args['help_text'])){ |
|
| 177 | - $help_text = AUI_Component_Helper::help_text($args['help_text']); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - |
|
| 181 | - // set help text in the correct possition |
|
| 182 | - if($label_after){ |
|
| 183 | - $output .= $label . $help_text; |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - // some input types need a separate wrap |
|
| 187 | - if($type == 'file') { |
|
| 188 | - $output = self::wrap( array( |
|
| 189 | - 'content' => $output, |
|
| 190 | - 'class' => 'form-group custom-file' |
|
| 191 | - ) ); |
|
| 192 | - }elseif($type == 'checkbox'){ |
|
| 193 | - $wrap_class = $args['switch'] ? 'custom-switch' : 'custom-checkbox'; |
|
| 194 | - $output = self::wrap( array( |
|
| 195 | - 'content' => $output, |
|
| 196 | - 'class' => 'custom-control '.$wrap_class |
|
| 197 | - ) ); |
|
| 198 | - |
|
| 199 | - if($args['label_type']=='horizontal'){ |
|
| 200 | - $output = '<div class="col-sm-2 col-form-label"></div><div class="col-sm-10">' . $output . '</div>'; |
|
| 201 | - } |
|
| 202 | - }elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - // allow password field to toggle view |
|
| 206 | - $args['input_group_right'] = '<span class="input-group-text c-pointer px-3" |
|
| 14 | + /** |
|
| 15 | + * Build the component. |
|
| 16 | + * |
|
| 17 | + * @param array $args |
|
| 18 | + * |
|
| 19 | + * @return string The rendered component. |
|
| 20 | + */ |
|
| 21 | + public static function input($args = array()){ |
|
| 22 | + $defaults = array( |
|
| 23 | + 'type' => 'text', |
|
| 24 | + 'name' => '', |
|
| 25 | + 'class' => '', |
|
| 26 | + 'wrap_class' => '', |
|
| 27 | + 'id' => '', |
|
| 28 | + 'placeholder'=> '', |
|
| 29 | + 'title' => '', |
|
| 30 | + 'value' => '', |
|
| 31 | + 'required' => false, |
|
| 32 | + 'label' => '', |
|
| 33 | + 'label_after'=> false, |
|
| 34 | + 'label_class'=> '', |
|
| 35 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 36 | + 'help_text' => '', |
|
| 37 | + 'validation_text' => '', |
|
| 38 | + 'validation_pattern' => '', |
|
| 39 | + 'no_wrap' => false, |
|
| 40 | + 'input_group_right' => '', |
|
| 41 | + 'input_group_left' => '', |
|
| 42 | + 'input_group_right_inside' => false, // forces the input group inside the input |
|
| 43 | + 'input_group_left_inside' => false, // forces the input group inside the input |
|
| 44 | + 'step' => '', |
|
| 45 | + 'switch' => false, // to show checkbox as a switch |
|
| 46 | + 'checked' => false, // set a checkbox or radio as selected |
|
| 47 | + 'password_toggle' => true, // toggle view/hide password |
|
| 48 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 49 | + 'extra_attributes' => array() // an array of extra attributes |
|
| 50 | + ); |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 54 | + */ |
|
| 55 | + $args = wp_parse_args( $args, $defaults ); |
|
| 56 | + $output = ''; |
|
| 57 | + if ( ! empty( $args['type'] ) ) { |
|
| 58 | + // hidden label option needs to be empty |
|
| 59 | + $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 60 | + |
|
| 61 | + $type = sanitize_html_class( $args['type'] ); |
|
| 62 | + |
|
| 63 | + $help_text = ''; |
|
| 64 | + $label = ''; |
|
| 65 | + $label_after = $args['label_after']; |
|
| 66 | + $label_args = array( |
|
| 67 | + 'title'=> $args['label'], |
|
| 68 | + 'for'=> $args['id'], |
|
| 69 | + 'class' => $args['label_class']." ", |
|
| 70 | + 'label_type' => $args['label_type'] |
|
| 71 | + ); |
|
| 72 | + |
|
| 73 | + // floating labels need label after |
|
| 74 | + if( $args['label_type'] == 'floating' && $type != 'checkbox' ){ |
|
| 75 | + $label_after = true; |
|
| 76 | + $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + // Some special sauce for files |
|
| 80 | + if($type=='file' ){ |
|
| 81 | + $label_after = true; // if type file we need the label after |
|
| 82 | + $args['class'] .= ' custom-file-input '; |
|
| 83 | + }elseif($type=='checkbox'){ |
|
| 84 | + $label_after = true; // if type file we need the label after |
|
| 85 | + $args['class'] .= ' custom-control-input '; |
|
| 86 | + }elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 87 | + $type = 'text'; |
|
| 88 | + //$args['class'] .= ' aui-flatpickr bg-initial '; |
|
| 89 | + $args['class'] .= ' bg-initial '; |
|
| 90 | + |
|
| 91 | + $args['extra_attributes']['data-aui-init'] = 'flatpickr'; |
|
| 92 | + // enqueue the script |
|
| 93 | + $aui_settings = AyeCode_UI_Settings::instance(); |
|
| 94 | + $aui_settings->enqueue_flatpickr(); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + |
|
| 98 | + // open/type |
|
| 99 | + $output .= '<input type="' . $type . '" '; |
|
| 100 | + |
|
| 101 | + // name |
|
| 102 | + if(!empty($args['name'])){ |
|
| 103 | + $output .= ' name="'.esc_attr($args['name']).'" '; |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + // id |
|
| 107 | + if(!empty($args['id'])){ |
|
| 108 | + $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + // placeholder |
|
| 112 | + if(!empty($args['placeholder'])){ |
|
| 113 | + $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + // title |
|
| 117 | + if(!empty($args['title'])){ |
|
| 118 | + $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + // value |
|
| 122 | + if(!empty($args['value'])){ |
|
| 123 | + $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + // checked, for radio and checkboxes |
|
| 127 | + if( ( $type == 'checkbox' || $type == 'radio' ) && $args['checked'] ){ |
|
| 128 | + $output .= ' checked '; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + // validation text |
|
| 132 | + if(!empty($args['validation_text'])){ |
|
| 133 | + $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 134 | + $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + // validation_pattern |
|
| 138 | + if(!empty($args['validation_pattern'])){ |
|
| 139 | + $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + // step (for numbers) |
|
| 143 | + if(!empty($args['step'])){ |
|
| 144 | + $output .= ' step="'.$args['step'].'" '; |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + // required |
|
| 148 | + if(!empty($args['required'])){ |
|
| 149 | + $output .= ' required '; |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + // class |
|
| 153 | + $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 154 | + $output .= ' class="form-control '.$class.'" '; |
|
| 155 | + |
|
| 156 | + // data-attributes |
|
| 157 | + $output .= AUI_Component_Helper::data_attributes($args); |
|
| 158 | + |
|
| 159 | + // extra attributes |
|
| 160 | + if(!empty($args['extra_attributes'])){ |
|
| 161 | + $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + // close |
|
| 165 | + $output .= ' >'; |
|
| 166 | + |
|
| 167 | + |
|
| 168 | + // label |
|
| 169 | + if(!empty($args['label'])){ |
|
| 170 | + if($type == 'file'){$label_args['class'] .= 'custom-file-label';} |
|
| 171 | + elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 172 | + $label = self::label( $label_args, $type ); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + // help text |
|
| 176 | + if(!empty($args['help_text'])){ |
|
| 177 | + $help_text = AUI_Component_Helper::help_text($args['help_text']); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + |
|
| 181 | + // set help text in the correct possition |
|
| 182 | + if($label_after){ |
|
| 183 | + $output .= $label . $help_text; |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + // some input types need a separate wrap |
|
| 187 | + if($type == 'file') { |
|
| 188 | + $output = self::wrap( array( |
|
| 189 | + 'content' => $output, |
|
| 190 | + 'class' => 'form-group custom-file' |
|
| 191 | + ) ); |
|
| 192 | + }elseif($type == 'checkbox'){ |
|
| 193 | + $wrap_class = $args['switch'] ? 'custom-switch' : 'custom-checkbox'; |
|
| 194 | + $output = self::wrap( array( |
|
| 195 | + 'content' => $output, |
|
| 196 | + 'class' => 'custom-control '.$wrap_class |
|
| 197 | + ) ); |
|
| 198 | + |
|
| 199 | + if($args['label_type']=='horizontal'){ |
|
| 200 | + $output = '<div class="col-sm-2 col-form-label"></div><div class="col-sm-10">' . $output . '</div>'; |
|
| 201 | + } |
|
| 202 | + }elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + // allow password field to toggle view |
|
| 206 | + $args['input_group_right'] = '<span class="input-group-text c-pointer px-3" |
|
| 207 | 207 | onclick="var $el = jQuery(this).find(\'i\');$el.toggleClass(\'fa-eye fa-eye-slash\'); |
| 208 | 208 | var $eli = jQuery(this).parent().parent().find(\'input\'); |
| 209 | 209 | if($el.hasClass(\'fa-eye\')) |
| 210 | 210 | {$eli.attr(\'type\',\'text\');} |
| 211 | 211 | else{$eli.attr(\'type\',\'password\');}" |
| 212 | 212 | ><i class="far fa-fw fa-eye-slash"></i></span>'; |
| 213 | - } |
|
| 214 | - |
|
| 215 | - // input group wraps |
|
| 216 | - if($args['input_group_left'] || $args['input_group_right']){ |
|
| 217 | - $w100 = strpos($args['class'], 'w-100') !== false ? ' w-100' : ''; |
|
| 218 | - if($args['input_group_left']){ |
|
| 219 | - $output = self::wrap( array( |
|
| 220 | - 'content' => $output, |
|
| 221 | - 'class' => $args['input_group_left_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 222 | - 'input_group_left' => $args['input_group_left'], |
|
| 223 | - 'input_group_left_inside' => $args['input_group_left_inside'] |
|
| 224 | - ) ); |
|
| 225 | - } |
|
| 226 | - if($args['input_group_right']){ |
|
| 227 | - $output = self::wrap( array( |
|
| 228 | - 'content' => $output, |
|
| 229 | - 'class' => $args['input_group_right_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 230 | - 'input_group_right' => $args['input_group_right'], |
|
| 231 | - 'input_group_right_inside' => $args['input_group_right_inside'] |
|
| 232 | - ) ); |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - if(!$label_after){ |
|
| 238 | - $output .= $help_text; |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 243 | - $output = self::wrap( array( |
|
| 244 | - 'content' => $output, |
|
| 245 | - 'class' => 'col-sm-10', |
|
| 246 | - ) ); |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - if(!$label_after){ |
|
| 250 | - $output = $label . $output; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - // wrap |
|
| 254 | - if(!$args['no_wrap']){ |
|
| 255 | - |
|
| 256 | - $form_group_class = $args['label_type']=='floating' && $type != 'checkbox' ? 'form-label-group' : 'form-group'; |
|
| 257 | - $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 258 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 259 | - $output = self::wrap(array( |
|
| 260 | - 'content' => $output, |
|
| 261 | - 'class' => $wrap_class, |
|
| 262 | - 'element_require' => $args['element_require'], |
|
| 263 | - 'argument_id' => $args['id'] |
|
| 264 | - )); |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - return $output; |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * Build the component. |
|
| 276 | - * |
|
| 277 | - * @param array $args |
|
| 278 | - * |
|
| 279 | - * @return string The rendered component. |
|
| 280 | - */ |
|
| 281 | - public static function textarea($args = array()){ |
|
| 282 | - $defaults = array( |
|
| 283 | - 'name' => '', |
|
| 284 | - 'class' => '', |
|
| 285 | - 'wrap_class' => '', |
|
| 286 | - 'id' => '', |
|
| 287 | - 'placeholder'=> '', |
|
| 288 | - 'title' => '', |
|
| 289 | - 'value' => '', |
|
| 290 | - 'required' => false, |
|
| 291 | - 'label' => '', |
|
| 292 | - 'label_after'=> false, |
|
| 293 | - 'label_class' => '', |
|
| 294 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 295 | - 'help_text' => '', |
|
| 296 | - 'validation_text' => '', |
|
| 297 | - 'validation_pattern' => '', |
|
| 298 | - 'no_wrap' => false, |
|
| 299 | - 'rows' => '', |
|
| 300 | - 'wysiwyg' => false, |
|
| 301 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 302 | - ); |
|
| 303 | - |
|
| 304 | - /** |
|
| 305 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 306 | - */ |
|
| 307 | - $args = wp_parse_args( $args, $defaults ); |
|
| 308 | - $output = ''; |
|
| 309 | - |
|
| 310 | - // hidden label option needs to be empty |
|
| 311 | - $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 312 | - |
|
| 313 | - // floating labels don't work with wysiwyg so set it as top |
|
| 314 | - if($args['label_type'] == 'floating' && !empty($args['wysiwyg'])){ |
|
| 315 | - $args['label_type'] = 'top'; |
|
| 316 | - } |
|
| 317 | - |
|
| 318 | - $label_after = $args['label_after']; |
|
| 319 | - |
|
| 320 | - // floating labels need label after |
|
| 321 | - if( $args['label_type'] == 'floating' && empty($args['wysiwyg']) ){ |
|
| 322 | - $label_after = true; |
|
| 323 | - $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - // label |
|
| 327 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 328 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 329 | - $label_args = array( |
|
| 330 | - 'title'=> $args['label'], |
|
| 331 | - 'for'=> $args['id'], |
|
| 332 | - 'class' => $args['label_class']." ", |
|
| 333 | - 'label_type' => $args['label_type'] |
|
| 334 | - ); |
|
| 335 | - $output .= self::label( $label_args ); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - // maybe horizontal label |
|
| 339 | - if($args['label_type']=='horizontal'){ |
|
| 340 | - $output .= '<div class="col-sm-10">'; |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - if(!empty($args['wysiwyg'])){ |
|
| 344 | - ob_start(); |
|
| 345 | - $content = $args['value']; |
|
| 346 | - $editor_id = !empty($args['id']) ? sanitize_html_class($args['id']) : 'wp_editor'; |
|
| 347 | - $settings = array( |
|
| 348 | - 'textarea_rows' => !empty(absint($args['rows'])) ? absint($args['rows']) : 4, |
|
| 349 | - 'quicktags' => false, |
|
| 350 | - 'media_buttons' => false, |
|
| 351 | - 'editor_class' => 'form-control', |
|
| 352 | - 'textarea_name' => !empty($args['name']) ? sanitize_html_class($args['name']) : sanitize_html_class($args['id']), |
|
| 353 | - 'teeny' => true, |
|
| 354 | - ); |
|
| 355 | - |
|
| 356 | - // maybe set settings if array |
|
| 357 | - if(is_array($args['wysiwyg'])){ |
|
| 358 | - $settings = wp_parse_args( $args['wysiwyg'], $settings ); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - wp_editor( $content, $editor_id, $settings ); |
|
| 362 | - $output .= ob_get_clean(); |
|
| 363 | - }else{ |
|
| 364 | - |
|
| 365 | - // open |
|
| 366 | - $output .= '<textarea '; |
|
| 367 | - |
|
| 368 | - // name |
|
| 369 | - if(!empty($args['name'])){ |
|
| 370 | - $output .= ' name="'.sanitize_html_class($args['name']).'" '; |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - // id |
|
| 374 | - if(!empty($args['id'])){ |
|
| 375 | - $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - // placeholder |
|
| 379 | - if(!empty($args['placeholder'])){ |
|
| 380 | - $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - // title |
|
| 384 | - if(!empty($args['title'])){ |
|
| 385 | - $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 386 | - } |
|
| 387 | - |
|
| 388 | - // validation text |
|
| 389 | - if(!empty($args['validation_text'])){ |
|
| 390 | - $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 391 | - $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 392 | - } |
|
| 393 | - |
|
| 394 | - // validation_pattern |
|
| 395 | - if(!empty($args['validation_pattern'])){ |
|
| 396 | - $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - // required |
|
| 400 | - if(!empty($args['required'])){ |
|
| 401 | - $output .= ' required '; |
|
| 402 | - } |
|
| 403 | - |
|
| 404 | - // rows |
|
| 405 | - if(!empty($args['rows'])){ |
|
| 406 | - $output .= ' rows="'.absint($args['rows']).'" '; |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - |
|
| 410 | - // class |
|
| 411 | - $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 412 | - $output .= ' class="form-control '.$class.'" '; |
|
| 413 | - |
|
| 414 | - |
|
| 415 | - // close tag |
|
| 416 | - $output .= ' >'; |
|
| 417 | - |
|
| 418 | - // value |
|
| 419 | - if(!empty($args['value'])){ |
|
| 420 | - $output .= sanitize_textarea_field($args['value']); |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - // closing tag |
|
| 424 | - $output .= '</textarea>'; |
|
| 425 | - |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - if(!empty($args['label']) && $label_after){ |
|
| 429 | - $label_args = array( |
|
| 430 | - 'title'=> $args['label'], |
|
| 431 | - 'for'=> $args['id'], |
|
| 432 | - 'class' => $args['label_class']." ", |
|
| 433 | - 'label_type' => $args['label_type'] |
|
| 434 | - ); |
|
| 435 | - $output .= self::label( $label_args ); |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - // help text |
|
| 439 | - if(!empty($args['help_text'])){ |
|
| 440 | - $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 441 | - } |
|
| 442 | - |
|
| 443 | - // maybe horizontal label |
|
| 444 | - if($args['label_type']=='horizontal'){ |
|
| 445 | - $output .= '</div>'; |
|
| 446 | - } |
|
| 447 | - |
|
| 448 | - |
|
| 449 | - // wrap |
|
| 450 | - if(!$args['no_wrap']){ |
|
| 451 | - $form_group_class = $args['label_type']=='floating' ? 'form-label-group' : 'form-group'; |
|
| 452 | - $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 453 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 454 | - $output = self::wrap(array( |
|
| 455 | - 'content' => $output, |
|
| 456 | - 'class' => $wrap_class, |
|
| 457 | - 'element_require' => $args['element_require'], |
|
| 458 | - 'argument_id' => $args['id'] |
|
| 459 | - )); |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - |
|
| 463 | - return $output; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - public static function label($args = array(), $type = ''){ |
|
| 467 | - //<label for="exampleInputEmail1">Email address</label> |
|
| 468 | - $defaults = array( |
|
| 469 | - 'title' => 'div', |
|
| 470 | - 'for' => '', |
|
| 471 | - 'class' => '', |
|
| 472 | - 'label_type' => '', // empty = hidden, top, horizontal |
|
| 473 | - ); |
|
| 474 | - |
|
| 475 | - /** |
|
| 476 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 477 | - */ |
|
| 478 | - $args = wp_parse_args( $args, $defaults ); |
|
| 479 | - $output = ''; |
|
| 480 | - |
|
| 481 | - if($args['title']){ |
|
| 482 | - |
|
| 483 | - // maybe hide labels //@todo set a global option for visibility class |
|
| 484 | - if($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type']) ){ |
|
| 485 | - $class = $args['class']; |
|
| 486 | - }else{ |
|
| 487 | - $class = 'sr-only '.$args['class']; |
|
| 488 | - } |
|
| 489 | - |
|
| 490 | - // maybe horizontal |
|
| 491 | - if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 492 | - $class .= ' col-sm-2 col-form-label'; |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - // open |
|
| 496 | - $output .= '<label '; |
|
| 497 | - |
|
| 498 | - // for |
|
| 499 | - if(!empty($args['for'])){ |
|
| 500 | - $output .= ' for="'.sanitize_text_field($args['for']).'" '; |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - // class |
|
| 504 | - $class = $class ? AUI_Component_Helper::esc_classes( $class ) : ''; |
|
| 505 | - $output .= ' class="'.$class.'" '; |
|
| 506 | - |
|
| 507 | - // close |
|
| 508 | - $output .= '>'; |
|
| 509 | - |
|
| 510 | - |
|
| 511 | - // title, don't escape fully as can contain html |
|
| 512 | - if(!empty($args['title'])){ |
|
| 513 | - $output .= wp_kses_post($args['title']); |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - // close wrap |
|
| 517 | - $output .= '</label>'; |
|
| 518 | - |
|
| 519 | - |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - |
|
| 523 | - return $output; |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - /** |
|
| 527 | - * Wrap some content in a HTML wrapper. |
|
| 528 | - * |
|
| 529 | - * @param array $args |
|
| 530 | - * |
|
| 531 | - * @return string |
|
| 532 | - */ |
|
| 533 | - public static function wrap($args = array()){ |
|
| 534 | - $defaults = array( |
|
| 535 | - 'type' => 'div', |
|
| 536 | - 'class' => 'form-group', |
|
| 537 | - 'content' => '', |
|
| 538 | - 'input_group_left' => '', |
|
| 539 | - 'input_group_right' => '', |
|
| 540 | - 'input_group_left_inside' => false, |
|
| 541 | - 'input_group_right_inside' => false, |
|
| 542 | - 'element_require' => '', |
|
| 543 | - 'argument_id' => '', |
|
| 544 | - ); |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 548 | - */ |
|
| 549 | - $args = wp_parse_args( $args, $defaults ); |
|
| 550 | - $output = ''; |
|
| 551 | - if($args['type']){ |
|
| 552 | - |
|
| 553 | - // open |
|
| 554 | - $output .= '<'.sanitize_html_class($args['type']); |
|
| 555 | - |
|
| 556 | - // element require |
|
| 557 | - if(!empty($args['element_require'])){ |
|
| 558 | - $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 559 | - $args['class'] .= " aui-conditional-field"; |
|
| 560 | - } |
|
| 561 | - |
|
| 562 | - // argument_id |
|
| 563 | - if( !empty($args['argument_id']) ){ |
|
| 564 | - $output .= ' data-argument="'.esc_attr($args['argument_id']).'"'; |
|
| 565 | - } |
|
| 566 | - |
|
| 567 | - // class |
|
| 568 | - $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 569 | - $output .= ' class="'.$class.'" '; |
|
| 570 | - |
|
| 571 | - // close wrap |
|
| 572 | - $output .= ' >'; |
|
| 573 | - |
|
| 574 | - |
|
| 575 | - // Input group left |
|
| 576 | - if(!empty($args['input_group_left'])){ |
|
| 577 | - $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 578 | - $input_group_left = strpos($args['input_group_left'], '<') !== false ? $args['input_group_left'] : '<span class="input-group-text">'.$args['input_group_left'].'</span>'; |
|
| 579 | - $output .= '<div class="input-group-prepend '.$position_class.'">'.$input_group_left.'</div>'; |
|
| 580 | - } |
|
| 581 | - |
|
| 582 | - // content |
|
| 583 | - $output .= $args['content']; |
|
| 584 | - |
|
| 585 | - // Input group right |
|
| 586 | - if(!empty($args['input_group_right'])){ |
|
| 587 | - $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 588 | - $input_group_right = strpos($args['input_group_right'], '<') !== false ? $args['input_group_right'] : '<span class="input-group-text">'.$args['input_group_right'].'</span>'; |
|
| 589 | - $output .= '<div class="input-group-append '.$position_class.'">'.$input_group_right.'</div>'; |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - |
|
| 593 | - // close wrap |
|
| 594 | - $output .= '</'.sanitize_html_class($args['type']).'>'; |
|
| 595 | - |
|
| 596 | - |
|
| 597 | - }else{ |
|
| 598 | - $output = $args['content']; |
|
| 599 | - } |
|
| 600 | - |
|
| 601 | - return $output; |
|
| 602 | - } |
|
| 603 | - |
|
| 604 | - /** |
|
| 605 | - * Build the component. |
|
| 606 | - * |
|
| 607 | - * @param array $args |
|
| 608 | - * |
|
| 609 | - * @return string The rendered component. |
|
| 610 | - */ |
|
| 611 | - public static function select($args = array()){ |
|
| 612 | - $defaults = array( |
|
| 613 | - 'class' => '', |
|
| 614 | - 'wrap_class' => '', |
|
| 615 | - 'id' => '', |
|
| 616 | - 'title' => '', |
|
| 617 | - 'value' => '', // can be an array or a string |
|
| 618 | - 'required' => false, |
|
| 619 | - 'label' => '', |
|
| 620 | - 'label_after'=> false, |
|
| 621 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 622 | - 'label_class' => '', |
|
| 623 | - 'help_text' => '', |
|
| 624 | - 'placeholder'=> '', |
|
| 625 | - 'options' => array(), // array or string |
|
| 626 | - 'icon' => '', |
|
| 627 | - 'multiple' => false, |
|
| 628 | - 'select2' => false, |
|
| 629 | - 'no_wrap' => false, |
|
| 630 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 631 | - 'extra_attributes' => array(), // an array of extra attributes |
|
| 632 | - ); |
|
| 633 | - |
|
| 634 | - /** |
|
| 635 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 636 | - */ |
|
| 637 | - $args = wp_parse_args( $args, $defaults ); |
|
| 638 | - $output = ''; |
|
| 639 | - |
|
| 640 | - // for now lets hide floating labels |
|
| 641 | - if( $args['label_type'] == 'floating' ){$args['label_type'] = 'hidden';} |
|
| 642 | - |
|
| 643 | - // hidden label option needs to be empty |
|
| 644 | - $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 645 | - |
|
| 646 | - |
|
| 647 | - $label_after = $args['label_after']; |
|
| 648 | - |
|
| 649 | - // floating labels need label after |
|
| 650 | - if( $args['label_type'] == 'floating' ){ |
|
| 651 | - $label_after = true; |
|
| 652 | - $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - // Maybe setup select2 |
|
| 656 | - $is_select2 = false; |
|
| 657 | - if(!empty($args['select2'])){ |
|
| 658 | - $args['class'] .= ' aui-select2'; |
|
| 659 | - $is_select2 = true; |
|
| 660 | - }elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 661 | - $is_select2 = true; |
|
| 662 | - } |
|
| 663 | - |
|
| 664 | - // select2 tags |
|
| 665 | - if( !empty($args['select2']) && $args['select2'] === 'tags'){ // triple equals needed here for some reason |
|
| 666 | - $args['data-tags'] = 'true'; |
|
| 667 | - $args['data-token-separators'] = "[',']"; |
|
| 668 | - $args['multiple'] = true; |
|
| 669 | - } |
|
| 670 | - |
|
| 671 | - // select2 placeholder |
|
| 672 | - if($is_select2 && !empty($args['placeholder']) && empty($args['data-placeholder'])){ |
|
| 673 | - $args['data-placeholder'] = esc_attr($args['placeholder']); |
|
| 674 | - $args['data-allow-clear'] = empty($args['data-allow-clear']) ? true : esc_attr($args['data-allow-clear']); |
|
| 675 | - } |
|
| 676 | - |
|
| 677 | - // label |
|
| 678 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 679 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 680 | - $label_args = array( |
|
| 681 | - 'title'=> $args['label'], |
|
| 682 | - 'for'=> $args['id'], |
|
| 683 | - 'class' => $args['label_class']." ", |
|
| 684 | - 'label_type' => $args['label_type'] |
|
| 685 | - ); |
|
| 686 | - $output .= self::label($label_args); |
|
| 687 | - } |
|
| 688 | - |
|
| 689 | - // maybe horizontal label |
|
| 690 | - if($args['label_type']=='horizontal'){ |
|
| 691 | - $output .= '<div class="col-sm-10">'; |
|
| 692 | - } |
|
| 693 | - |
|
| 694 | - // open/type |
|
| 695 | - $output .= '<select '; |
|
| 696 | - |
|
| 697 | - // style |
|
| 698 | - if($is_select2){ |
|
| 699 | - $output .= " style='width:100%;' "; |
|
| 700 | - } |
|
| 701 | - |
|
| 702 | - // element require |
|
| 703 | - if(!empty($args['element_require'])){ |
|
| 704 | - $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 705 | - $args['class'] .= " aui-conditional-field"; |
|
| 706 | - } |
|
| 707 | - |
|
| 708 | - // class |
|
| 709 | - $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 710 | - $output .= AUI_Component_Helper::class_attr('custom-select '.$class); |
|
| 711 | - |
|
| 712 | - // name |
|
| 713 | - if(!empty($args['name'])){ |
|
| 714 | - $output .= AUI_Component_Helper::name($args['name'],$args['multiple']); |
|
| 715 | - } |
|
| 716 | - |
|
| 717 | - // id |
|
| 718 | - if(!empty($args['id'])){ |
|
| 719 | - $output .= AUI_Component_Helper::id($args['id']); |
|
| 720 | - } |
|
| 721 | - |
|
| 722 | - // title |
|
| 723 | - if(!empty($args['title'])){ |
|
| 724 | - $output .= AUI_Component_Helper::title($args['title']); |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - // data-attributes |
|
| 728 | - $output .= AUI_Component_Helper::data_attributes($args); |
|
| 729 | - |
|
| 730 | - // aria-attributes |
|
| 731 | - $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 732 | - |
|
| 733 | - // extra attributes |
|
| 734 | - if(!empty($args['extra_attributes'])){ |
|
| 735 | - $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 736 | - } |
|
| 737 | - |
|
| 738 | - // required |
|
| 739 | - if(!empty($args['required'])){ |
|
| 740 | - $output .= ' required '; |
|
| 741 | - } |
|
| 742 | - |
|
| 743 | - // multiple |
|
| 744 | - if(!empty($args['multiple'])){ |
|
| 745 | - $output .= ' multiple '; |
|
| 746 | - } |
|
| 747 | - |
|
| 748 | - // close opening tag |
|
| 749 | - $output .= ' >'; |
|
| 750 | - |
|
| 751 | - // placeholder |
|
| 752 | - if(!empty($args['placeholder']) && !$is_select2){ |
|
| 753 | - $output .= '<option value="" disabled selected hidden>'.esc_attr($args['placeholder']).'</option>'; |
|
| 754 | - }elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 755 | - $output .= "<option></option>"; // select2 needs an empty select to fill the placeholder |
|
| 756 | - } |
|
| 757 | - |
|
| 758 | - // Options |
|
| 759 | - if(!empty($args['options'])){ |
|
| 760 | - |
|
| 761 | - if(!is_array($args['options'])){ |
|
| 762 | - $output .= $args['options']; // not the preferred way but an option |
|
| 763 | - }else{ |
|
| 764 | - foreach($args['options'] as $val => $name){ |
|
| 765 | - $selected = ''; |
|
| 766 | - if(is_array($name)){ |
|
| 767 | - if (isset($name['optgroup']) && ($name['optgroup'] == 'start' || $name['optgroup'] == 'end')) { |
|
| 768 | - $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 769 | - |
|
| 770 | - $output .= $name['optgroup'] == 'start' ? '<optgroup label="' . esc_attr($option_label) . '">' : '</optgroup>'; |
|
| 771 | - } else { |
|
| 772 | - $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 773 | - $option_value = isset($name['value']) ? $name['value'] : ''; |
|
| 774 | - if(!empty($args['multiple']) && !empty($args['value']) && is_array($args['value']) ){ |
|
| 775 | - $selected = in_array($option_value, stripslashes_deep($args['value'])) ? "selected" : ""; |
|
| 776 | - } elseif(!empty($args['value'])) { |
|
| 777 | - $selected = selected($option_value,stripslashes_deep($args['value']), false); |
|
| 778 | - } |
|
| 779 | - |
|
| 780 | - $output .= '<option value="' . esc_attr($option_value) . '" ' . $selected . '>' . $option_label . '</option>'; |
|
| 781 | - } |
|
| 782 | - }else{ |
|
| 783 | - if(!empty($args['value'])){ |
|
| 784 | - if(is_array($args['value'])){ |
|
| 785 | - $selected = in_array($val,$args['value']) ? 'selected="selected"' : ''; |
|
| 786 | - } elseif(!empty($args['value'])) { |
|
| 787 | - $selected = selected( $args['value'], $val, false); |
|
| 788 | - } |
|
| 789 | - } |
|
| 790 | - $output .= '<option value="'.esc_attr($val).'" '.$selected.'>'.esc_attr($name).'</option>'; |
|
| 791 | - } |
|
| 792 | - } |
|
| 793 | - } |
|
| 794 | - |
|
| 795 | - } |
|
| 796 | - |
|
| 797 | - // closing tag |
|
| 798 | - $output .= '</select>'; |
|
| 799 | - |
|
| 800 | - if(!empty($args['label']) && $label_after){ |
|
| 801 | - $label_args = array( |
|
| 802 | - 'title'=> $args['label'], |
|
| 803 | - 'for'=> $args['id'], |
|
| 804 | - 'class' => $args['label_class']." ", |
|
| 805 | - 'label_type' => $args['label_type'] |
|
| 806 | - ); |
|
| 807 | - $output .= self::label($label_args); |
|
| 808 | - } |
|
| 809 | - |
|
| 810 | - // help text |
|
| 811 | - if(!empty($args['help_text'])){ |
|
| 812 | - $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 813 | - } |
|
| 814 | - |
|
| 815 | - // maybe horizontal label |
|
| 816 | - if($args['label_type']=='horizontal'){ |
|
| 817 | - $output .= '</div>'; |
|
| 818 | - } |
|
| 819 | - |
|
| 820 | - |
|
| 821 | - // wrap |
|
| 822 | - if(!$args['no_wrap']){ |
|
| 823 | - $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 824 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 825 | - $output = self::wrap(array( |
|
| 826 | - 'content' => $output, |
|
| 827 | - 'class' => $wrap_class, |
|
| 828 | - 'element_require' => $args['element_require'], |
|
| 829 | - 'argument_id' => $args['id'] |
|
| 830 | - )); |
|
| 831 | - } |
|
| 832 | - |
|
| 833 | - |
|
| 834 | - return $output; |
|
| 835 | - } |
|
| 836 | - |
|
| 837 | - /** |
|
| 838 | - * Build the component. |
|
| 839 | - * |
|
| 840 | - * @param array $args |
|
| 841 | - * |
|
| 842 | - * @return string The rendered component. |
|
| 843 | - */ |
|
| 844 | - public static function radio($args = array()){ |
|
| 845 | - $defaults = array( |
|
| 846 | - 'class' => '', |
|
| 847 | - 'wrap_class' => '', |
|
| 848 | - 'id' => '', |
|
| 849 | - 'title' => '', |
|
| 850 | - 'horizontal' => false, // sets the lable horizontal |
|
| 851 | - 'value' => '', |
|
| 852 | - 'label' => '', |
|
| 853 | - 'label_class'=> '', |
|
| 854 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 855 | - 'inline' => true, |
|
| 856 | - 'required' => false, |
|
| 857 | - 'options' => array(), |
|
| 858 | - 'icon' => '', |
|
| 859 | - 'no_wrap' => false, |
|
| 860 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 861 | - 'extra_attributes' => array() // an array of extra attributes |
|
| 862 | - ); |
|
| 863 | - |
|
| 864 | - /** |
|
| 865 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 866 | - */ |
|
| 867 | - $args = wp_parse_args( $args, $defaults ); |
|
| 868 | - |
|
| 869 | - // for now lets use horizontal for floating |
|
| 870 | - if( $args['label_type'] == 'floating' ){$args['label_type'] = 'horizontal';} |
|
| 871 | - |
|
| 872 | - $label_args = array( |
|
| 873 | - 'title'=> $args['label'], |
|
| 874 | - 'class' => $args['label_class']." pt-0 ", |
|
| 875 | - 'label_type' => $args['label_type'] |
|
| 876 | - ); |
|
| 877 | - |
|
| 878 | - $output = ''; |
|
| 879 | - |
|
| 880 | - |
|
| 881 | - |
|
| 882 | - // label before |
|
| 883 | - if(!empty($args['label'])){ |
|
| 884 | - $output .= self::label( $label_args, 'radio' ); |
|
| 885 | - } |
|
| 886 | - |
|
| 887 | - // maybe horizontal label |
|
| 888 | - if($args['label_type']=='horizontal'){ |
|
| 889 | - $output .= '<div class="col-sm-10">'; |
|
| 890 | - } |
|
| 891 | - |
|
| 892 | - if(!empty($args['options'])){ |
|
| 893 | - $count = 0; |
|
| 894 | - foreach($args['options'] as $value => $label){ |
|
| 895 | - $option_args = $args; |
|
| 896 | - $option_args['value'] = $value; |
|
| 897 | - $option_args['label'] = $label; |
|
| 898 | - $option_args['checked'] = $value == $args['value'] ? true : false; |
|
| 899 | - $output .= self::radio_option($option_args,$count); |
|
| 900 | - $count++; |
|
| 901 | - } |
|
| 902 | - } |
|
| 903 | - |
|
| 904 | - // maybe horizontal label |
|
| 905 | - if($args['label_type']=='horizontal'){ |
|
| 906 | - $output .= '</div>'; |
|
| 907 | - } |
|
| 908 | - |
|
| 909 | - |
|
| 910 | - // wrap |
|
| 911 | - $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 912 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 913 | - $output = self::wrap(array( |
|
| 914 | - 'content' => $output, |
|
| 915 | - 'class' => $wrap_class, |
|
| 916 | - 'element_require' => $args['element_require'], |
|
| 917 | - 'argument_id' => $args['id'] |
|
| 918 | - )); |
|
| 919 | - |
|
| 920 | - |
|
| 921 | - return $output; |
|
| 922 | - } |
|
| 923 | - |
|
| 924 | - /** |
|
| 925 | - * Build the component. |
|
| 926 | - * |
|
| 927 | - * @param array $args |
|
| 928 | - * |
|
| 929 | - * @return string The rendered component. |
|
| 930 | - */ |
|
| 931 | - public static function radio_option($args = array(),$count = ''){ |
|
| 932 | - $defaults = array( |
|
| 933 | - 'class' => '', |
|
| 934 | - 'id' => '', |
|
| 935 | - 'title' => '', |
|
| 936 | - 'value' => '', |
|
| 937 | - 'required' => false, |
|
| 938 | - 'inline' => true, |
|
| 939 | - 'label' => '', |
|
| 940 | - 'options' => array(), |
|
| 941 | - 'icon' => '', |
|
| 942 | - 'no_wrap' => false, |
|
| 943 | - 'extra_attributes' => array() // an array of extra attributes |
|
| 944 | - ); |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 948 | - */ |
|
| 949 | - $args = wp_parse_args( $args, $defaults ); |
|
| 950 | - |
|
| 951 | - $output = ''; |
|
| 952 | - |
|
| 953 | - // open/type |
|
| 954 | - $output .= '<input type="radio"'; |
|
| 955 | - |
|
| 956 | - // class |
|
| 957 | - $output .= ' class="form-check-input" '; |
|
| 958 | - |
|
| 959 | - // name |
|
| 960 | - if(!empty($args['name'])){ |
|
| 961 | - $output .= AUI_Component_Helper::name($args['name']); |
|
| 962 | - } |
|
| 963 | - |
|
| 964 | - // id |
|
| 965 | - if(!empty($args['id'])){ |
|
| 966 | - $output .= AUI_Component_Helper::id($args['id'].$count); |
|
| 967 | - } |
|
| 968 | - |
|
| 969 | - // title |
|
| 970 | - if(!empty($args['title'])){ |
|
| 971 | - $output .= AUI_Component_Helper::title($args['title']); |
|
| 972 | - } |
|
| 973 | - |
|
| 974 | - // value |
|
| 975 | - if(isset($args['value'])){ |
|
| 976 | - $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 977 | - } |
|
| 978 | - |
|
| 979 | - // checked, for radio and checkboxes |
|
| 980 | - if( $args['checked'] ){ |
|
| 981 | - $output .= ' checked '; |
|
| 982 | - } |
|
| 983 | - |
|
| 984 | - // data-attributes |
|
| 985 | - $output .= AUI_Component_Helper::data_attributes($args); |
|
| 986 | - |
|
| 987 | - // aria-attributes |
|
| 988 | - $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 989 | - |
|
| 990 | - // extra attributes |
|
| 991 | - if(!empty($args['extra_attributes'])){ |
|
| 992 | - $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - // required |
|
| 996 | - if(!empty($args['required'])){ |
|
| 997 | - $output .= ' required '; |
|
| 998 | - } |
|
| 999 | - |
|
| 1000 | - // close opening tag |
|
| 1001 | - $output .= ' >'; |
|
| 1002 | - |
|
| 1003 | - // label |
|
| 1004 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 1005 | - }elseif(!empty($args['label'])){ |
|
| 1006 | - $output .= self::label(array('title'=>$args['label'],'for'=>$args['id'].$count,'class'=>'form-check-label'),'radio'); |
|
| 1007 | - } |
|
| 1008 | - |
|
| 1009 | - // wrap |
|
| 1010 | - if(!$args['no_wrap']){ |
|
| 1011 | - $wrap_class = $args['inline'] ? 'form-check form-check-inline' : 'form-check'; |
|
| 1012 | - $output = self::wrap(array( |
|
| 1013 | - 'content' => $output, |
|
| 1014 | - 'class' => $wrap_class |
|
| 1015 | - )); |
|
| 1016 | - } |
|
| 1017 | - |
|
| 1018 | - |
|
| 1019 | - return $output; |
|
| 1020 | - } |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + // input group wraps |
|
| 216 | + if($args['input_group_left'] || $args['input_group_right']){ |
|
| 217 | + $w100 = strpos($args['class'], 'w-100') !== false ? ' w-100' : ''; |
|
| 218 | + if($args['input_group_left']){ |
|
| 219 | + $output = self::wrap( array( |
|
| 220 | + 'content' => $output, |
|
| 221 | + 'class' => $args['input_group_left_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 222 | + 'input_group_left' => $args['input_group_left'], |
|
| 223 | + 'input_group_left_inside' => $args['input_group_left_inside'] |
|
| 224 | + ) ); |
|
| 225 | + } |
|
| 226 | + if($args['input_group_right']){ |
|
| 227 | + $output = self::wrap( array( |
|
| 228 | + 'content' => $output, |
|
| 229 | + 'class' => $args['input_group_right_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 230 | + 'input_group_right' => $args['input_group_right'], |
|
| 231 | + 'input_group_right_inside' => $args['input_group_right_inside'] |
|
| 232 | + ) ); |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + if(!$label_after){ |
|
| 238 | + $output .= $help_text; |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 243 | + $output = self::wrap( array( |
|
| 244 | + 'content' => $output, |
|
| 245 | + 'class' => 'col-sm-10', |
|
| 246 | + ) ); |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + if(!$label_after){ |
|
| 250 | + $output = $label . $output; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + // wrap |
|
| 254 | + if(!$args['no_wrap']){ |
|
| 255 | + |
|
| 256 | + $form_group_class = $args['label_type']=='floating' && $type != 'checkbox' ? 'form-label-group' : 'form-group'; |
|
| 257 | + $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 258 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 259 | + $output = self::wrap(array( |
|
| 260 | + 'content' => $output, |
|
| 261 | + 'class' => $wrap_class, |
|
| 262 | + 'element_require' => $args['element_require'], |
|
| 263 | + 'argument_id' => $args['id'] |
|
| 264 | + )); |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + return $output; |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * Build the component. |
|
| 276 | + * |
|
| 277 | + * @param array $args |
|
| 278 | + * |
|
| 279 | + * @return string The rendered component. |
|
| 280 | + */ |
|
| 281 | + public static function textarea($args = array()){ |
|
| 282 | + $defaults = array( |
|
| 283 | + 'name' => '', |
|
| 284 | + 'class' => '', |
|
| 285 | + 'wrap_class' => '', |
|
| 286 | + 'id' => '', |
|
| 287 | + 'placeholder'=> '', |
|
| 288 | + 'title' => '', |
|
| 289 | + 'value' => '', |
|
| 290 | + 'required' => false, |
|
| 291 | + 'label' => '', |
|
| 292 | + 'label_after'=> false, |
|
| 293 | + 'label_class' => '', |
|
| 294 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 295 | + 'help_text' => '', |
|
| 296 | + 'validation_text' => '', |
|
| 297 | + 'validation_pattern' => '', |
|
| 298 | + 'no_wrap' => false, |
|
| 299 | + 'rows' => '', |
|
| 300 | + 'wysiwyg' => false, |
|
| 301 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 302 | + ); |
|
| 303 | + |
|
| 304 | + /** |
|
| 305 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 306 | + */ |
|
| 307 | + $args = wp_parse_args( $args, $defaults ); |
|
| 308 | + $output = ''; |
|
| 309 | + |
|
| 310 | + // hidden label option needs to be empty |
|
| 311 | + $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 312 | + |
|
| 313 | + // floating labels don't work with wysiwyg so set it as top |
|
| 314 | + if($args['label_type'] == 'floating' && !empty($args['wysiwyg'])){ |
|
| 315 | + $args['label_type'] = 'top'; |
|
| 316 | + } |
|
| 317 | + |
|
| 318 | + $label_after = $args['label_after']; |
|
| 319 | + |
|
| 320 | + // floating labels need label after |
|
| 321 | + if( $args['label_type'] == 'floating' && empty($args['wysiwyg']) ){ |
|
| 322 | + $label_after = true; |
|
| 323 | + $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + // label |
|
| 327 | + if(!empty($args['label']) && is_array($args['label'])){ |
|
| 328 | + }elseif(!empty($args['label']) && !$label_after){ |
|
| 329 | + $label_args = array( |
|
| 330 | + 'title'=> $args['label'], |
|
| 331 | + 'for'=> $args['id'], |
|
| 332 | + 'class' => $args['label_class']." ", |
|
| 333 | + 'label_type' => $args['label_type'] |
|
| 334 | + ); |
|
| 335 | + $output .= self::label( $label_args ); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + // maybe horizontal label |
|
| 339 | + if($args['label_type']=='horizontal'){ |
|
| 340 | + $output .= '<div class="col-sm-10">'; |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + if(!empty($args['wysiwyg'])){ |
|
| 344 | + ob_start(); |
|
| 345 | + $content = $args['value']; |
|
| 346 | + $editor_id = !empty($args['id']) ? sanitize_html_class($args['id']) : 'wp_editor'; |
|
| 347 | + $settings = array( |
|
| 348 | + 'textarea_rows' => !empty(absint($args['rows'])) ? absint($args['rows']) : 4, |
|
| 349 | + 'quicktags' => false, |
|
| 350 | + 'media_buttons' => false, |
|
| 351 | + 'editor_class' => 'form-control', |
|
| 352 | + 'textarea_name' => !empty($args['name']) ? sanitize_html_class($args['name']) : sanitize_html_class($args['id']), |
|
| 353 | + 'teeny' => true, |
|
| 354 | + ); |
|
| 355 | + |
|
| 356 | + // maybe set settings if array |
|
| 357 | + if(is_array($args['wysiwyg'])){ |
|
| 358 | + $settings = wp_parse_args( $args['wysiwyg'], $settings ); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + wp_editor( $content, $editor_id, $settings ); |
|
| 362 | + $output .= ob_get_clean(); |
|
| 363 | + }else{ |
|
| 364 | + |
|
| 365 | + // open |
|
| 366 | + $output .= '<textarea '; |
|
| 367 | + |
|
| 368 | + // name |
|
| 369 | + if(!empty($args['name'])){ |
|
| 370 | + $output .= ' name="'.sanitize_html_class($args['name']).'" '; |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + // id |
|
| 374 | + if(!empty($args['id'])){ |
|
| 375 | + $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + // placeholder |
|
| 379 | + if(!empty($args['placeholder'])){ |
|
| 380 | + $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + // title |
|
| 384 | + if(!empty($args['title'])){ |
|
| 385 | + $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 386 | + } |
|
| 387 | + |
|
| 388 | + // validation text |
|
| 389 | + if(!empty($args['validation_text'])){ |
|
| 390 | + $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 391 | + $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 392 | + } |
|
| 393 | + |
|
| 394 | + // validation_pattern |
|
| 395 | + if(!empty($args['validation_pattern'])){ |
|
| 396 | + $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + // required |
|
| 400 | + if(!empty($args['required'])){ |
|
| 401 | + $output .= ' required '; |
|
| 402 | + } |
|
| 403 | + |
|
| 404 | + // rows |
|
| 405 | + if(!empty($args['rows'])){ |
|
| 406 | + $output .= ' rows="'.absint($args['rows']).'" '; |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + |
|
| 410 | + // class |
|
| 411 | + $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 412 | + $output .= ' class="form-control '.$class.'" '; |
|
| 413 | + |
|
| 414 | + |
|
| 415 | + // close tag |
|
| 416 | + $output .= ' >'; |
|
| 417 | + |
|
| 418 | + // value |
|
| 419 | + if(!empty($args['value'])){ |
|
| 420 | + $output .= sanitize_textarea_field($args['value']); |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + // closing tag |
|
| 424 | + $output .= '</textarea>'; |
|
| 425 | + |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + if(!empty($args['label']) && $label_after){ |
|
| 429 | + $label_args = array( |
|
| 430 | + 'title'=> $args['label'], |
|
| 431 | + 'for'=> $args['id'], |
|
| 432 | + 'class' => $args['label_class']." ", |
|
| 433 | + 'label_type' => $args['label_type'] |
|
| 434 | + ); |
|
| 435 | + $output .= self::label( $label_args ); |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + // help text |
|
| 439 | + if(!empty($args['help_text'])){ |
|
| 440 | + $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 441 | + } |
|
| 442 | + |
|
| 443 | + // maybe horizontal label |
|
| 444 | + if($args['label_type']=='horizontal'){ |
|
| 445 | + $output .= '</div>'; |
|
| 446 | + } |
|
| 447 | + |
|
| 448 | + |
|
| 449 | + // wrap |
|
| 450 | + if(!$args['no_wrap']){ |
|
| 451 | + $form_group_class = $args['label_type']=='floating' ? 'form-label-group' : 'form-group'; |
|
| 452 | + $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 453 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 454 | + $output = self::wrap(array( |
|
| 455 | + 'content' => $output, |
|
| 456 | + 'class' => $wrap_class, |
|
| 457 | + 'element_require' => $args['element_require'], |
|
| 458 | + 'argument_id' => $args['id'] |
|
| 459 | + )); |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + |
|
| 463 | + return $output; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + public static function label($args = array(), $type = ''){ |
|
| 467 | + //<label for="exampleInputEmail1">Email address</label> |
|
| 468 | + $defaults = array( |
|
| 469 | + 'title' => 'div', |
|
| 470 | + 'for' => '', |
|
| 471 | + 'class' => '', |
|
| 472 | + 'label_type' => '', // empty = hidden, top, horizontal |
|
| 473 | + ); |
|
| 474 | + |
|
| 475 | + /** |
|
| 476 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 477 | + */ |
|
| 478 | + $args = wp_parse_args( $args, $defaults ); |
|
| 479 | + $output = ''; |
|
| 480 | + |
|
| 481 | + if($args['title']){ |
|
| 482 | + |
|
| 483 | + // maybe hide labels //@todo set a global option for visibility class |
|
| 484 | + if($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type']) ){ |
|
| 485 | + $class = $args['class']; |
|
| 486 | + }else{ |
|
| 487 | + $class = 'sr-only '.$args['class']; |
|
| 488 | + } |
|
| 489 | + |
|
| 490 | + // maybe horizontal |
|
| 491 | + if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 492 | + $class .= ' col-sm-2 col-form-label'; |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + // open |
|
| 496 | + $output .= '<label '; |
|
| 497 | + |
|
| 498 | + // for |
|
| 499 | + if(!empty($args['for'])){ |
|
| 500 | + $output .= ' for="'.sanitize_text_field($args['for']).'" '; |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + // class |
|
| 504 | + $class = $class ? AUI_Component_Helper::esc_classes( $class ) : ''; |
|
| 505 | + $output .= ' class="'.$class.'" '; |
|
| 506 | + |
|
| 507 | + // close |
|
| 508 | + $output .= '>'; |
|
| 509 | + |
|
| 510 | + |
|
| 511 | + // title, don't escape fully as can contain html |
|
| 512 | + if(!empty($args['title'])){ |
|
| 513 | + $output .= wp_kses_post($args['title']); |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + // close wrap |
|
| 517 | + $output .= '</label>'; |
|
| 518 | + |
|
| 519 | + |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + |
|
| 523 | + return $output; |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + /** |
|
| 527 | + * Wrap some content in a HTML wrapper. |
|
| 528 | + * |
|
| 529 | + * @param array $args |
|
| 530 | + * |
|
| 531 | + * @return string |
|
| 532 | + */ |
|
| 533 | + public static function wrap($args = array()){ |
|
| 534 | + $defaults = array( |
|
| 535 | + 'type' => 'div', |
|
| 536 | + 'class' => 'form-group', |
|
| 537 | + 'content' => '', |
|
| 538 | + 'input_group_left' => '', |
|
| 539 | + 'input_group_right' => '', |
|
| 540 | + 'input_group_left_inside' => false, |
|
| 541 | + 'input_group_right_inside' => false, |
|
| 542 | + 'element_require' => '', |
|
| 543 | + 'argument_id' => '', |
|
| 544 | + ); |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 548 | + */ |
|
| 549 | + $args = wp_parse_args( $args, $defaults ); |
|
| 550 | + $output = ''; |
|
| 551 | + if($args['type']){ |
|
| 552 | + |
|
| 553 | + // open |
|
| 554 | + $output .= '<'.sanitize_html_class($args['type']); |
|
| 555 | + |
|
| 556 | + // element require |
|
| 557 | + if(!empty($args['element_require'])){ |
|
| 558 | + $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 559 | + $args['class'] .= " aui-conditional-field"; |
|
| 560 | + } |
|
| 561 | + |
|
| 562 | + // argument_id |
|
| 563 | + if( !empty($args['argument_id']) ){ |
|
| 564 | + $output .= ' data-argument="'.esc_attr($args['argument_id']).'"'; |
|
| 565 | + } |
|
| 566 | + |
|
| 567 | + // class |
|
| 568 | + $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 569 | + $output .= ' class="'.$class.'" '; |
|
| 570 | + |
|
| 571 | + // close wrap |
|
| 572 | + $output .= ' >'; |
|
| 573 | + |
|
| 574 | + |
|
| 575 | + // Input group left |
|
| 576 | + if(!empty($args['input_group_left'])){ |
|
| 577 | + $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 578 | + $input_group_left = strpos($args['input_group_left'], '<') !== false ? $args['input_group_left'] : '<span class="input-group-text">'.$args['input_group_left'].'</span>'; |
|
| 579 | + $output .= '<div class="input-group-prepend '.$position_class.'">'.$input_group_left.'</div>'; |
|
| 580 | + } |
|
| 581 | + |
|
| 582 | + // content |
|
| 583 | + $output .= $args['content']; |
|
| 584 | + |
|
| 585 | + // Input group right |
|
| 586 | + if(!empty($args['input_group_right'])){ |
|
| 587 | + $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 588 | + $input_group_right = strpos($args['input_group_right'], '<') !== false ? $args['input_group_right'] : '<span class="input-group-text">'.$args['input_group_right'].'</span>'; |
|
| 589 | + $output .= '<div class="input-group-append '.$position_class.'">'.$input_group_right.'</div>'; |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + |
|
| 593 | + // close wrap |
|
| 594 | + $output .= '</'.sanitize_html_class($args['type']).'>'; |
|
| 595 | + |
|
| 596 | + |
|
| 597 | + }else{ |
|
| 598 | + $output = $args['content']; |
|
| 599 | + } |
|
| 600 | + |
|
| 601 | + return $output; |
|
| 602 | + } |
|
| 603 | + |
|
| 604 | + /** |
|
| 605 | + * Build the component. |
|
| 606 | + * |
|
| 607 | + * @param array $args |
|
| 608 | + * |
|
| 609 | + * @return string The rendered component. |
|
| 610 | + */ |
|
| 611 | + public static function select($args = array()){ |
|
| 612 | + $defaults = array( |
|
| 613 | + 'class' => '', |
|
| 614 | + 'wrap_class' => '', |
|
| 615 | + 'id' => '', |
|
| 616 | + 'title' => '', |
|
| 617 | + 'value' => '', // can be an array or a string |
|
| 618 | + 'required' => false, |
|
| 619 | + 'label' => '', |
|
| 620 | + 'label_after'=> false, |
|
| 621 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 622 | + 'label_class' => '', |
|
| 623 | + 'help_text' => '', |
|
| 624 | + 'placeholder'=> '', |
|
| 625 | + 'options' => array(), // array or string |
|
| 626 | + 'icon' => '', |
|
| 627 | + 'multiple' => false, |
|
| 628 | + 'select2' => false, |
|
| 629 | + 'no_wrap' => false, |
|
| 630 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 631 | + 'extra_attributes' => array(), // an array of extra attributes |
|
| 632 | + ); |
|
| 633 | + |
|
| 634 | + /** |
|
| 635 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 636 | + */ |
|
| 637 | + $args = wp_parse_args( $args, $defaults ); |
|
| 638 | + $output = ''; |
|
| 639 | + |
|
| 640 | + // for now lets hide floating labels |
|
| 641 | + if( $args['label_type'] == 'floating' ){$args['label_type'] = 'hidden';} |
|
| 642 | + |
|
| 643 | + // hidden label option needs to be empty |
|
| 644 | + $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 645 | + |
|
| 646 | + |
|
| 647 | + $label_after = $args['label_after']; |
|
| 648 | + |
|
| 649 | + // floating labels need label after |
|
| 650 | + if( $args['label_type'] == 'floating' ){ |
|
| 651 | + $label_after = true; |
|
| 652 | + $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + // Maybe setup select2 |
|
| 656 | + $is_select2 = false; |
|
| 657 | + if(!empty($args['select2'])){ |
|
| 658 | + $args['class'] .= ' aui-select2'; |
|
| 659 | + $is_select2 = true; |
|
| 660 | + }elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 661 | + $is_select2 = true; |
|
| 662 | + } |
|
| 663 | + |
|
| 664 | + // select2 tags |
|
| 665 | + if( !empty($args['select2']) && $args['select2'] === 'tags'){ // triple equals needed here for some reason |
|
| 666 | + $args['data-tags'] = 'true'; |
|
| 667 | + $args['data-token-separators'] = "[',']"; |
|
| 668 | + $args['multiple'] = true; |
|
| 669 | + } |
|
| 670 | + |
|
| 671 | + // select2 placeholder |
|
| 672 | + if($is_select2 && !empty($args['placeholder']) && empty($args['data-placeholder'])){ |
|
| 673 | + $args['data-placeholder'] = esc_attr($args['placeholder']); |
|
| 674 | + $args['data-allow-clear'] = empty($args['data-allow-clear']) ? true : esc_attr($args['data-allow-clear']); |
|
| 675 | + } |
|
| 676 | + |
|
| 677 | + // label |
|
| 678 | + if(!empty($args['label']) && is_array($args['label'])){ |
|
| 679 | + }elseif(!empty($args['label']) && !$label_after){ |
|
| 680 | + $label_args = array( |
|
| 681 | + 'title'=> $args['label'], |
|
| 682 | + 'for'=> $args['id'], |
|
| 683 | + 'class' => $args['label_class']." ", |
|
| 684 | + 'label_type' => $args['label_type'] |
|
| 685 | + ); |
|
| 686 | + $output .= self::label($label_args); |
|
| 687 | + } |
|
| 688 | + |
|
| 689 | + // maybe horizontal label |
|
| 690 | + if($args['label_type']=='horizontal'){ |
|
| 691 | + $output .= '<div class="col-sm-10">'; |
|
| 692 | + } |
|
| 693 | + |
|
| 694 | + // open/type |
|
| 695 | + $output .= '<select '; |
|
| 696 | + |
|
| 697 | + // style |
|
| 698 | + if($is_select2){ |
|
| 699 | + $output .= " style='width:100%;' "; |
|
| 700 | + } |
|
| 701 | + |
|
| 702 | + // element require |
|
| 703 | + if(!empty($args['element_require'])){ |
|
| 704 | + $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 705 | + $args['class'] .= " aui-conditional-field"; |
|
| 706 | + } |
|
| 707 | + |
|
| 708 | + // class |
|
| 709 | + $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 710 | + $output .= AUI_Component_Helper::class_attr('custom-select '.$class); |
|
| 711 | + |
|
| 712 | + // name |
|
| 713 | + if(!empty($args['name'])){ |
|
| 714 | + $output .= AUI_Component_Helper::name($args['name'],$args['multiple']); |
|
| 715 | + } |
|
| 716 | + |
|
| 717 | + // id |
|
| 718 | + if(!empty($args['id'])){ |
|
| 719 | + $output .= AUI_Component_Helper::id($args['id']); |
|
| 720 | + } |
|
| 721 | + |
|
| 722 | + // title |
|
| 723 | + if(!empty($args['title'])){ |
|
| 724 | + $output .= AUI_Component_Helper::title($args['title']); |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + // data-attributes |
|
| 728 | + $output .= AUI_Component_Helper::data_attributes($args); |
|
| 729 | + |
|
| 730 | + // aria-attributes |
|
| 731 | + $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 732 | + |
|
| 733 | + // extra attributes |
|
| 734 | + if(!empty($args['extra_attributes'])){ |
|
| 735 | + $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 736 | + } |
|
| 737 | + |
|
| 738 | + // required |
|
| 739 | + if(!empty($args['required'])){ |
|
| 740 | + $output .= ' required '; |
|
| 741 | + } |
|
| 742 | + |
|
| 743 | + // multiple |
|
| 744 | + if(!empty($args['multiple'])){ |
|
| 745 | + $output .= ' multiple '; |
|
| 746 | + } |
|
| 747 | + |
|
| 748 | + // close opening tag |
|
| 749 | + $output .= ' >'; |
|
| 750 | + |
|
| 751 | + // placeholder |
|
| 752 | + if(!empty($args['placeholder']) && !$is_select2){ |
|
| 753 | + $output .= '<option value="" disabled selected hidden>'.esc_attr($args['placeholder']).'</option>'; |
|
| 754 | + }elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 755 | + $output .= "<option></option>"; // select2 needs an empty select to fill the placeholder |
|
| 756 | + } |
|
| 757 | + |
|
| 758 | + // Options |
|
| 759 | + if(!empty($args['options'])){ |
|
| 760 | + |
|
| 761 | + if(!is_array($args['options'])){ |
|
| 762 | + $output .= $args['options']; // not the preferred way but an option |
|
| 763 | + }else{ |
|
| 764 | + foreach($args['options'] as $val => $name){ |
|
| 765 | + $selected = ''; |
|
| 766 | + if(is_array($name)){ |
|
| 767 | + if (isset($name['optgroup']) && ($name['optgroup'] == 'start' || $name['optgroup'] == 'end')) { |
|
| 768 | + $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 769 | + |
|
| 770 | + $output .= $name['optgroup'] == 'start' ? '<optgroup label="' . esc_attr($option_label) . '">' : '</optgroup>'; |
|
| 771 | + } else { |
|
| 772 | + $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 773 | + $option_value = isset($name['value']) ? $name['value'] : ''; |
|
| 774 | + if(!empty($args['multiple']) && !empty($args['value']) && is_array($args['value']) ){ |
|
| 775 | + $selected = in_array($option_value, stripslashes_deep($args['value'])) ? "selected" : ""; |
|
| 776 | + } elseif(!empty($args['value'])) { |
|
| 777 | + $selected = selected($option_value,stripslashes_deep($args['value']), false); |
|
| 778 | + } |
|
| 779 | + |
|
| 780 | + $output .= '<option value="' . esc_attr($option_value) . '" ' . $selected . '>' . $option_label . '</option>'; |
|
| 781 | + } |
|
| 782 | + }else{ |
|
| 783 | + if(!empty($args['value'])){ |
|
| 784 | + if(is_array($args['value'])){ |
|
| 785 | + $selected = in_array($val,$args['value']) ? 'selected="selected"' : ''; |
|
| 786 | + } elseif(!empty($args['value'])) { |
|
| 787 | + $selected = selected( $args['value'], $val, false); |
|
| 788 | + } |
|
| 789 | + } |
|
| 790 | + $output .= '<option value="'.esc_attr($val).'" '.$selected.'>'.esc_attr($name).'</option>'; |
|
| 791 | + } |
|
| 792 | + } |
|
| 793 | + } |
|
| 794 | + |
|
| 795 | + } |
|
| 796 | + |
|
| 797 | + // closing tag |
|
| 798 | + $output .= '</select>'; |
|
| 799 | + |
|
| 800 | + if(!empty($args['label']) && $label_after){ |
|
| 801 | + $label_args = array( |
|
| 802 | + 'title'=> $args['label'], |
|
| 803 | + 'for'=> $args['id'], |
|
| 804 | + 'class' => $args['label_class']." ", |
|
| 805 | + 'label_type' => $args['label_type'] |
|
| 806 | + ); |
|
| 807 | + $output .= self::label($label_args); |
|
| 808 | + } |
|
| 809 | + |
|
| 810 | + // help text |
|
| 811 | + if(!empty($args['help_text'])){ |
|
| 812 | + $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 813 | + } |
|
| 814 | + |
|
| 815 | + // maybe horizontal label |
|
| 816 | + if($args['label_type']=='horizontal'){ |
|
| 817 | + $output .= '</div>'; |
|
| 818 | + } |
|
| 819 | + |
|
| 820 | + |
|
| 821 | + // wrap |
|
| 822 | + if(!$args['no_wrap']){ |
|
| 823 | + $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 824 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 825 | + $output = self::wrap(array( |
|
| 826 | + 'content' => $output, |
|
| 827 | + 'class' => $wrap_class, |
|
| 828 | + 'element_require' => $args['element_require'], |
|
| 829 | + 'argument_id' => $args['id'] |
|
| 830 | + )); |
|
| 831 | + } |
|
| 832 | + |
|
| 833 | + |
|
| 834 | + return $output; |
|
| 835 | + } |
|
| 836 | + |
|
| 837 | + /** |
|
| 838 | + * Build the component. |
|
| 839 | + * |
|
| 840 | + * @param array $args |
|
| 841 | + * |
|
| 842 | + * @return string The rendered component. |
|
| 843 | + */ |
|
| 844 | + public static function radio($args = array()){ |
|
| 845 | + $defaults = array( |
|
| 846 | + 'class' => '', |
|
| 847 | + 'wrap_class' => '', |
|
| 848 | + 'id' => '', |
|
| 849 | + 'title' => '', |
|
| 850 | + 'horizontal' => false, // sets the lable horizontal |
|
| 851 | + 'value' => '', |
|
| 852 | + 'label' => '', |
|
| 853 | + 'label_class'=> '', |
|
| 854 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 855 | + 'inline' => true, |
|
| 856 | + 'required' => false, |
|
| 857 | + 'options' => array(), |
|
| 858 | + 'icon' => '', |
|
| 859 | + 'no_wrap' => false, |
|
| 860 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 861 | + 'extra_attributes' => array() // an array of extra attributes |
|
| 862 | + ); |
|
| 863 | + |
|
| 864 | + /** |
|
| 865 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 866 | + */ |
|
| 867 | + $args = wp_parse_args( $args, $defaults ); |
|
| 868 | + |
|
| 869 | + // for now lets use horizontal for floating |
|
| 870 | + if( $args['label_type'] == 'floating' ){$args['label_type'] = 'horizontal';} |
|
| 871 | + |
|
| 872 | + $label_args = array( |
|
| 873 | + 'title'=> $args['label'], |
|
| 874 | + 'class' => $args['label_class']." pt-0 ", |
|
| 875 | + 'label_type' => $args['label_type'] |
|
| 876 | + ); |
|
| 877 | + |
|
| 878 | + $output = ''; |
|
| 879 | + |
|
| 880 | + |
|
| 881 | + |
|
| 882 | + // label before |
|
| 883 | + if(!empty($args['label'])){ |
|
| 884 | + $output .= self::label( $label_args, 'radio' ); |
|
| 885 | + } |
|
| 886 | + |
|
| 887 | + // maybe horizontal label |
|
| 888 | + if($args['label_type']=='horizontal'){ |
|
| 889 | + $output .= '<div class="col-sm-10">'; |
|
| 890 | + } |
|
| 891 | + |
|
| 892 | + if(!empty($args['options'])){ |
|
| 893 | + $count = 0; |
|
| 894 | + foreach($args['options'] as $value => $label){ |
|
| 895 | + $option_args = $args; |
|
| 896 | + $option_args['value'] = $value; |
|
| 897 | + $option_args['label'] = $label; |
|
| 898 | + $option_args['checked'] = $value == $args['value'] ? true : false; |
|
| 899 | + $output .= self::radio_option($option_args,$count); |
|
| 900 | + $count++; |
|
| 901 | + } |
|
| 902 | + } |
|
| 903 | + |
|
| 904 | + // maybe horizontal label |
|
| 905 | + if($args['label_type']=='horizontal'){ |
|
| 906 | + $output .= '</div>'; |
|
| 907 | + } |
|
| 908 | + |
|
| 909 | + |
|
| 910 | + // wrap |
|
| 911 | + $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 912 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 913 | + $output = self::wrap(array( |
|
| 914 | + 'content' => $output, |
|
| 915 | + 'class' => $wrap_class, |
|
| 916 | + 'element_require' => $args['element_require'], |
|
| 917 | + 'argument_id' => $args['id'] |
|
| 918 | + )); |
|
| 919 | + |
|
| 920 | + |
|
| 921 | + return $output; |
|
| 922 | + } |
|
| 923 | + |
|
| 924 | + /** |
|
| 925 | + * Build the component. |
|
| 926 | + * |
|
| 927 | + * @param array $args |
|
| 928 | + * |
|
| 929 | + * @return string The rendered component. |
|
| 930 | + */ |
|
| 931 | + public static function radio_option($args = array(),$count = ''){ |
|
| 932 | + $defaults = array( |
|
| 933 | + 'class' => '', |
|
| 934 | + 'id' => '', |
|
| 935 | + 'title' => '', |
|
| 936 | + 'value' => '', |
|
| 937 | + 'required' => false, |
|
| 938 | + 'inline' => true, |
|
| 939 | + 'label' => '', |
|
| 940 | + 'options' => array(), |
|
| 941 | + 'icon' => '', |
|
| 942 | + 'no_wrap' => false, |
|
| 943 | + 'extra_attributes' => array() // an array of extra attributes |
|
| 944 | + ); |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 948 | + */ |
|
| 949 | + $args = wp_parse_args( $args, $defaults ); |
|
| 950 | + |
|
| 951 | + $output = ''; |
|
| 952 | + |
|
| 953 | + // open/type |
|
| 954 | + $output .= '<input type="radio"'; |
|
| 955 | + |
|
| 956 | + // class |
|
| 957 | + $output .= ' class="form-check-input" '; |
|
| 958 | + |
|
| 959 | + // name |
|
| 960 | + if(!empty($args['name'])){ |
|
| 961 | + $output .= AUI_Component_Helper::name($args['name']); |
|
| 962 | + } |
|
| 963 | + |
|
| 964 | + // id |
|
| 965 | + if(!empty($args['id'])){ |
|
| 966 | + $output .= AUI_Component_Helper::id($args['id'].$count); |
|
| 967 | + } |
|
| 968 | + |
|
| 969 | + // title |
|
| 970 | + if(!empty($args['title'])){ |
|
| 971 | + $output .= AUI_Component_Helper::title($args['title']); |
|
| 972 | + } |
|
| 973 | + |
|
| 974 | + // value |
|
| 975 | + if(isset($args['value'])){ |
|
| 976 | + $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 977 | + } |
|
| 978 | + |
|
| 979 | + // checked, for radio and checkboxes |
|
| 980 | + if( $args['checked'] ){ |
|
| 981 | + $output .= ' checked '; |
|
| 982 | + } |
|
| 983 | + |
|
| 984 | + // data-attributes |
|
| 985 | + $output .= AUI_Component_Helper::data_attributes($args); |
|
| 986 | + |
|
| 987 | + // aria-attributes |
|
| 988 | + $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 989 | + |
|
| 990 | + // extra attributes |
|
| 991 | + if(!empty($args['extra_attributes'])){ |
|
| 992 | + $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + // required |
|
| 996 | + if(!empty($args['required'])){ |
|
| 997 | + $output .= ' required '; |
|
| 998 | + } |
|
| 999 | + |
|
| 1000 | + // close opening tag |
|
| 1001 | + $output .= ' >'; |
|
| 1002 | + |
|
| 1003 | + // label |
|
| 1004 | + if(!empty($args['label']) && is_array($args['label'])){ |
|
| 1005 | + }elseif(!empty($args['label'])){ |
|
| 1006 | + $output .= self::label(array('title'=>$args['label'],'for'=>$args['id'].$count,'class'=>'form-check-label'),'radio'); |
|
| 1007 | + } |
|
| 1008 | + |
|
| 1009 | + // wrap |
|
| 1010 | + if(!$args['no_wrap']){ |
|
| 1011 | + $wrap_class = $args['inline'] ? 'form-check form-check-inline' : 'form-check'; |
|
| 1012 | + $output = self::wrap(array( |
|
| 1013 | + 'content' => $output, |
|
| 1014 | + 'class' => $wrap_class |
|
| 1015 | + )); |
|
| 1016 | + } |
|
| 1017 | + |
|
| 1018 | + |
|
| 1019 | + return $output; |
|
| 1020 | + } |
|
| 1021 | 1021 | |
| 1022 | 1022 | } |
| 1023 | 1023 | \ No newline at end of file |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 3 | +if (!defined('ABSPATH')) { |
|
| 4 | 4 | exit; // Exit if accessed directly |
| 5 | 5 | } |
| 6 | 6 | |
@@ -18,7 +18,7 @@ discard block |
||
| 18 | 18 | * |
| 19 | 19 | * @return string The rendered component. |
| 20 | 20 | */ |
| 21 | - public static function input($args = array()){ |
|
| 21 | + public static function input($args = array()) { |
|
| 22 | 22 | $defaults = array( |
| 23 | 23 | 'type' => 'text', |
| 24 | 24 | 'name' => '', |
@@ -52,13 +52,13 @@ discard block |
||
| 52 | 52 | /** |
| 53 | 53 | * Parse incoming $args into an array and merge it with $defaults |
| 54 | 54 | */ |
| 55 | - $args = wp_parse_args( $args, $defaults ); |
|
| 55 | + $args = wp_parse_args($args, $defaults); |
|
| 56 | 56 | $output = ''; |
| 57 | - if ( ! empty( $args['type'] ) ) { |
|
| 57 | + if (!empty($args['type'])) { |
|
| 58 | 58 | // hidden label option needs to be empty |
| 59 | 59 | $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
| 60 | 60 | |
| 61 | - $type = sanitize_html_class( $args['type'] ); |
|
| 61 | + $type = sanitize_html_class($args['type']); |
|
| 62 | 62 | |
| 63 | 63 | $help_text = ''; |
| 64 | 64 | $label = ''; |
@@ -66,24 +66,24 @@ discard block |
||
| 66 | 66 | $label_args = array( |
| 67 | 67 | 'title'=> $args['label'], |
| 68 | 68 | 'for'=> $args['id'], |
| 69 | - 'class' => $args['label_class']." ", |
|
| 69 | + 'class' => $args['label_class'] . " ", |
|
| 70 | 70 | 'label_type' => $args['label_type'] |
| 71 | 71 | ); |
| 72 | 72 | |
| 73 | 73 | // floating labels need label after |
| 74 | - if( $args['label_type'] == 'floating' && $type != 'checkbox' ){ |
|
| 74 | + if ($args['label_type'] == 'floating' && $type != 'checkbox') { |
|
| 75 | 75 | $label_after = true; |
| 76 | 76 | $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | 79 | // Some special sauce for files |
| 80 | - if($type=='file' ){ |
|
| 80 | + if ($type == 'file') { |
|
| 81 | 81 | $label_after = true; // if type file we need the label after |
| 82 | 82 | $args['class'] .= ' custom-file-input '; |
| 83 | - }elseif($type=='checkbox'){ |
|
| 83 | + }elseif ($type == 'checkbox') { |
|
| 84 | 84 | $label_after = true; // if type file we need the label after |
| 85 | 85 | $args['class'] .= ' custom-control-input '; |
| 86 | - }elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 86 | + }elseif ($type == 'datepicker' || $type == 'timepicker') { |
|
| 87 | 87 | $type = 'text'; |
| 88 | 88 | //$args['class'] .= ' aui-flatpickr bg-initial '; |
| 89 | 89 | $args['class'] .= ' bg-initial '; |
@@ -99,65 +99,65 @@ discard block |
||
| 99 | 99 | $output .= '<input type="' . $type . '" '; |
| 100 | 100 | |
| 101 | 101 | // name |
| 102 | - if(!empty($args['name'])){ |
|
| 103 | - $output .= ' name="'.esc_attr($args['name']).'" '; |
|
| 102 | + if (!empty($args['name'])) { |
|
| 103 | + $output .= ' name="' . esc_attr($args['name']) . '" '; |
|
| 104 | 104 | } |
| 105 | 105 | |
| 106 | 106 | // id |
| 107 | - if(!empty($args['id'])){ |
|
| 108 | - $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 107 | + if (!empty($args['id'])) { |
|
| 108 | + $output .= ' id="' . sanitize_html_class($args['id']) . '" '; |
|
| 109 | 109 | } |
| 110 | 110 | |
| 111 | 111 | // placeholder |
| 112 | - if(!empty($args['placeholder'])){ |
|
| 113 | - $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 112 | + if (!empty($args['placeholder'])) { |
|
| 113 | + $output .= ' placeholder="' . esc_attr($args['placeholder']) . '" '; |
|
| 114 | 114 | } |
| 115 | 115 | |
| 116 | 116 | // title |
| 117 | - if(!empty($args['title'])){ |
|
| 118 | - $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 117 | + if (!empty($args['title'])) { |
|
| 118 | + $output .= ' title="' . esc_attr($args['title']) . '" '; |
|
| 119 | 119 | } |
| 120 | 120 | |
| 121 | 121 | // value |
| 122 | - if(!empty($args['value'])){ |
|
| 123 | - $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 122 | + if (!empty($args['value'])) { |
|
| 123 | + $output .= ' value="' . sanitize_text_field($args['value']) . '" '; |
|
| 124 | 124 | } |
| 125 | 125 | |
| 126 | 126 | // checked, for radio and checkboxes |
| 127 | - if( ( $type == 'checkbox' || $type == 'radio' ) && $args['checked'] ){ |
|
| 127 | + if (($type == 'checkbox' || $type == 'radio') && $args['checked']) { |
|
| 128 | 128 | $output .= ' checked '; |
| 129 | 129 | } |
| 130 | 130 | |
| 131 | 131 | // validation text |
| 132 | - if(!empty($args['validation_text'])){ |
|
| 133 | - $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 132 | + if (!empty($args['validation_text'])) { |
|
| 133 | + $output .= ' oninvalid="setCustomValidity(\'' . esc_attr($args['validation_text']) . '\')" '; |
|
| 134 | 134 | $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | 137 | // validation_pattern |
| 138 | - if(!empty($args['validation_pattern'])){ |
|
| 139 | - $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 138 | + if (!empty($args['validation_pattern'])) { |
|
| 139 | + $output .= ' pattern="' . $args['validation_pattern'] . '" '; |
|
| 140 | 140 | } |
| 141 | 141 | |
| 142 | 142 | // step (for numbers) |
| 143 | - if(!empty($args['step'])){ |
|
| 144 | - $output .= ' step="'.$args['step'].'" '; |
|
| 143 | + if (!empty($args['step'])) { |
|
| 144 | + $output .= ' step="' . $args['step'] . '" '; |
|
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | // required |
| 148 | - if(!empty($args['required'])){ |
|
| 148 | + if (!empty($args['required'])) { |
|
| 149 | 149 | $output .= ' required '; |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | 152 | // class |
| 153 | - $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 154 | - $output .= ' class="form-control '.$class.'" '; |
|
| 153 | + $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes($args['class']) : ''; |
|
| 154 | + $output .= ' class="form-control ' . $class . '" '; |
|
| 155 | 155 | |
| 156 | 156 | // data-attributes |
| 157 | 157 | $output .= AUI_Component_Helper::data_attributes($args); |
| 158 | 158 | |
| 159 | 159 | // extra attributes |
| 160 | - if(!empty($args['extra_attributes'])){ |
|
| 160 | + if (!empty($args['extra_attributes'])) { |
|
| 161 | 161 | $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
| 162 | 162 | } |
| 163 | 163 | |
@@ -166,40 +166,40 @@ discard block |
||
| 166 | 166 | |
| 167 | 167 | |
| 168 | 168 | // label |
| 169 | - if(!empty($args['label'])){ |
|
| 170 | - if($type == 'file'){$label_args['class'] .= 'custom-file-label';} |
|
| 171 | - elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 172 | - $label = self::label( $label_args, $type ); |
|
| 169 | + if (!empty($args['label'])) { |
|
| 170 | + if ($type == 'file') {$label_args['class'] .= 'custom-file-label'; } |
|
| 171 | + elseif ($type == 'checkbox') {$label_args['class'] .= 'custom-control-label'; } |
|
| 172 | + $label = self::label($label_args, $type); |
|
| 173 | 173 | } |
| 174 | 174 | |
| 175 | 175 | // help text |
| 176 | - if(!empty($args['help_text'])){ |
|
| 176 | + if (!empty($args['help_text'])) { |
|
| 177 | 177 | $help_text = AUI_Component_Helper::help_text($args['help_text']); |
| 178 | 178 | } |
| 179 | 179 | |
| 180 | 180 | |
| 181 | 181 | // set help text in the correct possition |
| 182 | - if($label_after){ |
|
| 182 | + if ($label_after) { |
|
| 183 | 183 | $output .= $label . $help_text; |
| 184 | 184 | } |
| 185 | 185 | |
| 186 | 186 | // some input types need a separate wrap |
| 187 | - if($type == 'file') { |
|
| 188 | - $output = self::wrap( array( |
|
| 187 | + if ($type == 'file') { |
|
| 188 | + $output = self::wrap(array( |
|
| 189 | 189 | 'content' => $output, |
| 190 | 190 | 'class' => 'form-group custom-file' |
| 191 | - ) ); |
|
| 192 | - }elseif($type == 'checkbox'){ |
|
| 191 | + )); |
|
| 192 | + }elseif ($type == 'checkbox') { |
|
| 193 | 193 | $wrap_class = $args['switch'] ? 'custom-switch' : 'custom-checkbox'; |
| 194 | - $output = self::wrap( array( |
|
| 194 | + $output = self::wrap(array( |
|
| 195 | 195 | 'content' => $output, |
| 196 | - 'class' => 'custom-control '.$wrap_class |
|
| 197 | - ) ); |
|
| 196 | + 'class' => 'custom-control ' . $wrap_class |
|
| 197 | + )); |
|
| 198 | 198 | |
| 199 | - if($args['label_type']=='horizontal'){ |
|
| 199 | + if ($args['label_type'] == 'horizontal') { |
|
| 200 | 200 | $output = '<div class="col-sm-2 col-form-label"></div><div class="col-sm-10">' . $output . '</div>'; |
| 201 | 201 | } |
| 202 | - }elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 202 | + }elseif ($type == 'password' && $args['password_toggle'] && !$args['input_group_right']) { |
|
| 203 | 203 | |
| 204 | 204 | |
| 205 | 205 | // allow password field to toggle view |
@@ -213,49 +213,49 @@ discard block |
||
| 213 | 213 | } |
| 214 | 214 | |
| 215 | 215 | // input group wraps |
| 216 | - if($args['input_group_left'] || $args['input_group_right']){ |
|
| 216 | + if ($args['input_group_left'] || $args['input_group_right']) { |
|
| 217 | 217 | $w100 = strpos($args['class'], 'w-100') !== false ? ' w-100' : ''; |
| 218 | - if($args['input_group_left']){ |
|
| 219 | - $output = self::wrap( array( |
|
| 218 | + if ($args['input_group_left']) { |
|
| 219 | + $output = self::wrap(array( |
|
| 220 | 220 | 'content' => $output, |
| 221 | - 'class' => $args['input_group_left_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 221 | + 'class' => $args['input_group_left_inside'] ? 'input-group-inside position-relative' . $w100 : 'input-group', |
|
| 222 | 222 | 'input_group_left' => $args['input_group_left'], |
| 223 | 223 | 'input_group_left_inside' => $args['input_group_left_inside'] |
| 224 | - ) ); |
|
| 224 | + )); |
|
| 225 | 225 | } |
| 226 | - if($args['input_group_right']){ |
|
| 227 | - $output = self::wrap( array( |
|
| 226 | + if ($args['input_group_right']) { |
|
| 227 | + $output = self::wrap(array( |
|
| 228 | 228 | 'content' => $output, |
| 229 | - 'class' => $args['input_group_right_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 229 | + 'class' => $args['input_group_right_inside'] ? 'input-group-inside position-relative' . $w100 : 'input-group', |
|
| 230 | 230 | 'input_group_right' => $args['input_group_right'], |
| 231 | 231 | 'input_group_right_inside' => $args['input_group_right_inside'] |
| 232 | - ) ); |
|
| 232 | + )); |
|
| 233 | 233 | } |
| 234 | 234 | |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | - if(!$label_after){ |
|
| 237 | + if (!$label_after) { |
|
| 238 | 238 | $output .= $help_text; |
| 239 | 239 | } |
| 240 | 240 | |
| 241 | 241 | |
| 242 | - if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 243 | - $output = self::wrap( array( |
|
| 242 | + if ($args['label_type'] == 'horizontal' && $type != 'checkbox') { |
|
| 243 | + $output = self::wrap(array( |
|
| 244 | 244 | 'content' => $output, |
| 245 | 245 | 'class' => 'col-sm-10', |
| 246 | - ) ); |
|
| 246 | + )); |
|
| 247 | 247 | } |
| 248 | 248 | |
| 249 | - if(!$label_after){ |
|
| 249 | + if (!$label_after) { |
|
| 250 | 250 | $output = $label . $output; |
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | // wrap |
| 254 | - if(!$args['no_wrap']){ |
|
| 254 | + if (!$args['no_wrap']) { |
|
| 255 | 255 | |
| 256 | - $form_group_class = $args['label_type']=='floating' && $type != 'checkbox' ? 'form-label-group' : 'form-group'; |
|
| 257 | - $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 258 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 256 | + $form_group_class = $args['label_type'] == 'floating' && $type != 'checkbox' ? 'form-label-group' : 'form-group'; |
|
| 257 | + $wrap_class = $args['label_type'] == 'horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 258 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class . " " . $args['wrap_class'] : $wrap_class; |
|
| 259 | 259 | $output = self::wrap(array( |
| 260 | 260 | 'content' => $output, |
| 261 | 261 | 'class' => $wrap_class, |
@@ -278,7 +278,7 @@ discard block |
||
| 278 | 278 | * |
| 279 | 279 | * @return string The rendered component. |
| 280 | 280 | */ |
| 281 | - public static function textarea($args = array()){ |
|
| 281 | + public static function textarea($args = array()) { |
|
| 282 | 282 | $defaults = array( |
| 283 | 283 | 'name' => '', |
| 284 | 284 | 'class' => '', |
@@ -304,43 +304,43 @@ discard block |
||
| 304 | 304 | /** |
| 305 | 305 | * Parse incoming $args into an array and merge it with $defaults |
| 306 | 306 | */ |
| 307 | - $args = wp_parse_args( $args, $defaults ); |
|
| 307 | + $args = wp_parse_args($args, $defaults); |
|
| 308 | 308 | $output = ''; |
| 309 | 309 | |
| 310 | 310 | // hidden label option needs to be empty |
| 311 | 311 | $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
| 312 | 312 | |
| 313 | 313 | // floating labels don't work with wysiwyg so set it as top |
| 314 | - if($args['label_type'] == 'floating' && !empty($args['wysiwyg'])){ |
|
| 314 | + if ($args['label_type'] == 'floating' && !empty($args['wysiwyg'])) { |
|
| 315 | 315 | $args['label_type'] = 'top'; |
| 316 | 316 | } |
| 317 | 317 | |
| 318 | 318 | $label_after = $args['label_after']; |
| 319 | 319 | |
| 320 | 320 | // floating labels need label after |
| 321 | - if( $args['label_type'] == 'floating' && empty($args['wysiwyg']) ){ |
|
| 321 | + if ($args['label_type'] == 'floating' && empty($args['wysiwyg'])) { |
|
| 322 | 322 | $label_after = true; |
| 323 | 323 | $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
| 324 | 324 | } |
| 325 | 325 | |
| 326 | 326 | // label |
| 327 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 328 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 327 | + if (!empty($args['label']) && is_array($args['label'])) { |
|
| 328 | + }elseif (!empty($args['label']) && !$label_after) { |
|
| 329 | 329 | $label_args = array( |
| 330 | 330 | 'title'=> $args['label'], |
| 331 | 331 | 'for'=> $args['id'], |
| 332 | - 'class' => $args['label_class']." ", |
|
| 332 | + 'class' => $args['label_class'] . " ", |
|
| 333 | 333 | 'label_type' => $args['label_type'] |
| 334 | 334 | ); |
| 335 | - $output .= self::label( $label_args ); |
|
| 335 | + $output .= self::label($label_args); |
|
| 336 | 336 | } |
| 337 | 337 | |
| 338 | 338 | // maybe horizontal label |
| 339 | - if($args['label_type']=='horizontal'){ |
|
| 339 | + if ($args['label_type'] == 'horizontal') { |
|
| 340 | 340 | $output .= '<div class="col-sm-10">'; |
| 341 | 341 | } |
| 342 | 342 | |
| 343 | - if(!empty($args['wysiwyg'])){ |
|
| 343 | + if (!empty($args['wysiwyg'])) { |
|
| 344 | 344 | ob_start(); |
| 345 | 345 | $content = $args['value']; |
| 346 | 346 | $editor_id = !empty($args['id']) ? sanitize_html_class($args['id']) : 'wp_editor'; |
@@ -354,69 +354,69 @@ discard block |
||
| 354 | 354 | ); |
| 355 | 355 | |
| 356 | 356 | // maybe set settings if array |
| 357 | - if(is_array($args['wysiwyg'])){ |
|
| 358 | - $settings = wp_parse_args( $args['wysiwyg'], $settings ); |
|
| 357 | + if (is_array($args['wysiwyg'])) { |
|
| 358 | + $settings = wp_parse_args($args['wysiwyg'], $settings); |
|
| 359 | 359 | } |
| 360 | 360 | |
| 361 | - wp_editor( $content, $editor_id, $settings ); |
|
| 361 | + wp_editor($content, $editor_id, $settings); |
|
| 362 | 362 | $output .= ob_get_clean(); |
| 363 | - }else{ |
|
| 363 | + } else { |
|
| 364 | 364 | |
| 365 | 365 | // open |
| 366 | 366 | $output .= '<textarea '; |
| 367 | 367 | |
| 368 | 368 | // name |
| 369 | - if(!empty($args['name'])){ |
|
| 370 | - $output .= ' name="'.sanitize_html_class($args['name']).'" '; |
|
| 369 | + if (!empty($args['name'])) { |
|
| 370 | + $output .= ' name="' . sanitize_html_class($args['name']) . '" '; |
|
| 371 | 371 | } |
| 372 | 372 | |
| 373 | 373 | // id |
| 374 | - if(!empty($args['id'])){ |
|
| 375 | - $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 374 | + if (!empty($args['id'])) { |
|
| 375 | + $output .= ' id="' . sanitize_html_class($args['id']) . '" '; |
|
| 376 | 376 | } |
| 377 | 377 | |
| 378 | 378 | // placeholder |
| 379 | - if(!empty($args['placeholder'])){ |
|
| 380 | - $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 379 | + if (!empty($args['placeholder'])) { |
|
| 380 | + $output .= ' placeholder="' . esc_attr($args['placeholder']) . '" '; |
|
| 381 | 381 | } |
| 382 | 382 | |
| 383 | 383 | // title |
| 384 | - if(!empty($args['title'])){ |
|
| 385 | - $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 384 | + if (!empty($args['title'])) { |
|
| 385 | + $output .= ' title="' . esc_attr($args['title']) . '" '; |
|
| 386 | 386 | } |
| 387 | 387 | |
| 388 | 388 | // validation text |
| 389 | - if(!empty($args['validation_text'])){ |
|
| 390 | - $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 389 | + if (!empty($args['validation_text'])) { |
|
| 390 | + $output .= ' oninvalid="setCustomValidity(\'' . esc_attr($args['validation_text']) . '\')" '; |
|
| 391 | 391 | $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | // validation_pattern |
| 395 | - if(!empty($args['validation_pattern'])){ |
|
| 396 | - $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 395 | + if (!empty($args['validation_pattern'])) { |
|
| 396 | + $output .= ' pattern="' . $args['validation_pattern'] . '" '; |
|
| 397 | 397 | } |
| 398 | 398 | |
| 399 | 399 | // required |
| 400 | - if(!empty($args['required'])){ |
|
| 400 | + if (!empty($args['required'])) { |
|
| 401 | 401 | $output .= ' required '; |
| 402 | 402 | } |
| 403 | 403 | |
| 404 | 404 | // rows |
| 405 | - if(!empty($args['rows'])){ |
|
| 406 | - $output .= ' rows="'.absint($args['rows']).'" '; |
|
| 405 | + if (!empty($args['rows'])) { |
|
| 406 | + $output .= ' rows="' . absint($args['rows']) . '" '; |
|
| 407 | 407 | } |
| 408 | 408 | |
| 409 | 409 | |
| 410 | 410 | // class |
| 411 | 411 | $class = !empty($args['class']) ? $args['class'] : ''; |
| 412 | - $output .= ' class="form-control '.$class.'" '; |
|
| 412 | + $output .= ' class="form-control ' . $class . '" '; |
|
| 413 | 413 | |
| 414 | 414 | |
| 415 | 415 | // close tag |
| 416 | 416 | $output .= ' >'; |
| 417 | 417 | |
| 418 | 418 | // value |
| 419 | - if(!empty($args['value'])){ |
|
| 419 | + if (!empty($args['value'])) { |
|
| 420 | 420 | $output .= sanitize_textarea_field($args['value']); |
| 421 | 421 | } |
| 422 | 422 | |
@@ -425,32 +425,32 @@ discard block |
||
| 425 | 425 | |
| 426 | 426 | } |
| 427 | 427 | |
| 428 | - if(!empty($args['label']) && $label_after){ |
|
| 428 | + if (!empty($args['label']) && $label_after) { |
|
| 429 | 429 | $label_args = array( |
| 430 | 430 | 'title'=> $args['label'], |
| 431 | 431 | 'for'=> $args['id'], |
| 432 | - 'class' => $args['label_class']." ", |
|
| 432 | + 'class' => $args['label_class'] . " ", |
|
| 433 | 433 | 'label_type' => $args['label_type'] |
| 434 | 434 | ); |
| 435 | - $output .= self::label( $label_args ); |
|
| 435 | + $output .= self::label($label_args); |
|
| 436 | 436 | } |
| 437 | 437 | |
| 438 | 438 | // help text |
| 439 | - if(!empty($args['help_text'])){ |
|
| 439 | + if (!empty($args['help_text'])) { |
|
| 440 | 440 | $output .= AUI_Component_Helper::help_text($args['help_text']); |
| 441 | 441 | } |
| 442 | 442 | |
| 443 | 443 | // maybe horizontal label |
| 444 | - if($args['label_type']=='horizontal'){ |
|
| 444 | + if ($args['label_type'] == 'horizontal') { |
|
| 445 | 445 | $output .= '</div>'; |
| 446 | 446 | } |
| 447 | 447 | |
| 448 | 448 | |
| 449 | 449 | // wrap |
| 450 | - if(!$args['no_wrap']){ |
|
| 451 | - $form_group_class = $args['label_type']=='floating' ? 'form-label-group' : 'form-group'; |
|
| 452 | - $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 453 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 450 | + if (!$args['no_wrap']) { |
|
| 451 | + $form_group_class = $args['label_type'] == 'floating' ? 'form-label-group' : 'form-group'; |
|
| 452 | + $wrap_class = $args['label_type'] == 'horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 453 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class . " " . $args['wrap_class'] : $wrap_class; |
|
| 454 | 454 | $output = self::wrap(array( |
| 455 | 455 | 'content' => $output, |
| 456 | 456 | 'class' => $wrap_class, |
@@ -463,7 +463,7 @@ discard block |
||
| 463 | 463 | return $output; |
| 464 | 464 | } |
| 465 | 465 | |
| 466 | - public static function label($args = array(), $type = ''){ |
|
| 466 | + public static function label($args = array(), $type = '') { |
|
| 467 | 467 | //<label for="exampleInputEmail1">Email address</label> |
| 468 | 468 | $defaults = array( |
| 469 | 469 | 'title' => 'div', |
@@ -475,20 +475,20 @@ discard block |
||
| 475 | 475 | /** |
| 476 | 476 | * Parse incoming $args into an array and merge it with $defaults |
| 477 | 477 | */ |
| 478 | - $args = wp_parse_args( $args, $defaults ); |
|
| 478 | + $args = wp_parse_args($args, $defaults); |
|
| 479 | 479 | $output = ''; |
| 480 | 480 | |
| 481 | - if($args['title']){ |
|
| 481 | + if ($args['title']) { |
|
| 482 | 482 | |
| 483 | 483 | // maybe hide labels //@todo set a global option for visibility class |
| 484 | - if($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type']) ){ |
|
| 484 | + if ($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type'])) { |
|
| 485 | 485 | $class = $args['class']; |
| 486 | - }else{ |
|
| 487 | - $class = 'sr-only '.$args['class']; |
|
| 486 | + } else { |
|
| 487 | + $class = 'sr-only ' . $args['class']; |
|
| 488 | 488 | } |
| 489 | 489 | |
| 490 | 490 | // maybe horizontal |
| 491 | - if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 491 | + if ($args['label_type'] == 'horizontal' && $type != 'checkbox') { |
|
| 492 | 492 | $class .= ' col-sm-2 col-form-label'; |
| 493 | 493 | } |
| 494 | 494 | |
@@ -496,20 +496,20 @@ discard block |
||
| 496 | 496 | $output .= '<label '; |
| 497 | 497 | |
| 498 | 498 | // for |
| 499 | - if(!empty($args['for'])){ |
|
| 500 | - $output .= ' for="'.sanitize_text_field($args['for']).'" '; |
|
| 499 | + if (!empty($args['for'])) { |
|
| 500 | + $output .= ' for="' . sanitize_text_field($args['for']) . '" '; |
|
| 501 | 501 | } |
| 502 | 502 | |
| 503 | 503 | // class |
| 504 | - $class = $class ? AUI_Component_Helper::esc_classes( $class ) : ''; |
|
| 505 | - $output .= ' class="'.$class.'" '; |
|
| 504 | + $class = $class ? AUI_Component_Helper::esc_classes($class) : ''; |
|
| 505 | + $output .= ' class="' . $class . '" '; |
|
| 506 | 506 | |
| 507 | 507 | // close |
| 508 | 508 | $output .= '>'; |
| 509 | 509 | |
| 510 | 510 | |
| 511 | 511 | // title, don't escape fully as can contain html |
| 512 | - if(!empty($args['title'])){ |
|
| 512 | + if (!empty($args['title'])) { |
|
| 513 | 513 | $output .= wp_kses_post($args['title']); |
| 514 | 514 | } |
| 515 | 515 | |
@@ -530,7 +530,7 @@ discard block |
||
| 530 | 530 | * |
| 531 | 531 | * @return string |
| 532 | 532 | */ |
| 533 | - public static function wrap($args = array()){ |
|
| 533 | + public static function wrap($args = array()) { |
|
| 534 | 534 | $defaults = array( |
| 535 | 535 | 'type' => 'div', |
| 536 | 536 | 'class' => 'form-group', |
@@ -546,55 +546,55 @@ discard block |
||
| 546 | 546 | /** |
| 547 | 547 | * Parse incoming $args into an array and merge it with $defaults |
| 548 | 548 | */ |
| 549 | - $args = wp_parse_args( $args, $defaults ); |
|
| 549 | + $args = wp_parse_args($args, $defaults); |
|
| 550 | 550 | $output = ''; |
| 551 | - if($args['type']){ |
|
| 551 | + if ($args['type']) { |
|
| 552 | 552 | |
| 553 | 553 | // open |
| 554 | - $output .= '<'.sanitize_html_class($args['type']); |
|
| 554 | + $output .= '<' . sanitize_html_class($args['type']); |
|
| 555 | 555 | |
| 556 | 556 | // element require |
| 557 | - if(!empty($args['element_require'])){ |
|
| 557 | + if (!empty($args['element_require'])) { |
|
| 558 | 558 | $output .= AUI_Component_Helper::element_require($args['element_require']); |
| 559 | 559 | $args['class'] .= " aui-conditional-field"; |
| 560 | 560 | } |
| 561 | 561 | |
| 562 | 562 | // argument_id |
| 563 | - if( !empty($args['argument_id']) ){ |
|
| 564 | - $output .= ' data-argument="'.esc_attr($args['argument_id']).'"'; |
|
| 563 | + if (!empty($args['argument_id'])) { |
|
| 564 | + $output .= ' data-argument="' . esc_attr($args['argument_id']) . '"'; |
|
| 565 | 565 | } |
| 566 | 566 | |
| 567 | 567 | // class |
| 568 | - $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 569 | - $output .= ' class="'.$class.'" '; |
|
| 568 | + $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes($args['class']) : ''; |
|
| 569 | + $output .= ' class="' . $class . '" '; |
|
| 570 | 570 | |
| 571 | 571 | // close wrap |
| 572 | 572 | $output .= ' >'; |
| 573 | 573 | |
| 574 | 574 | |
| 575 | 575 | // Input group left |
| 576 | - if(!empty($args['input_group_left'])){ |
|
| 576 | + if (!empty($args['input_group_left'])) { |
|
| 577 | 577 | $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
| 578 | - $input_group_left = strpos($args['input_group_left'], '<') !== false ? $args['input_group_left'] : '<span class="input-group-text">'.$args['input_group_left'].'</span>'; |
|
| 579 | - $output .= '<div class="input-group-prepend '.$position_class.'">'.$input_group_left.'</div>'; |
|
| 578 | + $input_group_left = strpos($args['input_group_left'], '<') !== false ? $args['input_group_left'] : '<span class="input-group-text">' . $args['input_group_left'] . '</span>'; |
|
| 579 | + $output .= '<div class="input-group-prepend ' . $position_class . '">' . $input_group_left . '</div>'; |
|
| 580 | 580 | } |
| 581 | 581 | |
| 582 | 582 | // content |
| 583 | 583 | $output .= $args['content']; |
| 584 | 584 | |
| 585 | 585 | // Input group right |
| 586 | - if(!empty($args['input_group_right'])){ |
|
| 586 | + if (!empty($args['input_group_right'])) { |
|
| 587 | 587 | $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
| 588 | - $input_group_right = strpos($args['input_group_right'], '<') !== false ? $args['input_group_right'] : '<span class="input-group-text">'.$args['input_group_right'].'</span>'; |
|
| 589 | - $output .= '<div class="input-group-append '.$position_class.'">'.$input_group_right.'</div>'; |
|
| 588 | + $input_group_right = strpos($args['input_group_right'], '<') !== false ? $args['input_group_right'] : '<span class="input-group-text">' . $args['input_group_right'] . '</span>'; |
|
| 589 | + $output .= '<div class="input-group-append ' . $position_class . '">' . $input_group_right . '</div>'; |
|
| 590 | 590 | } |
| 591 | 591 | |
| 592 | 592 | |
| 593 | 593 | // close wrap |
| 594 | - $output .= '</'.sanitize_html_class($args['type']).'>'; |
|
| 594 | + $output .= '</' . sanitize_html_class($args['type']) . '>'; |
|
| 595 | 595 | |
| 596 | 596 | |
| 597 | - }else{ |
|
| 597 | + } else { |
|
| 598 | 598 | $output = $args['content']; |
| 599 | 599 | } |
| 600 | 600 | |
@@ -608,7 +608,7 @@ discard block |
||
| 608 | 608 | * |
| 609 | 609 | * @return string The rendered component. |
| 610 | 610 | */ |
| 611 | - public static function select($args = array()){ |
|
| 611 | + public static function select($args = array()) { |
|
| 612 | 612 | $defaults = array( |
| 613 | 613 | 'class' => '', |
| 614 | 614 | 'wrap_class' => '', |
@@ -634,11 +634,11 @@ discard block |
||
| 634 | 634 | /** |
| 635 | 635 | * Parse incoming $args into an array and merge it with $defaults |
| 636 | 636 | */ |
| 637 | - $args = wp_parse_args( $args, $defaults ); |
|
| 637 | + $args = wp_parse_args($args, $defaults); |
|
| 638 | 638 | $output = ''; |
| 639 | 639 | |
| 640 | 640 | // for now lets hide floating labels |
| 641 | - if( $args['label_type'] == 'floating' ){$args['label_type'] = 'hidden';} |
|
| 641 | + if ($args['label_type'] == 'floating') {$args['label_type'] = 'hidden'; } |
|
| 642 | 642 | |
| 643 | 643 | // hidden label option needs to be empty |
| 644 | 644 | $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
@@ -647,47 +647,47 @@ discard block |
||
| 647 | 647 | $label_after = $args['label_after']; |
| 648 | 648 | |
| 649 | 649 | // floating labels need label after |
| 650 | - if( $args['label_type'] == 'floating' ){ |
|
| 650 | + if ($args['label_type'] == 'floating') { |
|
| 651 | 651 | $label_after = true; |
| 652 | 652 | $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
| 653 | 653 | } |
| 654 | 654 | |
| 655 | 655 | // Maybe setup select2 |
| 656 | 656 | $is_select2 = false; |
| 657 | - if(!empty($args['select2'])){ |
|
| 657 | + if (!empty($args['select2'])) { |
|
| 658 | 658 | $args['class'] .= ' aui-select2'; |
| 659 | 659 | $is_select2 = true; |
| 660 | - }elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 660 | + }elseif (strpos($args['class'], 'aui-select2') !== false) { |
|
| 661 | 661 | $is_select2 = true; |
| 662 | 662 | } |
| 663 | 663 | |
| 664 | 664 | // select2 tags |
| 665 | - if( !empty($args['select2']) && $args['select2'] === 'tags'){ // triple equals needed here for some reason |
|
| 665 | + if (!empty($args['select2']) && $args['select2'] === 'tags') { // triple equals needed here for some reason |
|
| 666 | 666 | $args['data-tags'] = 'true'; |
| 667 | 667 | $args['data-token-separators'] = "[',']"; |
| 668 | 668 | $args['multiple'] = true; |
| 669 | 669 | } |
| 670 | 670 | |
| 671 | 671 | // select2 placeholder |
| 672 | - if($is_select2 && !empty($args['placeholder']) && empty($args['data-placeholder'])){ |
|
| 672 | + if ($is_select2 && !empty($args['placeholder']) && empty($args['data-placeholder'])) { |
|
| 673 | 673 | $args['data-placeholder'] = esc_attr($args['placeholder']); |
| 674 | 674 | $args['data-allow-clear'] = empty($args['data-allow-clear']) ? true : esc_attr($args['data-allow-clear']); |
| 675 | 675 | } |
| 676 | 676 | |
| 677 | 677 | // label |
| 678 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 679 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 678 | + if (!empty($args['label']) && is_array($args['label'])) { |
|
| 679 | + }elseif (!empty($args['label']) && !$label_after) { |
|
| 680 | 680 | $label_args = array( |
| 681 | 681 | 'title'=> $args['label'], |
| 682 | 682 | 'for'=> $args['id'], |
| 683 | - 'class' => $args['label_class']." ", |
|
| 683 | + 'class' => $args['label_class'] . " ", |
|
| 684 | 684 | 'label_type' => $args['label_type'] |
| 685 | 685 | ); |
| 686 | 686 | $output .= self::label($label_args); |
| 687 | 687 | } |
| 688 | 688 | |
| 689 | 689 | // maybe horizontal label |
| 690 | - if($args['label_type']=='horizontal'){ |
|
| 690 | + if ($args['label_type'] == 'horizontal') { |
|
| 691 | 691 | $output .= '<div class="col-sm-10">'; |
| 692 | 692 | } |
| 693 | 693 | |
@@ -695,32 +695,32 @@ discard block |
||
| 695 | 695 | $output .= '<select '; |
| 696 | 696 | |
| 697 | 697 | // style |
| 698 | - if($is_select2){ |
|
| 698 | + if ($is_select2) { |
|
| 699 | 699 | $output .= " style='width:100%;' "; |
| 700 | 700 | } |
| 701 | 701 | |
| 702 | 702 | // element require |
| 703 | - if(!empty($args['element_require'])){ |
|
| 703 | + if (!empty($args['element_require'])) { |
|
| 704 | 704 | $output .= AUI_Component_Helper::element_require($args['element_require']); |
| 705 | 705 | $args['class'] .= " aui-conditional-field"; |
| 706 | 706 | } |
| 707 | 707 | |
| 708 | 708 | // class |
| 709 | 709 | $class = !empty($args['class']) ? $args['class'] : ''; |
| 710 | - $output .= AUI_Component_Helper::class_attr('custom-select '.$class); |
|
| 710 | + $output .= AUI_Component_Helper::class_attr('custom-select ' . $class); |
|
| 711 | 711 | |
| 712 | 712 | // name |
| 713 | - if(!empty($args['name'])){ |
|
| 714 | - $output .= AUI_Component_Helper::name($args['name'],$args['multiple']); |
|
| 713 | + if (!empty($args['name'])) { |
|
| 714 | + $output .= AUI_Component_Helper::name($args['name'], $args['multiple']); |
|
| 715 | 715 | } |
| 716 | 716 | |
| 717 | 717 | // id |
| 718 | - if(!empty($args['id'])){ |
|
| 718 | + if (!empty($args['id'])) { |
|
| 719 | 719 | $output .= AUI_Component_Helper::id($args['id']); |
| 720 | 720 | } |
| 721 | 721 | |
| 722 | 722 | // title |
| 723 | - if(!empty($args['title'])){ |
|
| 723 | + if (!empty($args['title'])) { |
|
| 724 | 724 | $output .= AUI_Component_Helper::title($args['title']); |
| 725 | 725 | } |
| 726 | 726 | |
@@ -731,17 +731,17 @@ discard block |
||
| 731 | 731 | $output .= AUI_Component_Helper::aria_attributes($args); |
| 732 | 732 | |
| 733 | 733 | // extra attributes |
| 734 | - if(!empty($args['extra_attributes'])){ |
|
| 734 | + if (!empty($args['extra_attributes'])) { |
|
| 735 | 735 | $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
| 736 | 736 | } |
| 737 | 737 | |
| 738 | 738 | // required |
| 739 | - if(!empty($args['required'])){ |
|
| 739 | + if (!empty($args['required'])) { |
|
| 740 | 740 | $output .= ' required '; |
| 741 | 741 | } |
| 742 | 742 | |
| 743 | 743 | // multiple |
| 744 | - if(!empty($args['multiple'])){ |
|
| 744 | + if (!empty($args['multiple'])) { |
|
| 745 | 745 | $output .= ' multiple '; |
| 746 | 746 | } |
| 747 | 747 | |
@@ -749,21 +749,21 @@ discard block |
||
| 749 | 749 | $output .= ' >'; |
| 750 | 750 | |
| 751 | 751 | // placeholder |
| 752 | - if(!empty($args['placeholder']) && !$is_select2){ |
|
| 753 | - $output .= '<option value="" disabled selected hidden>'.esc_attr($args['placeholder']).'</option>'; |
|
| 754 | - }elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 752 | + if (!empty($args['placeholder']) && !$is_select2) { |
|
| 753 | + $output .= '<option value="" disabled selected hidden>' . esc_attr($args['placeholder']) . '</option>'; |
|
| 754 | + }elseif ($is_select2 && !empty($args['placeholder'])) { |
|
| 755 | 755 | $output .= "<option></option>"; // select2 needs an empty select to fill the placeholder |
| 756 | 756 | } |
| 757 | 757 | |
| 758 | 758 | // Options |
| 759 | - if(!empty($args['options'])){ |
|
| 759 | + if (!empty($args['options'])) { |
|
| 760 | 760 | |
| 761 | - if(!is_array($args['options'])){ |
|
| 761 | + if (!is_array($args['options'])) { |
|
| 762 | 762 | $output .= $args['options']; // not the preferred way but an option |
| 763 | - }else{ |
|
| 764 | - foreach($args['options'] as $val => $name){ |
|
| 763 | + } else { |
|
| 764 | + foreach ($args['options'] as $val => $name) { |
|
| 765 | 765 | $selected = ''; |
| 766 | - if(is_array($name)){ |
|
| 766 | + if (is_array($name)) { |
|
| 767 | 767 | if (isset($name['optgroup']) && ($name['optgroup'] == 'start' || $name['optgroup'] == 'end')) { |
| 768 | 768 | $option_label = isset($name['label']) ? $name['label'] : ''; |
| 769 | 769 | |
@@ -771,23 +771,23 @@ discard block |
||
| 771 | 771 | } else { |
| 772 | 772 | $option_label = isset($name['label']) ? $name['label'] : ''; |
| 773 | 773 | $option_value = isset($name['value']) ? $name['value'] : ''; |
| 774 | - if(!empty($args['multiple']) && !empty($args['value']) && is_array($args['value']) ){ |
|
| 774 | + if (!empty($args['multiple']) && !empty($args['value']) && is_array($args['value'])) { |
|
| 775 | 775 | $selected = in_array($option_value, stripslashes_deep($args['value'])) ? "selected" : ""; |
| 776 | - } elseif(!empty($args['value'])) { |
|
| 777 | - $selected = selected($option_value,stripslashes_deep($args['value']), false); |
|
| 776 | + } elseif (!empty($args['value'])) { |
|
| 777 | + $selected = selected($option_value, stripslashes_deep($args['value']), false); |
|
| 778 | 778 | } |
| 779 | 779 | |
| 780 | 780 | $output .= '<option value="' . esc_attr($option_value) . '" ' . $selected . '>' . $option_label . '</option>'; |
| 781 | 781 | } |
| 782 | - }else{ |
|
| 783 | - if(!empty($args['value'])){ |
|
| 784 | - if(is_array($args['value'])){ |
|
| 785 | - $selected = in_array($val,$args['value']) ? 'selected="selected"' : ''; |
|
| 786 | - } elseif(!empty($args['value'])) { |
|
| 787 | - $selected = selected( $args['value'], $val, false); |
|
| 782 | + } else { |
|
| 783 | + if (!empty($args['value'])) { |
|
| 784 | + if (is_array($args['value'])) { |
|
| 785 | + $selected = in_array($val, $args['value']) ? 'selected="selected"' : ''; |
|
| 786 | + } elseif (!empty($args['value'])) { |
|
| 787 | + $selected = selected($args['value'], $val, false); |
|
| 788 | 788 | } |
| 789 | 789 | } |
| 790 | - $output .= '<option value="'.esc_attr($val).'" '.$selected.'>'.esc_attr($name).'</option>'; |
|
| 790 | + $output .= '<option value="' . esc_attr($val) . '" ' . $selected . '>' . esc_attr($name) . '</option>'; |
|
| 791 | 791 | } |
| 792 | 792 | } |
| 793 | 793 | } |
@@ -797,31 +797,31 @@ discard block |
||
| 797 | 797 | // closing tag |
| 798 | 798 | $output .= '</select>'; |
| 799 | 799 | |
| 800 | - if(!empty($args['label']) && $label_after){ |
|
| 800 | + if (!empty($args['label']) && $label_after) { |
|
| 801 | 801 | $label_args = array( |
| 802 | 802 | 'title'=> $args['label'], |
| 803 | 803 | 'for'=> $args['id'], |
| 804 | - 'class' => $args['label_class']." ", |
|
| 804 | + 'class' => $args['label_class'] . " ", |
|
| 805 | 805 | 'label_type' => $args['label_type'] |
| 806 | 806 | ); |
| 807 | 807 | $output .= self::label($label_args); |
| 808 | 808 | } |
| 809 | 809 | |
| 810 | 810 | // help text |
| 811 | - if(!empty($args['help_text'])){ |
|
| 811 | + if (!empty($args['help_text'])) { |
|
| 812 | 812 | $output .= AUI_Component_Helper::help_text($args['help_text']); |
| 813 | 813 | } |
| 814 | 814 | |
| 815 | 815 | // maybe horizontal label |
| 816 | - if($args['label_type']=='horizontal'){ |
|
| 816 | + if ($args['label_type'] == 'horizontal') { |
|
| 817 | 817 | $output .= '</div>'; |
| 818 | 818 | } |
| 819 | 819 | |
| 820 | 820 | |
| 821 | 821 | // wrap |
| 822 | - if(!$args['no_wrap']){ |
|
| 823 | - $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 824 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 822 | + if (!$args['no_wrap']) { |
|
| 823 | + $wrap_class = $args['label_type'] == 'horizontal' ? 'form-group row' : 'form-group'; |
|
| 824 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class . " " . $args['wrap_class'] : $wrap_class; |
|
| 825 | 825 | $output = self::wrap(array( |
| 826 | 826 | 'content' => $output, |
| 827 | 827 | 'class' => $wrap_class, |
@@ -841,7 +841,7 @@ discard block |
||
| 841 | 841 | * |
| 842 | 842 | * @return string The rendered component. |
| 843 | 843 | */ |
| 844 | - public static function radio($args = array()){ |
|
| 844 | + public static function radio($args = array()) { |
|
| 845 | 845 | $defaults = array( |
| 846 | 846 | 'class' => '', |
| 847 | 847 | 'wrap_class' => '', |
@@ -864,14 +864,14 @@ discard block |
||
| 864 | 864 | /** |
| 865 | 865 | * Parse incoming $args into an array and merge it with $defaults |
| 866 | 866 | */ |
| 867 | - $args = wp_parse_args( $args, $defaults ); |
|
| 867 | + $args = wp_parse_args($args, $defaults); |
|
| 868 | 868 | |
| 869 | 869 | // for now lets use horizontal for floating |
| 870 | - if( $args['label_type'] == 'floating' ){$args['label_type'] = 'horizontal';} |
|
| 870 | + if ($args['label_type'] == 'floating') {$args['label_type'] = 'horizontal'; } |
|
| 871 | 871 | |
| 872 | 872 | $label_args = array( |
| 873 | 873 | 'title'=> $args['label'], |
| 874 | - 'class' => $args['label_class']." pt-0 ", |
|
| 874 | + 'class' => $args['label_class'] . " pt-0 ", |
|
| 875 | 875 | 'label_type' => $args['label_type'] |
| 876 | 876 | ); |
| 877 | 877 | |
@@ -880,36 +880,36 @@ discard block |
||
| 880 | 880 | |
| 881 | 881 | |
| 882 | 882 | // label before |
| 883 | - if(!empty($args['label'])){ |
|
| 884 | - $output .= self::label( $label_args, 'radio' ); |
|
| 883 | + if (!empty($args['label'])) { |
|
| 884 | + $output .= self::label($label_args, 'radio'); |
|
| 885 | 885 | } |
| 886 | 886 | |
| 887 | 887 | // maybe horizontal label |
| 888 | - if($args['label_type']=='horizontal'){ |
|
| 888 | + if ($args['label_type'] == 'horizontal') { |
|
| 889 | 889 | $output .= '<div class="col-sm-10">'; |
| 890 | 890 | } |
| 891 | 891 | |
| 892 | - if(!empty($args['options'])){ |
|
| 892 | + if (!empty($args['options'])) { |
|
| 893 | 893 | $count = 0; |
| 894 | - foreach($args['options'] as $value => $label){ |
|
| 894 | + foreach ($args['options'] as $value => $label) { |
|
| 895 | 895 | $option_args = $args; |
| 896 | 896 | $option_args['value'] = $value; |
| 897 | 897 | $option_args['label'] = $label; |
| 898 | 898 | $option_args['checked'] = $value == $args['value'] ? true : false; |
| 899 | - $output .= self::radio_option($option_args,$count); |
|
| 899 | + $output .= self::radio_option($option_args, $count); |
|
| 900 | 900 | $count++; |
| 901 | 901 | } |
| 902 | 902 | } |
| 903 | 903 | |
| 904 | 904 | // maybe horizontal label |
| 905 | - if($args['label_type']=='horizontal'){ |
|
| 905 | + if ($args['label_type'] == 'horizontal') { |
|
| 906 | 906 | $output .= '</div>'; |
| 907 | 907 | } |
| 908 | 908 | |
| 909 | 909 | |
| 910 | 910 | // wrap |
| 911 | - $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 912 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 911 | + $wrap_class = $args['label_type'] == 'horizontal' ? 'form-group row' : 'form-group'; |
|
| 912 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class . " " . $args['wrap_class'] : $wrap_class; |
|
| 913 | 913 | $output = self::wrap(array( |
| 914 | 914 | 'content' => $output, |
| 915 | 915 | 'class' => $wrap_class, |
@@ -928,7 +928,7 @@ discard block |
||
| 928 | 928 | * |
| 929 | 929 | * @return string The rendered component. |
| 930 | 930 | */ |
| 931 | - public static function radio_option($args = array(),$count = ''){ |
|
| 931 | + public static function radio_option($args = array(), $count = '') { |
|
| 932 | 932 | $defaults = array( |
| 933 | 933 | 'class' => '', |
| 934 | 934 | 'id' => '', |
@@ -946,7 +946,7 @@ discard block |
||
| 946 | 946 | /** |
| 947 | 947 | * Parse incoming $args into an array and merge it with $defaults |
| 948 | 948 | */ |
| 949 | - $args = wp_parse_args( $args, $defaults ); |
|
| 949 | + $args = wp_parse_args($args, $defaults); |
|
| 950 | 950 | |
| 951 | 951 | $output = ''; |
| 952 | 952 | |
@@ -957,27 +957,27 @@ discard block |
||
| 957 | 957 | $output .= ' class="form-check-input" '; |
| 958 | 958 | |
| 959 | 959 | // name |
| 960 | - if(!empty($args['name'])){ |
|
| 960 | + if (!empty($args['name'])) { |
|
| 961 | 961 | $output .= AUI_Component_Helper::name($args['name']); |
| 962 | 962 | } |
| 963 | 963 | |
| 964 | 964 | // id |
| 965 | - if(!empty($args['id'])){ |
|
| 966 | - $output .= AUI_Component_Helper::id($args['id'].$count); |
|
| 965 | + if (!empty($args['id'])) { |
|
| 966 | + $output .= AUI_Component_Helper::id($args['id'] . $count); |
|
| 967 | 967 | } |
| 968 | 968 | |
| 969 | 969 | // title |
| 970 | - if(!empty($args['title'])){ |
|
| 970 | + if (!empty($args['title'])) { |
|
| 971 | 971 | $output .= AUI_Component_Helper::title($args['title']); |
| 972 | 972 | } |
| 973 | 973 | |
| 974 | 974 | // value |
| 975 | - if(isset($args['value'])){ |
|
| 976 | - $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 975 | + if (isset($args['value'])) { |
|
| 976 | + $output .= ' value="' . sanitize_text_field($args['value']) . '" '; |
|
| 977 | 977 | } |
| 978 | 978 | |
| 979 | 979 | // checked, for radio and checkboxes |
| 980 | - if( $args['checked'] ){ |
|
| 980 | + if ($args['checked']) { |
|
| 981 | 981 | $output .= ' checked '; |
| 982 | 982 | } |
| 983 | 983 | |
@@ -988,12 +988,12 @@ discard block |
||
| 988 | 988 | $output .= AUI_Component_Helper::aria_attributes($args); |
| 989 | 989 | |
| 990 | 990 | // extra attributes |
| 991 | - if(!empty($args['extra_attributes'])){ |
|
| 991 | + if (!empty($args['extra_attributes'])) { |
|
| 992 | 992 | $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
| 993 | 993 | } |
| 994 | 994 | |
| 995 | 995 | // required |
| 996 | - if(!empty($args['required'])){ |
|
| 996 | + if (!empty($args['required'])) { |
|
| 997 | 997 | $output .= ' required '; |
| 998 | 998 | } |
| 999 | 999 | |
@@ -1001,13 +1001,13 @@ discard block |
||
| 1001 | 1001 | $output .= ' >'; |
| 1002 | 1002 | |
| 1003 | 1003 | // label |
| 1004 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 1005 | - }elseif(!empty($args['label'])){ |
|
| 1006 | - $output .= self::label(array('title'=>$args['label'],'for'=>$args['id'].$count,'class'=>'form-check-label'),'radio'); |
|
| 1004 | + if (!empty($args['label']) && is_array($args['label'])) { |
|
| 1005 | + }elseif (!empty($args['label'])) { |
|
| 1006 | + $output .= self::label(array('title'=>$args['label'], 'for'=>$args['id'] . $count, 'class'=>'form-check-label'), 'radio'); |
|
| 1007 | 1007 | } |
| 1008 | 1008 | |
| 1009 | 1009 | // wrap |
| 1010 | - if(!$args['no_wrap']){ |
|
| 1010 | + if (!$args['no_wrap']) { |
|
| 1011 | 1011 | $wrap_class = $args['inline'] ? 'form-check form-check-inline' : 'form-check'; |
| 1012 | 1012 | $output = self::wrap(array( |
| 1013 | 1013 | 'content' => $output, |