abstract-sv-wc-api-xml-request.php
3.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?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
* 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.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade the plugin to newer
* versions in the future. If you wish to customize the plugin for your
* needs please refer to http://www.skyverge.com
*
* @package SkyVerge/WooCommerce/API/Request
* @author SkyVerge
* @copyright Copyright (c) 2013-2016, SkyVerge, Inc.
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
*/
defined( 'ABSPATH' ) or exit;
if ( ! class_exists( 'SV_WC_API_XML_Request' ) ) :
/**
* Base XML API request class.
*
* @since 4.3.0
*/
abstract class SV_WC_API_XML_Request implements SV_WC_API_Request {
/** @var array request data */
protected $request_data;
/** @var string root element for XML */
protected $root_element;
/** @var \XMLWriter $xml object */
protected $xml;
/** @var string complete request XML */
protected $request_xml;
/**
* Get the method for this request.
*
* @since 4.3.0
*/
public function get_method() { }
/**
* Get the path for this request.
*
* @since 4.3.0
* @return string
*/
public function get_path() {
return '';
}
/**
* Convert the request data into XML.
*
* @since 4.3.0
* @return string
*/
protected function to_xml() {
if ( ! empty( $this->request_xml ) ) {
return $this->request_xml;
}
$this->xml = new XMLWriter();
// Create XML document in memory
$this->xml->openMemory();
// Set XML version & encoding
$this->xml->startDocument( '1.0', 'UTF-8' );
$request_data = $this->get_request_data();
SV_WC_Helper::array_to_xml( $this->xml, $this->get_root_element(), $request_data[ $this->get_root_element() ] );
$this->xml->endDocument();
return $this->request_xml = $this->xml->outputMemory();
}
/**
* Return the request data to be converted to XML
*
* @since 4.3.0
* @return array
*/
public function get_request_data() {
return $this->request_data;
}
/**
* Get the string representation of this request
*
* @since 4.3.0
* @see SV_WC_API_Request::to_string()
* @return string
*/
public function to_string() {
return $this->to_xml();
}
/**
* Get the string representation of this request with any and all sensitive elements masked
* or removed.
*
* @since 4.3.0
* @see SV_WC_API_Request::to_string_safe()
* @return string
*/
public function to_string_safe() {
return $this->prettify_xml( $this->to_string() );
}
/**
* Helper method for making XML pretty, suitable for logging or rendering
*
* @since 4.3.0
* @param string $xml_string ugly XML string
* @return string
*/
public function prettify_xml( $xml_string ) {
$dom = new DOMDocument();
// suppress errors for invalid XML syntax issues
if ( @$dom->loadXML( $xml_string ) ) {
$dom->formatOutput = true;
$xml_string = $dom->saveXML();
}
return $xml_string;
}
/**
* Concrete classes must implement this method to return the root element
* for the XML document
*
* @since 4.3.0
* @return string
*/
abstract protected function get_root_element();
}
endif; // class exists check