@@ -5,12 +5,12 @@ |
||
| 5 | 5 | // @codingStandardsIgnoreFile |
| 6 | 6 | |
| 7 | 7 | /** |
| 8 | - * This interface exists to provide backwards compatibility with PHP 5.3 |
|
| 9 | - * |
|
| 10 | - * This should _not_ be used by any third-party code. |
|
| 11 | - * |
|
| 12 | - * @ignore |
|
| 13 | - */ |
|
| 8 | + * This interface exists to provide backwards compatibility with PHP 5.3 |
|
| 9 | + * |
|
| 10 | + * This should _not_ be used by any third-party code. |
|
| 11 | + * |
|
| 12 | + * @ignore |
|
| 13 | + */ |
|
| 14 | 14 | if (interface_exists('JsonSerializable')) { |
| 15 | 15 | interface JsonSerializable extends \JsonSerializable |
| 16 | 16 | { |
@@ -9,780 +9,780 @@ |
||
| 9 | 9 | * @author Roman Ožana <[email protected]> |
| 10 | 10 | */ |
| 11 | 11 | class Emogrifier { |
| 12 | - /** |
|
| 13 | - * @var string |
|
| 14 | - */ |
|
| 15 | - const ENCODING = 'UTF-8'; |
|
| 16 | - |
|
| 17 | - /** |
|
| 18 | - * @var integer |
|
| 19 | - */ |
|
| 20 | - const CACHE_KEY_CSS = 0; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * @var integer |
|
| 24 | - */ |
|
| 25 | - const CACHE_KEY_SELECTOR = 1; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @var integer |
|
| 29 | - */ |
|
| 30 | - const CACHE_KEY_XPATH = 2; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var integer |
|
| 34 | - */ |
|
| 35 | - const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * for calculating nth-of-type and nth-child selectors. |
|
| 39 | - * |
|
| 40 | - * @var integer |
|
| 41 | - */ |
|
| 42 | - const INDEX = 0; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * for calculating nth-of-type and nth-child selectors. |
|
| 46 | - * |
|
| 47 | - * @var integer |
|
| 48 | - */ |
|
| 49 | - const MULTIPLIER = 1; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 54 | - const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 59 | - const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * @var string |
|
| 63 | - */ |
|
| 64 | - private $html = ''; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @var string |
|
| 68 | - */ |
|
| 69 | - private $css = ''; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @var array<string> |
|
| 73 | - */ |
|
| 74 | - private $unprocessableHtmlTags = array('wbr'); |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * @var array<array> |
|
| 78 | - */ |
|
| 79 | - private $caches = array( |
|
| 80 | - self::CACHE_KEY_CSS => array(), |
|
| 81 | - self::CACHE_KEY_SELECTOR => array(), |
|
| 82 | - self::CACHE_KEY_XPATH => array(), |
|
| 83 | - self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
| 84 | - ); |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * the visited nodes with the XPath paths as array keys. |
|
| 88 | - * |
|
| 89 | - * @var array<\DOMNode> |
|
| 90 | - */ |
|
| 91 | - private $visitedNodes = array(); |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
| 95 | - * as key/value pairs for the inner array. |
|
| 96 | - * |
|
| 97 | - * @var array<array><string> |
|
| 98 | - */ |
|
| 99 | - private $styleAttributesForNodes = array(); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * This attribute applies to the case where you want to preserve your original text encoding. |
|
| 103 | - * |
|
| 104 | - * By default, emogrifier translates your text into HTML entities for two reasons: |
|
| 105 | - * |
|
| 106 | - * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
| 107 | - * |
|
| 108 | - * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
| 109 | - * |
|
| 110 | - * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
| 111 | - * |
|
| 112 | - * @var boolean |
|
| 113 | - */ |
|
| 114 | - public $preserveEncoding = false; |
|
| 115 | - |
|
| 116 | - public static $_media = ''; |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * The constructor. |
|
| 120 | - * |
|
| 121 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 122 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 123 | - */ |
|
| 124 | - public function __construct($html = '', $css = '') { |
|
| 125 | - $this->setHtml($html); |
|
| 126 | - $this->setCss($css); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * The destructor. |
|
| 131 | - */ |
|
| 132 | - public function __destruct() { |
|
| 133 | - $this->purgeVisitedNodes(); |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Sets the HTML to emogrify. |
|
| 138 | - * |
|
| 139 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 140 | - */ |
|
| 141 | - public function setHtml($html = '') { |
|
| 142 | - $this->html = $html; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Sets the CSS to merge with the HTML. |
|
| 147 | - * |
|
| 148 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 149 | - */ |
|
| 150 | - public function setCss($css = '') { |
|
| 151 | - $this->css = $css; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Clears all caches. |
|
| 156 | - */ |
|
| 157 | - private function clearAllCaches() { |
|
| 158 | - $this->clearCache(self::CACHE_KEY_CSS); |
|
| 159 | - $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
| 160 | - $this->clearCache(self::CACHE_KEY_XPATH); |
|
| 161 | - $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Clears a single cache by key. |
|
| 166 | - * |
|
| 167 | - * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
| 168 | - * |
|
| 169 | - * @throws InvalidArgumentException |
|
| 170 | - */ |
|
| 171 | - private function clearCache($key) { |
|
| 172 | - $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 173 | - if (!in_array($key, $allowedCacheKeys, true)) { |
|
| 174 | - throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - $this->caches[$key] = array(); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Purges the visited nodes. |
|
| 182 | - */ |
|
| 183 | - private function purgeVisitedNodes() { |
|
| 184 | - $this->visitedNodes = array(); |
|
| 185 | - $this->styleAttributesForNodes = array(); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Marks a tag for removal. |
|
| 190 | - * |
|
| 191 | - * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
| 192 | - * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
| 193 | - * |
|
| 194 | - * Note: The tags will not be removed if they have any content. |
|
| 195 | - * |
|
| 196 | - * @param string $tagName the tag name, e.g., "p" |
|
| 197 | - */ |
|
| 198 | - public function addUnprocessableHtmlTag($tagName) { |
|
| 199 | - $this->unprocessableHtmlTags[] = $tagName; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Drops a tag from the removal list. |
|
| 204 | - * |
|
| 205 | - * @param string $tagName the tag name, e.g., "p" |
|
| 206 | - */ |
|
| 207 | - public function removeUnprocessableHtmlTag($tagName) { |
|
| 208 | - $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
| 209 | - if ($key !== false) { |
|
| 210 | - unset($this->unprocessableHtmlTags[$key]); |
|
| 211 | - } |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Applies the CSS you submit to the HTML you submit. |
|
| 216 | - * |
|
| 217 | - * This method places the CSS inline. |
|
| 218 | - * |
|
| 219 | - * @return string |
|
| 220 | - * |
|
| 221 | - * @throws BadMethodCallException |
|
| 222 | - */ |
|
| 223 | - public function emogrify() { |
|
| 224 | - if ($this->html === '') { |
|
| 225 | - throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - $xmlDocument = $this->createXmlDocument(); |
|
| 229 | - $xpath = new DOMXPath($xmlDocument); |
|
| 230 | - $this->clearAllCaches(); |
|
| 231 | - |
|
| 232 | - // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
| 233 | - // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
| 234 | - // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
| 235 | - $this->purgeVisitedNodes(); |
|
| 236 | - |
|
| 237 | - $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
| 238 | - if ($nodesWithStyleAttributes !== false) { |
|
| 239 | - /** @var $nodeWithStyleAttribute DOMNode */ |
|
| 240 | - foreach ($nodesWithStyleAttributes as $node) { |
|
| 241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 242 | - |
|
| 243 | - // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
| 244 | - $nodePath = $node->getNodePath(); |
|
| 245 | - if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
| 246 | - $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
| 247 | - $this->visitedNodes[$nodePath] = $node; |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - $node->setAttribute('style', $normalizedOriginalStyle); |
|
| 251 | - } |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - // grab any existing style blocks from the html and append them to the existing CSS |
|
| 255 | - // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
| 256 | - $allCss = $this->css; |
|
| 257 | - |
|
| 258 | - $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
| 259 | - |
|
| 260 | - $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
| 261 | - self::$_media = ''; // reset |
|
| 262 | - |
|
| 263 | - $cssKey = md5($cssParts['css']); |
|
| 264 | - if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
| 265 | - // process the CSS file for selectors and definitions |
|
| 266 | - preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
| 267 | - |
|
| 268 | - $allSelectors = array(); |
|
| 269 | - foreach ($matches as $key => $selectorString) { |
|
| 270 | - // if there is a blank definition, skip |
|
| 271 | - if (!strlen(trim($selectorString[2]))) { |
|
| 272 | - continue; |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - // else split by commas and duplicate attributes so we can sort by selector precedence |
|
| 276 | - $selectors = explode(',', $selectorString[1]); |
|
| 277 | - foreach ($selectors as $selector) { |
|
| 278 | - // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
| 279 | - if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
| 280 | - continue; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - $allSelectors[] = array('selector' => trim($selector), |
|
| 284 | - 'attributes' => trim($selectorString[2]), |
|
| 285 | - // keep track of where it appears in the file, since order is important |
|
| 286 | - 'line' => $key, |
|
| 287 | - ); |
|
| 288 | - } |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - // now sort the selectors by precedence |
|
| 292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 293 | - |
|
| 294 | - $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
| 298 | - // query the body for the xpath selector |
|
| 299 | - $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
| 300 | - |
|
| 301 | - /** @var $node \DOMNode */ |
|
| 302 | - foreach ($nodesMatchingCssSelectors as $node) { |
|
| 303 | - // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
| 304 | - if ($node->hasAttribute('style')) { |
|
| 305 | - // break it up into an associative array |
|
| 306 | - $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 307 | - } else { |
|
| 308 | - $oldStyleDeclarations = array(); |
|
| 309 | - } |
|
| 310 | - $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
| 311 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
| 312 | - } |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - // now iterate through the nodes that contained inline styles in the original HTML |
|
| 316 | - foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
| 317 | - $node = $this->visitedNodes[$nodePath]; |
|
| 318 | - $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 319 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - // This removes styles from your email that contain display:none. |
|
| 323 | - // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
| 324 | - // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
| 325 | - // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
| 326 | - $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
| 327 | - // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
| 328 | - // we don't try to call removeChild on a nonexistent child node |
|
| 329 | - if ($nodesWithStyleDisplayNone->length > 0) { |
|
| 330 | - /** @var $node \DOMNode */ |
|
| 331 | - foreach ($nodesWithStyleDisplayNone as $node) { |
|
| 332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 333 | - $node->parentNode->removeChild($node); |
|
| 334 | - } |
|
| 335 | - } |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
| 339 | - |
|
| 340 | - if ($this->preserveEncoding) { |
|
| 341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 343 | - } else { |
|
| 344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 345 | - } |
|
| 346 | - } else { |
|
| 347 | - return $xmlDocument->saveHTML(); |
|
| 348 | - } |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - public function strtolower(array $m) { |
|
| 352 | - return strtolower($m[0]); |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * This method merges old or existing name/value array with new name/value array. |
|
| 358 | - * and then generates a string of the combined style suitable for placing inline. |
|
| 359 | - * This becomes the single point for CSS string generation allowing for consistent. |
|
| 360 | - * CSS output no matter where the CSS originally came from. |
|
| 361 | - * @param array $oldStyles |
|
| 362 | - * @param array $newStyles |
|
| 363 | - * @return string |
|
| 364 | - */ |
|
| 365 | - private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
| 366 | - $combinedStyles = array_merge($oldStyles, $newStyles); |
|
| 367 | - $style = ''; |
|
| 368 | - foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
| 369 | - $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
| 370 | - } |
|
| 371 | - return trim($style); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * Copies the media part from CSS array parts to $xmlDocument. |
|
| 377 | - * |
|
| 378 | - * @param array $cssParts |
|
| 379 | - * @param DOMDocument $xmlDocument |
|
| 380 | - */ |
|
| 381 | - public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
| 382 | - if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
| 383 | - $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
| 384 | - } |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Returns CSS content. |
|
| 389 | - * |
|
| 390 | - * @param DOMXPath $xpath |
|
| 391 | - * @return string |
|
| 392 | - */ |
|
| 393 | - private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
| 394 | - $styleNodes = $xpath->query('//style'); |
|
| 395 | - |
|
| 396 | - if ($styleNodes === false) { |
|
| 397 | - return ''; |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - $css = ''; |
|
| 401 | - /** @var $styleNode DOMNode */ |
|
| 402 | - foreach ($styleNodes as $styleNode) { |
|
| 403 | - $css .= "\n\n" . $styleNode->nodeValue; |
|
| 404 | - $styleNode->parentNode->removeChild($styleNode); |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - return $css; |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Adds a style element with $css to $document. |
|
| 412 | - * |
|
| 413 | - * @param DOMDocument $document |
|
| 414 | - * @param string $css |
|
| 415 | - */ |
|
| 416 | - private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
| 417 | - $styleElement = $document->createElement('style', $css); |
|
| 418 | - $styleAttribute = $document->createAttribute('type'); |
|
| 419 | - $styleAttribute->value = 'text/css'; |
|
| 420 | - $styleElement->appendChild($styleAttribute); |
|
| 421 | - |
|
| 422 | - $head = $this->getOrCreateHeadElement($document); |
|
| 423 | - $head->appendChild($styleElement); |
|
| 424 | - } |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * Returns the existing or creates a new head element in $document. |
|
| 428 | - * |
|
| 429 | - * @param DOMDocument $document |
|
| 430 | - * @return DOMNode the head element |
|
| 431 | - */ |
|
| 432 | - private function getOrCreateHeadElement(DOMDocument $document) { |
|
| 433 | - $head = $document->getElementsByTagName('head')->item(0); |
|
| 434 | - |
|
| 435 | - if ($head === null) { |
|
| 436 | - $head = $document->createElement('head'); |
|
| 437 | - $html = $document->getElementsByTagName('html')->item(0); |
|
| 438 | - $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - return $head; |
|
| 442 | - } |
|
| 443 | - |
|
| 444 | - /** |
|
| 445 | - * Splits input CSS code to an array where: |
|
| 446 | - * |
|
| 447 | - * - key "css" will be contains clean CSS code. |
|
| 448 | - * - key "media" will be contains all valuable media queries. |
|
| 449 | - * |
|
| 450 | - * Example: |
|
| 451 | - * |
|
| 452 | - * The CSS code. |
|
| 453 | - * |
|
| 454 | - * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
| 455 | - * |
|
| 456 | - * will be parsed into the following array: |
|
| 457 | - * |
|
| 458 | - * "css" => "h1 { color:red; }" |
|
| 459 | - * "media" => "@media { h1 {}}" |
|
| 460 | - * |
|
| 461 | - * @param string $css |
|
| 462 | - * @return array |
|
| 463 | - */ |
|
| 464 | - private function splitCssAndMediaQuery($css) { |
|
| 465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 466 | - |
|
| 467 | - // filter the CSS |
|
| 468 | - $search = array( |
|
| 469 | - // get rid of css comment code |
|
| 470 | - '/\\/\\*.*\\*\\//sU', |
|
| 471 | - // strip out any import directives |
|
| 472 | - '/^\\s*@import\\s[^;]+;/misU', |
|
| 473 | - // strip remains media enclosures |
|
| 474 | - '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
| 475 | - ); |
|
| 476 | - |
|
| 477 | - $replace = array( |
|
| 478 | - '', |
|
| 479 | - '', |
|
| 480 | - '', |
|
| 481 | - ); |
|
| 482 | - |
|
| 483 | - // clean CSS before output |
|
| 484 | - $css = preg_replace($search, $replace, $css); |
|
| 485 | - |
|
| 486 | - return array('css' => $css, 'media' => self::$_media); |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - private function _media_concat( $matches ) { |
|
| 490 | - self::$_media .= $matches[0]; |
|
| 491 | - } |
|
| 492 | - |
|
| 493 | - /** |
|
| 494 | - * Creates a DOMDocument instance with the current HTML. |
|
| 495 | - * |
|
| 496 | - * @return DOMDocument |
|
| 497 | - */ |
|
| 498 | - private function createXmlDocument() { |
|
| 499 | - $xmlDocument = new DOMDocument; |
|
| 500 | - $xmlDocument->encoding = self::ENCODING; |
|
| 501 | - $xmlDocument->strictErrorChecking = false; |
|
| 502 | - $xmlDocument->formatOutput = true; |
|
| 503 | - $libXmlState = libxml_use_internal_errors(true); |
|
| 504 | - $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
| 505 | - libxml_clear_errors(); |
|
| 506 | - libxml_use_internal_errors($libXmlState); |
|
| 507 | - $xmlDocument->normalizeDocument(); |
|
| 508 | - |
|
| 509 | - return $xmlDocument; |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
| 514 | - * |
|
| 515 | - * @return string the unified HTML |
|
| 516 | - * |
|
| 517 | - * @throws BadMethodCallException |
|
| 518 | - */ |
|
| 519 | - private function getUnifiedHtml() { |
|
| 520 | - if (!empty($this->unprocessableHtmlTags)) { |
|
| 521 | - $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
| 522 | - $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
| 523 | - } else { |
|
| 524 | - $bodyWithoutUnprocessableTags = $this->html; |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 529 | - } else { |
|
| 530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 531 | - } |
|
| 532 | - } |
|
| 533 | - |
|
| 534 | - /** |
|
| 535 | - * @param array $a |
|
| 536 | - * @param array $b |
|
| 537 | - * |
|
| 538 | - * @return integer |
|
| 539 | - */ |
|
| 540 | - private function sortBySelectorPrecedence(array $a, array $b) { |
|
| 541 | - $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
| 542 | - $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
| 543 | - |
|
| 544 | - // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
| 545 | - // selectors with greater precedence get sorted last. |
|
| 546 | - // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
| 547 | - // arithmetic operators. |
|
| 548 | - // @see http://forge.typo3.org/issues/55605 |
|
| 549 | - $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
| 550 | - $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
| 551 | - return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
| 552 | - } |
|
| 553 | - |
|
| 554 | - /** |
|
| 555 | - * @param string $selector |
|
| 556 | - * |
|
| 557 | - * @return integer |
|
| 558 | - */ |
|
| 559 | - private function getCssSelectorPrecedence($selector) { |
|
| 560 | - $selectorKey = md5($selector); |
|
| 561 | - if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
| 562 | - $precedence = 0; |
|
| 563 | - $value = 100; |
|
| 564 | - // ids: worth 100, classes: worth 10, elements: worth 1 |
|
| 565 | - $search = array('\\#','\\.',''); |
|
| 566 | - |
|
| 567 | - foreach ($search as $s) { |
|
| 568 | - if (trim($selector == '')) { |
|
| 569 | - break; |
|
| 570 | - } |
|
| 571 | - $number = 0; |
|
| 572 | - $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
| 573 | - $precedence += ($value * $number); |
|
| 574 | - $value /= 10; |
|
| 575 | - } |
|
| 576 | - $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
| 577 | - } |
|
| 578 | - |
|
| 579 | - return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
| 580 | - } |
|
| 581 | - |
|
| 582 | - /** |
|
| 583 | - * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
| 584 | - * |
|
| 585 | - * @see http://plasmasturm.org/log/444/ |
|
| 586 | - * |
|
| 587 | - * @param string $paramCssSelector |
|
| 588 | - * |
|
| 589 | - * @return string |
|
| 590 | - */ |
|
| 591 | - private function translateCssToXpath($paramCssSelector) { |
|
| 592 | - $cssSelector = ' ' . $paramCssSelector . ' '; |
|
| 593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 594 | - $cssSelector = trim($cssSelector); |
|
| 595 | - $xpathKey = md5($cssSelector); |
|
| 596 | - if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
| 597 | - // returns an Xpath selector |
|
| 598 | - $search = array( |
|
| 599 | - // Matches any element that is a child of parent. |
|
| 600 | - '/\\s+>\\s+/', |
|
| 601 | - // Matches any element that is an adjacent sibling. |
|
| 602 | - '/\\s+\\+\\s+/', |
|
| 603 | - // Matches any element that is a descendant of an parent element element. |
|
| 604 | - '/\\s+/', |
|
| 605 | - // first-child pseudo-selector |
|
| 606 | - '/([^\\/]+):first-child/i', |
|
| 607 | - // last-child pseudo-selector |
|
| 608 | - '/([^\\/]+):last-child/i', |
|
| 609 | - // Matches attribute only selector |
|
| 610 | - '/^\\[(\\w+)\\]/', |
|
| 611 | - // Matches element with attribute |
|
| 612 | - '/(\\w)\\[(\\w+)\\]/', |
|
| 613 | - // Matches element with EXACT attribute |
|
| 614 | - '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
| 615 | - ); |
|
| 616 | - $replace = array( |
|
| 617 | - '/', |
|
| 618 | - '/following-sibling::*[1]/self::', |
|
| 619 | - '//', |
|
| 620 | - '*[1]/self::\\1', |
|
| 621 | - '*[last()]/self::\\1', |
|
| 622 | - '*[@\\1]', |
|
| 623 | - '\\1[@\\2]', |
|
| 624 | - '\\1[@\\2="\\3"]', |
|
| 625 | - ); |
|
| 626 | - |
|
| 627 | - $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
| 628 | - |
|
| 629 | - $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
| 630 | - $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
| 631 | - |
|
| 632 | - // Advanced selectors are going to require a bit more advanced emogrification. |
|
| 633 | - // When we required PHP 5.3, we could do this with closures. |
|
| 634 | - $cssSelector = preg_replace_callback( |
|
| 635 | - '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 636 | - array($this, 'translateNthChild'), $cssSelector |
|
| 637 | - ); |
|
| 638 | - $cssSelector = preg_replace_callback( |
|
| 639 | - '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 640 | - array($this, 'translateNthOfType'), $cssSelector |
|
| 641 | - ); |
|
| 642 | - |
|
| 643 | - $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
| 644 | - } |
|
| 645 | - return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
| 646 | - } |
|
| 647 | - |
|
| 648 | - /** |
|
| 649 | - * @param array $match |
|
| 650 | - * |
|
| 651 | - * @return string |
|
| 652 | - */ |
|
| 653 | - private function matchIdAttributes(array $match) { |
|
| 654 | - return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * @param array $match |
|
| 659 | - * |
|
| 660 | - * @return string |
|
| 661 | - */ |
|
| 662 | - private function matchClassAttributes(array $match) { |
|
| 663 | - return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
| 664 | - implode( |
|
| 665 | - '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
| 666 | - explode('.', substr($match[2], 1)) |
|
| 667 | - ) . '"," "))]'; |
|
| 668 | - } |
|
| 669 | - |
|
| 670 | - /** |
|
| 671 | - * @param array $match |
|
| 672 | - * |
|
| 673 | - * @return string |
|
| 674 | - */ |
|
| 675 | - private function translateNthChild(array $match) { |
|
| 676 | - $result = $this->parseNth($match); |
|
| 677 | - |
|
| 678 | - if (isset($result[self::MULTIPLIER])) { |
|
| 679 | - if ($result[self::MULTIPLIER] < 0) { |
|
| 680 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 681 | - return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 682 | - } else { |
|
| 683 | - return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 684 | - } |
|
| 685 | - } else { |
|
| 686 | - return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
| 687 | - } |
|
| 688 | - } |
|
| 689 | - |
|
| 690 | - /** |
|
| 691 | - * @param array $match |
|
| 692 | - * |
|
| 693 | - * @return string |
|
| 694 | - */ |
|
| 695 | - private function translateNthOfType(array $match) { |
|
| 696 | - $result = $this->parseNth($match); |
|
| 697 | - |
|
| 698 | - if (isset($result[self::MULTIPLIER])) { |
|
| 699 | - if ($result[self::MULTIPLIER] < 0) { |
|
| 700 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 701 | - return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 702 | - } else { |
|
| 703 | - return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 704 | - } |
|
| 705 | - } else { |
|
| 706 | - return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
| 707 | - } |
|
| 708 | - } |
|
| 709 | - |
|
| 710 | - /** |
|
| 711 | - * @param array $match |
|
| 712 | - * |
|
| 713 | - * @return array |
|
| 714 | - */ |
|
| 715 | - private function parseNth(array $match) { |
|
| 716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 717 | - $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
| 718 | - return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
| 719 | - } elseif (stripos($match[2], 'n') === false) { |
|
| 720 | - // if there is a multiplier |
|
| 721 | - $index = intval(str_replace(' ', '', $match[2])); |
|
| 722 | - return array(self::INDEX => $index); |
|
| 723 | - } else { |
|
| 724 | - if (isset($match[3])) { |
|
| 725 | - $multipleTerm = str_replace($match[3], '', $match[2]); |
|
| 726 | - $index = intval(str_replace(' ', '', $match[3])); |
|
| 727 | - } else { |
|
| 728 | - $multipleTerm = $match[2]; |
|
| 729 | - $index = 0; |
|
| 730 | - } |
|
| 731 | - |
|
| 732 | - $multiplier = str_ireplace('n', '', $multipleTerm); |
|
| 733 | - |
|
| 734 | - if (!strlen($multiplier)) { |
|
| 735 | - $multiplier = 1; |
|
| 736 | - } elseif ($multiplier == 0) { |
|
| 737 | - return array(self::INDEX => $index); |
|
| 738 | - } else { |
|
| 739 | - $multiplier = intval($multiplier); |
|
| 740 | - } |
|
| 741 | - |
|
| 742 | - while ($index < 0) { |
|
| 743 | - $index += abs($multiplier); |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
| 747 | - } |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Parses a CSS declaration block into property name/value pairs. |
|
| 752 | - * |
|
| 753 | - * Example: |
|
| 754 | - * |
|
| 755 | - * The declaration block. |
|
| 756 | - * |
|
| 757 | - * "color: #000; font-weight: bold;". |
|
| 758 | - * |
|
| 759 | - * will be parsed into the following array: |
|
| 760 | - * |
|
| 761 | - * "color" => "#000" |
|
| 762 | - * "font-weight" => "bold" |
|
| 763 | - * |
|
| 764 | - * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
| 765 | - * |
|
| 766 | - * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
| 767 | - */ |
|
| 768 | - private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
| 769 | - if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
| 770 | - return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
| 771 | - } |
|
| 772 | - |
|
| 773 | - $properties = array(); |
|
| 774 | - $declarations = explode(';', $cssDeclarationBlock); |
|
| 775 | - foreach ($declarations as $declaration) { |
|
| 776 | - $matches = array(); |
|
| 777 | - if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
| 778 | - continue; |
|
| 779 | - } |
|
| 780 | - $propertyName = strtolower($matches[1]); |
|
| 781 | - $propertyValue = $matches[2]; |
|
| 782 | - $properties[$propertyName] = $propertyValue; |
|
| 783 | - } |
|
| 784 | - $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
| 785 | - |
|
| 786 | - return $properties; |
|
| 787 | - } |
|
| 12 | + /** |
|
| 13 | + * @var string |
|
| 14 | + */ |
|
| 15 | + const ENCODING = 'UTF-8'; |
|
| 16 | + |
|
| 17 | + /** |
|
| 18 | + * @var integer |
|
| 19 | + */ |
|
| 20 | + const CACHE_KEY_CSS = 0; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * @var integer |
|
| 24 | + */ |
|
| 25 | + const CACHE_KEY_SELECTOR = 1; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @var integer |
|
| 29 | + */ |
|
| 30 | + const CACHE_KEY_XPATH = 2; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var integer |
|
| 34 | + */ |
|
| 35 | + const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * for calculating nth-of-type and nth-child selectors. |
|
| 39 | + * |
|
| 40 | + * @var integer |
|
| 41 | + */ |
|
| 42 | + const INDEX = 0; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * for calculating nth-of-type and nth-child selectors. |
|
| 46 | + * |
|
| 47 | + * @var integer |
|
| 48 | + */ |
|
| 49 | + const MULTIPLIER = 1; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | + const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | + const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * @var string |
|
| 63 | + */ |
|
| 64 | + private $html = ''; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @var string |
|
| 68 | + */ |
|
| 69 | + private $css = ''; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @var array<string> |
|
| 73 | + */ |
|
| 74 | + private $unprocessableHtmlTags = array('wbr'); |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * @var array<array> |
|
| 78 | + */ |
|
| 79 | + private $caches = array( |
|
| 80 | + self::CACHE_KEY_CSS => array(), |
|
| 81 | + self::CACHE_KEY_SELECTOR => array(), |
|
| 82 | + self::CACHE_KEY_XPATH => array(), |
|
| 83 | + self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
| 84 | + ); |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * the visited nodes with the XPath paths as array keys. |
|
| 88 | + * |
|
| 89 | + * @var array<\DOMNode> |
|
| 90 | + */ |
|
| 91 | + private $visitedNodes = array(); |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
| 95 | + * as key/value pairs for the inner array. |
|
| 96 | + * |
|
| 97 | + * @var array<array><string> |
|
| 98 | + */ |
|
| 99 | + private $styleAttributesForNodes = array(); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * This attribute applies to the case where you want to preserve your original text encoding. |
|
| 103 | + * |
|
| 104 | + * By default, emogrifier translates your text into HTML entities for two reasons: |
|
| 105 | + * |
|
| 106 | + * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
| 107 | + * |
|
| 108 | + * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
| 109 | + * |
|
| 110 | + * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
| 111 | + * |
|
| 112 | + * @var boolean |
|
| 113 | + */ |
|
| 114 | + public $preserveEncoding = false; |
|
| 115 | + |
|
| 116 | + public static $_media = ''; |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * The constructor. |
|
| 120 | + * |
|
| 121 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 122 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 123 | + */ |
|
| 124 | + public function __construct($html = '', $css = '') { |
|
| 125 | + $this->setHtml($html); |
|
| 126 | + $this->setCss($css); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * The destructor. |
|
| 131 | + */ |
|
| 132 | + public function __destruct() { |
|
| 133 | + $this->purgeVisitedNodes(); |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Sets the HTML to emogrify. |
|
| 138 | + * |
|
| 139 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 140 | + */ |
|
| 141 | + public function setHtml($html = '') { |
|
| 142 | + $this->html = $html; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Sets the CSS to merge with the HTML. |
|
| 147 | + * |
|
| 148 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 149 | + */ |
|
| 150 | + public function setCss($css = '') { |
|
| 151 | + $this->css = $css; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Clears all caches. |
|
| 156 | + */ |
|
| 157 | + private function clearAllCaches() { |
|
| 158 | + $this->clearCache(self::CACHE_KEY_CSS); |
|
| 159 | + $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
| 160 | + $this->clearCache(self::CACHE_KEY_XPATH); |
|
| 161 | + $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Clears a single cache by key. |
|
| 166 | + * |
|
| 167 | + * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
| 168 | + * |
|
| 169 | + * @throws InvalidArgumentException |
|
| 170 | + */ |
|
| 171 | + private function clearCache($key) { |
|
| 172 | + $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 173 | + if (!in_array($key, $allowedCacheKeys, true)) { |
|
| 174 | + throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + $this->caches[$key] = array(); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Purges the visited nodes. |
|
| 182 | + */ |
|
| 183 | + private function purgeVisitedNodes() { |
|
| 184 | + $this->visitedNodes = array(); |
|
| 185 | + $this->styleAttributesForNodes = array(); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Marks a tag for removal. |
|
| 190 | + * |
|
| 191 | + * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
| 192 | + * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
| 193 | + * |
|
| 194 | + * Note: The tags will not be removed if they have any content. |
|
| 195 | + * |
|
| 196 | + * @param string $tagName the tag name, e.g., "p" |
|
| 197 | + */ |
|
| 198 | + public function addUnprocessableHtmlTag($tagName) { |
|
| 199 | + $this->unprocessableHtmlTags[] = $tagName; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Drops a tag from the removal list. |
|
| 204 | + * |
|
| 205 | + * @param string $tagName the tag name, e.g., "p" |
|
| 206 | + */ |
|
| 207 | + public function removeUnprocessableHtmlTag($tagName) { |
|
| 208 | + $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
| 209 | + if ($key !== false) { |
|
| 210 | + unset($this->unprocessableHtmlTags[$key]); |
|
| 211 | + } |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Applies the CSS you submit to the HTML you submit. |
|
| 216 | + * |
|
| 217 | + * This method places the CSS inline. |
|
| 218 | + * |
|
| 219 | + * @return string |
|
| 220 | + * |
|
| 221 | + * @throws BadMethodCallException |
|
| 222 | + */ |
|
| 223 | + public function emogrify() { |
|
| 224 | + if ($this->html === '') { |
|
| 225 | + throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + $xmlDocument = $this->createXmlDocument(); |
|
| 229 | + $xpath = new DOMXPath($xmlDocument); |
|
| 230 | + $this->clearAllCaches(); |
|
| 231 | + |
|
| 232 | + // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
| 233 | + // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
| 234 | + // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
| 235 | + $this->purgeVisitedNodes(); |
|
| 236 | + |
|
| 237 | + $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
| 238 | + if ($nodesWithStyleAttributes !== false) { |
|
| 239 | + /** @var $nodeWithStyleAttribute DOMNode */ |
|
| 240 | + foreach ($nodesWithStyleAttributes as $node) { |
|
| 241 | + $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 242 | + |
|
| 243 | + // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
| 244 | + $nodePath = $node->getNodePath(); |
|
| 245 | + if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
| 246 | + $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
| 247 | + $this->visitedNodes[$nodePath] = $node; |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + $node->setAttribute('style', $normalizedOriginalStyle); |
|
| 251 | + } |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + // grab any existing style blocks from the html and append them to the existing CSS |
|
| 255 | + // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
| 256 | + $allCss = $this->css; |
|
| 257 | + |
|
| 258 | + $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
| 259 | + |
|
| 260 | + $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
| 261 | + self::$_media = ''; // reset |
|
| 262 | + |
|
| 263 | + $cssKey = md5($cssParts['css']); |
|
| 264 | + if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
| 265 | + // process the CSS file for selectors and definitions |
|
| 266 | + preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
| 267 | + |
|
| 268 | + $allSelectors = array(); |
|
| 269 | + foreach ($matches as $key => $selectorString) { |
|
| 270 | + // if there is a blank definition, skip |
|
| 271 | + if (!strlen(trim($selectorString[2]))) { |
|
| 272 | + continue; |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + // else split by commas and duplicate attributes so we can sort by selector precedence |
|
| 276 | + $selectors = explode(',', $selectorString[1]); |
|
| 277 | + foreach ($selectors as $selector) { |
|
| 278 | + // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
| 279 | + if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
| 280 | + continue; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + $allSelectors[] = array('selector' => trim($selector), |
|
| 284 | + 'attributes' => trim($selectorString[2]), |
|
| 285 | + // keep track of where it appears in the file, since order is important |
|
| 286 | + 'line' => $key, |
|
| 287 | + ); |
|
| 288 | + } |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + // now sort the selectors by precedence |
|
| 292 | + usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 293 | + |
|
| 294 | + $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
| 298 | + // query the body for the xpath selector |
|
| 299 | + $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
| 300 | + |
|
| 301 | + /** @var $node \DOMNode */ |
|
| 302 | + foreach ($nodesMatchingCssSelectors as $node) { |
|
| 303 | + // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
| 304 | + if ($node->hasAttribute('style')) { |
|
| 305 | + // break it up into an associative array |
|
| 306 | + $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 307 | + } else { |
|
| 308 | + $oldStyleDeclarations = array(); |
|
| 309 | + } |
|
| 310 | + $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
| 311 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
| 312 | + } |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + // now iterate through the nodes that contained inline styles in the original HTML |
|
| 316 | + foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
| 317 | + $node = $this->visitedNodes[$nodePath]; |
|
| 318 | + $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 319 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + // This removes styles from your email that contain display:none. |
|
| 323 | + // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
| 324 | + // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
| 325 | + // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
| 326 | + $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
| 327 | + // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
| 328 | + // we don't try to call removeChild on a nonexistent child node |
|
| 329 | + if ($nodesWithStyleDisplayNone->length > 0) { |
|
| 330 | + /** @var $node \DOMNode */ |
|
| 331 | + foreach ($nodesWithStyleDisplayNone as $node) { |
|
| 332 | + if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 333 | + $node->parentNode->removeChild($node); |
|
| 334 | + } |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
| 339 | + |
|
| 340 | + if ($this->preserveEncoding) { |
|
| 341 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | + return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 343 | + } else { |
|
| 344 | + return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 345 | + } |
|
| 346 | + } else { |
|
| 347 | + return $xmlDocument->saveHTML(); |
|
| 348 | + } |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + public function strtolower(array $m) { |
|
| 352 | + return strtolower($m[0]); |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * This method merges old or existing name/value array with new name/value array. |
|
| 358 | + * and then generates a string of the combined style suitable for placing inline. |
|
| 359 | + * This becomes the single point for CSS string generation allowing for consistent. |
|
| 360 | + * CSS output no matter where the CSS originally came from. |
|
| 361 | + * @param array $oldStyles |
|
| 362 | + * @param array $newStyles |
|
| 363 | + * @return string |
|
| 364 | + */ |
|
| 365 | + private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
| 366 | + $combinedStyles = array_merge($oldStyles, $newStyles); |
|
| 367 | + $style = ''; |
|
| 368 | + foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
| 369 | + $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
| 370 | + } |
|
| 371 | + return trim($style); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * Copies the media part from CSS array parts to $xmlDocument. |
|
| 377 | + * |
|
| 378 | + * @param array $cssParts |
|
| 379 | + * @param DOMDocument $xmlDocument |
|
| 380 | + */ |
|
| 381 | + public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
| 382 | + if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
| 383 | + $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
| 384 | + } |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Returns CSS content. |
|
| 389 | + * |
|
| 390 | + * @param DOMXPath $xpath |
|
| 391 | + * @return string |
|
| 392 | + */ |
|
| 393 | + private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
| 394 | + $styleNodes = $xpath->query('//style'); |
|
| 395 | + |
|
| 396 | + if ($styleNodes === false) { |
|
| 397 | + return ''; |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + $css = ''; |
|
| 401 | + /** @var $styleNode DOMNode */ |
|
| 402 | + foreach ($styleNodes as $styleNode) { |
|
| 403 | + $css .= "\n\n" . $styleNode->nodeValue; |
|
| 404 | + $styleNode->parentNode->removeChild($styleNode); |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + return $css; |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Adds a style element with $css to $document. |
|
| 412 | + * |
|
| 413 | + * @param DOMDocument $document |
|
| 414 | + * @param string $css |
|
| 415 | + */ |
|
| 416 | + private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
| 417 | + $styleElement = $document->createElement('style', $css); |
|
| 418 | + $styleAttribute = $document->createAttribute('type'); |
|
| 419 | + $styleAttribute->value = 'text/css'; |
|
| 420 | + $styleElement->appendChild($styleAttribute); |
|
| 421 | + |
|
| 422 | + $head = $this->getOrCreateHeadElement($document); |
|
| 423 | + $head->appendChild($styleElement); |
|
| 424 | + } |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * Returns the existing or creates a new head element in $document. |
|
| 428 | + * |
|
| 429 | + * @param DOMDocument $document |
|
| 430 | + * @return DOMNode the head element |
|
| 431 | + */ |
|
| 432 | + private function getOrCreateHeadElement(DOMDocument $document) { |
|
| 433 | + $head = $document->getElementsByTagName('head')->item(0); |
|
| 434 | + |
|
| 435 | + if ($head === null) { |
|
| 436 | + $head = $document->createElement('head'); |
|
| 437 | + $html = $document->getElementsByTagName('html')->item(0); |
|
| 438 | + $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + return $head; |
|
| 442 | + } |
|
| 443 | + |
|
| 444 | + /** |
|
| 445 | + * Splits input CSS code to an array where: |
|
| 446 | + * |
|
| 447 | + * - key "css" will be contains clean CSS code. |
|
| 448 | + * - key "media" will be contains all valuable media queries. |
|
| 449 | + * |
|
| 450 | + * Example: |
|
| 451 | + * |
|
| 452 | + * The CSS code. |
|
| 453 | + * |
|
| 454 | + * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
| 455 | + * |
|
| 456 | + * will be parsed into the following array: |
|
| 457 | + * |
|
| 458 | + * "css" => "h1 { color:red; }" |
|
| 459 | + * "media" => "@media { h1 {}}" |
|
| 460 | + * |
|
| 461 | + * @param string $css |
|
| 462 | + * @return array |
|
| 463 | + */ |
|
| 464 | + private function splitCssAndMediaQuery($css) { |
|
| 465 | + $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 466 | + |
|
| 467 | + // filter the CSS |
|
| 468 | + $search = array( |
|
| 469 | + // get rid of css comment code |
|
| 470 | + '/\\/\\*.*\\*\\//sU', |
|
| 471 | + // strip out any import directives |
|
| 472 | + '/^\\s*@import\\s[^;]+;/misU', |
|
| 473 | + // strip remains media enclosures |
|
| 474 | + '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
| 475 | + ); |
|
| 476 | + |
|
| 477 | + $replace = array( |
|
| 478 | + '', |
|
| 479 | + '', |
|
| 480 | + '', |
|
| 481 | + ); |
|
| 482 | + |
|
| 483 | + // clean CSS before output |
|
| 484 | + $css = preg_replace($search, $replace, $css); |
|
| 485 | + |
|
| 486 | + return array('css' => $css, 'media' => self::$_media); |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + private function _media_concat( $matches ) { |
|
| 490 | + self::$_media .= $matches[0]; |
|
| 491 | + } |
|
| 492 | + |
|
| 493 | + /** |
|
| 494 | + * Creates a DOMDocument instance with the current HTML. |
|
| 495 | + * |
|
| 496 | + * @return DOMDocument |
|
| 497 | + */ |
|
| 498 | + private function createXmlDocument() { |
|
| 499 | + $xmlDocument = new DOMDocument; |
|
| 500 | + $xmlDocument->encoding = self::ENCODING; |
|
| 501 | + $xmlDocument->strictErrorChecking = false; |
|
| 502 | + $xmlDocument->formatOutput = true; |
|
| 503 | + $libXmlState = libxml_use_internal_errors(true); |
|
| 504 | + $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
| 505 | + libxml_clear_errors(); |
|
| 506 | + libxml_use_internal_errors($libXmlState); |
|
| 507 | + $xmlDocument->normalizeDocument(); |
|
| 508 | + |
|
| 509 | + return $xmlDocument; |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
| 514 | + * |
|
| 515 | + * @return string the unified HTML |
|
| 516 | + * |
|
| 517 | + * @throws BadMethodCallException |
|
| 518 | + */ |
|
| 519 | + private function getUnifiedHtml() { |
|
| 520 | + if (!empty($this->unprocessableHtmlTags)) { |
|
| 521 | + $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
| 522 | + $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
| 523 | + } else { |
|
| 524 | + $bodyWithoutUnprocessableTags = $this->html; |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | + return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 529 | + } else { |
|
| 530 | + return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 531 | + } |
|
| 532 | + } |
|
| 533 | + |
|
| 534 | + /** |
|
| 535 | + * @param array $a |
|
| 536 | + * @param array $b |
|
| 537 | + * |
|
| 538 | + * @return integer |
|
| 539 | + */ |
|
| 540 | + private function sortBySelectorPrecedence(array $a, array $b) { |
|
| 541 | + $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
| 542 | + $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
| 543 | + |
|
| 544 | + // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
| 545 | + // selectors with greater precedence get sorted last. |
|
| 546 | + // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
| 547 | + // arithmetic operators. |
|
| 548 | + // @see http://forge.typo3.org/issues/55605 |
|
| 549 | + $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
| 550 | + $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
| 551 | + return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
| 552 | + } |
|
| 553 | + |
|
| 554 | + /** |
|
| 555 | + * @param string $selector |
|
| 556 | + * |
|
| 557 | + * @return integer |
|
| 558 | + */ |
|
| 559 | + private function getCssSelectorPrecedence($selector) { |
|
| 560 | + $selectorKey = md5($selector); |
|
| 561 | + if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
| 562 | + $precedence = 0; |
|
| 563 | + $value = 100; |
|
| 564 | + // ids: worth 100, classes: worth 10, elements: worth 1 |
|
| 565 | + $search = array('\\#','\\.',''); |
|
| 566 | + |
|
| 567 | + foreach ($search as $s) { |
|
| 568 | + if (trim($selector == '')) { |
|
| 569 | + break; |
|
| 570 | + } |
|
| 571 | + $number = 0; |
|
| 572 | + $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
| 573 | + $precedence += ($value * $number); |
|
| 574 | + $value /= 10; |
|
| 575 | + } |
|
| 576 | + $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
| 577 | + } |
|
| 578 | + |
|
| 579 | + return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
| 580 | + } |
|
| 581 | + |
|
| 582 | + /** |
|
| 583 | + * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
| 584 | + * |
|
| 585 | + * @see http://plasmasturm.org/log/444/ |
|
| 586 | + * |
|
| 587 | + * @param string $paramCssSelector |
|
| 588 | + * |
|
| 589 | + * @return string |
|
| 590 | + */ |
|
| 591 | + private function translateCssToXpath($paramCssSelector) { |
|
| 592 | + $cssSelector = ' ' . $paramCssSelector . ' '; |
|
| 593 | + $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 594 | + $cssSelector = trim($cssSelector); |
|
| 595 | + $xpathKey = md5($cssSelector); |
|
| 596 | + if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
| 597 | + // returns an Xpath selector |
|
| 598 | + $search = array( |
|
| 599 | + // Matches any element that is a child of parent. |
|
| 600 | + '/\\s+>\\s+/', |
|
| 601 | + // Matches any element that is an adjacent sibling. |
|
| 602 | + '/\\s+\\+\\s+/', |
|
| 603 | + // Matches any element that is a descendant of an parent element element. |
|
| 604 | + '/\\s+/', |
|
| 605 | + // first-child pseudo-selector |
|
| 606 | + '/([^\\/]+):first-child/i', |
|
| 607 | + // last-child pseudo-selector |
|
| 608 | + '/([^\\/]+):last-child/i', |
|
| 609 | + // Matches attribute only selector |
|
| 610 | + '/^\\[(\\w+)\\]/', |
|
| 611 | + // Matches element with attribute |
|
| 612 | + '/(\\w)\\[(\\w+)\\]/', |
|
| 613 | + // Matches element with EXACT attribute |
|
| 614 | + '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
| 615 | + ); |
|
| 616 | + $replace = array( |
|
| 617 | + '/', |
|
| 618 | + '/following-sibling::*[1]/self::', |
|
| 619 | + '//', |
|
| 620 | + '*[1]/self::\\1', |
|
| 621 | + '*[last()]/self::\\1', |
|
| 622 | + '*[@\\1]', |
|
| 623 | + '\\1[@\\2]', |
|
| 624 | + '\\1[@\\2="\\3"]', |
|
| 625 | + ); |
|
| 626 | + |
|
| 627 | + $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
| 628 | + |
|
| 629 | + $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
| 630 | + $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
| 631 | + |
|
| 632 | + // Advanced selectors are going to require a bit more advanced emogrification. |
|
| 633 | + // When we required PHP 5.3, we could do this with closures. |
|
| 634 | + $cssSelector = preg_replace_callback( |
|
| 635 | + '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 636 | + array($this, 'translateNthChild'), $cssSelector |
|
| 637 | + ); |
|
| 638 | + $cssSelector = preg_replace_callback( |
|
| 639 | + '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 640 | + array($this, 'translateNthOfType'), $cssSelector |
|
| 641 | + ); |
|
| 642 | + |
|
| 643 | + $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
| 644 | + } |
|
| 645 | + return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
| 646 | + } |
|
| 647 | + |
|
| 648 | + /** |
|
| 649 | + * @param array $match |
|
| 650 | + * |
|
| 651 | + * @return string |
|
| 652 | + */ |
|
| 653 | + private function matchIdAttributes(array $match) { |
|
| 654 | + return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * @param array $match |
|
| 659 | + * |
|
| 660 | + * @return string |
|
| 661 | + */ |
|
| 662 | + private function matchClassAttributes(array $match) { |
|
| 663 | + return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
| 664 | + implode( |
|
| 665 | + '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
| 666 | + explode('.', substr($match[2], 1)) |
|
| 667 | + ) . '"," "))]'; |
|
| 668 | + } |
|
| 669 | + |
|
| 670 | + /** |
|
| 671 | + * @param array $match |
|
| 672 | + * |
|
| 673 | + * @return string |
|
| 674 | + */ |
|
| 675 | + private function translateNthChild(array $match) { |
|
| 676 | + $result = $this->parseNth($match); |
|
| 677 | + |
|
| 678 | + if (isset($result[self::MULTIPLIER])) { |
|
| 679 | + if ($result[self::MULTIPLIER] < 0) { |
|
| 680 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 681 | + return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 682 | + } else { |
|
| 683 | + return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 684 | + } |
|
| 685 | + } else { |
|
| 686 | + return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
| 687 | + } |
|
| 688 | + } |
|
| 689 | + |
|
| 690 | + /** |
|
| 691 | + * @param array $match |
|
| 692 | + * |
|
| 693 | + * @return string |
|
| 694 | + */ |
|
| 695 | + private function translateNthOfType(array $match) { |
|
| 696 | + $result = $this->parseNth($match); |
|
| 697 | + |
|
| 698 | + if (isset($result[self::MULTIPLIER])) { |
|
| 699 | + if ($result[self::MULTIPLIER] < 0) { |
|
| 700 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 701 | + return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 702 | + } else { |
|
| 703 | + return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 704 | + } |
|
| 705 | + } else { |
|
| 706 | + return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
| 707 | + } |
|
| 708 | + } |
|
| 709 | + |
|
| 710 | + /** |
|
| 711 | + * @param array $match |
|
| 712 | + * |
|
| 713 | + * @return array |
|
| 714 | + */ |
|
| 715 | + private function parseNth(array $match) { |
|
| 716 | + if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 717 | + $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
| 718 | + return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
| 719 | + } elseif (stripos($match[2], 'n') === false) { |
|
| 720 | + // if there is a multiplier |
|
| 721 | + $index = intval(str_replace(' ', '', $match[2])); |
|
| 722 | + return array(self::INDEX => $index); |
|
| 723 | + } else { |
|
| 724 | + if (isset($match[3])) { |
|
| 725 | + $multipleTerm = str_replace($match[3], '', $match[2]); |
|
| 726 | + $index = intval(str_replace(' ', '', $match[3])); |
|
| 727 | + } else { |
|
| 728 | + $multipleTerm = $match[2]; |
|
| 729 | + $index = 0; |
|
| 730 | + } |
|
| 731 | + |
|
| 732 | + $multiplier = str_ireplace('n', '', $multipleTerm); |
|
| 733 | + |
|
| 734 | + if (!strlen($multiplier)) { |
|
| 735 | + $multiplier = 1; |
|
| 736 | + } elseif ($multiplier == 0) { |
|
| 737 | + return array(self::INDEX => $index); |
|
| 738 | + } else { |
|
| 739 | + $multiplier = intval($multiplier); |
|
| 740 | + } |
|
| 741 | + |
|
| 742 | + while ($index < 0) { |
|
| 743 | + $index += abs($multiplier); |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
| 747 | + } |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Parses a CSS declaration block into property name/value pairs. |
|
| 752 | + * |
|
| 753 | + * Example: |
|
| 754 | + * |
|
| 755 | + * The declaration block. |
|
| 756 | + * |
|
| 757 | + * "color: #000; font-weight: bold;". |
|
| 758 | + * |
|
| 759 | + * will be parsed into the following array: |
|
| 760 | + * |
|
| 761 | + * "color" => "#000" |
|
| 762 | + * "font-weight" => "bold" |
|
| 763 | + * |
|
| 764 | + * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
| 765 | + * |
|
| 766 | + * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
| 767 | + */ |
|
| 768 | + private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
| 769 | + if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
| 770 | + return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
| 771 | + } |
|
| 772 | + |
|
| 773 | + $properties = array(); |
|
| 774 | + $declarations = explode(';', $cssDeclarationBlock); |
|
| 775 | + foreach ($declarations as $declaration) { |
|
| 776 | + $matches = array(); |
|
| 777 | + if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
| 778 | + continue; |
|
| 779 | + } |
|
| 780 | + $propertyName = strtolower($matches[1]); |
|
| 781 | + $propertyValue = $matches[2]; |
|
| 782 | + $properties[$propertyName] = $propertyValue; |
|
| 783 | + } |
|
| 784 | + $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
| 785 | + |
|
| 786 | + return $properties; |
|
| 787 | + } |
|
| 788 | 788 | } |
@@ -238,7 +238,7 @@ discard block |
||
| 238 | 238 | if ($nodesWithStyleAttributes !== false) { |
| 239 | 239 | /** @var $nodeWithStyleAttribute DOMNode */ |
| 240 | 240 | foreach ($nodesWithStyleAttributes as $node) { |
| 241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 241 | + $normalizedOriginalStyle = preg_replace_callback('/[A-z\\-]+(?=\\:)/S', array($this, 'strtolower'), $node->getAttribute('style')); |
|
| 242 | 242 | |
| 243 | 243 | // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
| 244 | 244 | $nodePath = $node->getNodePath(); |
@@ -289,7 +289,7 @@ discard block |
||
| 289 | 289 | } |
| 290 | 290 | |
| 291 | 291 | // now sort the selectors by precedence |
| 292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 292 | + usort($allSelectors, array($this, 'sortBySelectorPrecedence')); |
|
| 293 | 293 | |
| 294 | 294 | $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
| 295 | 295 | } |
@@ -329,7 +329,7 @@ discard block |
||
| 329 | 329 | if ($nodesWithStyleDisplayNone->length > 0) { |
| 330 | 330 | /** @var $node \DOMNode */ |
| 331 | 331 | foreach ($nodesWithStyleDisplayNone as $node) { |
| 332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 332 | + if ($node->parentNode && is_callable(array($node->parentNode, 'removeChild'))) { |
|
| 333 | 333 | $node->parentNode->removeChild($node); |
| 334 | 334 | } |
| 335 | 335 | } |
@@ -338,10 +338,10 @@ discard block |
||
| 338 | 338 | $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
| 339 | 339 | |
| 340 | 340 | if ($this->preserveEncoding) { |
| 341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 341 | + if (function_exists('mb_convert_encoding')) { |
|
| 342 | + return mb_convert_encoding($xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES'); |
|
| 343 | 343 | } else { |
| 344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 344 | + return htmlspecialchars_decode(utf8_encode(html_entity_decode($xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING))); |
|
| 345 | 345 | } |
| 346 | 346 | } else { |
| 347 | 347 | return $xmlDocument->saveHTML(); |
@@ -462,7 +462,7 @@ discard block |
||
| 462 | 462 | * @return array |
| 463 | 463 | */ |
| 464 | 464 | private function splitCssAndMediaQuery($css) { |
| 465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 465 | + $css = preg_replace_callback('#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array($this, '_media_concat'), $css); |
|
| 466 | 466 | |
| 467 | 467 | // filter the CSS |
| 468 | 468 | $search = array( |
@@ -486,7 +486,7 @@ discard block |
||
| 486 | 486 | return array('css' => $css, 'media' => self::$_media); |
| 487 | 487 | } |
| 488 | 488 | |
| 489 | - private function _media_concat( $matches ) { |
|
| 489 | + private function _media_concat($matches) { |
|
| 490 | 490 | self::$_media .= $matches[0]; |
| 491 | 491 | } |
| 492 | 492 | |
@@ -524,10 +524,10 @@ discard block |
||
| 524 | 524 | $bodyWithoutUnprocessableTags = $this->html; |
| 525 | 525 | } |
| 526 | 526 | |
| 527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 527 | + if (function_exists('mb_convert_encoding')) { |
|
| 528 | + return mb_convert_encoding($bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING); |
|
| 529 | 529 | } else { |
| 530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 530 | + return htmlspecialchars_decode(utf8_decode(htmlentities($bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false))); |
|
| 531 | 531 | } |
| 532 | 532 | } |
| 533 | 533 | |
@@ -562,7 +562,7 @@ discard block |
||
| 562 | 562 | $precedence = 0; |
| 563 | 563 | $value = 100; |
| 564 | 564 | // ids: worth 100, classes: worth 10, elements: worth 1 |
| 565 | - $search = array('\\#','\\.',''); |
|
| 565 | + $search = array('\\#', '\\.', ''); |
|
| 566 | 566 | |
| 567 | 567 | foreach ($search as $s) { |
| 568 | 568 | if (trim($selector == '')) { |
@@ -590,7 +590,7 @@ discard block |
||
| 590 | 590 | */ |
| 591 | 591 | private function translateCssToXpath($paramCssSelector) { |
| 592 | 592 | $cssSelector = ' ' . $paramCssSelector . ' '; |
| 593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 593 | + $cssSelector = preg_replace_callback('/\s+\w+\s+/', array($this, 'strtolower'), $cssSelector); |
|
| 594 | 594 | $cssSelector = trim($cssSelector); |
| 595 | 595 | $xpathKey = md5($cssSelector); |
| 596 | 596 | if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
@@ -713,7 +713,7 @@ discard block |
||
| 713 | 713 | * @return array |
| 714 | 714 | */ |
| 715 | 715 | private function parseNth(array $match) { |
| 716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 716 | + if (in_array(strtolower($match[2]), array('even', 'odd'))) { |
|
| 717 | 717 | $index = strtolower($match[2]) == 'even' ? 0 : 1; |
| 718 | 718 | return array(self::MULTIPLIER => 2, self::INDEX => $index); |
| 719 | 719 | } elseif (stripos($match[2], 'n') === false) { |
@@ -1,6 +1,8 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | // Exit if accessed directly |
| 3 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 3 | +if ( ! defined( 'ABSPATH' ) ) { |
|
| 4 | + exit; |
|
| 5 | +} |
|
| 4 | 6 | |
| 5 | 7 | class WPInv_Item { |
| 6 | 8 | public $ID = 0; |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | // Exit if accessed directly |
| 3 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 3 | +if (!defined('ABSPATH')) exit; |
|
| 4 | 4 | |
| 5 | 5 | class WPInv_Item { |
| 6 | 6 | public $ID = 0; |
@@ -49,26 +49,26 @@ discard block |
||
| 49 | 49 | public $filter; |
| 50 | 50 | |
| 51 | 51 | |
| 52 | - public function __construct( $_id = false, $_args = array() ) { |
|
| 53 | - $item = WP_Post::get_instance( $_id ); |
|
| 54 | - return $this->setup_item( $item ); |
|
| 52 | + public function __construct($_id = false, $_args = array()) { |
|
| 53 | + $item = WP_Post::get_instance($_id); |
|
| 54 | + return $this->setup_item($item); |
|
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - private function setup_item( $item ) { |
|
| 58 | - if( ! is_object( $item ) ) { |
|
| 57 | + private function setup_item($item) { |
|
| 58 | + if (!is_object($item)) { |
|
| 59 | 59 | return false; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - if( ! is_a( $item, 'WP_Post' ) ) { |
|
| 62 | + if (!is_a($item, 'WP_Post')) { |
|
| 63 | 63 | return false; |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - if( 'wpi_item' !== $item->post_type ) { |
|
| 66 | + if ('wpi_item' !== $item->post_type) { |
|
| 67 | 67 | return false; |
| 68 | 68 | } |
| 69 | 69 | |
| 70 | - foreach ( $item as $key => $value ) { |
|
| 71 | - switch ( $key ) { |
|
| 70 | + foreach ($item as $key => $value) { |
|
| 71 | + switch ($key) { |
|
| 72 | 72 | default: |
| 73 | 73 | $this->$key = $value; |
| 74 | 74 | break; |
@@ -78,38 +78,38 @@ discard block |
||
| 78 | 78 | return true; |
| 79 | 79 | } |
| 80 | 80 | |
| 81 | - public function __get( $key ) { |
|
| 82 | - if ( method_exists( $this, 'get_' . $key ) ) { |
|
| 83 | - return call_user_func( array( $this, 'get_' . $key ) ); |
|
| 81 | + public function __get($key) { |
|
| 82 | + if (method_exists($this, 'get_' . $key)) { |
|
| 83 | + return call_user_func(array($this, 'get_' . $key)); |
|
| 84 | 84 | } else { |
| 85 | - return new WP_Error( 'wpinv-item-invalid-property', sprintf( __( 'Can\'t get property %s', 'invoicing' ), $key ) ); |
|
| 85 | + return new WP_Error('wpinv-item-invalid-property', sprintf(__('Can\'t get property %s', 'invoicing'), $key)); |
|
| 86 | 86 | } |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - public function create( $data = array(), $wp_error = false ) { |
|
| 90 | - if ( $this->ID != 0 ) { |
|
| 89 | + public function create($data = array(), $wp_error = false) { |
|
| 90 | + if ($this->ID != 0) { |
|
| 91 | 91 | return false; |
| 92 | 92 | } |
| 93 | 93 | |
| 94 | 94 | $defaults = array( |
| 95 | 95 | 'post_type' => 'wpi_item', |
| 96 | 96 | 'post_status' => 'draft', |
| 97 | - 'post_title' => __( 'New Invoice Item', 'invoicing' ) |
|
| 97 | + 'post_title' => __('New Invoice Item', 'invoicing') |
|
| 98 | 98 | ); |
| 99 | 99 | |
| 100 | - $args = wp_parse_args( $data, $defaults ); |
|
| 100 | + $args = wp_parse_args($data, $defaults); |
|
| 101 | 101 | |
| 102 | - do_action( 'wpinv_item_pre_create', $args ); |
|
| 102 | + do_action('wpinv_item_pre_create', $args); |
|
| 103 | 103 | |
| 104 | - $id = wp_insert_post( $args, $wp_error ); |
|
| 104 | + $id = wp_insert_post($args, $wp_error); |
|
| 105 | 105 | if ($wp_error && is_wp_error($id)) { |
| 106 | 106 | return $id; |
| 107 | 107 | } |
| 108 | - if ( !$id ) { |
|
| 108 | + if (!$id) { |
|
| 109 | 109 | return false; |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | - $item = WP_Post::get_instance( $id ); |
|
| 112 | + $item = WP_Post::get_instance($id); |
|
| 113 | 113 | |
| 114 | 114 | if (!empty($item) && !empty($data['meta'])) { |
| 115 | 115 | $this->ID = $item->ID; |
@@ -117,47 +117,47 @@ discard block |
||
| 117 | 117 | } |
| 118 | 118 | |
| 119 | 119 | // Set custom id if not set. |
| 120 | - if ( empty( $data['meta']['custom_id'] ) && !$this->get_custom_id() ) { |
|
| 121 | - $this->save_metas( array( 'custom_id' => $id ) ); |
|
| 120 | + if (empty($data['meta']['custom_id']) && !$this->get_custom_id()) { |
|
| 121 | + $this->save_metas(array('custom_id' => $id)); |
|
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - do_action( 'wpinv_item_create', $id, $args ); |
|
| 124 | + do_action('wpinv_item_create', $id, $args); |
|
| 125 | 125 | |
| 126 | - return $this->setup_item( $item ); |
|
| 126 | + return $this->setup_item($item); |
|
| 127 | 127 | } |
| 128 | 128 | |
| 129 | - public function update( $data = array(), $wp_error = false ) { |
|
| 130 | - if ( !$this->ID > 0 ) { |
|
| 129 | + public function update($data = array(), $wp_error = false) { |
|
| 130 | + if (!$this->ID > 0) { |
|
| 131 | 131 | return false; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | $data['ID'] = $this->ID; |
| 135 | 135 | |
| 136 | - do_action( 'wpinv_item_pre_update', $data ); |
|
| 136 | + do_action('wpinv_item_pre_update', $data); |
|
| 137 | 137 | |
| 138 | - $id = wp_update_post( $data, $wp_error ); |
|
| 138 | + $id = wp_update_post($data, $wp_error); |
|
| 139 | 139 | if ($wp_error && is_wp_error($id)) { |
| 140 | 140 | return $id; |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - if ( !$id ) { |
|
| 143 | + if (!$id) { |
|
| 144 | 144 | return false; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - $item = WP_Post::get_instance( $id ); |
|
| 147 | + $item = WP_Post::get_instance($id); |
|
| 148 | 148 | if (!empty($item) && !empty($data['meta'])) { |
| 149 | 149 | $this->ID = $item->ID; |
| 150 | 150 | $this->save_metas($data['meta']); |
| 151 | 151 | } |
| 152 | 152 | |
| 153 | 153 | // Set custom id if not set. |
| 154 | - if ( empty( $data['meta']['custom_id'] ) && !$this->get_custom_id() ) { |
|
| 155 | - $this->save_metas( array( 'custom_id' => $id ) ); |
|
| 154 | + if (empty($data['meta']['custom_id']) && !$this->get_custom_id()) { |
|
| 155 | + $this->save_metas(array('custom_id' => $id)); |
|
| 156 | 156 | } |
| 157 | 157 | |
| 158 | - do_action( 'wpinv_item_update', $id, $data ); |
|
| 158 | + do_action('wpinv_item_update', $id, $data); |
|
| 159 | 159 | |
| 160 | - return $this->setup_item( $item ); |
|
| 160 | + return $this->setup_item($item); |
|
| 161 | 161 | } |
| 162 | 162 | |
| 163 | 163 | public function get_ID() { |
@@ -165,111 +165,111 @@ discard block |
||
| 165 | 165 | } |
| 166 | 166 | |
| 167 | 167 | public function get_name() { |
| 168 | - return get_the_title( $this->ID ); |
|
| 168 | + return get_the_title($this->ID); |
|
| 169 | 169 | } |
| 170 | 170 | |
| 171 | 171 | public function get_title() { |
| 172 | - return get_the_title( $this->ID ); |
|
| 172 | + return get_the_title($this->ID); |
|
| 173 | 173 | } |
| 174 | 174 | |
| 175 | 175 | public function get_status() { |
| 176 | - return get_post_status( $this->ID ); |
|
| 176 | + return get_post_status($this->ID); |
|
| 177 | 177 | } |
| 178 | 178 | |
| 179 | 179 | public function get_summary() { |
| 180 | - $post = get_post( $this->ID ); |
|
| 181 | - return !empty( $post->post_excerpt ) ? $post->post_excerpt : ''; |
|
| 180 | + $post = get_post($this->ID); |
|
| 181 | + return !empty($post->post_excerpt) ? $post->post_excerpt : ''; |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | public function get_price() { |
| 185 | - if ( ! isset( $this->price ) ) { |
|
| 186 | - $this->price = get_post_meta( $this->ID, '_wpinv_price', true ); |
|
| 185 | + if (!isset($this->price)) { |
|
| 186 | + $this->price = get_post_meta($this->ID, '_wpinv_price', true); |
|
| 187 | 187 | |
| 188 | - if ( $this->price ) { |
|
| 189 | - $this->price = wpinv_sanitize_amount( $this->price ); |
|
| 188 | + if ($this->price) { |
|
| 189 | + $this->price = wpinv_sanitize_amount($this->price); |
|
| 190 | 190 | } else { |
| 191 | 191 | $this->price = 0; |
| 192 | 192 | } |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | - return apply_filters( 'wpinv_get_item_price', $this->price, $this->ID ); |
|
| 195 | + return apply_filters('wpinv_get_item_price', $this->price, $this->ID); |
|
| 196 | 196 | } |
| 197 | 197 | |
| 198 | 198 | public function get_vat_rule() { |
| 199 | 199 | global $wpinv_euvat; |
| 200 | 200 | |
| 201 | - if( !isset( $this->vat_rule ) ) { |
|
| 202 | - $this->vat_rule = get_post_meta( $this->ID, '_wpinv_vat_rule', true ); |
|
| 201 | + if (!isset($this->vat_rule)) { |
|
| 202 | + $this->vat_rule = get_post_meta($this->ID, '_wpinv_vat_rule', true); |
|
| 203 | 203 | |
| 204 | - if ( empty( $this->vat_rule ) ) { |
|
| 204 | + if (empty($this->vat_rule)) { |
|
| 205 | 205 | $this->vat_rule = $wpinv_euvat->allow_vat_rules() ? 'digital' : 'physical'; |
| 206 | 206 | } |
| 207 | 207 | } |
| 208 | 208 | |
| 209 | - return apply_filters( 'wpinv_get_item_vat_rule', $this->vat_rule, $this->ID ); |
|
| 209 | + return apply_filters('wpinv_get_item_vat_rule', $this->vat_rule, $this->ID); |
|
| 210 | 210 | } |
| 211 | 211 | |
| 212 | 212 | public function get_vat_class() { |
| 213 | - if( !isset( $this->vat_class ) ) { |
|
| 214 | - $this->vat_class = get_post_meta( $this->ID, '_wpinv_vat_class', true ); |
|
| 213 | + if (!isset($this->vat_class)) { |
|
| 214 | + $this->vat_class = get_post_meta($this->ID, '_wpinv_vat_class', true); |
|
| 215 | 215 | |
| 216 | - if ( empty( $this->vat_class ) ) { |
|
| 216 | + if (empty($this->vat_class)) { |
|
| 217 | 217 | $this->vat_class = '_standard'; |
| 218 | 218 | } |
| 219 | 219 | } |
| 220 | 220 | |
| 221 | - return apply_filters( 'wpinv_get_item_vat_class', $this->vat_class, $this->ID ); |
|
| 221 | + return apply_filters('wpinv_get_item_vat_class', $this->vat_class, $this->ID); |
|
| 222 | 222 | } |
| 223 | 223 | |
| 224 | 224 | public function get_type() { |
| 225 | - if( ! isset( $this->type ) ) { |
|
| 226 | - $this->type = get_post_meta( $this->ID, '_wpinv_type', true ); |
|
| 225 | + if (!isset($this->type)) { |
|
| 226 | + $this->type = get_post_meta($this->ID, '_wpinv_type', true); |
|
| 227 | 227 | |
| 228 | - if ( empty( $this->type ) ) { |
|
| 228 | + if (empty($this->type)) { |
|
| 229 | 229 | $this->type = 'custom'; |
| 230 | 230 | } |
| 231 | 231 | } |
| 232 | 232 | |
| 233 | - return apply_filters( 'wpinv_get_item_type', $this->type, $this->ID ); |
|
| 233 | + return apply_filters('wpinv_get_item_type', $this->type, $this->ID); |
|
| 234 | 234 | } |
| 235 | 235 | |
| 236 | 236 | public function get_custom_id() { |
| 237 | - $custom_id = get_post_meta( $this->ID, '_wpinv_custom_id', true ); |
|
| 237 | + $custom_id = get_post_meta($this->ID, '_wpinv_custom_id', true); |
|
| 238 | 238 | |
| 239 | - return apply_filters( 'wpinv_get_item_custom_id', $custom_id, $this->ID ); |
|
| 239 | + return apply_filters('wpinv_get_item_custom_id', $custom_id, $this->ID); |
|
| 240 | 240 | } |
| 241 | 241 | |
| 242 | 242 | public function get_custom_name() { |
| 243 | - $custom_name = get_post_meta( $this->ID, '_wpinv_custom_name', true ); |
|
| 243 | + $custom_name = get_post_meta($this->ID, '_wpinv_custom_name', true); |
|
| 244 | 244 | |
| 245 | - return apply_filters( 'wpinv_get_item_custom_name', $custom_name, $this->ID ); |
|
| 245 | + return apply_filters('wpinv_get_item_custom_name', $custom_name, $this->ID); |
|
| 246 | 246 | } |
| 247 | 247 | |
| 248 | 248 | public function get_custom_singular_name() { |
| 249 | - $custom_singular_name = get_post_meta( $this->ID, '_wpinv_custom_singular_name', true ); |
|
| 249 | + $custom_singular_name = get_post_meta($this->ID, '_wpinv_custom_singular_name', true); |
|
| 250 | 250 | |
| 251 | - return apply_filters( 'wpinv_get_item_custom_singular_name', $custom_singular_name, $this->ID ); |
|
| 251 | + return apply_filters('wpinv_get_item_custom_singular_name', $custom_singular_name, $this->ID); |
|
| 252 | 252 | } |
| 253 | 253 | |
| 254 | 254 | public function get_editable() { |
| 255 | - $editable = get_post_meta( $this->ID, '_wpinv_editable', true ); |
|
| 255 | + $editable = get_post_meta($this->ID, '_wpinv_editable', true); |
|
| 256 | 256 | |
| 257 | - return apply_filters( 'wpinv_item_get_editable', $editable, $this->ID ); |
|
| 257 | + return apply_filters('wpinv_item_get_editable', $editable, $this->ID); |
|
| 258 | 258 | } |
| 259 | 259 | |
| 260 | 260 | public function get_excerpt() { |
| 261 | - $excerpt = get_the_excerpt( $this->ID ); |
|
| 261 | + $excerpt = get_the_excerpt($this->ID); |
|
| 262 | 262 | |
| 263 | - return apply_filters( 'wpinv_item_get_excerpt', $excerpt, $this->ID ); |
|
| 263 | + return apply_filters('wpinv_item_get_excerpt', $excerpt, $this->ID); |
|
| 264 | 264 | } |
| 265 | 265 | |
| 266 | 266 | /** |
| 267 | 267 | * Checks whether the item allows a user to set their own price |
| 268 | 268 | */ |
| 269 | 269 | public function get_is_dynamic_pricing() { |
| 270 | - $is_dynamic_pricing = get_post_meta( $this->ID, '_wpinv_dynamic_pricing', true ); |
|
| 270 | + $is_dynamic_pricing = get_post_meta($this->ID, '_wpinv_dynamic_pricing', true); |
|
| 271 | 271 | |
| 272 | - return (int) apply_filters( 'wpinv_item_get_is_dynamic_pricing', $is_dynamic_pricing, $this->ID ); |
|
| 272 | + return (int) apply_filters('wpinv_item_get_is_dynamic_pricing', $is_dynamic_pricing, $this->ID); |
|
| 273 | 273 | |
| 274 | 274 | } |
| 275 | 275 | |
@@ -279,32 +279,32 @@ discard block |
||
| 279 | 279 | public function get_minimum_price() { |
| 280 | 280 | |
| 281 | 281 | //Fetch the minimum price and cast it to a float |
| 282 | - $price = (float) get_post_meta( $this->ID, '_minimum_price', true ); |
|
| 282 | + $price = (float) get_post_meta($this->ID, '_minimum_price', true); |
|
| 283 | 283 | |
| 284 | 284 | //Sanitize it |
| 285 | - $price = wpinv_sanitize_amount( $price ); |
|
| 285 | + $price = wpinv_sanitize_amount($price); |
|
| 286 | 286 | |
| 287 | 287 | //Filter then return it |
| 288 | - return apply_filters( 'wpinv_item_get_minimum_price', $price, $this->ID ); |
|
| 288 | + return apply_filters('wpinv_item_get_minimum_price', $price, $this->ID); |
|
| 289 | 289 | |
| 290 | 290 | } |
| 291 | 291 | |
| 292 | 292 | public function get_is_recurring() { |
| 293 | - $is_recurring = get_post_meta( $this->ID, '_wpinv_is_recurring', true ); |
|
| 293 | + $is_recurring = get_post_meta($this->ID, '_wpinv_is_recurring', true); |
|
| 294 | 294 | |
| 295 | - return apply_filters( 'wpinv_item_get_is_recurring', $is_recurring, $this->ID ); |
|
| 295 | + return apply_filters('wpinv_item_get_is_recurring', $is_recurring, $this->ID); |
|
| 296 | 296 | |
| 297 | 297 | } |
| 298 | 298 | |
| 299 | - public function get_recurring_period( $full = false ) { |
|
| 300 | - $period = get_post_meta( $this->ID, '_wpinv_recurring_period', true ); |
|
| 299 | + public function get_recurring_period($full = false) { |
|
| 300 | + $period = get_post_meta($this->ID, '_wpinv_recurring_period', true); |
|
| 301 | 301 | |
| 302 | - if ( !in_array( $period, array( 'D', 'W', 'M', 'Y' ) ) ) { |
|
| 302 | + if (!in_array($period, array('D', 'W', 'M', 'Y'))) { |
|
| 303 | 303 | $period = 'D'; |
| 304 | 304 | } |
| 305 | 305 | |
| 306 | - if ( $full ) { |
|
| 307 | - switch( $period ) { |
|
| 306 | + if ($full) { |
|
| 307 | + switch ($period) { |
|
| 308 | 308 | case 'D': |
| 309 | 309 | $period = 'day'; |
| 310 | 310 | break; |
@@ -320,40 +320,40 @@ discard block |
||
| 320 | 320 | } |
| 321 | 321 | } |
| 322 | 322 | |
| 323 | - return apply_filters( 'wpinv_item_recurring_period', $period, $full, $this->ID ); |
|
| 323 | + return apply_filters('wpinv_item_recurring_period', $period, $full, $this->ID); |
|
| 324 | 324 | } |
| 325 | 325 | |
| 326 | 326 | public function get_recurring_interval() { |
| 327 | - $interval = (int)get_post_meta( $this->ID, '_wpinv_recurring_interval', true ); |
|
| 327 | + $interval = (int) get_post_meta($this->ID, '_wpinv_recurring_interval', true); |
|
| 328 | 328 | |
| 329 | - if ( !$interval > 0 ) { |
|
| 329 | + if (!$interval > 0) { |
|
| 330 | 330 | $interval = 1; |
| 331 | 331 | } |
| 332 | 332 | |
| 333 | - return apply_filters( 'wpinv_item_recurring_interval', $interval, $this->ID ); |
|
| 333 | + return apply_filters('wpinv_item_recurring_interval', $interval, $this->ID); |
|
| 334 | 334 | } |
| 335 | 335 | |
| 336 | 336 | public function get_recurring_limit() { |
| 337 | - $limit = get_post_meta( $this->ID, '_wpinv_recurring_limit', true ); |
|
| 337 | + $limit = get_post_meta($this->ID, '_wpinv_recurring_limit', true); |
|
| 338 | 338 | |
| 339 | - return (int)apply_filters( 'wpinv_item_recurring_limit', $limit, $this->ID ); |
|
| 339 | + return (int) apply_filters('wpinv_item_recurring_limit', $limit, $this->ID); |
|
| 340 | 340 | } |
| 341 | 341 | |
| 342 | 342 | public function get_free_trial() { |
| 343 | - $free_trial = get_post_meta( $this->ID, '_wpinv_free_trial', true ); |
|
| 343 | + $free_trial = get_post_meta($this->ID, '_wpinv_free_trial', true); |
|
| 344 | 344 | |
| 345 | - return apply_filters( 'wpinv_item_get_free_trial', $free_trial, $this->ID ); |
|
| 345 | + return apply_filters('wpinv_item_get_free_trial', $free_trial, $this->ID); |
|
| 346 | 346 | } |
| 347 | 347 | |
| 348 | - public function get_trial_period( $full = false ) { |
|
| 349 | - $period = get_post_meta( $this->ID, '_wpinv_trial_period', true ); |
|
| 348 | + public function get_trial_period($full = false) { |
|
| 349 | + $period = get_post_meta($this->ID, '_wpinv_trial_period', true); |
|
| 350 | 350 | |
| 351 | - if ( !in_array( $period, array( 'D', 'W', 'M', 'Y' ) ) ) { |
|
| 351 | + if (!in_array($period, array('D', 'W', 'M', 'Y'))) { |
|
| 352 | 352 | $period = 'D'; |
| 353 | 353 | } |
| 354 | 354 | |
| 355 | - if ( $full ) { |
|
| 356 | - switch( $period ) { |
|
| 355 | + if ($full) { |
|
| 356 | + switch ($period) { |
|
| 357 | 357 | case 'D': |
| 358 | 358 | $period = 'day'; |
| 359 | 359 | break; |
@@ -369,47 +369,47 @@ discard block |
||
| 369 | 369 | } |
| 370 | 370 | } |
| 371 | 371 | |
| 372 | - return apply_filters( 'wpinv_item_trial_period', $period, $full, $this->ID ); |
|
| 372 | + return apply_filters('wpinv_item_trial_period', $period, $full, $this->ID); |
|
| 373 | 373 | } |
| 374 | 374 | |
| 375 | 375 | public function get_trial_interval() { |
| 376 | - $interval = absint( get_post_meta( $this->ID, '_wpinv_trial_interval', true ) ); |
|
| 376 | + $interval = absint(get_post_meta($this->ID, '_wpinv_trial_interval', true)); |
|
| 377 | 377 | |
| 378 | - if ( !$interval > 0 ) { |
|
| 378 | + if (!$interval > 0) { |
|
| 379 | 379 | $interval = 1; |
| 380 | 380 | } |
| 381 | 381 | |
| 382 | - return apply_filters( 'wpinv_item_trial_interval', $interval, $this->ID ); |
|
| 382 | + return apply_filters('wpinv_item_trial_interval', $interval, $this->ID); |
|
| 383 | 383 | } |
| 384 | 384 | |
| 385 | 385 | public function get_the_price() { |
| 386 | - $item_price = wpinv_price( wpinv_format_amount( $this->get_price() ) ); |
|
| 386 | + $item_price = wpinv_price(wpinv_format_amount($this->get_price())); |
|
| 387 | 387 | |
| 388 | - return apply_filters( 'wpinv_get_the_item_price', $item_price, $this->ID ); |
|
| 388 | + return apply_filters('wpinv_get_the_item_price', $item_price, $this->ID); |
|
| 389 | 389 | } |
| 390 | 390 | |
| 391 | 391 | public function is_recurring() { |
| 392 | 392 | $is_recurring = $this->get_is_recurring(); |
| 393 | 393 | |
| 394 | - return (bool)apply_filters( 'wpinv_is_recurring_item', $is_recurring, $this->ID ); |
|
| 394 | + return (bool) apply_filters('wpinv_is_recurring_item', $is_recurring, $this->ID); |
|
| 395 | 395 | } |
| 396 | 396 | |
| 397 | 397 | public function has_free_trial() { |
| 398 | 398 | $free_trial = $this->is_recurring() && $this->get_free_trial() ? true : false; |
| 399 | 399 | |
| 400 | - return (bool)apply_filters( 'wpinv_item_has_free_trial', $free_trial, $this->ID ); |
|
| 400 | + return (bool) apply_filters('wpinv_item_has_free_trial', $free_trial, $this->ID); |
|
| 401 | 401 | } |
| 402 | 402 | |
| 403 | 403 | public function is_free() { |
| 404 | 404 | $is_free = false; |
| 405 | 405 | |
| 406 | - $price = get_post_meta( $this->ID, '_wpinv_price', true ); |
|
| 406 | + $price = get_post_meta($this->ID, '_wpinv_price', true); |
|
| 407 | 407 | |
| 408 | - if ( (float)$price == 0 ) { |
|
| 408 | + if ((float) $price == 0) { |
|
| 409 | 409 | $is_free = true; |
| 410 | 410 | } |
| 411 | 411 | |
| 412 | - return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID ); |
|
| 412 | + return (bool) apply_filters('wpinv_is_free_item', $is_free, $this->ID); |
|
| 413 | 413 | |
| 414 | 414 | } |
| 415 | 415 | |
@@ -418,15 +418,15 @@ discard block |
||
| 418 | 418 | |
| 419 | 419 | $is_editable = $editable === 0 || $editable === '0' ? false : true; |
| 420 | 420 | |
| 421 | - return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID ); |
|
| 421 | + return (bool) apply_filters('wpinv_item_is_editable', $is_editable, $this->ID); |
|
| 422 | 422 | } |
| 423 | 423 | |
| 424 | - public function save_metas( $metas = array() ) { |
|
| 425 | - if ( empty( $metas ) ) { |
|
| 424 | + public function save_metas($metas = array()) { |
|
| 425 | + if (empty($metas)) { |
|
| 426 | 426 | return false; |
| 427 | 427 | } |
| 428 | 428 | |
| 429 | - foreach ( $metas as $meta_key => $meta_value ) { |
|
| 429 | + foreach ($metas as $meta_key => $meta_value) { |
|
| 430 | 430 | $meta_key = strpos($meta_key, '_wpinv_') !== 0 ? '_wpinv_' . $meta_key : $meta_key; |
| 431 | 431 | |
| 432 | 432 | $this->update_meta($meta_key, $meta_value); |
@@ -435,77 +435,77 @@ discard block |
||
| 435 | 435 | return true; |
| 436 | 436 | } |
| 437 | 437 | |
| 438 | - public function update_meta( $meta_key = '', $meta_value = '', $prev_value = '' ) { |
|
| 439 | - if ( empty( $meta_key ) ) { |
|
| 438 | + public function update_meta($meta_key = '', $meta_value = '', $prev_value = '') { |
|
| 439 | + if (empty($meta_key)) { |
|
| 440 | 440 | return false; |
| 441 | 441 | } |
| 442 | 442 | |
| 443 | - if( '_wpinv_minimum_price' === $meta_key ) { |
|
| 443 | + if ('_wpinv_minimum_price' === $meta_key) { |
|
| 444 | 444 | $meta_key = '_minimum_price'; |
| 445 | 445 | } |
| 446 | 446 | |
| 447 | - $meta_value = apply_filters( 'wpinv_update_item_meta_' . $meta_key, $meta_value, $this->ID ); |
|
| 447 | + $meta_value = apply_filters('wpinv_update_item_meta_' . $meta_key, $meta_value, $this->ID); |
|
| 448 | 448 | |
| 449 | - return update_post_meta( $this->ID, $meta_key, $meta_value, $prev_value ); |
|
| 449 | + return update_post_meta($this->ID, $meta_key, $meta_value, $prev_value); |
|
| 450 | 450 | } |
| 451 | 451 | |
| 452 | - public function get_fees( $type = 'fee', $item_id = 0 ) { |
|
| 452 | + public function get_fees($type = 'fee', $item_id = 0) { |
|
| 453 | 453 | global $wpi_session; |
| 454 | 454 | |
| 455 | - $fees = $wpi_session->get( 'wpi_cart_fees' ); |
|
| 455 | + $fees = $wpi_session->get('wpi_cart_fees'); |
|
| 456 | 456 | |
| 457 | - if ( ! wpinv_get_cart_contents() ) { |
|
| 457 | + if (!wpinv_get_cart_contents()) { |
|
| 458 | 458 | // We can only get item type fees when the cart is empty |
| 459 | 459 | $type = 'custom'; |
| 460 | 460 | } |
| 461 | 461 | |
| 462 | - if ( ! empty( $fees ) && ! empty( $type ) && 'all' !== $type ) { |
|
| 463 | - foreach( $fees as $key => $fee ) { |
|
| 464 | - if( ! empty( $fee['type'] ) && $type != $fee['type'] ) { |
|
| 465 | - unset( $fees[ $key ] ); |
|
| 462 | + if (!empty($fees) && !empty($type) && 'all' !== $type) { |
|
| 463 | + foreach ($fees as $key => $fee) { |
|
| 464 | + if (!empty($fee['type']) && $type != $fee['type']) { |
|
| 465 | + unset($fees[$key]); |
|
| 466 | 466 | } |
| 467 | 467 | } |
| 468 | 468 | } |
| 469 | 469 | |
| 470 | - if ( ! empty( $fees ) && ! empty( $item_id ) ) { |
|
| 470 | + if (!empty($fees) && !empty($item_id)) { |
|
| 471 | 471 | // Remove fees that don't belong to the specified Item |
| 472 | - foreach ( $fees as $key => $fee ) { |
|
| 473 | - if ( (int) $item_id !== (int)$fee['custom_id'] ) { |
|
| 474 | - unset( $fees[ $key ] ); |
|
| 472 | + foreach ($fees as $key => $fee) { |
|
| 473 | + if ((int) $item_id !== (int) $fee['custom_id']) { |
|
| 474 | + unset($fees[$key]); |
|
| 475 | 475 | } |
| 476 | 476 | } |
| 477 | 477 | } |
| 478 | 478 | |
| 479 | - if ( ! empty( $fees ) ) { |
|
| 479 | + if (!empty($fees)) { |
|
| 480 | 480 | // Remove fees that belong to a specific item but are not in the cart |
| 481 | - foreach( $fees as $key => $fee ) { |
|
| 482 | - if( empty( $fee['custom_id'] ) ) { |
|
| 481 | + foreach ($fees as $key => $fee) { |
|
| 482 | + if (empty($fee['custom_id'])) { |
|
| 483 | 483 | continue; |
| 484 | 484 | } |
| 485 | 485 | |
| 486 | - if ( !wpinv_item_in_cart( $fee['custom_id'] ) ) { |
|
| 487 | - unset( $fees[ $key ] ); |
|
| 486 | + if (!wpinv_item_in_cart($fee['custom_id'])) { |
|
| 487 | + unset($fees[$key]); |
|
| 488 | 488 | } |
| 489 | 489 | } |
| 490 | 490 | } |
| 491 | 491 | |
| 492 | - return ! empty( $fees ) ? $fees : array(); |
|
| 492 | + return !empty($fees) ? $fees : array(); |
|
| 493 | 493 | } |
| 494 | 494 | |
| 495 | 495 | public function can_purchase() { |
| 496 | 496 | $can_purchase = true; |
| 497 | 497 | |
| 498 | - if ( !current_user_can( 'edit_post', $this->ID ) && $this->post_status != 'publish' ) { |
|
| 498 | + if (!current_user_can('edit_post', $this->ID) && $this->post_status != 'publish') { |
|
| 499 | 499 | $can_purchase = false; |
| 500 | 500 | } |
| 501 | 501 | |
| 502 | - return (bool)apply_filters( 'wpinv_can_purchase_item', $can_purchase, $this ); |
|
| 502 | + return (bool) apply_filters('wpinv_can_purchase_item', $can_purchase, $this); |
|
| 503 | 503 | } |
| 504 | 504 | |
| 505 | 505 | /** |
| 506 | 506 | * Checks whether this item supports dynamic pricing or not |
| 507 | 507 | */ |
| 508 | 508 | public function supports_dynamic_pricing() { |
| 509 | - return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this ); |
|
| 509 | + return (bool) apply_filters('wpinv_item_supports_dynamic_pricing', true, $this); |
|
| 510 | 510 | } |
| 511 | 511 | } |
@@ -1,6 +1,8 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | // Exit if accessed directly |
| 3 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 3 | +if ( ! defined( 'ABSPATH' ) ) { |
|
| 4 | + exit; |
|
| 5 | +} |
|
| 4 | 6 | |
| 5 | 7 | add_action( 'wpinv_worldpay_cc_form', '__return_false' ); |
| 6 | 8 | |
@@ -1,12 +1,12 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | // Exit if accessed directly |
| 3 | -if ( ! defined( 'ABSPATH' ) ) exit; |
|
| 3 | +if (!defined('ABSPATH')) exit; |
|
| 4 | 4 | |
| 5 | -add_action( 'wpinv_worldpay_cc_form', '__return_false' ); |
|
| 5 | +add_action('wpinv_worldpay_cc_form', '__return_false'); |
|
| 6 | 6 | |
| 7 | -function wpinv_process_worldpay_payment( $purchase_data ) { |
|
| 8 | - if( ! wp_verify_nonce( $purchase_data['gateway_nonce'], 'wpi-gateway' ) ) { |
|
| 9 | - wp_die( __( 'Nonce verification has failed', 'invoicing' ), __( 'Error', 'invoicing' ), array( 'response' => 403 ) ); |
|
| 7 | +function wpinv_process_worldpay_payment($purchase_data) { |
|
| 8 | + if (!wp_verify_nonce($purchase_data['gateway_nonce'], 'wpi-gateway')) { |
|
| 9 | + wp_die(__('Nonce verification has failed', 'invoicing'), __('Error', 'invoicing'), array('response' => 403)); |
|
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | // Collect payment data |
@@ -24,132 +24,132 @@ discard block |
||
| 24 | 24 | ); |
| 25 | 25 | |
| 26 | 26 | // Record the pending payment |
| 27 | - $invoice = wpinv_get_invoice( $purchase_data['invoice_id'] ); |
|
| 27 | + $invoice = wpinv_get_invoice($purchase_data['invoice_id']); |
|
| 28 | 28 | |
| 29 | - if ( !empty( $invoice ) ) { |
|
| 29 | + if (!empty($invoice)) { |
|
| 30 | 30 | $quantities_enabled = wpinv_item_quantities_enabled(); |
| 31 | 31 | |
| 32 | - $instId = wpinv_get_option( 'worldpay_instId', false ); |
|
| 32 | + $instId = wpinv_get_option('worldpay_instId', false); |
|
| 33 | 33 | $cartId = $invoice->get_number(); |
| 34 | - $testMode = wpinv_is_test_mode( 'worldpay' ) ? 100 : 0; |
|
| 34 | + $testMode = wpinv_is_test_mode('worldpay') ? 100 : 0; |
|
| 35 | 35 | $name = $invoice->get_user_full_name(); |
| 36 | - $address = wp_strip_all_tags( $invoice->get_address(), true ); |
|
| 36 | + $address = wp_strip_all_tags($invoice->get_address(), true); |
|
| 37 | 37 | $postcode = $invoice->zip; |
| 38 | 38 | $tel = $invoice->phone; |
| 39 | 39 | $email = $invoice->get_email(); |
| 40 | 40 | $country = $invoice->country; |
| 41 | - $amount = wpinv_sanitize_amount( $invoice->get_total() ); |
|
| 41 | + $amount = wpinv_sanitize_amount($invoice->get_total()); |
|
| 42 | 42 | $currency = wpinv_get_currency(); |
| 43 | 43 | |
| 44 | 44 | $items = array(); |
| 45 | - foreach ( $invoice->get_cart_details() as $item ) { |
|
| 45 | + foreach ($invoice->get_cart_details() as $item) { |
|
| 46 | 46 | $item_desc = $item['name']; |
| 47 | - $quantity = !empty( $item['quantity'] ) && $item['quantity'] > 0 ? $item['quantity'] : 1; |
|
| 48 | - $item_desc .= ' (' . ( $quantities_enabled ? $quantity . 'x ' : '' ) . wpinv_price( wpinv_format_amount( $item['item_price'] ) ) . ')'; |
|
| 47 | + $quantity = !empty($item['quantity']) && $item['quantity'] > 0 ? $item['quantity'] : 1; |
|
| 48 | + $item_desc .= ' (' . ($quantities_enabled ? $quantity . 'x ' : '') . wpinv_price(wpinv_format_amount($item['item_price'])) . ')'; |
|
| 49 | 49 | |
| 50 | 50 | $items[] = $item_desc; |
| 51 | 51 | } |
| 52 | 52 | |
| 53 | - $desc = implode( ', ', $items ); |
|
| 54 | - if ( wpinv_use_taxes() && $invoice->get_tax() > 0 ) { |
|
| 55 | - $desc .= ', ' . wp_sprintf( __( 'Tax: %s', 'invoicing' ), $invoice->get_tax( true ) ); |
|
| 53 | + $desc = implode(', ', $items); |
|
| 54 | + if (wpinv_use_taxes() && $invoice->get_tax() > 0) { |
|
| 55 | + $desc .= ', ' . wp_sprintf(__('Tax: %s', 'invoicing'), $invoice->get_tax(true)); |
|
| 56 | 56 | } |
| 57 | 57 | |
| 58 | 58 | $extra_params = array(); |
| 59 | 59 | $extra_params['MC_description'] = $desc; |
| 60 | - $extra_params['MC_callback'] = wpinv_get_ipn_url( 'worldpay' ); |
|
| 60 | + $extra_params['MC_callback'] = wpinv_get_ipn_url('worldpay'); |
|
| 61 | 61 | $extra_params['MC_key'] = $invoice->get_key(); |
| 62 | 62 | $extra_params['MC_invoice_id'] = $invoice->ID; |
| 63 | 63 | $extra_params['address1'] = $address; |
| 64 | 64 | $extra_params['town'] = $invoice->city; |
| 65 | 65 | $extra_params['region'] = $invoice->state; |
| 66 | - $extra_params['amountString'] = $invoice->get_total( true ); |
|
| 67 | - $extra_params['countryString'] = wpinv_country_name( $invoice->country ); |
|
| 66 | + $extra_params['amountString'] = $invoice->get_total(true); |
|
| 67 | + $extra_params['countryString'] = wpinv_country_name($invoice->country); |
|
| 68 | 68 | $extra_params['compName'] = $invoice->company; |
| 69 | 69 | |
| 70 | - $extra_params = apply_filters( 'wpinv_worldpay_form_extra_parameters', $extra_params, $invoice ); |
|
| 70 | + $extra_params = apply_filters('wpinv_worldpay_form_extra_parameters', $extra_params, $invoice); |
|
| 71 | 71 | |
| 72 | - $redirect_text = __( 'Redirecting to Worldpay site, click on button if not redirected.', 'invoicing' ); |
|
| 73 | - $redirect_text = apply_filters( 'wpinv_worldpay_redirect_text', $redirect_text, $invoice ); |
|
| 72 | + $redirect_text = __('Redirecting to Worldpay site, click on button if not redirected.', 'invoicing'); |
|
| 73 | + $redirect_text = apply_filters('wpinv_worldpay_redirect_text', $redirect_text, $invoice); |
|
| 74 | 74 | |
| 75 | 75 | // Empty the shopping cart |
| 76 | 76 | wpinv_empty_cart(); |
| 77 | 77 | ?> |
| 78 | 78 | <div class="wpi-worldpay-form" style="padding:20px;font-family:arial,sans-serif;text-align:center;color:#555"> |
| 79 | -<?php do_action( 'wpinv_worldpay_form_before', $invoice ); ?> |
|
| 80 | -<h3><?php echo $redirect_text ;?></h3> |
|
| 79 | +<?php do_action('wpinv_worldpay_form_before', $invoice); ?> |
|
| 80 | +<h3><?php echo $redirect_text; ?></h3> |
|
| 81 | 81 | <form action="<?php echo wpinv_get_worldpay_redirect(); ?>" name="wpi_worldpay_form" method="POST"> |
| 82 | - <input type="hidden" value="<?php echo $amount;?>" name="amount"> |
|
| 83 | - <input type="hidden" value="<?php echo esc_attr( $cartId );?>" name="cartId"> |
|
| 84 | - <input type="hidden" value="<?php echo $currency;?>" name="currency"> |
|
| 85 | - <input type="hidden" value="<?php echo $instId;?>" name="instId"> |
|
| 86 | - <input type="hidden" value="<?php echo $testMode;?>" name="testMode"> |
|
| 87 | - <input type="hidden" value="<?php echo esc_attr( $name );?>" name="name"> |
|
| 88 | - <input type="hidden" value="<?php echo esc_attr( $address );?>" name="address"> |
|
| 89 | - <input type="hidden" value="<?php echo esc_attr( $postcode );?>" name="postcode"> |
|
| 90 | - <input type="hidden" value="<?php echo esc_attr( $tel );?>" name="tel"> |
|
| 91 | - <input type="hidden" value="<?php echo esc_attr( $email );?>" name="email"> |
|
| 92 | - <input type="hidden" value="<?php echo esc_attr( $country );?>" name="country"> |
|
| 93 | - <input type="hidden" value="<?php echo esc_attr( $desc );?>" name="desc"> |
|
| 94 | - <?php foreach ( $extra_params as $param => $value ) { ?> |
|
| 95 | - <?php if ( !empty( $value !== false ) ) { ?> |
|
| 96 | - <input type="hidden" value="<?php echo esc_attr( $value );?>" name="<?php echo esc_attr( $param );?>"> |
|
| 82 | + <input type="hidden" value="<?php echo $amount; ?>" name="amount"> |
|
| 83 | + <input type="hidden" value="<?php echo esc_attr($cartId); ?>" name="cartId"> |
|
| 84 | + <input type="hidden" value="<?php echo $currency; ?>" name="currency"> |
|
| 85 | + <input type="hidden" value="<?php echo $instId; ?>" name="instId"> |
|
| 86 | + <input type="hidden" value="<?php echo $testMode; ?>" name="testMode"> |
|
| 87 | + <input type="hidden" value="<?php echo esc_attr($name); ?>" name="name"> |
|
| 88 | + <input type="hidden" value="<?php echo esc_attr($address); ?>" name="address"> |
|
| 89 | + <input type="hidden" value="<?php echo esc_attr($postcode); ?>" name="postcode"> |
|
| 90 | + <input type="hidden" value="<?php echo esc_attr($tel); ?>" name="tel"> |
|
| 91 | + <input type="hidden" value="<?php echo esc_attr($email); ?>" name="email"> |
|
| 92 | + <input type="hidden" value="<?php echo esc_attr($country); ?>" name="country"> |
|
| 93 | + <input type="hidden" value="<?php echo esc_attr($desc); ?>" name="desc"> |
|
| 94 | + <?php foreach ($extra_params as $param => $value) { ?> |
|
| 95 | + <?php if (!empty($value !== false)) { ?> |
|
| 96 | + <input type="hidden" value="<?php echo esc_attr($value); ?>" name="<?php echo esc_attr($param); ?>"> |
|
| 97 | 97 | <?php } ?> |
| 98 | 98 | <?php } ?> |
| 99 | - <?php do_action( 'wpinv_worldpay_form_parameters', $invoice ); ?> |
|
| 100 | - <input type="submit" name="wpi_worldpay_submit" value="<?php esc_attr_e( 'Pay by Credit Card / Debit Card (WorldPay)', 'invoicing' ) ;?>"> |
|
| 99 | + <?php do_action('wpinv_worldpay_form_parameters', $invoice); ?> |
|
| 100 | + <input type="submit" name="wpi_worldpay_submit" value="<?php esc_attr_e('Pay by Credit Card / Debit Card (WorldPay)', 'invoicing'); ?>"> |
|
| 101 | 101 | </form> |
| 102 | 102 | <script type="text/javascript">document.wpi_worldpay_form.submit();</script> |
| 103 | -<?php do_action( 'wpinv_worldpay_form_after', $invoice ); ?> |
|
| 103 | +<?php do_action('wpinv_worldpay_form_after', $invoice); ?> |
|
| 104 | 104 | </div> |
| 105 | 105 | <?php |
| 106 | 106 | } else { |
| 107 | - wpinv_record_gateway_error( __( 'Payment Error', 'invoicing' ), sprintf( __( 'Payment creation failed while processing a worldpay payment. Payment data: %s', 'invoicing' ), json_encode( $payment_data ) ), $invoice ); |
|
| 107 | + wpinv_record_gateway_error(__('Payment Error', 'invoicing'), sprintf(__('Payment creation failed while processing a worldpay payment. Payment data: %s', 'invoicing'), json_encode($payment_data)), $invoice); |
|
| 108 | 108 | // If errors are present, send the user back to the purchase page so they can be corrected |
| 109 | - wpinv_send_back_to_checkout( '?payment-mode=' . $purchase_data['post_data']['wpi-gateway'] ); |
|
| 109 | + wpinv_send_back_to_checkout('?payment-mode=' . $purchase_data['post_data']['wpi-gateway']); |
|
| 110 | 110 | } |
| 111 | 111 | } |
| 112 | -add_action( 'wpinv_gateway_worldpay', 'wpinv_process_worldpay_payment' ); |
|
| 112 | +add_action('wpinv_gateway_worldpay', 'wpinv_process_worldpay_payment'); |
|
| 113 | 113 | |
| 114 | 114 | function wpinv_get_worldpay_redirect() { |
| 115 | - $redirect = wpinv_is_test_mode( 'worldpay' ) ? 'https://secure-test.worldpay.com/wcc/purchase' : 'https://secure.worldpay.com/wcc/purchase'; |
|
| 115 | + $redirect = wpinv_is_test_mode('worldpay') ? 'https://secure-test.worldpay.com/wcc/purchase' : 'https://secure.worldpay.com/wcc/purchase'; |
|
| 116 | 116 | |
| 117 | - return apply_filters( 'wpinv_worldpay_redirect', $redirect ); |
|
| 117 | + return apply_filters('wpinv_worldpay_redirect', $redirect); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | 120 | function wpinv_process_worldpay_ipn() { |
| 121 | - $request = wpinv_get_post_data( 'post' ); |
|
| 121 | + $request = wpinv_get_post_data('post'); |
|
| 122 | 122 | |
| 123 | - if ( !empty( $request['cartId'] ) && !empty( $request['transStatus'] ) && !empty( $request['installation'] ) && isset( $request['testMode'] ) && isset( $request['MC_invoice_id'] ) && isset( $request['MC_key'] ) ) { |
|
| 123 | + if (!empty($request['cartId']) && !empty($request['transStatus']) && !empty($request['installation']) && isset($request['testMode']) && isset($request['MC_invoice_id']) && isset($request['MC_key'])) { |
|
| 124 | 124 | $invoice_id = $request['MC_invoice_id']; |
| 125 | 125 | |
| 126 | - if ( $invoice_id == wpinv_get_invoice_id_by_key( $request['MC_key'] ) && $invoice = wpinv_get_invoice( $invoice_id ) ) { |
|
| 127 | - if ( $request['transStatus'] == 'Y' ) { |
|
| 128 | - wpinv_update_payment_status( $invoice_id, 'publish' ); |
|
| 129 | - wpinv_set_payment_transaction_id( $invoice_id, $request['transId'] ); |
|
| 130 | - wpinv_insert_payment_note( $invoice_id, sprintf( __( 'Worldpay Transaction ID: %s', 'invoicing' ), $request['transId'] ) ); |
|
| 126 | + if ($invoice_id == wpinv_get_invoice_id_by_key($request['MC_key']) && $invoice = wpinv_get_invoice($invoice_id)) { |
|
| 127 | + if ($request['transStatus'] == 'Y') { |
|
| 128 | + wpinv_update_payment_status($invoice_id, 'publish'); |
|
| 129 | + wpinv_set_payment_transaction_id($invoice_id, $request['transId']); |
|
| 130 | + wpinv_insert_payment_note($invoice_id, sprintf(__('Worldpay Transaction ID: %s', 'invoicing'), $request['transId'])); |
|
| 131 | 131 | return; |
| 132 | - } else if ( $request['transStatus'] == 'C' ) { |
|
| 133 | - wpinv_update_payment_status( $invoice_id, 'wpi-failed' ); |
|
| 134 | - wpinv_insert_payment_note( $invoice_id, __( 'Payment transaction failed while processing Worldpay payment, kindly check IPN log.', 'invoicing' ) ); |
|
| 132 | + } else if ($request['transStatus'] == 'C') { |
|
| 133 | + wpinv_update_payment_status($invoice_id, 'wpi-failed'); |
|
| 134 | + wpinv_insert_payment_note($invoice_id, __('Payment transaction failed while processing Worldpay payment, kindly check IPN log.', 'invoicing')); |
|
| 135 | 135 | |
| 136 | - wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Payment transaction failed while processing Worldpay payment. IPN data: %s', 'invoicing' ), json_encode( $request ) ), $invoice_id ); |
|
| 136 | + wpinv_record_gateway_error(__('IPN Error', 'invoicing'), sprintf(__('Payment transaction failed while processing Worldpay payment. IPN data: %s', 'invoicing'), json_encode($request)), $invoice_id); |
|
| 137 | 137 | return; |
| 138 | 138 | } |
| 139 | 139 | } |
| 140 | 140 | } |
| 141 | 141 | return; |
| 142 | 142 | } |
| 143 | -add_action( 'wpinv_verify_worldpay_ipn', 'wpinv_process_worldpay_ipn' ); |
|
| 143 | +add_action('wpinv_verify_worldpay_ipn', 'wpinv_process_worldpay_ipn'); |
|
| 144 | 144 | |
| 145 | 145 | function wpinv_is_worldpay_valid_for_use() { |
| 146 | - return in_array( wpinv_get_currency(), apply_filters( 'wpinv_worldpay_supported_currencies', array( 'AUD', 'ARS', 'CAD', 'CHF', 'DKK', 'EUR', 'HKD', 'MYR', 'GBP', 'NZD', 'NOK', 'SGD', 'LKR', 'SEK', 'TRY', 'USD', 'ZAR' ))); |
|
| 146 | + return in_array(wpinv_get_currency(), apply_filters('wpinv_worldpay_supported_currencies', array('AUD', 'ARS', 'CAD', 'CHF', 'DKK', 'EUR', 'HKD', 'MYR', 'GBP', 'NZD', 'NOK', 'SGD', 'LKR', 'SEK', 'TRY', 'USD', 'ZAR'))); |
|
| 147 | 147 | } |
| 148 | 148 | |
| 149 | -function wpinv_check_worldpay_currency_support( $gateway_list ) { |
|
| 150 | - if ( isset( $gateway_list['worldpay'] ) && ! wpinv_is_worldpay_valid_for_use() ) { |
|
| 151 | - unset( $gateway_list['worldpay'] ); |
|
| 149 | +function wpinv_check_worldpay_currency_support($gateway_list) { |
|
| 150 | + if (isset($gateway_list['worldpay']) && !wpinv_is_worldpay_valid_for_use()) { |
|
| 151 | + unset($gateway_list['worldpay']); |
|
| 152 | 152 | } |
| 153 | 153 | return $gateway_list; |
| 154 | 154 | } |
| 155 | -add_filter( 'wpinv_enabled_payment_gateways', 'wpinv_check_worldpay_currency_support', 10, 1 ); |
|
| 156 | 155 | \ No newline at end of file |
| 156 | +add_filter('wpinv_enabled_payment_gateways', 'wpinv_check_worldpay_currency_support', 10, 1); |
|
| 157 | 157 | \ No newline at end of file |
@@ -40,7 +40,7 @@ discard block |
||
| 40 | 40 | const EXCEPTION_CURL = 10; |
| 41 | 41 | |
| 42 | 42 | private $ch; |
| 43 | - private $login; |
|
| 43 | + private $login; |
|
| 44 | 44 | private $response; |
| 45 | 45 | private $response_xml; |
| 46 | 46 | private $results; |
@@ -48,9 +48,9 @@ discard block |
||
| 48 | 48 | private $url; |
| 49 | 49 | private $xml; |
| 50 | 50 | |
| 51 | - public function __construct($login, $transkey, $test = self::USE_PRODUCTION_SERVER) |
|
| 52 | - { |
|
| 53 | - $login = trim($login); |
|
| 51 | + public function __construct($login, $transkey, $test = self::USE_PRODUCTION_SERVER) |
|
| 52 | + { |
|
| 53 | + $login = trim($login); |
|
| 54 | 54 | $transkey = trim($transkey); |
| 55 | 55 | if (empty($login) || empty($transkey)) |
| 56 | 56 | { |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | |
| 64 | 64 | $subdomain = ($test) ? 'apitest' : 'api'; |
| 65 | 65 | $this->url = 'https://' . $subdomain . '.authorize.net/xml/v1/request.api'; |
| 66 | - } |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | 68 | /** |
| 69 | 69 | * remove XML response namespaces |
@@ -78,9 +78,9 @@ discard block |
||
| 78 | 78 | return str_replace(' xmlns:xsd="http://www.w3.org/2001/XMLSchema"','',$input); |
| 79 | 79 | } |
| 80 | 80 | |
| 81 | - public function __toString() |
|
| 82 | - { |
|
| 83 | - $output = ''; |
|
| 81 | + public function __toString() |
|
| 82 | + { |
|
| 83 | + $output = ''; |
|
| 84 | 84 | $output .= '<table summary="Authorize.Net Results" id="authnet">' . "\n"; |
| 85 | 85 | $output .= '<tr>' . "\n\t\t" . '<th colspan="2"><b>Class Parameters</b></th>' . "\n" . '</tr>' . "\n"; |
| 86 | 86 | $output .= '<tr>' . "\n\t\t" . '<td><b>API Login ID</b></td><td>' . $this->login . '</td>' . "\n" . '</tr>' . "\n"; |
@@ -117,9 +117,9 @@ discard block |
||
| 117 | 117 | $output .= '</table>'; |
| 118 | 118 | |
| 119 | 119 | return $output; |
| 120 | - } |
|
| 120 | + } |
|
| 121 | 121 | |
| 122 | - public function __destruct() |
|
| 122 | + public function __destruct() |
|
| 123 | 123 | { |
| 124 | 124 | if (isset($this->ch)) |
| 125 | 125 | { |
@@ -128,31 +128,31 @@ discard block |
||
| 128 | 128 | } |
| 129 | 129 | |
| 130 | 130 | public function __get($var) |
| 131 | - { |
|
| 132 | - return $this->response_xml->$var; |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - public function __set($key, $value) |
|
| 136 | - { |
|
| 137 | - trigger_error('You cannot set parameters directly in ' . __CLASS__ . '.', E_USER_WARNING); |
|
| 138 | - return false; |
|
| 139 | - } |
|
| 140 | - |
|
| 141 | - public function __call($api_call, $args) |
|
| 142 | - { |
|
| 143 | - $this->xml = new SimpleXMLElement('<' . $api_call . '></' . $api_call . '>'); |
|
| 131 | + { |
|
| 132 | + return $this->response_xml->$var; |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + public function __set($key, $value) |
|
| 136 | + { |
|
| 137 | + trigger_error('You cannot set parameters directly in ' . __CLASS__ . '.', E_USER_WARNING); |
|
| 138 | + return false; |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + public function __call($api_call, $args) |
|
| 142 | + { |
|
| 143 | + $this->xml = new SimpleXMLElement('<' . $api_call . '></' . $api_call . '>'); |
|
| 144 | 144 | $this->xml->addAttribute('xmlns', 'AnetApi/xml/v1/schema/AnetApiSchema.xsd'); |
| 145 | - $merch_auth = $this->xml->addChild('merchantAuthentication'); |
|
| 145 | + $merch_auth = $this->xml->addChild('merchantAuthentication'); |
|
| 146 | 146 | $merch_auth->addChild('name', $this->login); |
| 147 | - $merch_auth->addChild('transactionKey', $this->transkey); |
|
| 147 | + $merch_auth->addChild('transactionKey', $this->transkey); |
|
| 148 | 148 | |
| 149 | - $this->setParameters($this->xml, $args[0]); |
|
| 150 | - $this->process(); |
|
| 151 | - } |
|
| 149 | + $this->setParameters($this->xml, $args[0]); |
|
| 150 | + $this->process(); |
|
| 151 | + } |
|
| 152 | 152 | |
| 153 | - private function setParameters($xml, $array) |
|
| 154 | - { |
|
| 155 | - if (is_array($array)) |
|
| 153 | + private function setParameters($xml, $array) |
|
| 154 | + { |
|
| 155 | + if (is_array($array)) |
|
| 156 | 156 | { |
| 157 | 157 | $first = true; |
| 158 | 158 | foreach ($array as $key => $value) |
@@ -184,34 +184,34 @@ discard block |
||
| 184 | 184 | } |
| 185 | 185 | } |
| 186 | 186 | } |
| 187 | - } |
|
| 187 | + } |
|
| 188 | 188 | |
| 189 | - private function process() |
|
| 190 | - { |
|
| 191 | - $this->xml = $this->xml->asXML(); |
|
| 189 | + private function process() |
|
| 190 | + { |
|
| 191 | + $this->xml = $this->xml->asXML(); |
|
| 192 | 192 | |
| 193 | - $this->ch = curl_init(); |
|
| 193 | + $this->ch = curl_init(); |
|
| 194 | 194 | curl_setopt($this->ch, CURLOPT_URL, $this->url); |
| 195 | - curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, 1); |
|
| 196 | - curl_setopt($this->ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); |
|
| 197 | - curl_setopt($this->ch, CURLOPT_HEADER, 0); |
|
| 198 | - curl_setopt($this->ch, CURLOPT_POSTFIELDS, $this->xml); |
|
| 199 | - curl_setopt($this->ch, CURLOPT_POST, 1); |
|
| 200 | - curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 2); |
|
| 201 | - curl_setopt($this->ch, CURLOPT_CAINFO, dirname(__FILE__) . '/ssl/cert.pem'); |
|
| 195 | + curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, 1); |
|
| 196 | + curl_setopt($this->ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); |
|
| 197 | + curl_setopt($this->ch, CURLOPT_HEADER, 0); |
|
| 198 | + curl_setopt($this->ch, CURLOPT_POSTFIELDS, $this->xml); |
|
| 199 | + curl_setopt($this->ch, CURLOPT_POST, 1); |
|
| 200 | + curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 2); |
|
| 201 | + curl_setopt($this->ch, CURLOPT_CAINFO, dirname(__FILE__) . '/ssl/cert.pem'); |
|
| 202 | 202 | |
| 203 | 203 | if(($this->response = curl_exec($this->ch)) !== false) |
| 204 | 204 | { |
| 205 | 205 | $this->response_xml = @new SimpleXMLElement($this->response); |
| 206 | 206 | |
| 207 | - curl_close($this->ch); |
|
| 207 | + curl_close($this->ch); |
|
| 208 | 208 | unset($this->ch); |
| 209 | 209 | return; |
| 210 | - } |
|
| 210 | + } |
|
| 211 | 211 | throw new AuthnetXMLException('Connection error: ' . curl_error($this->ch) . ' (' . curl_errno($this->ch) . ')', self::EXCEPTION_CURL); |
| 212 | - } |
|
| 212 | + } |
|
| 213 | 213 | |
| 214 | - public function isSuccessful() |
|
| 214 | + public function isSuccessful() |
|
| 215 | 215 | { |
| 216 | 216 | return $this->response_xml->messages->resultCode == 'Ok'; |
| 217 | 217 | } |
@@ -165,20 +165,17 @@ |
||
| 165 | 165 | { |
| 166 | 166 | $xmlx = $xml; |
| 167 | 167 | $first = false; |
| 168 | - } |
|
| 169 | - else |
|
| 168 | + } else |
|
| 170 | 169 | { |
| 171 | 170 | $parent = $xml->xpath('parent::*'); |
| 172 | 171 | $xmlx = $parent[0]->addChild($xml->getName()); |
| 173 | 172 | } |
| 174 | - } |
|
| 175 | - else |
|
| 173 | + } else |
|
| 176 | 174 | { |
| 177 | 175 | $xmlx = $xml->addChild($key); |
| 178 | 176 | } |
| 179 | 177 | $this->setParameters($xmlx, $value); |
| 180 | - } |
|
| 181 | - else |
|
| 178 | + } else |
|
| 182 | 179 | { |
| 183 | 180 | $xml->$key = $value; |
| 184 | 181 | } |
@@ -50,7 +50,7 @@ discard block |
||
| 50 | 50 | |
| 51 | 51 | public function __construct($login, $transkey, $test = self::USE_PRODUCTION_SERVER) |
| 52 | 52 | { |
| 53 | - $login = trim($login); |
|
| 53 | + $login = trim($login); |
|
| 54 | 54 | $transkey = trim($transkey); |
| 55 | 55 | if (empty($login) || empty($transkey)) |
| 56 | 56 | { |
@@ -73,14 +73,14 @@ discard block |
||
| 73 | 73 | private function removeResponseXMLNS($input) |
| 74 | 74 | { |
| 75 | 75 | // why remove them one at a time? all three aren't consistantly used in the response |
| 76 | - $input = str_replace(' xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"','',$input); |
|
| 77 | - $input = str_replace(' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"','',$input); |
|
| 78 | - return str_replace(' xmlns:xsd="http://www.w3.org/2001/XMLSchema"','',$input); |
|
| 76 | + $input = str_replace(' xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"', '', $input); |
|
| 77 | + $input = str_replace(' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"', '', $input); |
|
| 78 | + return str_replace(' xmlns:xsd="http://www.w3.org/2001/XMLSchema"', '', $input); |
|
| 79 | 79 | } |
| 80 | 80 | |
| 81 | 81 | public function __toString() |
| 82 | 82 | { |
| 83 | - $output = ''; |
|
| 83 | + $output = ''; |
|
| 84 | 84 | $output .= '<table summary="Authorize.Net Results" id="authnet">' . "\n"; |
| 85 | 85 | $output .= '<tr>' . "\n\t\t" . '<th colspan="2"><b>Class Parameters</b></th>' . "\n" . '</tr>' . "\n"; |
| 86 | 86 | $output .= '<tr>' . "\n\t\t" . '<td><b>API Login ID</b></td><td>' . $this->login . '</td>' . "\n" . '</tr>' . "\n"; |
@@ -159,9 +159,9 @@ discard block |
||
| 159 | 159 | { |
| 160 | 160 | if (is_array($value)) |
| 161 | 161 | { |
| 162 | - if(is_numeric($key)) |
|
| 162 | + if (is_numeric($key)) |
|
| 163 | 163 | { |
| 164 | - if($first === true) |
|
| 164 | + if ($first === true) |
|
| 165 | 165 | { |
| 166 | 166 | $xmlx = $xml; |
| 167 | 167 | $first = false; |
@@ -200,7 +200,7 @@ discard block |
||
| 200 | 200 | curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 2); |
| 201 | 201 | curl_setopt($this->ch, CURLOPT_CAINFO, dirname(__FILE__) . '/ssl/cert.pem'); |
| 202 | 202 | |
| 203 | - if(($this->response = curl_exec($this->ch)) !== false) |
|
| 203 | + if (($this->response = curl_exec($this->ch)) !== false) |
|
| 204 | 204 | { |
| 205 | 205 | $this->response_xml = @new SimpleXMLElement($this->response); |
| 206 | 206 | |
@@ -96,7 +96,7 @@ |
||
| 96 | 96 | curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, false); |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - if (preg_match('/xml/',$post_url)) { |
|
| 99 | + if (preg_match('/xml/', $post_url)) { |
|
| 100 | 100 | curl_setopt($curl_request, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); |
| 101 | 101 | } |
| 102 | 102 | |
@@ -29,7 +29,7 @@ discard block |
||
| 29 | 29 | $this->xml = @simplexml_load_string($response); |
| 30 | 30 | |
| 31 | 31 | // Remove namespaces for use with XPath. |
| 32 | - $this->xpath_xml = @simplexml_load_string(preg_replace('/ xmlns:xsi[^>]+/','',$response)); |
|
| 32 | + $this->xpath_xml = @simplexml_load_string(preg_replace('/ xmlns:xsi[^>]+/', '', $response)); |
|
| 33 | 33 | } |
| 34 | 34 | } |
| 35 | 35 | |
@@ -116,12 +116,12 @@ discard block |
||
| 116 | 116 | { |
| 117 | 117 | $start = "<$elementName>"; |
| 118 | 118 | $end = "</$elementName>"; |
| 119 | - if (strpos($this->response,$start) === false || strpos($this->response,$end) === false) { |
|
| 119 | + if (strpos($this->response, $start) === false || strpos($this->response, $end) === false) { |
|
| 120 | 120 | return false; |
| 121 | 121 | } else { |
| 122 | - $start_position = strpos($this->response, $start)+strlen($start); |
|
| 122 | + $start_position = strpos($this->response, $start) + strlen($start); |
|
| 123 | 123 | $end_position = strpos($this->response, $end); |
| 124 | - return substr($this->response, $start_position, $end_position-$start_position); |
|
| 124 | + return substr($this->response, $start_position, $end_position - $start_position); |
|
| 125 | 125 | } |
| 126 | 126 | } |
| 127 | 127 | |
@@ -91,13 +91,13 @@ |
||
| 91 | 91 | return $this->_sendRequest(); |
| 92 | 92 | } |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * |
|
| 96 | - * |
|
| 97 | - * @param string $response |
|
| 98 | - * |
|
| 99 | - * @return AuthorizeNetARB_Response |
|
| 100 | - */ |
|
| 94 | + /** |
|
| 95 | + * |
|
| 96 | + * |
|
| 97 | + * @param string $response |
|
| 98 | + * |
|
| 99 | + * @return AuthorizeNetARB_Response |
|
| 100 | + */ |
|
| 101 | 101 | protected function _handleResponse($response) |
| 102 | 102 | { |
| 103 | 103 | return new AuthorizeNetARB_Response($response); |
@@ -116,7 +116,7 @@ |
||
| 116 | 116 | */ |
| 117 | 117 | protected function _setPostString() |
| 118 | 118 | { |
| 119 | - $this->_post_string =<<<XML |
|
| 119 | + $this->_post_string = <<<XML |
|
| 120 | 120 | <?xml version="1.0" encoding="utf-8"?> |
| 121 | 121 | <ARB{$this->_request_type} xmlns= "AnetApi/xml/v1/schema/AnetApiSchema.xsd"> |
| 122 | 122 | <merchantAuthentication> |
@@ -316,9 +316,9 @@ |
||
| 316 | 316 | return $this->_sendRequest(); |
| 317 | 317 | } |
| 318 | 318 | |
| 319 | - /** |
|
| 320 | - * @return string |
|
| 321 | - */ |
|
| 319 | + /** |
|
| 320 | + * @return string |
|
| 321 | + */ |
|
| 322 | 322 | protected function _getPostUrl() |
| 323 | 323 | { |
| 324 | 324 | return ($this->_sandbox ? self::SANDBOX_URL : self::LIVE_URL); |
@@ -309,10 +309,10 @@ discard block |
||
| 309 | 309 | { |
| 310 | 310 | $this->_validationMode = $validationMode; |
| 311 | 311 | $this->_constructXml("validateCustomerPaymentProfileRequest"); |
| 312 | - $this->_xml->addChild("customerProfileId",$customerProfileId); |
|
| 313 | - $this->_xml->addChild("customerPaymentProfileId",$customerPaymentProfileId); |
|
| 314 | - $this->_xml->addChild("customerShippingAddressId",$customerShippingAddressId); |
|
| 315 | - $this->_xml->addChild("cardCode",$cardCode); |
|
| 312 | + $this->_xml->addChild("customerProfileId", $customerProfileId); |
|
| 313 | + $this->_xml->addChild("customerPaymentProfileId", $customerPaymentProfileId); |
|
| 314 | + $this->_xml->addChild("customerShippingAddressId", $customerShippingAddressId); |
|
| 315 | + $this->_xml->addChild("cardCode", $cardCode); |
|
| 316 | 316 | return $this->_sendRequest(); |
| 317 | 317 | } |
| 318 | 318 | |
@@ -341,13 +341,13 @@ discard block |
||
| 341 | 341 | */ |
| 342 | 342 | protected function _setPostString() |
| 343 | 343 | { |
| 344 | - ($this->_validationMode != "none" ? $this->_xml->addChild('validationMode',$this->_validationMode) : ""); |
|
| 344 | + ($this->_validationMode != "none" ? $this->_xml->addChild('validationMode', $this->_validationMode) : ""); |
|
| 345 | 345 | $this->_post_string = $this->_xml->asXML(); |
| 346 | 346 | |
| 347 | 347 | // Add extraOptions CDATA |
| 348 | 348 | if ($this->_extraOptions) { |
| 349 | 349 | $this->_xml->addChild("extraOptions"); |
| 350 | - $this->_post_string = str_replace("<extraOptions></extraOptions>",'<extraOptions><![CDATA[' . $this->_extraOptions . ']]></extraOptions>', $this->_xml->asXML()); |
|
| 350 | + $this->_post_string = str_replace("<extraOptions></extraOptions>", '<extraOptions><![CDATA[' . $this->_extraOptions . ']]></extraOptions>', $this->_xml->asXML()); |
|
| 351 | 351 | $this->_extraOptions = false; |
| 352 | 352 | } |
| 353 | 353 | // Blank out our validation mode, so that we don't include it in calls that |
@@ -362,12 +362,12 @@ discard block |
||
| 362 | 362 | */ |
| 363 | 363 | private function _constructXml($request_type) |
| 364 | 364 | { |
| 365 | - $string = '<?xml version="1.0" encoding="utf-8"?><'.$request_type.' xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"></'.$request_type.'>'; |
|
| 365 | + $string = '<?xml version="1.0" encoding="utf-8"?><' . $request_type . ' xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"></' . $request_type . '>'; |
|
| 366 | 366 | $this->_xml = @new SimpleXMLElement($string); |
| 367 | 367 | $merchant = $this->_xml->addChild('merchantAuthentication'); |
| 368 | - $merchant->addChild('name',$this->_api_login); |
|
| 369 | - $merchant->addChild('transactionKey',$this->_transaction_key); |
|
| 370 | - ($this->_refId ? $this->_xml->addChild('refId',$this->_refId) : ""); |
|
| 368 | + $merchant->addChild('name', $this->_api_login); |
|
| 369 | + $merchant->addChild('transactionKey', $this->_transaction_key); |
|
| 370 | + ($this->_refId ? $this->_xml->addChild('refId', $this->_refId) : ""); |
|
| 371 | 371 | } |
| 372 | 372 | |
| 373 | 373 | /** |
@@ -378,7 +378,7 @@ discard block |
||
| 378 | 378 | */ |
| 379 | 379 | private function _addObject($destination, $object) |
| 380 | 380 | { |
| 381 | - $array = (array)$object; |
|
| 381 | + $array = (array) $object; |
|
| 382 | 382 | foreach ($array as $key => $value) { |
| 383 | 383 | if ($value && !is_object($value)) { |
| 384 | 384 | if (is_array($value) && count($value)) { |
@@ -387,7 +387,7 @@ discard block |
||
| 387 | 387 | $this->_addObject($items, $item); |
| 388 | 388 | } |
| 389 | 389 | } else { |
| 390 | - $destination->addChild($key,$value); |
|
| 390 | + $destination->addChild($key, $value); |
|
| 391 | 391 | } |
| 392 | 392 | } elseif (is_object($value) && self::_notEmpty($value)) { |
| 393 | 393 | $dest = $destination->addChild($key); |
@@ -405,7 +405,7 @@ discard block |
||
| 405 | 405 | */ |
| 406 | 406 | private static function _notEmpty($object) |
| 407 | 407 | { |
| 408 | - $array = (array)$object; |
|
| 408 | + $array = (array) $object; |
|
| 409 | 409 | foreach ($array as $key => $value) { |
| 410 | 410 | if ($value && !is_object($value)) { |
| 411 | 411 | return true; |
@@ -441,9 +441,9 @@ discard block |
||
| 441 | 441 | */ |
| 442 | 442 | public function getValidationResponses() |
| 443 | 443 | { |
| 444 | - $responses = (array)$this->xml->validationDirectResponseList; |
|
| 444 | + $responses = (array) $this->xml->validationDirectResponseList; |
|
| 445 | 445 | $return = array(); |
| 446 | - foreach ((array)$responses["string"] as $response) { |
|
| 446 | + foreach ((array) $responses["string"] as $response) { |
|
| 447 | 447 | $return[] = new AuthorizeNetAIM_Response($response, ",", "", array()); |
| 448 | 448 | } |
| 449 | 449 | return $return; |
@@ -462,7 +462,7 @@ discard block |
||
| 462 | 462 | */ |
| 463 | 463 | public function getCustomerProfileIds() |
| 464 | 464 | { |
| 465 | - $ids = (array)$this->xml->ids; |
|
| 465 | + $ids = (array) $this->xml->ids; |
|
| 466 | 466 | return $ids["numericString"]; |
| 467 | 467 | } |
| 468 | 468 | |
@@ -471,7 +471,7 @@ discard block |
||
| 471 | 471 | */ |
| 472 | 472 | public function getCustomerPaymentProfileIds() |
| 473 | 473 | { |
| 474 | - $ids = (array)$this->xml->customerPaymentProfileIdList; |
|
| 474 | + $ids = (array) $this->xml->customerPaymentProfileIdList; |
|
| 475 | 475 | return $ids["numericString"]; |
| 476 | 476 | } |
| 477 | 477 | |
@@ -480,7 +480,7 @@ discard block |
||
| 480 | 480 | */ |
| 481 | 481 | public function getCustomerShippingAddressIds() |
| 482 | 482 | { |
| 483 | - $ids = (array)$this->xml->customerShippingAddressIdList; |
|
| 483 | + $ids = (array) $this->xml->customerShippingAddressIdList; |
|
| 484 | 484 | return $ids["numericString"]; |
| 485 | 485 | } |
| 486 | 486 | |