oont-contents/plugins/woocommerce-square/includes/Framework/Api/API_JSON_Response.php
2025-02-08 15:10:23 +01:00

85 lines
2.1 KiB
PHP

<?php
/**
* WooCommerce Plugin Framework
*
* This source file is subject to the GNU General Public License v3.0
* that is bundled with this package in the file license.txt.
* It is also available through the world-wide-web at this URL:
* http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@skyverge.com so we can send you a copy immediately.
*
* @since 3.0.0
* @author WooCommerce / SkyVerge
* @copyright Copyright (c) 2013-2019, SkyVerge, Inc.
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later
*
* Modified by WooCommerce on 01 December 2021.
*/
namespace WooCommerce\Square\Framework\Api;
defined( 'ABSPATH' ) or exit;
/**
* Base JSON API response class.
*
* @since 3.0.0
*/
abstract class API_JSON_Response {
/** @var string string representation of this response */
protected $raw_response_json;
/** @var mixed decoded response data */
public $response_data;
/**
* Build the data object from the raw JSON.
*
* @since 3.0.0
* @param string $raw_response_json The raw JSON
*/
public function __construct( $raw_response_json ) {
$this->raw_response_json = $raw_response_json;
$this->response_data = json_decode( $raw_response_json );
}
/**
* Magic accessor for response data attributes
*
* @since 3.0.0
* @param string $name The attribute name to get.
* @return mixed The attribute value
*/
public function __get( $name ) {
// accessing the response_data object indirectly via attribute (useful when it's a class)
return isset( $this->response_data->$name ) ? $this->response_data->$name : null;
}
/**
* Get the string representation of this response.
*
* @since 3.0.0
* @return string
*/
public function to_string() {
return $this->raw_response_json;
}
/**
* Get the string representation of this response with any and all sensitive elements masked
* or removed.
*
* @since 3.0.0
* @return string
*/
public function to_string_safe() {
return $this->to_string();
}
}