Data_Compatibility.php
134 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce Plugin Framework |
| 4 | * |
| 5 | * This source file is subject to the GNU General Public License v3.0 |
| 6 | * that is bundled with this package in the file license.txt. |
| 7 | * It is also available through the world-wide-web at this URL: |
| 8 | * http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 9 | * If you did not receive a copy of the license and are unable to |
| 10 | * obtain it through the world-wide-web, please send an email |
| 11 | * to license@skyverge.com so we can send you a copy immediately. |
| 12 | * |
| 13 | * @since 3.0.0 |
| 14 | * @author WooCommerce / SkyVerge |
| 15 | * @copyright Copyright (c) 2021-2022, WooCommerce. |
| 16 | * @copyright Copyright (c) 2013-2019, SkyVerge, Inc. |
| 17 | * @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 18 | * |
| 19 | * Modified by WooCommerce on 01 December 2021. |
| 20 | */ |
| 21 | |
| 22 | namespace WooCommerce\Square\Framework\Compatibility; |
| 23 | use WooCommerce\Square\Framework\Plugin_Compatibility; |
| 24 | |
| 25 | defined( 'ABSPATH' ) or exit; |
| 26 | |
| 27 | /** |
| 28 | * WooCommerce data compatibility class. |
| 29 | * |
| 30 | * @since 3.0.0 |
| 31 | */ |
| 32 | abstract class Data_Compatibility { |
| 33 | |
| 34 | /** |
| 35 | * Gets an object property. |
| 36 | * |
| 37 | * @since 3.0.0 |
| 38 | * @param \WC_Data $object the data object, likely \WC_Order or \WC_Product |
| 39 | * @param string $prop the property name |
| 40 | * @param string $context if 'view' then the value will be filtered |
| 41 | * @param array $compat_props Compatibility properties. |
| 42 | * @return mixed |
| 43 | */ |
| 44 | public static function get_prop( $object, $prop, $context = 'edit', $compat_props = array() ) { |
| 45 | |
| 46 | $value = ''; |
| 47 | |
| 48 | if ( is_callable( array( $object, "get_{$prop}" ) ) ) { |
| 49 | $value = $object->{"get_{$prop}"}( $context ); |
| 50 | } |
| 51 | |
| 52 | return $value; |
| 53 | } |
| 54 | |
| 55 | |
| 56 | /** |
| 57 | * Sets an object's properties. |
| 58 | * |
| 59 | * Note that this does not save any data to the database. |
| 60 | * |
| 61 | * @since 3.0.0 |
| 62 | * @param \WC_Data $object the data object, likely \WC_Order or \WC_Product |
| 63 | * @param array $props the new properties as $key => $value |
| 64 | * @param array $compat_props Compatibility properties. |
| 65 | * @return \WC_Data |
| 66 | */ |
| 67 | public static function set_props( $object, $props, $compat_props = array() ) { |
| 68 | $object->set_props( $props ); |
| 69 | |
| 70 | return $object; |
| 71 | } |
| 72 | |
| 73 | |
| 74 | /** |
| 75 | * Gets an object's stored meta value. |
| 76 | * |
| 77 | * @since 3.0.0 |
| 78 | * @param \WC_Data $object the data object, likely \WC_Order or \WC_Product |
| 79 | * @param string $key the meta key |
| 80 | * @param bool $single whether to get the meta as a single item. Defaults to `true` |
| 81 | * @param string $context if 'view' then the value will be filtered |
| 82 | * @return mixed |
| 83 | */ |
| 84 | public static function get_meta( $object, $key = '', $single = true, $context = 'edit' ) { |
| 85 | $value = $object->get_meta( $key, $single, $context ); |
| 86 | |
| 87 | return $value; |
| 88 | } |
| 89 | |
| 90 | |
| 91 | /** |
| 92 | * Stores an object meta value. |
| 93 | * |
| 94 | * @since 3.0.0 |
| 95 | * @param \WC_Data $object the data object, likely \WC_Order or \WC_Product |
| 96 | * @param string $key the meta key |
| 97 | * @param string $value the meta value |
| 98 | * @param bool $unique Optional. Whether the meta should be unique. |
| 99 | */ |
| 100 | public static function add_meta_data( $object, $key, $value, $unique = false ) { |
| 101 | $object->add_meta_data( $key, $value, $unique ); |
| 102 | $object->save_meta_data(); |
| 103 | } |
| 104 | |
| 105 | |
| 106 | /** |
| 107 | * Updates an object's stored meta value. |
| 108 | * |
| 109 | * @since 3.0.0 |
| 110 | * @param \WC_Data $object the data object, likely \WC_Order or \WC_Product |
| 111 | * @param string $key the meta key |
| 112 | * @param string $value the meta value |
| 113 | * @param int|string $meta_id Optional. The specific meta ID to update |
| 114 | */ |
| 115 | public static function update_meta_data( $object, $key, $value, $meta_id = '' ) { |
| 116 | $object->update_meta_data( $key, $value, $meta_id ); |
| 117 | $object->save_meta_data(); |
| 118 | } |
| 119 | |
| 120 | |
| 121 | /** |
| 122 | * Deletes an object's stored meta value. |
| 123 | * |
| 124 | * @since 3.0.0 |
| 125 | * @param \WC_Data $object the data object, likely \WC_Order or \WC_Product |
| 126 | * @param string $key the meta key |
| 127 | */ |
| 128 | public static function delete_meta_data( $object, $key ) { |
| 129 | $object->delete_meta_data( $key ); |
| 130 | $object->save_meta_data(); |
| 131 | } |
| 132 | } |
| 133 | |
| 134 |