@@ -22,19 +22,19 @@ discard block |
||
22 | 22 | { |
23 | 23 | const ERROR_NO_BOUNDARIES_SPECIFIED = 44401; |
24 | 24 | |
25 | - /** |
|
26 | - * @var RequestHelper |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var RequestHelper |
|
27 | + */ |
|
28 | 28 | protected $helper; |
29 | 29 | |
30 | - /** |
|
31 | - * @var RequestHelper_Boundaries_Boundary[] |
|
32 | - */ |
|
30 | + /** |
|
31 | + * @var RequestHelper_Boundaries_Boundary[] |
|
32 | + */ |
|
33 | 33 | protected $boundaries = array(); |
34 | 34 | |
35 | - /** |
|
36 | - * @var integer |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var integer |
|
37 | + */ |
|
38 | 38 | protected $contentLength = 0; |
39 | 39 | |
40 | 40 | public function __construct(RequestHelper $helper) |
@@ -42,31 +42,31 @@ discard block |
||
42 | 42 | $this->helper = $helper; |
43 | 43 | } |
44 | 44 | |
45 | - /** |
|
46 | - * Retrieves the string that is used to separate mime boundaries in the body. |
|
47 | - * |
|
48 | - * @return string |
|
49 | - */ |
|
45 | + /** |
|
46 | + * Retrieves the string that is used to separate mime boundaries in the body. |
|
47 | + * |
|
48 | + * @return string |
|
49 | + */ |
|
50 | 50 | public function getMimeBoundary() : string |
51 | 51 | { |
52 | 52 | return $this->helper->getMimeBoundary(); |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Retrieves the end of line character(s) used in the body. |
|
57 | - * |
|
58 | - * @return string |
|
59 | - */ |
|
55 | + /** |
|
56 | + * Retrieves the end of line character(s) used in the body. |
|
57 | + * |
|
58 | + * @return string |
|
59 | + */ |
|
60 | 60 | public function getEOL() : string |
61 | 61 | { |
62 | 62 | return $this->helper->getEOL(); |
63 | 63 | } |
64 | 64 | |
65 | - /** |
|
66 | - * Retrieves the total content length of all boundary contents. |
|
67 | - * |
|
68 | - * @return int |
|
69 | - */ |
|
65 | + /** |
|
66 | + * Retrieves the total content length of all boundary contents. |
|
67 | + * |
|
68 | + * @return int |
|
69 | + */ |
|
70 | 70 | public function getContentLength() : int |
71 | 71 | { |
72 | 72 | // this must use strlen, and not mb_strlen: the content length |
@@ -75,15 +75,15 @@ discard block |
||
75 | 75 | return strlen($this->render()); |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Adds a file to be sent with the request. |
|
80 | - * |
|
81 | - * @param string $varName The variable name to send the file in |
|
82 | - * @param string $fileName The name of the file as it should be received at the destination |
|
83 | - * @param string $content The raw content of the file |
|
84 | - * @param string $contentType The content type, use the constants to specify this |
|
85 | - * @param string $encoding The encoding of the file, use the constants to specify this |
|
86 | - */ |
|
78 | + /** |
|
79 | + * Adds a file to be sent with the request. |
|
80 | + * |
|
81 | + * @param string $varName The variable name to send the file in |
|
82 | + * @param string $fileName The name of the file as it should be received at the destination |
|
83 | + * @param string $content The raw content of the file |
|
84 | + * @param string $contentType The content type, use the constants to specify this |
|
85 | + * @param string $encoding The encoding of the file, use the constants to specify this |
|
86 | + */ |
|
87 | 87 | public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries |
88 | 88 | { |
89 | 89 | if(empty($contentType)) |
@@ -107,13 +107,13 @@ discard block |
||
107 | 107 | return $this->addBoundary($boundary); |
108 | 108 | } |
109 | 109 | |
110 | - /** |
|
111 | - * Adds arbitrary content. |
|
112 | - * |
|
113 | - * @param string $varName |
|
114 | - * @param string $content |
|
115 | - * @param string $contentType |
|
116 | - */ |
|
110 | + /** |
|
111 | + * Adds arbitrary content. |
|
112 | + * |
|
113 | + * @param string $varName |
|
114 | + * @param string $content |
|
115 | + * @param string $contentType |
|
116 | + */ |
|
117 | 117 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries |
118 | 118 | { |
119 | 119 | $content = ConvertHelper::string2utf8($content); |
@@ -127,13 +127,13 @@ discard block |
||
127 | 127 | return $this->addBoundary($boundary); |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Adds a variable to be sent with the request. If it |
|
132 | - * already exists, its value is overwritten. |
|
133 | - * |
|
134 | - * @param string $name |
|
135 | - * @param string $value |
|
136 | - */ |
|
130 | + /** |
|
131 | + * Adds a variable to be sent with the request. If it |
|
132 | + * already exists, its value is overwritten. |
|
133 | + * |
|
134 | + * @param string $name |
|
135 | + * @param string $value |
|
136 | + */ |
|
137 | 137 | public function addVariable(string $name, string $value) : RequestHelper_Boundaries |
138 | 138 | { |
139 | 139 | $boundary = $this->createBoundary($value) |
@@ -149,11 +149,11 @@ discard block |
||
149 | 149 | return $this; |
150 | 150 | } |
151 | 151 | |
152 | - /** |
|
153 | - * Renders the response body with all mime boundaries. |
|
154 | - * |
|
155 | - * @return string |
|
156 | - */ |
|
152 | + /** |
|
153 | + * Renders the response body with all mime boundaries. |
|
154 | + * |
|
155 | + * @return string |
|
156 | + */ |
|
157 | 157 | public function render() : string |
158 | 158 | { |
159 | 159 | if(empty($this->boundaries)) |
@@ -37,25 +37,25 @@ discard block |
||
37 | 37 | |
38 | 38 | const ERROR_INVALID_SERIALIZED_DATA = 56301; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $string; |
44 | 44 | |
45 | - /** |
|
46 | - * @var mixed |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var mixed |
|
47 | + */ |
|
48 | 48 | protected $value; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $type; |
54 | 54 | |
55 | - /** |
|
56 | - * @param mixed $value |
|
57 | - * @param array|null $serialized |
|
58 | - */ |
|
55 | + /** |
|
56 | + * @param mixed $value |
|
57 | + * @param array|null $serialized |
|
58 | + */ |
|
59 | 59 | public function __construct($value, $serialized=null) |
60 | 60 | { |
61 | 61 | if(is_array($serialized)) |
@@ -68,40 +68,40 @@ discard block |
||
68 | 68 | } |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * Creates a new variable info instance from a PHP variable |
|
73 | - * of any type. |
|
74 | - * |
|
75 | - * @param mixed $variable |
|
76 | - * @return VariableInfo |
|
77 | - */ |
|
71 | + /** |
|
72 | + * Creates a new variable info instance from a PHP variable |
|
73 | + * of any type. |
|
74 | + * |
|
75 | + * @param mixed $variable |
|
76 | + * @return VariableInfo |
|
77 | + */ |
|
78 | 78 | public static function fromVariable($variable) : VariableInfo |
79 | 79 | { |
80 | 80 | return new VariableInfo($variable); |
81 | 81 | } |
82 | 82 | |
83 | - /** |
|
84 | - * Restores a variable info instance using a previously serialized |
|
85 | - * array using the serialize() method. |
|
86 | - * |
|
87 | - * @param array $serialized |
|
88 | - * @return VariableInfo |
|
89 | - * @see VariableInfo::serialize() |
|
90 | - */ |
|
83 | + /** |
|
84 | + * Restores a variable info instance using a previously serialized |
|
85 | + * array using the serialize() method. |
|
86 | + * |
|
87 | + * @param array $serialized |
|
88 | + * @return VariableInfo |
|
89 | + * @see VariableInfo::serialize() |
|
90 | + */ |
|
91 | 91 | public static function fromSerialized(array $serialized) : VariableInfo |
92 | 92 | { |
93 | 93 | return new VariableInfo(null, $serialized); |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Parses a previously serialized data set to restore the |
|
98 | - * variable information from it. |
|
99 | - * |
|
100 | - * @param array $serialized |
|
101 | - * @throws BaseException |
|
102 | - * |
|
103 | - * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA |
|
104 | - */ |
|
96 | + /** |
|
97 | + * Parses a previously serialized data set to restore the |
|
98 | + * variable information from it. |
|
99 | + * |
|
100 | + * @param array $serialized |
|
101 | + * @throws BaseException |
|
102 | + * |
|
103 | + * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA |
|
104 | + */ |
|
105 | 105 | protected function parseSerialized(array $serialized) : void |
106 | 106 | { |
107 | 107 | if(!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options'])) |
@@ -136,12 +136,12 @@ discard block |
||
136 | 136 | return $this->value; |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * The variable type - this is the same string that |
|
141 | - * is returned by the PHP function `gettype`. |
|
142 | - * |
|
143 | - * @return string |
|
144 | - */ |
|
139 | + /** |
|
140 | + * The variable type - this is the same string that |
|
141 | + * is returned by the PHP function `gettype`. |
|
142 | + * |
|
143 | + * @return string |
|
144 | + */ |
|
145 | 145 | public function getType() : string |
146 | 146 | { |
147 | 147 | return $this->type; |
@@ -155,13 +155,13 @@ discard block |
||
155 | 155 | ); |
156 | 156 | } |
157 | 157 | |
158 | - /** |
|
159 | - * Whether to prepend the variable type before the value, |
|
160 | - * like the var_dump function. Example: <code>string "Some text"</code>. |
|
161 | - * |
|
162 | - * @param bool $enable |
|
163 | - * @return VariableInfo |
|
164 | - */ |
|
158 | + /** |
|
159 | + * Whether to prepend the variable type before the value, |
|
160 | + * like the var_dump function. Example: <code>string "Some text"</code>. |
|
161 | + * |
|
162 | + * @param bool $enable |
|
163 | + * @return VariableInfo |
|
164 | + */ |
|
165 | 165 | public function enableType(bool $enable=true) : VariableInfo |
166 | 166 | { |
167 | 167 | return $this->setOption('prepend-type', $enable); |
@@ -32,39 +32,39 @@ discard block |
||
32 | 32 | const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. |
33 | 33 | const SECONDS_PER_YEAR = 31536000; |
34 | 34 | |
35 | - /** |
|
36 | - * @var int |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var int |
|
37 | + */ |
|
38 | 38 | protected $dateFrom; |
39 | 39 | |
40 | - /** |
|
41 | - * @var int |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var int |
|
42 | + */ |
|
43 | 43 | protected $dateTo; |
44 | 44 | |
45 | - /** |
|
46 | - * @var bool |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var bool |
|
47 | + */ |
|
48 | 48 | protected $future = false; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $interval = ''; |
54 | 54 | |
55 | - /** |
|
56 | - * @var int |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var int |
|
57 | + */ |
|
58 | 58 | protected $difference = 0; |
59 | 59 | |
60 | - /** |
|
61 | - * @var int |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var int |
|
62 | + */ |
|
63 | 63 | protected $dateDiff = 0; |
64 | 64 | |
65 | - /** |
|
66 | - * @var array|NULL |
|
67 | - */ |
|
65 | + /** |
|
66 | + * @var array|NULL |
|
67 | + */ |
|
68 | 68 | protected static $texts = null; |
69 | 69 | |
70 | 70 | public function __construct() |
@@ -84,17 +84,17 @@ discard block |
||
84 | 84 | self::$texts = null; |
85 | 85 | } |
86 | 86 | |
87 | - /** |
|
88 | - * Sets the origin date to calculate from. |
|
89 | - * |
|
90 | - * NOTE: if this is further in the future than |
|
91 | - * the to: date, it will be considered as a |
|
92 | - * calculation for something to come, i.e. |
|
93 | - * "In two days". |
|
94 | - * |
|
95 | - * @param \DateTime $date |
|
96 | - * @return ConvertHelper_DurationConverter |
|
97 | - */ |
|
87 | + /** |
|
88 | + * Sets the origin date to calculate from. |
|
89 | + * |
|
90 | + * NOTE: if this is further in the future than |
|
91 | + * the to: date, it will be considered as a |
|
92 | + * calculation for something to come, i.e. |
|
93 | + * "In two days". |
|
94 | + * |
|
95 | + * @param \DateTime $date |
|
96 | + * @return ConvertHelper_DurationConverter |
|
97 | + */ |
|
98 | 98 | public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter |
99 | 99 | { |
100 | 100 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -102,13 +102,13 @@ discard block |
||
102 | 102 | return $this; |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Sets the date to calculate to. Defaults to |
|
107 | - * the current time if not set. |
|
108 | - * |
|
109 | - * @param \DateTime $date |
|
110 | - * @return ConvertHelper_DurationConverter |
|
111 | - */ |
|
105 | + /** |
|
106 | + * Sets the date to calculate to. Defaults to |
|
107 | + * the current time if not set. |
|
108 | + * |
|
109 | + * @param \DateTime $date |
|
110 | + * @return ConvertHelper_DurationConverter |
|
111 | + */ |
|
112 | 112 | public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter |
113 | 113 | { |
114 | 114 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -116,14 +116,14 @@ discard block |
||
116 | 116 | return $this; |
117 | 117 | } |
118 | 118 | |
119 | - /** |
|
120 | - * Converts the specified dates to a human readable string. |
|
121 | - * |
|
122 | - * @throws ConvertHelper_Exception |
|
123 | - * @return string |
|
124 | - * |
|
125 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
126 | - */ |
|
119 | + /** |
|
120 | + * Converts the specified dates to a human readable string. |
|
121 | + * |
|
122 | + * @throws ConvertHelper_Exception |
|
123 | + * @return string |
|
124 | + * |
|
125 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
126 | + */ |
|
127 | 127 | public function convert() : string |
128 | 128 | { |
129 | 129 | $this->initTexts(); |
@@ -31,17 +31,17 @@ discard block |
||
31 | 31 | |
32 | 32 | const BASE_2 = 1024; |
33 | 33 | |
34 | - /** |
|
35 | - * @var ConvertHelper_StorageSizeEnum_Size[] |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var ConvertHelper_StorageSizeEnum_Size[] |
|
36 | + */ |
|
37 | 37 | protected static $sizes = array(); |
38 | 38 | |
39 | - /** |
|
40 | - * Initializes the supported unit notations, and |
|
41 | - * how they are supposed to be calculated. |
|
42 | - * |
|
43 | - * @see ConvertHelper_SizeNotation::parseSize() |
|
44 | - */ |
|
39 | + /** |
|
40 | + * Initializes the supported unit notations, and |
|
41 | + * how they are supposed to be calculated. |
|
42 | + * |
|
43 | + * @see ConvertHelper_SizeNotation::parseSize() |
|
44 | + */ |
|
45 | 45 | protected static function init() : void |
46 | 46 | { |
47 | 47 | if(!empty(self::$sizes)) { |
@@ -68,28 +68,28 @@ discard block |
||
68 | 68 | } |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * Called whenever the application locale is changed, |
|
73 | - * to reset the size definitions so the labels get |
|
74 | - * translated to the new locale. |
|
75 | - */ |
|
71 | + /** |
|
72 | + * Called whenever the application locale is changed, |
|
73 | + * to reset the size definitions so the labels get |
|
74 | + * translated to the new locale. |
|
75 | + */ |
|
76 | 76 | public static function handle_localeChanged() : void |
77 | 77 | { |
78 | 78 | self::$sizes = array(); |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Adds a storage size to the internal collection. |
|
83 | - * |
|
84 | - * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
85 | - * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
86 | - * @param int $exponent The multiplier of the base to get the byte value |
|
87 | - * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
88 | - * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
89 | - * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
90 | - * |
|
91 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
92 | - */ |
|
81 | + /** |
|
82 | + * Adds a storage size to the internal collection. |
|
83 | + * |
|
84 | + * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
85 | + * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
86 | + * @param int $exponent The multiplier of the base to get the byte value |
|
87 | + * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
88 | + * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
89 | + * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
90 | + * |
|
91 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
92 | + */ |
|
93 | 93 | protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) : void |
94 | 94 | { |
95 | 95 | self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size( |
@@ -102,11 +102,11 @@ discard block |
||
102 | 102 | ); |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Retrieves all known sizes. |
|
107 | - * |
|
108 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
109 | - */ |
|
105 | + /** |
|
106 | + * Retrieves all known sizes. |
|
107 | + * |
|
108 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
109 | + */ |
|
110 | 110 | public static function getSizes() : array |
111 | 111 | { |
112 | 112 | self::init(); |
@@ -114,15 +114,15 @@ discard block |
||
114 | 114 | return self::$sizes; |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Retrieves a size definition instance by its name. |
|
119 | - * |
|
120 | - * @param string $name Case insensitive. For example "kb", "MiB"... |
|
121 | - * @throws ConvertHelper_Exception |
|
122 | - * @return ConvertHelper_StorageSizeEnum_Size |
|
123 | - * |
|
124 | - * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
125 | - */ |
|
117 | + /** |
|
118 | + * Retrieves a size definition instance by its name. |
|
119 | + * |
|
120 | + * @param string $name Case insensitive. For example "kb", "MiB"... |
|
121 | + * @throws ConvertHelper_Exception |
|
122 | + * @return ConvertHelper_StorageSizeEnum_Size |
|
123 | + * |
|
124 | + * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
125 | + */ |
|
126 | 126 | public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size |
127 | 127 | { |
128 | 128 | self::init(); |
@@ -144,10 +144,10 @@ discard block |
||
144 | 144 | ); |
145 | 145 | } |
146 | 146 | |
147 | - /** |
|
148 | - * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
149 | - * @return array |
|
150 | - */ |
|
147 | + /** |
|
148 | + * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
149 | + * @return array |
|
150 | + */ |
|
151 | 151 | public static function getSizeNames() : array |
152 | 152 | { |
153 | 153 | self::init(); |
@@ -155,16 +155,16 @@ discard block |
||
155 | 155 | return array_keys(self::$sizes); |
156 | 156 | } |
157 | 157 | |
158 | - /** |
|
159 | - * Retrieves all available storage sizes for the specified |
|
160 | - * base value. |
|
161 | - * |
|
162 | - * @param int $base |
|
163 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
164 | - * |
|
165 | - * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
166 | - * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
167 | - */ |
|
158 | + /** |
|
159 | + * Retrieves all available storage sizes for the specified |
|
160 | + * base value. |
|
161 | + * |
|
162 | + * @param int $base |
|
163 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
164 | + * |
|
165 | + * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
166 | + * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
167 | + */ |
|
168 | 168 | public static function getSizesByBase(int $base) : array |
169 | 169 | { |
170 | 170 | self::init(); |
@@ -23,37 +23,37 @@ |
||
23 | 23 | { |
24 | 24 | const ERROR_NOT_LOADED_YET = 56501; |
25 | 25 | |
26 | - /** |
|
27 | - * @var \SimpleXMLElement|NULL |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var \SimpleXMLElement|NULL |
|
28 | + */ |
|
29 | 29 | private $element = null; |
30 | 30 | |
31 | - /** |
|
32 | - * @var XMLHelper_SimpleXML_Error[] |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var XMLHelper_SimpleXML_Error[] |
|
33 | + */ |
|
34 | 34 | private $errors = array(); |
35 | 35 | |
36 | - /** |
|
37 | - * Creates a simplexml instance from an XML string. |
|
38 | - * |
|
39 | - * NOTE: returns false in case of a fatal error. |
|
40 | - * |
|
41 | - * @param string $string |
|
42 | - * @return \SimpleXMLElement|NULL |
|
43 | - */ |
|
36 | + /** |
|
37 | + * Creates a simplexml instance from an XML string. |
|
38 | + * |
|
39 | + * NOTE: returns false in case of a fatal error. |
|
40 | + * |
|
41 | + * @param string $string |
|
42 | + * @return \SimpleXMLElement|NULL |
|
43 | + */ |
|
44 | 44 | public function loadString(string $string) : ?\SimpleXMLElement |
45 | 45 | { |
46 | 46 | return $this->load('string', $string); |
47 | 47 | } |
48 | 48 | |
49 | - /** |
|
50 | - * Creates a simplexml instance from an XML file. |
|
51 | - * |
|
52 | - * NOTE: returns false in case of a fatal error. |
|
53 | - * |
|
54 | - * @param string $file |
|
55 | - * @return \SimpleXMLElement|NULL |
|
56 | - */ |
|
49 | + /** |
|
50 | + * Creates a simplexml instance from an XML file. |
|
51 | + * |
|
52 | + * NOTE: returns false in case of a fatal error. |
|
53 | + * |
|
54 | + * @param string $file |
|
55 | + * @return \SimpleXMLElement|NULL |
|
56 | + */ |
|
57 | 57 | public function loadFile(string $file) : ?\SimpleXMLElement |
58 | 58 | { |
59 | 59 | return $this->load('file', $file); |
@@ -24,9 +24,9 @@ |
||
24 | 24 | const ERROR_CANNOT_UNSERIALIZE_ERROR_DATA = 57201; |
25 | 25 | const ERROR_ERROR_DATA_KEY_MISSING = 57202; |
26 | 26 | |
27 | - /** |
|
28 | - * @var \LibXMLError |
|
29 | - */ |
|
27 | + /** |
|
28 | + * @var \LibXMLError |
|
29 | + */ |
|
30 | 30 | private $error; |
31 | 31 | |
32 | 32 | private static $requiredKeys = array( |
@@ -36,19 +36,19 @@ discard block |
||
36 | 36 | { |
37 | 37 | const ERROR_STRING_ALREADY_HAS_BODY_TAG = 57001; |
38 | 38 | |
39 | - /** |
|
40 | - * @var \DOMElement |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var \DOMElement |
|
41 | + */ |
|
42 | 42 | private $bodyNode; |
43 | 43 | |
44 | - /** |
|
45 | - * @var XMLHelper_DOMErrors |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var XMLHelper_DOMErrors |
|
46 | + */ |
|
47 | 47 | private $errors; |
48 | 48 | |
49 | - /** |
|
50 | - * @var string |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var string |
|
51 | + */ |
|
52 | 52 | private static $htmlTemplate = |
53 | 53 | '<!DOCTYPE html>'. |
54 | 54 | '<html>'. |
@@ -60,9 +60,9 @@ discard block |
||
60 | 60 | '</body>'. |
61 | 61 | '</html>'; |
62 | 62 | |
63 | - /** |
|
64 | - * @var \DOMDocument |
|
65 | - */ |
|
63 | + /** |
|
64 | + * @var \DOMDocument |
|
65 | + */ |
|
66 | 66 | private $dom; |
67 | 67 | |
68 | 68 | private function __construct(string $html) |
@@ -70,13 +70,13 @@ discard block |
||
70 | 70 | $this->load($html); |
71 | 71 | } |
72 | 72 | |
73 | - /** |
|
74 | - * Creates an HTML loader from an HTML fragment (without |
|
75 | - * doctype, head and body elements). |
|
76 | - * |
|
77 | - * @param string $fragment |
|
78 | - * @return XMLHelper_HTMLLoader |
|
79 | - */ |
|
73 | + /** |
|
74 | + * Creates an HTML loader from an HTML fragment (without |
|
75 | + * doctype, head and body elements). |
|
76 | + * |
|
77 | + * @param string $fragment |
|
78 | + * @return XMLHelper_HTMLLoader |
|
79 | + */ |
|
80 | 80 | public static function loadFragment(string $fragment) : XMLHelper_HTMLLoader |
81 | 81 | { |
82 | 82 | self::checkFragment($fragment); |
@@ -87,24 +87,24 @@ discard block |
||
87 | 87 | return new XMLHelper_HTMLLoader($pseudoHTML); |
88 | 88 | } |
89 | 89 | |
90 | - /** |
|
91 | - * Creates an HTML loader from a full HTML document (including |
|
92 | - * doctype, head and body elements). |
|
93 | - * |
|
94 | - * @param string $html |
|
95 | - * @return XMLHelper_HTMLLoader |
|
96 | - */ |
|
90 | + /** |
|
91 | + * Creates an HTML loader from a full HTML document (including |
|
92 | + * doctype, head and body elements). |
|
93 | + * |
|
94 | + * @param string $html |
|
95 | + * @return XMLHelper_HTMLLoader |
|
96 | + */ |
|
97 | 97 | public static function loadHTML(string $html) : XMLHelper_HTMLLoader |
98 | 98 | { |
99 | 99 | return new XMLHelper_HTMLLoader($html); |
100 | 100 | } |
101 | 101 | |
102 | - /** |
|
103 | - * Verifies that the fragment does not already contain a body element or doctype. |
|
104 | - * |
|
105 | - * @param string $fragment |
|
106 | - * @throws XMLHelper_Exception |
|
107 | - */ |
|
102 | + /** |
|
103 | + * Verifies that the fragment does not already contain a body element or doctype. |
|
104 | + * |
|
105 | + * @param string $fragment |
|
106 | + * @throws XMLHelper_Exception |
|
107 | + */ |
|
108 | 108 | private static function checkFragment(string $fragment) : void |
109 | 109 | { |
110 | 110 | if(!stristr($fragment, '<body') && !stristr($fragment, 'doctype')) |
@@ -142,65 +142,65 @@ discard block |
||
142 | 142 | return $this->bodyNode; |
143 | 143 | } |
144 | 144 | |
145 | - /** |
|
146 | - * Retrieves the document's `<body>` tag node. |
|
147 | - * |
|
148 | - * @return \DOMDocument |
|
149 | - */ |
|
145 | + /** |
|
146 | + * Retrieves the document's `<body>` tag node. |
|
147 | + * |
|
148 | + * @return \DOMDocument |
|
149 | + */ |
|
150 | 150 | public function getDOM() : \DOMDocument |
151 | 151 | { |
152 | 152 | return $this->dom; |
153 | 153 | } |
154 | 154 | |
155 | - /** |
|
156 | - * Retrieves all nodes from the HTML fragment (= child nodes |
|
157 | - * of the `<body>` element). |
|
158 | - * |
|
159 | - * @return \DOMNodeList |
|
160 | - */ |
|
155 | + /** |
|
156 | + * Retrieves all nodes from the HTML fragment (= child nodes |
|
157 | + * of the `<body>` element). |
|
158 | + * |
|
159 | + * @return \DOMNodeList |
|
160 | + */ |
|
161 | 161 | public function getFragmentNodes() : \DOMNodeList |
162 | 162 | { |
163 | 163 | return $this->bodyNode->childNodes; |
164 | 164 | } |
165 | 165 | |
166 | - /** |
|
167 | - * Retrieves the LibXML HTML parsing errors collection, which |
|
168 | - * can be used to review any errors that occurred while loading |
|
169 | - * the HTML document. |
|
170 | - * |
|
171 | - * @return XMLHelper_DOMErrors |
|
172 | - */ |
|
166 | + /** |
|
167 | + * Retrieves the LibXML HTML parsing errors collection, which |
|
168 | + * can be used to review any errors that occurred while loading |
|
169 | + * the HTML document. |
|
170 | + * |
|
171 | + * @return XMLHelper_DOMErrors |
|
172 | + */ |
|
173 | 173 | public function getErrors() : XMLHelper_DOMErrors |
174 | 174 | { |
175 | 175 | return $this->errors; |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Returns a valid HTML string. |
|
180 | - * |
|
181 | - * @return string |
|
182 | - */ |
|
178 | + /** |
|
179 | + * Returns a valid HTML string. |
|
180 | + * |
|
181 | + * @return string |
|
182 | + */ |
|
183 | 183 | public function toHTML() : string |
184 | 184 | { |
185 | 185 | return $this->dom->saveHTML(); |
186 | 186 | } |
187 | 187 | |
188 | - /** |
|
189 | - * Returns a valid XML string. |
|
190 | - * |
|
191 | - * @return string |
|
192 | - */ |
|
188 | + /** |
|
189 | + * Returns a valid XML string. |
|
190 | + * |
|
191 | + * @return string |
|
192 | + */ |
|
193 | 193 | public function toXML() : string |
194 | 194 | { |
195 | 195 | return $this->dom->saveXML(); |
196 | 196 | } |
197 | 197 | |
198 | - /** |
|
199 | - * Converts the HTML fragment to valid XML (= all |
|
200 | - * child nodes of the `<body>` element). |
|
201 | - * |
|
202 | - * @return string |
|
203 | - */ |
|
198 | + /** |
|
199 | + * Converts the HTML fragment to valid XML (= all |
|
200 | + * child nodes of the `<body>` element). |
|
201 | + * |
|
202 | + * @return string |
|
203 | + */ |
|
204 | 204 | public function fragmentToXML() : string |
205 | 205 | { |
206 | 206 | $nodes = $this->getFragmentNodes(); |
@@ -23,14 +23,14 @@ discard block |
||
23 | 23 | { |
24 | 24 | const SERIALIZE_SEPARATOR = '__SERSEP__'; |
25 | 25 | |
26 | - /** |
|
27 | - * @var XMLHelper_DOMErrors_Error[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var XMLHelper_DOMErrors_Error[] |
|
28 | + */ |
|
29 | 29 | private $errors; |
30 | 30 | |
31 | - /** |
|
32 | - * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors |
|
33 | + */ |
|
34 | 34 | public function __construct(array $libxmlErrors) |
35 | 35 | { |
36 | 36 | foreach($libxmlErrors as $error) |
@@ -56,11 +56,11 @@ discard block |
||
56 | 56 | return $this->errors; |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Retrieves all warnings, if any. |
|
61 | - * |
|
62 | - * @return XMLHelper_DOMErrors_Error[] |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Retrieves all warnings, if any. |
|
61 | + * |
|
62 | + * @return XMLHelper_DOMErrors_Error[] |
|
63 | + */ |
|
64 | 64 | public function getWarnings() |
65 | 65 | { |
66 | 66 | return $this->getByLevel(LIBXML_ERR_WARNING); |
@@ -107,12 +107,12 @@ discard block |
||
107 | 107 | } |
108 | 108 | |
109 | 109 | |
110 | - /** |
|
111 | - * Retrieves all errors by the specified libxml error level. |
|
112 | - * |
|
113 | - * @param int $level |
|
114 | - * @return \AppUtils\XMLHelper_DOMErrors_Error[] |
|
115 | - */ |
|
110 | + /** |
|
111 | + * Retrieves all errors by the specified libxml error level. |
|
112 | + * |
|
113 | + * @param int $level |
|
114 | + * @return \AppUtils\XMLHelper_DOMErrors_Error[] |
|
115 | + */ |
|
116 | 116 | public function getByLevel(int $level) |
117 | 117 | { |
118 | 118 | $result = array(); |
@@ -128,12 +128,12 @@ discard block |
||
128 | 128 | return $result; |
129 | 129 | } |
130 | 130 | |
131 | - /** |
|
132 | - * Retrieves all errors by the specified libxml error code. |
|
133 | - * |
|
134 | - * @param int $code |
|
135 | - * @return \AppUtils\XMLHelper_DOMErrors_Error[] |
|
136 | - */ |
|
131 | + /** |
|
132 | + * Retrieves all errors by the specified libxml error code. |
|
133 | + * |
|
134 | + * @param int $code |
|
135 | + * @return \AppUtils\XMLHelper_DOMErrors_Error[] |
|
136 | + */ |
|
137 | 137 | public function getByCode(int $code) |
138 | 138 | { |
139 | 139 | $result = array(); |
@@ -149,12 +149,12 @@ discard block |
||
149 | 149 | return $result; |
150 | 150 | } |
151 | 151 | |
152 | - /** |
|
153 | - * Checks whether there are errors matching the libxml error level. |
|
154 | - * |
|
155 | - * @param int $level |
|
156 | - * @return bool |
|
157 | - */ |
|
152 | + /** |
|
153 | + * Checks whether there are errors matching the libxml error level. |
|
154 | + * |
|
155 | + * @param int $level |
|
156 | + * @return bool |
|
157 | + */ |
|
158 | 158 | public function hasErrorsByLevel(int $level) : bool |
159 | 159 | { |
160 | 160 | foreach($this->errors as $error) |
@@ -168,12 +168,12 @@ discard block |
||
168 | 168 | return false; |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * Checks whether there are any errors matching the libxml error code. |
|
173 | - * |
|
174 | - * @param int $code |
|
175 | - * @return bool |
|
176 | - */ |
|
171 | + /** |
|
172 | + * Checks whether there are any errors matching the libxml error code. |
|
173 | + * |
|
174 | + * @param int $code |
|
175 | + * @return bool |
|
176 | + */ |
|
177 | 177 | public function hasErrorsByCode(int $code) : bool |
178 | 178 | { |
179 | 179 | foreach($this->errors as $error) |
@@ -199,13 +199,13 @@ discard block |
||
199 | 199 | return $result; |
200 | 200 | } |
201 | 201 | |
202 | - /** |
|
203 | - * Serializes the errors collection, so it can be stored and |
|
204 | - * restored as needed, using the `fromSerialized()` method. |
|
205 | - * |
|
206 | - * @return string |
|
207 | - * @see XMLHelper_DOMErrors::fromSerialized() |
|
208 | - */ |
|
202 | + /** |
|
203 | + * Serializes the errors collection, so it can be stored and |
|
204 | + * restored as needed, using the `fromSerialized()` method. |
|
205 | + * |
|
206 | + * @return string |
|
207 | + * @see XMLHelper_DOMErrors::fromSerialized() |
|
208 | + */ |
|
209 | 209 | public function serialize() : string |
210 | 210 | { |
211 | 211 | $data = array(); |
@@ -218,14 +218,14 @@ discard block |
||
218 | 218 | return implode(self::SERIALIZE_SEPARATOR, $data); |
219 | 219 | } |
220 | 220 | |
221 | - /** |
|
222 | - * Restores the errors collection from a previously serialized |
|
223 | - * collection, using `serialize()`. |
|
224 | - * |
|
225 | - * @param string $serialized |
|
226 | - * @return XMLHelper_DOMErrors |
|
227 | - * @see XMLHelper_DOMErrors::serialize() |
|
228 | - */ |
|
221 | + /** |
|
222 | + * Restores the errors collection from a previously serialized |
|
223 | + * collection, using `serialize()`. |
|
224 | + * |
|
225 | + * @param string $serialized |
|
226 | + * @return XMLHelper_DOMErrors |
|
227 | + * @see XMLHelper_DOMErrors::serialize() |
|
228 | + */ |
|
229 | 229 | public static function fromSerialized(string $serialized) : XMLHelper_DOMErrors |
230 | 230 | { |
231 | 231 | $parts = explode(self::SERIALIZE_SEPARATOR, $serialized); |
@@ -14,9 +14,9 @@ |
||
14 | 14 | * @see http://www.xmlsoft.org/html/libxml-xmlerror.html |
15 | 15 | */ |
16 | 16 | |
17 | - /** |
|
18 | - * @var string $list |
|
19 | - */ |
|
17 | + /** |
|
18 | + * @var string $list |
|
19 | + */ |
|
20 | 20 | $list = file_get_contents('libxmlerrors.txt'); |
21 | 21 | $outputFile = 'LibXML.php'; |
22 | 22 | $lines = explode("\n", $list); |