Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Abstracting the WC_Meta_Data Properties with __set/__get

This commit is contained in:
Cesar Rodas 2017-05-23 19:15:13 -04:00
parent b158ba2c47
commit dafc795d7c
2 changed files with 42 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
includes/class-wc-meta-data.php
View File

@ -1,5 +1,9 @@
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Wraps an array (meta data for now) and tells if there was any changes.
*
@ -12,13 +16,21 @@
* @author crodas
*/
class WC_Meta_Data {
public $id;
public $key;
public $value;
/**
* Current data for metadata
*
* @since 3.1.0
* @var arrray
*/
protected $current_data;
protected $previous_value = array();
protected $properties = array( 'id', 'key', 'value' );
/**
* Metadata data
*
* @since 3.1.0
* @var arrray
*/
protected $data;
/**
* Default constructor
@ -26,11 +38,7 @@ class WC_Meta_Data {
* @param Array meta data to wrap behind this function
*/
public function __construct( Array $meta ) {
foreach ( $meta as $key => $value ) {
if ( in_array( $key, $this->properties ) ) {
$this->$key = $value;
}
}
$this->current_data = $meta;
$this->apply_changes();
}
@ -38,9 +46,22 @@ class WC_Meta_Data {
* Merge changes with data and clear.
*/
public function apply_changes() {
foreach ( $this->properties as $property ) {
$this->previous_value[ $property ] = $this->$property;
$this->data = $this->current_data;
}
public function __set( $key, $value ) {
$this->current_data[ $key ] = $value;
}
public function __isset( $key ) {
return array_key_exists( $key, $this->current_data );
}
public function __get( $key ) {
if ( array_key_exists( $key, $this->current_data )) {
return $this->current_data[ $key ];
}
return null;
}
/**
@ -49,11 +70,11 @@ class WC_Meta_Data {
* @return array
*/
public function get_changes() {
$changes = array();
foreach ( array( 'id', 'key', 'value' ) as $property ) {
if ( array_key_exists( $property, $this->previous_value ) &&
$this->previous_value[ $property ] !== $this->$property ) {
$changes[ $property ] = $this->$property;
foreach ( $this->current_data as $id => $value) {
if ( ! array_key_exists( $id, $this->data ) || $value !== $this->data[ $id ] ) {
$changes[ $id ] = $value;
}
}

6
tests/unit-tests/crud/data.php
View File

@ -139,7 +139,7 @@ class WC_Tests_CRUD_Data extends WC_Unit_Test_Case {
*/
function test_get_meta_data_cache_invalidation() {
$object = new WC_Order;
$object->add_meta_data( 'test_meta_key', 'val1', true );
$object->add_meta_data( 'test_meta_key', array( 'val1' ), true );
$object->add_meta_data( 'test_multi_meta_key', 'val2' );
$object->add_meta_data( 'test_multi_meta_key', 'val3' );
$object->save();
@ -242,7 +242,9 @@ class WC_Tests_CRUD_Data extends WC_Unit_Test_Case {
$object->set_meta_data( $metadata );
foreach ( $object->get_meta_data() as $id => $meta ) {
$this->assertEquals( get_object_vars( $metadata[ $id ] ), get_object_vars( $meta ) );
$this->assertEquals( $metadata[ $id ]->id, $meta->id);
$this->assertEquals( $metadata[ $id ]->key, $meta->key);
$this->assertEquals( $metadata[ $id ]->value, $meta->value);
}
}