AyeCode / invoicing

includes/libraries/class-emogrifier.php

Indentation +779 added lines, -779 removed lines

@@ -9,346 +9,346 @@ 
  * @author Roman Ožana <ozana@omdesign.cz>
  */
 class Emogrifier {
-	/**
-	 * @var string
-	 */
-	const ENCODING = 'UTF-8';
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_CSS = 0;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_SELECTOR = 1;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_XPATH = 2;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_CSS_DECLARATION_BLOCK = 3;
-
-	/**
-	 * for calculating nth-of-type and nth-child selectors.
-	 *
-	 * @var integer
-	 */
-	const INDEX = 0;
-
-	/**
-	 * for calculating nth-of-type and nth-child selectors.
-	 *
-	 * @var integer
-	 */
-	const MULTIPLIER = 1;
-
-	/**
-	 * @var string
-	 */
-	const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/';
-
-	/**
-	 * @var string
-	 */
-	const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
-
-	/**
-	 * @var string
-	 */
-	private $html = '';
-
-	/**
-	 * @var string
-	 */
-	private $css = '';
-
-	/**
-	 * @var array<string>
-	 */
-	private $unprocessableHtmlTags = array('wbr');
-
-	/**
-	 * @var array<array>
-	 */
-	private $caches = array(
-		self::CACHE_KEY_CSS => array(),
-		self::CACHE_KEY_SELECTOR => array(),
-		self::CACHE_KEY_XPATH => array(),
-		self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(),
-	);
-
-	/**
-	 * the visited nodes with the XPath paths as array keys.
-	 *
-	 * @var array<\DOMNode>
-	 */
-	private $visitedNodes = array();
-
-	/**
-	 * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values.
-	 * as key/value pairs for the inner array.
-	 *
-	 * @var array<array><string>
-	 */
-	private $styleAttributesForNodes = array();
-
-	/**
-	 * This attribute applies to the case where you want to preserve your original text encoding.
-	 *
-	 * By default, emogrifier translates your text into HTML entities for two reasons:
-	 *
-	 * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email.
-	 *
-	 * 2. It translates any illegal XML characters that DOMDocument cannot work with.
-	 *
-	 * If you would like to preserve your original encoding, set this attribute to TRUE.
-	 *
-	 * @var boolean
-	 */
-	public $preserveEncoding = false;
-
-	public static $_media = '';
-
-	/**
-	 * The constructor.
-	 *
-	 * @param string $html the HTML to emogrify, must be UTF-8-encoded
-	 * @param string $css the CSS to merge, must be UTF-8-encoded
-	 */
-	public function __construct($html = '', $css = '') {
-		$this->setHtml($html);
-		$this->setCss($css);
-	}
-
-	/**
-	 * The destructor.
-	 */
-	public function __destruct() {
-		$this->purgeVisitedNodes();
-	}
-
-	/**
-	 * Sets the HTML to emogrify.
-	 *
-	 * @param string $html the HTML to emogrify, must be UTF-8-encoded
-	 */
-	public function setHtml($html = '') {
-		$this->html = $html;
-	}
-
-	/**
-	 * Sets the CSS to merge with the HTML.
-	 *
-	 * @param string $css the CSS to merge, must be UTF-8-encoded
-	 */
-	public function setCss($css = '') {
-		$this->css = $css;
-	}
-
-	/**
-	 * Clears all caches.
-	 */
-	private function clearAllCaches() {
-		$this->clearCache(self::CACHE_KEY_CSS);
-		$this->clearCache(self::CACHE_KEY_SELECTOR);
-		$this->clearCache(self::CACHE_KEY_XPATH);
-		$this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK);
-	}
-
-	/**
-	 * Clears a single cache by key.
-	 *
-	 * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	private function clearCache($key) {
-		$allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK);
-		if (!in_array($key, $allowedCacheKeys, true)) {
-			throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
-		}
-
-		$this->caches[$key] = array();
-	}
-
-	/**
-	 * Purges the visited nodes.
-	 */
-	private function purgeVisitedNodes() {
-		$this->visitedNodes = array();
-		$this->styleAttributesForNodes = array();
-	}
-
-	/**
-	 * Marks a tag for removal.
-	 *
-	 * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them.
-	 * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document.
-	 *
-	 * Note: The tags will not be removed if they have any content.
-	 *
-	 * @param string $tagName the tag name, e.g., "p"
-	 */
-	public function addUnprocessableHtmlTag($tagName) {
-		$this->unprocessableHtmlTags[] = $tagName;
-	}
-
-	/**
-	 * Drops a tag from the removal list.
-	 *
-	 * @param string $tagName the tag name, e.g., "p"
-	 */
-	public function removeUnprocessableHtmlTag($tagName) {
-		$key = array_search($tagName, $this->unprocessableHtmlTags, true);
-		if ($key !== false) {
-			unset($this->unprocessableHtmlTags[$key]);
-		}
-	}
-
-	/**
-	 * Applies the CSS you submit to the HTML you submit.
-	 *
-	 * This method places the CSS inline.
-	 *
-	 * @return string
-	 *
-	 * @throws BadMethodCallException
-	 */
-	public function emogrify() {
-		if ($this->html === '') {
-			throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096);
-		}
-
-		$xmlDocument = $this->createXmlDocument();
-		$xpath = new DOMXPath($xmlDocument);
-		$this->clearAllCaches();
-
-		// before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none');
-		// we wouldn't have to do this if DOMXPath supported XPath 2.0.
-		// also store a reference of nodes with existing inline styles so we don't overwrite them
-		$this->purgeVisitedNodes();
-
-		$nodesWithStyleAttributes = $xpath->query('//*[@style]');
-		if ($nodesWithStyleAttributes !== false) {
-			/** @var $nodeWithStyleAttribute DOMNode */
-			foreach ($nodesWithStyleAttributes as $node) {
-				$normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') );
-
-				// in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles
-				$nodePath = $node->getNodePath();
-				if (!isset($this->styleAttributesForNodes[$nodePath])) {
-					$this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle);
-					$this->visitedNodes[$nodePath] = $node;
-				}
-
-				$node->setAttribute('style', $normalizedOriginalStyle);
-			}
-		}
-
-		// grab any existing style blocks from the html and append them to the existing CSS
-		// (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
-		$allCss = $this->css;
-
-		$allCss .= $this->getCssFromAllStyleNodes($xpath);
-
-		$cssParts = $this->splitCssAndMediaQuery($allCss);
-		self::$_media = ''; // reset
-
-		$cssKey = md5($cssParts['css']);
-		if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
-			// process the CSS file for selectors and definitions
-			preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER);
-
-			$allSelectors = array();
-			foreach ($matches as $key => $selectorString) {
-				// if there is a blank definition, skip
-				if (!strlen(trim($selectorString[2]))) {
-					continue;
-				}
-
-				// else split by commas and duplicate attributes so we can sort by selector precedence
-				$selectors = explode(',', $selectorString[1]);
-				foreach ($selectors as $selector) {
-					// don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes
-					if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) {
-						continue;
-					}
-
-					$allSelectors[] = array('selector' => trim($selector),
-											 'attributes' => trim($selectorString[2]),
-											 // keep track of where it appears in the file, since order is important
-											 'line' => $key,
-					);
-				}
-			}
-
-			// now sort the selectors by precedence
-			usort($allSelectors, array($this,'sortBySelectorPrecedence'));
-
-			$this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors;
-		}
-
-		foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) {
-			// query the body for the xpath selector
-			$nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector']));
-
-			/** @var $node \DOMNode */
-			foreach ($nodesMatchingCssSelectors as $node) {
-				// if it has a style attribute, get it, process it, and append (overwrite) new stuff
-				if ($node->hasAttribute('style')) {
-					// break it up into an associative array
-					$oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style'));
-				} else {
-					$oldStyleDeclarations = array();
-				}
-				$newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']);
-				$node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
-			}
-		}
-
-		// now iterate through the nodes that contained inline styles in the original HTML
-		foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
-			$node = $this->visitedNodes[$nodePath];
-			$currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style'));
-			$node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
-		}
-
-		// This removes styles from your email that contain display:none.
-		// We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0,
-		// lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need
-		// to translate() the letters that would be in 'NONE' ("NOE") to lowercase.
-		$nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]');
-		// The checks on parentNode and is_callable below ensure that if we've deleted the parent node,
-		// we don't try to call removeChild on a nonexistent child node
-		if ($nodesWithStyleDisplayNone->length > 0) {
-			/** @var $node \DOMNode */
-			foreach ($nodesWithStyleDisplayNone as $node) {
-				if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) {
-					$node->parentNode->removeChild($node);
-				}
-			}
-		}
-
-		$this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument);
-
-		if ($this->preserveEncoding) {
-			// Deprecated since PHP 8.2
-			if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
-				return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' );
-			} else {
-				return mb_encode_numericentity( $xmlDocument->saveHTML(), [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
-				//return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) );
-			}
-		} else {
-			return $xmlDocument->saveHTML();
-		}
-	}
+    /**
+     * @var string
+     */
+    const ENCODING = 'UTF-8';
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_CSS = 0;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_SELECTOR = 1;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_XPATH = 2;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_CSS_DECLARATION_BLOCK = 3;
+
+    /**
+     * for calculating nth-of-type and nth-child selectors.
+     *
+     * @var integer
+     */
+    const INDEX = 0;
+
+    /**
+     * for calculating nth-of-type and nth-child selectors.
+     *
+     * @var integer
+     */
+    const MULTIPLIER = 1;
+
+    /**
+     * @var string
+     */
+    const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/';
+
+    /**
+     * @var string
+     */
+    const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
+
+    /**
+     * @var string
+     */
+    private $html = '';
+
+    /**
+     * @var string
+     */
+    private $css = '';
+
+    /**
+     * @var array<string>
+     */
+    private $unprocessableHtmlTags = array('wbr');
+
+    /**
+     * @var array<array>
+     */
+    private $caches = array(
+        self::CACHE_KEY_CSS => array(),
+        self::CACHE_KEY_SELECTOR => array(),
+        self::CACHE_KEY_XPATH => array(),
+        self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(),
+    );
+
+    /**
+     * the visited nodes with the XPath paths as array keys.
+     *
+     * @var array<\DOMNode>
+     */
+    private $visitedNodes = array();
+
+    /**
+     * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values.
+     * as key/value pairs for the inner array.
+     *
+     * @var array<array><string>
+     */
+    private $styleAttributesForNodes = array();
+
+    /**
+     * This attribute applies to the case where you want to preserve your original text encoding.
+     *
+     * By default, emogrifier translates your text into HTML entities for two reasons:
+     *
+     * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email.
+     *
+     * 2. It translates any illegal XML characters that DOMDocument cannot work with.
+     *
+     * If you would like to preserve your original encoding, set this attribute to TRUE.
+     *
+     * @var boolean
+     */
+    public $preserveEncoding = false;
+
+    public static $_media = '';
+
+    /**
+     * The constructor.
+     *
+     * @param string $html the HTML to emogrify, must be UTF-8-encoded
+     * @param string $css the CSS to merge, must be UTF-8-encoded
+     */
+    public function __construct($html = '', $css = '') {
+        $this->setHtml($html);
+        $this->setCss($css);
+    }
+
+    /**
+     * The destructor.
+     */
+    public function __destruct() {
+        $this->purgeVisitedNodes();
+    }
+
+    /**
+     * Sets the HTML to emogrify.
+     *
+     * @param string $html the HTML to emogrify, must be UTF-8-encoded
+     */
+    public function setHtml($html = '') {
+        $this->html = $html;
+    }
+
+    /**
+     * Sets the CSS to merge with the HTML.
+     *
+     * @param string $css the CSS to merge, must be UTF-8-encoded
+     */
+    public function setCss($css = '') {
+        $this->css = $css;
+    }
+
+    /**
+     * Clears all caches.
+     */
+    private function clearAllCaches() {
+        $this->clearCache(self::CACHE_KEY_CSS);
+        $this->clearCache(self::CACHE_KEY_SELECTOR);
+        $this->clearCache(self::CACHE_KEY_XPATH);
+        $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK);
+    }
+
+    /**
+     * Clears a single cache by key.
+     *
+     * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK
+     *
+     * @throws InvalidArgumentException
+     */
+    private function clearCache($key) {
+        $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK);
+        if (!in_array($key, $allowedCacheKeys, true)) {
+            throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
+        }
+
+        $this->caches[$key] = array();
+    }
+
+    /**
+     * Purges the visited nodes.
+     */
+    private function purgeVisitedNodes() {
+        $this->visitedNodes = array();
+        $this->styleAttributesForNodes = array();
+    }
+
+    /**
+     * Marks a tag for removal.
+     *
+     * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them.
+     * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document.
+     *
+     * Note: The tags will not be removed if they have any content.
+     *
+     * @param string $tagName the tag name, e.g., "p"
+     */
+    public function addUnprocessableHtmlTag($tagName) {
+        $this->unprocessableHtmlTags[] = $tagName;
+    }
+
+    /**
+     * Drops a tag from the removal list.
+     *
+     * @param string $tagName the tag name, e.g., "p"
+     */
+    public function removeUnprocessableHtmlTag($tagName) {
+        $key = array_search($tagName, $this->unprocessableHtmlTags, true);
+        if ($key !== false) {
+            unset($this->unprocessableHtmlTags[$key]);
+        }
+    }
+
+    /**
+     * Applies the CSS you submit to the HTML you submit.
+     *
+     * This method places the CSS inline.
+     *
+     * @return string
+     *
+     * @throws BadMethodCallException
+     */
+    public function emogrify() {
+        if ($this->html === '') {
+            throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096);
+        }
+
+        $xmlDocument = $this->createXmlDocument();
+        $xpath = new DOMXPath($xmlDocument);
+        $this->clearAllCaches();
+
+        // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none');
+        // we wouldn't have to do this if DOMXPath supported XPath 2.0.
+        // also store a reference of nodes with existing inline styles so we don't overwrite them
+        $this->purgeVisitedNodes();
+
+        $nodesWithStyleAttributes = $xpath->query('//*[@style]');
+        if ($nodesWithStyleAttributes !== false) {
+            /** @var $nodeWithStyleAttribute DOMNode */
+            foreach ($nodesWithStyleAttributes as $node) {
+                $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') );
+
+                // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles
+                $nodePath = $node->getNodePath();
+                if (!isset($this->styleAttributesForNodes[$nodePath])) {
+                    $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle);
+                    $this->visitedNodes[$nodePath] = $node;
+                }
+
+                $node->setAttribute('style', $normalizedOriginalStyle);
+            }
+        }
+
+        // grab any existing style blocks from the html and append them to the existing CSS
+        // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
+        $allCss = $this->css;
+
+        $allCss .= $this->getCssFromAllStyleNodes($xpath);
+
+        $cssParts = $this->splitCssAndMediaQuery($allCss);
+        self::$_media = ''; // reset
+
+        $cssKey = md5($cssParts['css']);
+        if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
+            // process the CSS file for selectors and definitions
+            preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER);
+
+            $allSelectors = array();
+            foreach ($matches as $key => $selectorString) {
+                // if there is a blank definition, skip
+                if (!strlen(trim($selectorString[2]))) {
+                    continue;
+                }
+
+                // else split by commas and duplicate attributes so we can sort by selector precedence
+                $selectors = explode(',', $selectorString[1]);
+                foreach ($selectors as $selector) {
+                    // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes
+                    if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) {
+                        continue;
+                    }
+
+                    $allSelectors[] = array('selector' => trim($selector),
+                                                'attributes' => trim($selectorString[2]),
+                                                // keep track of where it appears in the file, since order is important
+                                                'line' => $key,
+                    );
+                }
+            }
+
+            // now sort the selectors by precedence
+            usort($allSelectors, array($this,'sortBySelectorPrecedence'));
+
+            $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors;
+        }
+
+        foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) {
+            // query the body for the xpath selector
+            $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector']));
+
+            /** @var $node \DOMNode */
+            foreach ($nodesMatchingCssSelectors as $node) {
+                // if it has a style attribute, get it, process it, and append (overwrite) new stuff
+                if ($node->hasAttribute('style')) {
+                    // break it up into an associative array
+                    $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style'));
+                } else {
+                    $oldStyleDeclarations = array();
+                }
+                $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']);
+                $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
+            }
+        }
+
+        // now iterate through the nodes that contained inline styles in the original HTML
+        foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
+            $node = $this->visitedNodes[$nodePath];
+            $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style'));
+            $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
+        }
+
+        // This removes styles from your email that contain display:none.
+        // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0,
+        // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need
+        // to translate() the letters that would be in 'NONE' ("NOE") to lowercase.
+        $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]');
+        // The checks on parentNode and is_callable below ensure that if we've deleted the parent node,
+        // we don't try to call removeChild on a nonexistent child node
+        if ($nodesWithStyleDisplayNone->length > 0) {
+            /** @var $node \DOMNode */
+            foreach ($nodesWithStyleDisplayNone as $node) {
+                if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) {
+                    $node->parentNode->removeChild($node);
+                }
+            }
+        }
+
+        $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument);
+
+        if ($this->preserveEncoding) {
+            // Deprecated since PHP 8.2
+            if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
+                return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' );
+            } else {
+                return mb_encode_numericentity( $xmlDocument->saveHTML(), [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
+                //return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) );
+            }
+        } else {
+            return $xmlDocument->saveHTML();
+        }
+    }
 
     /**
      * String to lower.
@@ -358,143 +358,143 @@ 
      * @param array $m
      * @return string
      */
-	public function strtolower(array $m) {
-		return strtolower($m[0]);
-	}
-
-
-	/**
-	 * This method merges old or existing name/value array with new name/value array.
-	 * and then generates a string of the combined style suitable for placing inline.
-	 * This becomes the single point for CSS string generation allowing for consistent.
-	 * CSS output no matter where the CSS originally came from.
-	 * @param array $oldStyles
-	 * @param array $newStyles
-	 * @return string
-	 */
-	private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) {
-		$combinedStyles = array_merge($oldStyles, $newStyles);
-		$style = '';
-		foreach ($combinedStyles as $attributeName => $attributeValue) {
-			$style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ');
-		}
-		return trim($style);
-	}
-
-
-	/**
-	 * Copies the media part from CSS array parts to $xmlDocument.
-	 *
-	 * @param array $cssParts
-	 * @param DOMDocument $xmlDocument
-	 */
-	public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) {
-		if (isset($cssParts['media']) && $cssParts['media'] !== '') {
-			$this->addStyleElementToDocument($xmlDocument, $cssParts['media']);
-		}
-	}
-
-	/**
-	 * Returns CSS content.
-	 *
-	 * @param DOMXPath $xpath
-	 * @return string
-	 */
-	private function getCssFromAllStyleNodes(DOMXPath $xpath) {
-		$styleNodes = $xpath->query('//style');
-
-		if ($styleNodes === false) {
-			return '';
-		}
-
-		$css = '';
-		/** @var $styleNode DOMNode */
-		foreach ($styleNodes as $styleNode) {
-			$css .= "\n\n" . $styleNode->nodeValue;
-			$styleNode->parentNode->removeChild($styleNode);
-		}
-
-		return $css;
-	}
-
-	/**
-	 * Adds a style element with $css to $document.
-	 *
-	 * @param DOMDocument $document
-	 * @param string $css
-	 */
-	private function addStyleElementToDocument(DOMDocument $document, $css) {
-		$styleElement = $document->createElement('style', $css);
-		$styleAttribute = $document->createAttribute('type');
-		$styleAttribute->value = 'text/css';
-		$styleElement->appendChild($styleAttribute);
-
-		$head = $this->getOrCreateHeadElement($document);
-		$head->appendChild($styleElement);
-	}
-
-	/**
-	 * Returns the existing or creates a new head element in $document.
-	 *
-	 * @param DOMDocument $document
-	 * @return DOMNode the head element
-	 */
-	private function getOrCreateHeadElement(DOMDocument $document) {
-		$head = $document->getElementsByTagName('head')->item(0);
-
-		if ($head === null) {
-			$head = $document->createElement('head');
-			$html = $document->getElementsByTagName('html')->item(0);
-			$html->insertBefore($head, $document->getElementsByTagName('body')->item(0));
-		}
-
-		return $head;
-	}
-
-	/**
-	 * Splits input CSS code to an array where:
-	 *
-	 * - key "css" will be contains clean CSS code.
-	 * - key "media" will be contains all valuable media queries.
-	 *
-	 * Example:
-	 *
-	 * The CSS code.
-	 *
-	 *   "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}"
-	 *
-	 * will be parsed into the following array:
-	 *
-	 *   "css" => "h1 { color:red; }"
-	 *   "media" => "@media { h1 {}}"
-	 *
-	 * @param string $css
-	 * @return array
-	 */
-	private function splitCssAndMediaQuery($css) {
-		$css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css );
-
-		// filter the CSS
-		$search = array(
-			// get rid of css comment code
-			'/\\/\\*.*\\*\\//sU',
-			// strip out any import directives
-			'/^\\s*@import\\s[^;]+;/misU',
-			// strip remains media enclosures
-			'/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
-		);
-
-		$replace = array(
-			'',
-			'',
-			'',
-		);
-
-		// clean CSS before output
-		$css = preg_replace($search, $replace, $css);
-
-		return array('css' => $css, 'media' => self::$_media);
-	}
+    public function strtolower(array $m) {
+        return strtolower($m[0]);
+    }
+
+
+    /**
+     * This method merges old or existing name/value array with new name/value array.
+     * and then generates a string of the combined style suitable for placing inline.
+     * This becomes the single point for CSS string generation allowing for consistent.
+     * CSS output no matter where the CSS originally came from.
+     * @param array $oldStyles
+     * @param array $newStyles
+     * @return string
+     */
+    private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) {
+        $combinedStyles = array_merge($oldStyles, $newStyles);
+        $style = '';
+        foreach ($combinedStyles as $attributeName => $attributeValue) {
+            $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ');
+        }
+        return trim($style);
+    }
+
+
+    /**
+     * Copies the media part from CSS array parts to $xmlDocument.
+     *
+     * @param array $cssParts
+     * @param DOMDocument $xmlDocument
+     */
+    public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) {
+        if (isset($cssParts['media']) && $cssParts['media'] !== '') {
+            $this->addStyleElementToDocument($xmlDocument, $cssParts['media']);
+        }
+    }
+
+    /**
+     * Returns CSS content.
+     *
+     * @param DOMXPath $xpath
+     * @return string
+     */
+    private function getCssFromAllStyleNodes(DOMXPath $xpath) {
+        $styleNodes = $xpath->query('//style');
+
+        if ($styleNodes === false) {
+            return '';
+        }
+
+        $css = '';
+        /** @var $styleNode DOMNode */
+        foreach ($styleNodes as $styleNode) {
+            $css .= "\n\n" . $styleNode->nodeValue;
+            $styleNode->parentNode->removeChild($styleNode);
+        }
+
+        return $css;
+    }
+
+    /**
+     * Adds a style element with $css to $document.
+     *
+     * @param DOMDocument $document
+     * @param string $css
+     */
+    private function addStyleElementToDocument(DOMDocument $document, $css) {
+        $styleElement = $document->createElement('style', $css);
+        $styleAttribute = $document->createAttribute('type');
+        $styleAttribute->value = 'text/css';
+        $styleElement->appendChild($styleAttribute);
+
+        $head = $this->getOrCreateHeadElement($document);
+        $head->appendChild($styleElement);
+    }
+
+    /**
+     * Returns the existing or creates a new head element in $document.
+     *
+     * @param DOMDocument $document
+     * @return DOMNode the head element
+     */
+    private function getOrCreateHeadElement(DOMDocument $document) {
+        $head = $document->getElementsByTagName('head')->item(0);
+
+        if ($head === null) {
+            $head = $document->createElement('head');
+            $html = $document->getElementsByTagName('html')->item(0);
+            $html->insertBefore($head, $document->getElementsByTagName('body')->item(0));
+        }
+
+        return $head;
+    }
+
+    /**
+     * Splits input CSS code to an array where:
+     *
+     * - key "css" will be contains clean CSS code.
+     * - key "media" will be contains all valuable media queries.
+     *
+     * Example:
+     *
+     * The CSS code.
+     *
+     *   "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}"
+     *
+     * will be parsed into the following array:
+     *
+     *   "css" => "h1 { color:red; }"
+     *   "media" => "@media { h1 {}}"
+     *
+     * @param string $css
+     * @return array
+     */
+    private function splitCssAndMediaQuery($css) {
+        $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css );
+
+        // filter the CSS
+        $search = array(
+            // get rid of css comment code
+            '/\\/\\*.*\\*\\//sU',
+            // strip out any import directives
+            '/^\\s*@import\\s[^;]+;/misU',
+            // strip remains media enclosures
+            '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
+        );
+
+        $replace = array(
+            '',
+            '',
+            '',
+        );
+
+        // clean CSS before output
+        $css = preg_replace($search, $replace, $css);
+
+        return array('css' => $css, 'media' => self::$_media);
+    }
 
     /**
      * Media concat.
@@ -503,306 +503,306 @@ 
      *
      * @param array $matches Matches result array.
      */
-	private function _media_concat( $matches ) {
-		self::$_media .= $matches[0];
-	}
-
-	/**
-	 * Creates a DOMDocument instance with the current HTML.
-	 *
-	 * @return DOMDocument
-	 */
-	private function createXmlDocument() {
-		$xmlDocument = new DOMDocument;
-		$xmlDocument->encoding = self::ENCODING;
-		$xmlDocument->strictErrorChecking = false;
-		$xmlDocument->formatOutput = true;
-		$libXmlState = libxml_use_internal_errors(true);
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		/** @scrutinizer ignore-unhandled */ @$xmlDocument->loadHTML($this->getUnifiedHtml());
-		libxml_clear_errors();
-		libxml_use_internal_errors($libXmlState);
-		$xmlDocument->normalizeDocument();
-
-		return $xmlDocument;
-	}
-
-	/**
-	 * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed.
-	 *
-	 * @return string the unified HTML
-	 *
-	 * @throws BadMethodCallException
-	 */
-	private function getUnifiedHtml() {
-		if (!empty($this->unprocessableHtmlTags)) {
-			$unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
-			$bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html);
-		} else {
-			$bodyWithoutUnprocessableTags = $this->html;
-		}
-
-		// Deprecated since PHP 8.2
-		if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
-			return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING );
-		} else {
-			return mb_encode_numericentity( $bodyWithoutUnprocessableTags, [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
-			//return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) );
-		}
-	}
-
-	/**
-	 * @param array $a
-	 * @param array $b
-	 *
-	 * @return integer
-	 */
-	private function sortBySelectorPrecedence(array $a, array $b) {
-		$precedenceA = $this->getCssSelectorPrecedence($a['selector']);
-		$precedenceB = $this->getCssSelectorPrecedence($b['selector']);
-
-		// We want these sorted in ascending order so selectors with lesser precedence get processed first and
-		// selectors with greater precedence get sorted last.
-		// The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around
-		// arithmetic operators.
-		// @see http://forge.typo3.org/issues/55605
-		$precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1);
-		$precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1);
-		return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
-	}
-
-	/**
-	 * @param string $selector
-	 *
-	 * @return integer
-	 */
-	private function getCssSelectorPrecedence($selector) {
-		$selectorKey = md5($selector);
-		if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
-			$precedence = 0;
-			$value = 100;
-			// ids: worth 100, classes: worth 10, elements: worth 1
-			$search = array('\\#','\\.','');
-
-			foreach ($search as $s) {
-				if (trim($selector == '')) {
-					break;
-				}
-				$number = 0;
-				$selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
-				$precedence += ($value * $number);
-				$value /= 10;
-			}
-			$this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
-		}
-
-		return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
-	}
-
-	/**
-	 * Right now, we support all CSS 1 selectors and most CSS2/3 selectors.
-	 *
-	 * @see http://plasmasturm.org/log/444/
-	 *
-	 * @param string $paramCssSelector
-	 *
-	 * @return string
-	 */
-	private function translateCssToXpath($paramCssSelector) {
-		$cssSelector = ' ' . $paramCssSelector . ' ';
-		$cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector );
-		$cssSelector = trim($cssSelector);
-		$xpathKey = md5($cssSelector);
-		if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) {
-			// returns an Xpath selector
-			$search = array(
-				// Matches any element that is a child of parent.
-				'/\\s+>\\s+/',
-				// Matches any element that is an adjacent sibling.
-				'/\\s+\\+\\s+/',
-				// Matches any element that is a descendant of an parent element element.
-				'/\\s+/',
-				// first-child pseudo-selector
-				'/([^\\/]+):first-child/i',
-				// last-child pseudo-selector
-				'/([^\\/]+):last-child/i',
-				// Matches attribute only selector
-				'/^\\[(\\w+)\\]/',
-				// Matches element with attribute
-				'/(\\w)\\[(\\w+)\\]/',
-				// Matches element with EXACT attribute
-				'/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/',
-			);
-			$replace = array(
-				'/',
-				'/following-sibling::*[1]/self::',
-				'//',
-				'*[1]/self::\\1',
-				'*[last()]/self::\\1',
-				'*[@\\1]',
-				'\\1[@\\2]',
-				'\\1[@\\2="\\3"]',
-			);
-
-			$cssSelector = '//' . preg_replace($search, $replace, $cssSelector);
-
-			$cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector);
-			$cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector);
-
-			// Advanced selectors are going to require a bit more advanced emogrification.
-			// When we required PHP 5.3, we could do this with closures.
-			$cssSelector = preg_replace_callback(
-				'/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
-				array($this, 'translateNthChild'), $cssSelector
-			);
-			$cssSelector = preg_replace_callback(
-				'/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
-				array($this, 'translateNthOfType'), $cssSelector
-			);
-
-			$this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector;
-		}
-		return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey];
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function matchIdAttributes(array $match) {
-		return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]';
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function matchClassAttributes(array $match) {
-		return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' .
-			implode(
-				'"," "))][contains(concat(" ",@class," "),concat(" ","',
-				explode('.', substr($match[2], 1))
-			) . '"," "))]';
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function translateNthChild(array $match) {
-		$result = $this->parseNth($match);
-
-		if (isset($result[self::MULTIPLIER])) {
-			if ($result[self::MULTIPLIER] < 0) {
-				$result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
-				return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
-			} else {
-				return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
-			}
-		} else {
-			return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]);
-		}
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function translateNthOfType(array $match) {
-		$result = $this->parseNth($match);
-
-		if (isset($result[self::MULTIPLIER])) {
-			if ($result[self::MULTIPLIER] < 0) {
-				$result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
-				return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
-			} else {
-				return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
-			}
-		} else {
-			return sprintf('%s[%u]', $match[1], $result[self::INDEX]);
-		}
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return array
-	 */
-	private function parseNth(array $match) {
-		if (in_array(strtolower($match[2]), array('even','odd'))) {
-			$index = strtolower($match[2]) == 'even' ? 0 : 1;
-			return array(self::MULTIPLIER => 2, self::INDEX => $index);
-		} elseif (stripos($match[2], 'n') === false) {
-			// if there is a multiplier
-			$index = intval(str_replace(' ', '', $match[2]));
-			return array(self::INDEX => $index);
-		} else {
-			if (isset($match[3])) {
-				$multipleTerm = str_replace($match[3], '', $match[2]);
-				$index = intval(str_replace(' ', '', $match[3]));
-			} else {
-				$multipleTerm = $match[2];
-				$index = 0;
-			}
-
-			$multiplier = str_ireplace('n', '', $multipleTerm);
-
-			if (!strlen($multiplier)) {
-				$multiplier = 1;
-			} elseif ($multiplier == 0) {
-				return array(self::INDEX => $index);
-			} else {
-				$multiplier = intval($multiplier);
-			}
-
-			while ($index < 0) {
-				$index += abs($multiplier);
-			}
-
-			return array(self::MULTIPLIER => $multiplier, self::INDEX => $index);
-		}
-	}
-
-	/**
-	 * Parses a CSS declaration block into property name/value pairs.
-	 *
-	 * Example:
-	 *
-	 * The declaration block.
-	 *
-	 *   "color: #000; font-weight: bold;".
-	 *
-	 * will be parsed into the following array:
-	 *
-	 *   "color" => "#000"
-	 *   "font-weight" => "bold"
-	 *
-	 * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty
-	 *
-	 * @return array the CSS declarations with the property names as array keys and the property values as array values
-	 */
-	private function parseCssDeclarationBlock($cssDeclarationBlock) {
-		if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) {
-			return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock];
-		}
-
-		$properties = array();
-		$declarations = explode(';', $cssDeclarationBlock);
-		foreach ($declarations as $declaration) {
-			$matches = array();
-			if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) {
-				continue;
-			}
-			$propertyName = strtolower($matches[1]);
-			$propertyValue = $matches[2];
-			$properties[$propertyName] = $propertyValue;
-		}
-		$this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties;
-
-		return $properties;
-	}
+    private function _media_concat( $matches ) {
+        self::$_media .= $matches[0];
+    }
+
+    /**
+     * Creates a DOMDocument instance with the current HTML.
+     *
+     * @return DOMDocument
+     */
+    private function createXmlDocument() {
+        $xmlDocument = new DOMDocument;
+        $xmlDocument->encoding = self::ENCODING;
+        $xmlDocument->strictErrorChecking = false;
+        $xmlDocument->formatOutput = true;
+        $libXmlState = libxml_use_internal_errors(true);
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        /** @scrutinizer ignore-unhandled */ @$xmlDocument->loadHTML($this->getUnifiedHtml());
+        libxml_clear_errors();
+        libxml_use_internal_errors($libXmlState);
+        $xmlDocument->normalizeDocument();
+
+        return $xmlDocument;
+    }
+
+    /**
+     * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed.
+     *
+     * @return string the unified HTML
+     *
+     * @throws BadMethodCallException
+     */
+    private function getUnifiedHtml() {
+        if (!empty($this->unprocessableHtmlTags)) {
+            $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
+            $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html);
+        } else {
+            $bodyWithoutUnprocessableTags = $this->html;
+        }
+
+        // Deprecated since PHP 8.2
+        if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
+            return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING );
+        } else {
+            return mb_encode_numericentity( $bodyWithoutUnprocessableTags, [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
+            //return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) );
+        }
+    }
+
+    /**
+     * @param array $a
+     * @param array $b
+     *
+     * @return integer
+     */
+    private function sortBySelectorPrecedence(array $a, array $b) {
+        $precedenceA = $this->getCssSelectorPrecedence($a['selector']);
+        $precedenceB = $this->getCssSelectorPrecedence($b['selector']);
+
+        // We want these sorted in ascending order so selectors with lesser precedence get processed first and
+        // selectors with greater precedence get sorted last.
+        // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around
+        // arithmetic operators.
+        // @see http://forge.typo3.org/issues/55605
+        $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1);
+        $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1);
+        return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
+    }
+
+    /**
+     * @param string $selector
+     *
+     * @return integer
+     */
+    private function getCssSelectorPrecedence($selector) {
+        $selectorKey = md5($selector);
+        if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
+            $precedence = 0;
+            $value = 100;
+            // ids: worth 100, classes: worth 10, elements: worth 1
+            $search = array('\\#','\\.','');
+
+            foreach ($search as $s) {
+                if (trim($selector == '')) {
+                    break;
+                }
+                $number = 0;
+                $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
+                $precedence += ($value * $number);
+                $value /= 10;
+            }
+            $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
+        }
+
+        return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
+    }
+
+    /**
+     * Right now, we support all CSS 1 selectors and most CSS2/3 selectors.
+     *
+     * @see http://plasmasturm.org/log/444/
+     *
+     * @param string $paramCssSelector
+     *
+     * @return string
+     */
+    private function translateCssToXpath($paramCssSelector) {
+        $cssSelector = ' ' . $paramCssSelector . ' ';
+        $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector );
+        $cssSelector = trim($cssSelector);
+        $xpathKey = md5($cssSelector);
+        if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) {
+            // returns an Xpath selector
+            $search = array(
+                // Matches any element that is a child of parent.
+                '/\\s+>\\s+/',
+                // Matches any element that is an adjacent sibling.
+                '/\\s+\\+\\s+/',
+                // Matches any element that is a descendant of an parent element element.
+                '/\\s+/',
+                // first-child pseudo-selector
+                '/([^\\/]+):first-child/i',
+                // last-child pseudo-selector
+                '/([^\\/]+):last-child/i',
+                // Matches attribute only selector
+                '/^\\[(\\w+)\\]/',
+                // Matches element with attribute
+                '/(\\w)\\[(\\w+)\\]/',
+                // Matches element with EXACT attribute
+                '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/',
+            );
+            $replace = array(
+                '/',
+                '/following-sibling::*[1]/self::',
+                '//',
+                '*[1]/self::\\1',
+                '*[last()]/self::\\1',
+                '*[@\\1]',
+                '\\1[@\\2]',
+                '\\1[@\\2="\\3"]',
+            );
+
+            $cssSelector = '//' . preg_replace($search, $replace, $cssSelector);
+
+            $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector);
+            $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector);
+
+            // Advanced selectors are going to require a bit more advanced emogrification.
+            // When we required PHP 5.3, we could do this with closures.
+            $cssSelector = preg_replace_callback(
+                '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+                array($this, 'translateNthChild'), $cssSelector
+            );
+            $cssSelector = preg_replace_callback(
+                '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+                array($this, 'translateNthOfType'), $cssSelector
+            );
+
+            $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector;
+        }
+        return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey];
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function matchIdAttributes(array $match) {
+        return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]';
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function matchClassAttributes(array $match) {
+        return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' .
+            implode(
+                '"," "))][contains(concat(" ",@class," "),concat(" ","',
+                explode('.', substr($match[2], 1))
+            ) . '"," "))]';
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function translateNthChild(array $match) {
+        $result = $this->parseNth($match);
+
+        if (isset($result[self::MULTIPLIER])) {
+            if ($result[self::MULTIPLIER] < 0) {
+                $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
+                return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
+            } else {
+                return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
+            }
+        } else {
+            return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]);
+        }
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function translateNthOfType(array $match) {
+        $result = $this->parseNth($match);
+
+        if (isset($result[self::MULTIPLIER])) {
+            if ($result[self::MULTIPLIER] < 0) {
+                $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
+                return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
+            } else {
+                return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
+            }
+        } else {
+            return sprintf('%s[%u]', $match[1], $result[self::INDEX]);
+        }
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return array
+     */
+    private function parseNth(array $match) {
+        if (in_array(strtolower($match[2]), array('even','odd'))) {
+            $index = strtolower($match[2]) == 'even' ? 0 : 1;
+            return array(self::MULTIPLIER => 2, self::INDEX => $index);
+        } elseif (stripos($match[2], 'n') === false) {
+            // if there is a multiplier
+            $index = intval(str_replace(' ', '', $match[2]));
+            return array(self::INDEX => $index);
+        } else {
+            if (isset($match[3])) {
+                $multipleTerm = str_replace($match[3], '', $match[2]);
+                $index = intval(str_replace(' ', '', $match[3]));
+            } else {
+                $multipleTerm = $match[2];
+                $index = 0;
+            }
+
+            $multiplier = str_ireplace('n', '', $multipleTerm);
+
+            if (!strlen($multiplier)) {
+                $multiplier = 1;
+            } elseif ($multiplier == 0) {
+                return array(self::INDEX => $index);
+            } else {
+                $multiplier = intval($multiplier);
+            }
+
+            while ($index < 0) {
+                $index += abs($multiplier);
+            }
+
+            return array(self::MULTIPLIER => $multiplier, self::INDEX => $index);
+        }
+    }
+
+    /**
+     * Parses a CSS declaration block into property name/value pairs.
+     *
+     * Example:
+     *
+     * The declaration block.
+     *
+     *   "color: #000; font-weight: bold;".
+     *
+     * will be parsed into the following array:
+     *
+     *   "color" => "#000"
+     *   "font-weight" => "bold"
+     *
+     * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty
+     *
+     * @return array the CSS declarations with the property names as array keys and the property values as array values
+     */
+    private function parseCssDeclarationBlock($cssDeclarationBlock) {
+        if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) {
+            return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock];
+        }
+
+        $properties = array();
+        $declarations = explode(';', $cssDeclarationBlock);
+        foreach ($declarations as $declaration) {
+            $matches = array();
+            if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) {
+                continue;
+            }
+            $propertyName = strtolower($matches[1]);
+            $propertyValue = $matches[2];
+            $properties[$propertyName] = $propertyValue;
+        }
+        $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties;
+
+        return $properties;
+    }
 }

includes/wpinv-payment-functions.php

Indentation +286 added lines, -286 removed lines

@@ -1,196 +1,196 @@ 
 <?php
 function wpinv_is_subscription_payment( $invoice = '' ) {
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
-		$invoice = wpinv_get_invoice( $invoice );
-	}
+    if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
+        $invoice = wpinv_get_invoice( $invoice );
+    }
 
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( $invoice->is_renewal() ) {
-		return true;
-	}
+    if ( $invoice->is_renewal() ) {
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 function wpinv_payment_link_transaction_id( $invoice = '' ) {
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
-		$invoice = wpinv_get_invoice( $invoice );
-	}
+    if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
+        $invoice = wpinv_get_invoice( $invoice );
+    }
 
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice );
+    return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice );
 }
 
 function wpinv_subscription_initial_payment_desc( $amount, $period, $interval, $trial_period = '', $trial_interval = 0 ) {
-	$interval   = (int)$interval > 0 ? (int)$interval : 1;
-
-	if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
-		$amount = __( 'Free', 'invoicing' );
-		$interval = $trial_interval;
-		$period = $trial_period;
-	}
-
-	$description = '';
-	switch ( $period ) {
-		case 'D':
-		case 'day':
-			$description = wp_sprintf( _n( '%s for the first day.', '%1$s for the first %2$d days.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'W':
-		case 'week':
-			$description = wp_sprintf( _n( '%s for the first week.', '%1$s for the first %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'M':
-		case 'month':
-			$description = wp_sprintf( _n( '%s for the first month.', '%1$s for the first %2$d months.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'Y':
-		case 'year':
-			$description = wp_sprintf( _n( '%s for the first year.', '%1$s for the first %2$d years.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-	}
-
-	return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval );
+    $interval   = (int)$interval > 0 ? (int)$interval : 1;
+
+    if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
+        $amount = __( 'Free', 'invoicing' );
+        $interval = $trial_interval;
+        $period = $trial_period;
+    }
+
+    $description = '';
+    switch ( $period ) {
+        case 'D':
+        case 'day':
+            $description = wp_sprintf( _n( '%s for the first day.', '%1$s for the first %2$d days.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'W':
+        case 'week':
+            $description = wp_sprintf( _n( '%s for the first week.', '%1$s for the first %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'M':
+        case 'month':
+            $description = wp_sprintf( _n( '%s for the first month.', '%1$s for the first %2$d months.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'Y':
+        case 'year':
+            $description = wp_sprintf( _n( '%s for the first year.', '%1$s for the first %2$d years.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+    }
+
+    return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval );
 }
 
 function wpinv_subscription_recurring_payment_desc( $amount, $period, $interval, $bill_times = 0, $trial_period = '', $trial_interval = 0 ) {
-	$interval   = (int)$interval > 0 ? (int)$interval : 1;
-	$bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0;
-
-	$description = '';
-	switch ( $period ) {
-		case 'D':
-		case 'day':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d days, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d days.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one day.', '%1$s for each day, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each day.', '%1$s for each %2$d days.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'W':
-		case 'week':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d weeks, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d weeks.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one week.', '%1$s for each week, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each week.', '%1$s for each %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'M':
-		case 'month':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d months, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d months.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one month.', '%1$s for each month, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each month.', '%1$s for each %2$d months.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'Y':
-		case 'year':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d years, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d years.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one year.', '%1$s for each year, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each year.', '%1$s for each %2$d years.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-	}
-
-	return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
+    $interval   = (int)$interval > 0 ? (int)$interval : 1;
+    $bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0;
+
+    $description = '';
+    switch ( $period ) {
+        case 'D':
+        case 'day':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d days, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d days.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one day.', '%1$s for each day, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each day.', '%1$s for each %2$d days.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'W':
+        case 'week':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d weeks, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d weeks.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one week.', '%1$s for each week, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each week.', '%1$s for each %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'M':
+        case 'month':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d months, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d months.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one month.', '%1$s for each month, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each month.', '%1$s for each %2$d months.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'Y':
+        case 'year':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d years, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d years.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one year.', '%1$s for each year, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each year.', '%1$s for each %2$d years.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+    }
+
+    return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
 }
 
 function wpinv_subscription_payment_desc( $invoice ) {
-	if ( empty( $invoice ) ) {
-		return null;
-	}
-
-	$description = '';
-	if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) {
-		if ( $item->has_free_trial() ) {
-			$trial_period = $item->get_trial_period();
-			$trial_interval = $item->get_trial_interval();
-		} else {
-			$trial_period = '';
-			$trial_interval = 0;
-		}
-
-		$description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() );
-	}
-
-	return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice );
+    if ( empty( $invoice ) ) {
+        return null;
+    }
+
+    $description = '';
+    if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) {
+        if ( $item->has_free_trial() ) {
+            $trial_period = $item->get_trial_period();
+            $trial_interval = $item->get_trial_interval();
+        } else {
+            $trial_period = '';
+            $trial_interval = 0;
+        }
+
+        $description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() );
+    }
+
+    return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice );
 }
 
 function wpinv_get_billing_cycle( $initial, $recurring, $period, $interval, $bill_times, $trial_period = '', $trial_interval = 0, $currency = '' ) {
-	$initial_total      = wpinv_round_amount( $initial );
-	$recurring_total    = wpinv_round_amount( $recurring );
+    $initial_total      = wpinv_round_amount( $initial );
+    $recurring_total    = wpinv_round_amount( $recurring );
 
-	if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
-		// Free trial
-	} else {
-		if ( $bill_times == 1 ) {
-			$recurring_total = $initial_total;
-		} elseif ( $bill_times > 1 && $initial_total != $recurring_total ) {
-			$bill_times--;
-		}
-	}
+    if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
+        // Free trial
+    } else {
+        if ( $bill_times == 1 ) {
+            $recurring_total = $initial_total;
+        } elseif ( $bill_times > 1 && $initial_total != $recurring_total ) {
+            $bill_times--;
+        }
+    }
 
-	$initial_amount     = wpinv_price( $initial_total, $currency );
-	$recurring_amount   = wpinv_price( $recurring_total, $currency );
+    $initial_amount     = wpinv_price( $initial_total, $currency );
+    $recurring_amount   = wpinv_price( $recurring_total, $currency );
 
-	$recurring          = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
+    $recurring          = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
 
-	if ( $initial_total != $recurring_total ) {
-		$initial        = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval );
+    if ( $initial_total != $recurring_total ) {
+        $initial        = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval );
 
-		$description    = wp_sprintf( __( '%1$s Then %2$s', 'invoicing' ), $initial, $recurring );
-	} else {
-		$description    = $recurring;
-	}
+        $description    = wp_sprintf( __( '%1$s Then %2$s', 'invoicing' ), $initial, $recurring );
+    } else {
+        $description    = $recurring;
+    }
 
-	return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency );
+    return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency );
 }
 
 /**
@@ -202,25 +202,25 @@ 
  */
 function getpaid_get_card_name( $card_number ) {
 
-	// Known regexes.
-	$regexes = array(
-		'/^4/'                     => __( 'Visa', 'invoicing' ),
-		'/^5[1-5]/'                => __( 'Mastercard', 'invoicing' ),
-		'/^3[47]/'                 => __( 'Amex', 'invoicing' ),
-		'/^3(?:0[0-5]|[68])/'      => __( 'Diners Club', 'invoicing' ),
-		'/^6(?:011|5)/'            => __( 'Discover', 'invoicing' ),
-		'/^(?:2131|1800|35\d{3})/' => __( 'JCB', 'invoicing' ),
-	);
-
-	// Confirm if one matches.
-	foreach ( $regexes as $regex => $card ) {
-		if ( preg_match( $regex, $card_number ) >= 1 ) {
-			return $card;
-		}
-	}
-
-	// None matched.
-	return __( 'Card', 'invoicing' );
+    // Known regexes.
+    $regexes = array(
+        '/^4/'                     => __( 'Visa', 'invoicing' ),
+        '/^5[1-5]/'                => __( 'Mastercard', 'invoicing' ),
+        '/^3[47]/'                 => __( 'Amex', 'invoicing' ),
+        '/^3(?:0[0-5]|[68])/'      => __( 'Diners Club', 'invoicing' ),
+        '/^6(?:011|5)/'            => __( 'Discover', 'invoicing' ),
+        '/^(?:2131|1800|35\d{3})/' => __( 'JCB', 'invoicing' ),
+    );
+
+    // Confirm if one matches.
+    foreach ( $regexes as $regex => $card ) {
+        if ( preg_match( $regex, $card_number ) >= 1 ) {
+            return $card;
+        }
+    }
+
+    // None matched.
+    return __( 'Card', 'invoicing' );
 
 }
 
@@ -230,24 +230,24 @@ 
  * @param WPInv_Invoice|int|null $invoice
  */
 function wpinv_send_back_to_checkout( $invoice = null ) {
-	$response = array( 'success' => false );
-	$invoice  = wpinv_get_invoice( $invoice );
-
-	// Was an invoice created?
-	if ( ! empty( $invoice ) ) {
-		$invoice             = is_scalar( $invoice ) ? new WPInv_Invoice( $invoice ) : $invoice;
-		$response['invoice'] = $invoice->get_id();
-		do_action( 'getpaid_checkout_invoice_exception', $invoice );
-	}
-
-	// Do we have any errors?
-	if ( wpinv_get_errors() ) {
-		$response['data'] = getpaid_get_errors_html( true, false );
-	} else {
-		$response['data'] = __( 'An error occured while processing your payment. Please try again.', 'invoicing' );
-	}
-
-	wp_send_json( $response );
+    $response = array( 'success' => false );
+    $invoice  = wpinv_get_invoice( $invoice );
+
+    // Was an invoice created?
+    if ( ! empty( $invoice ) ) {
+        $invoice             = is_scalar( $invoice ) ? new WPInv_Invoice( $invoice ) : $invoice;
+        $response['invoice'] = $invoice->get_id();
+        do_action( 'getpaid_checkout_invoice_exception', $invoice );
+    }
+
+    // Do we have any errors?
+    if ( wpinv_get_errors() ) {
+        $response['data'] = getpaid_get_errors_html( true, false );
+    } else {
+        $response['data'] = __( 'An error occured while processing your payment. Please try again.', 'invoicing' );
+    }
+
+    wp_send_json( $response );
 }
 
 /**
@@ -256,7 +256,7 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_site_key() {
-	return apply_filters( 'getpaid_recaptcha_site_key', wpinv_get_option( 'recaptcha_site_key', '' ) );
+    return apply_filters( 'getpaid_recaptcha_site_key', wpinv_get_option( 'recaptcha_site_key', '' ) );
 }
 
 /**
@@ -265,7 +265,7 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_secret_key() {
-	return apply_filters( 'getpaid_recaptcha_secret_key', wpinv_get_option( 'recaptcha_secret_key', '' ) );
+    return apply_filters( 'getpaid_recaptcha_secret_key', wpinv_get_option( 'recaptcha_secret_key', '' ) );
 }
 
 /**
@@ -274,7 +274,7 @@ 
  * @return bool
  */
 function getpaid_is_recaptcha_enabled() {
-	return wpinv_get_option( 'enable_recaptcha', false ) && getpaid_get_recaptcha_site_key() && getpaid_get_recaptcha_secret_key();
+    return wpinv_get_option( 'enable_recaptcha', false ) && getpaid_get_recaptcha_site_key() && getpaid_get_recaptcha_secret_key();
 }
 
 /**
@@ -283,27 +283,27 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_version() {
-	return apply_filters( 'getpaid_recaptcha_version', wpinv_get_option( 'recaptcha_version', 'v2' ) );
+    return apply_filters( 'getpaid_recaptcha_version', wpinv_get_option( 'recaptcha_version', 'v2' ) );
 }
 
 function getpaid_recaptcha_api_url() {
-	// Prevent conflicts with Ninja Forms recaptcha.
-	if ( ! empty( $_REQUEST['action'] ) && $_REQUEST['action'] == 'geodir_ninja_forms' ) {
-		$url = '';
-	} else {
-		$url = getpaid_recaptcha_get_api_url();
-	}
-
-	return apply_filters( 'getpaid_recaptcha_api_url', $url );
+    // Prevent conflicts with Ninja Forms recaptcha.
+    if ( ! empty( $_REQUEST['action'] ) && $_REQUEST['action'] == 'geodir_ninja_forms' ) {
+        $url = '';
+    } else {
+        $url = getpaid_recaptcha_get_api_url();
+    }
+
+    return apply_filters( 'getpaid_recaptcha_api_url', $url );
 }
 
 function getpaid_recaptcha_get_api_url() {
-	return add_query_arg(
-		array(
-			'render' => 'v2' === getpaid_get_recaptcha_version() ? 'explicit' : getpaid_get_recaptcha_site_key(),
-		),
-		'https://www.google.com/recaptcha/api.js'
-	);
+    return add_query_arg(
+        array(
+            'render' => 'v2' === getpaid_get_recaptcha_version() ? 'explicit' : getpaid_get_recaptcha_site_key(),
+        ),
+        'https://www.google.com/recaptcha/api.js'
+    );
 }
 
 /**
@@ -312,42 +312,42 @@ 
  * @return array
  */
 function getpaid_get_recaptcha_settings() {
-	$settings = array(
-		'enabled' => getpaid_is_recaptcha_enabled(),
-		'version' => getpaid_get_recaptcha_version(),
-	);
-
-	if ( ! getpaid_is_recaptcha_enabled() ) {
-		return $settings;
-	}
-
-	$settings['sitekey'] = getpaid_get_recaptcha_site_key();
-
-	// Version 2 render params.
-	if ( 'v2' === getpaid_get_recaptcha_version() ) {
-		$settings['render_params'] = array(
-			'sitekey'  => getpaid_get_recaptcha_site_key(),
-			'theme'    => 'light',
-			'size'     => 'normal',
-			'tabindex' => 0,
-		);
-	}
-
-	return apply_filters( 'getpaid_recaptcha_settings', $settings );
+    $settings = array(
+        'enabled' => getpaid_is_recaptcha_enabled(),
+        'version' => getpaid_get_recaptcha_version(),
+    );
+
+    if ( ! getpaid_is_recaptcha_enabled() ) {
+        return $settings;
+    }
+
+    $settings['sitekey'] = getpaid_get_recaptcha_site_key();
+
+    // Version 2 render params.
+    if ( 'v2' === getpaid_get_recaptcha_version() ) {
+        $settings['render_params'] = array(
+            'sitekey'  => getpaid_get_recaptcha_site_key(),
+            'theme'    => 'light',
+            'size'     => 'normal',
+            'tabindex' => 0,
+        );
+    }
+
+    return apply_filters( 'getpaid_recaptcha_settings', $settings );
 }
 
 /**
  * Displays reCAPTCHA before payment button.
  */
 function getpaid_display_recaptcha_before_payment_button() {
-	if ( ! getpaid_is_recaptcha_enabled() || 'v2' !== getpaid_get_recaptcha_version() ) {
-		return;
-	}
-
-	printf(
-		'<div class="getpaid-recaptcha-wrapper"><div class="g-recaptcha mw-100 overflow-hidden my-2" id="getpaid-recaptcha-%s"></div></div>',
-		esc_attr( wp_unique_id() )
-	);
+    if ( ! getpaid_is_recaptcha_enabled() || 'v2' !== getpaid_get_recaptcha_version() ) {
+        return;
+    }
+
+    printf(
+        '<div class="getpaid-recaptcha-wrapper"><div class="g-recaptcha mw-100 overflow-hidden my-2" id="getpaid-recaptcha-%s"></div></div>',
+        esc_attr( wp_unique_id() )
+    );
 }
 add_action( 'getpaid_before_payment_form_pay_button', 'getpaid_display_recaptcha_before_payment_button' );
 
@@ -358,43 +358,43 @@ 
  */
 function getpaid_validate_recaptcha_response( $submission ) {
 
-	// Check if reCAPTCHA is enabled.
-	if ( ! getpaid_is_recaptcha_enabled() ) {
-		return;
-	}
-
-	$token = $submission->get_field( 'g-recaptcha-response' );
-
-	// Abort if no token was provided.
-	if ( empty( $token ) ) {
-		wp_send_json_error( 'v2' === getpaid_get_recaptcha_version() ? __( 'Please confirm that you are not a robot.', 'invoicing' ) : __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
-
-	$result = wp_remote_post(
-		'https://www.google.com/recaptcha/api/siteverify',
-		array(
-			'body' => array(
-				'secret'   => getpaid_get_recaptcha_secret_key(),
-				'response' => $token,
-			),
-		)
-	);
-
-	// Site not reachable, give benefit of doubt.
-	if ( is_wp_error( $result ) ) {
-		return;
-	}
-
-	$result = json_decode( wp_remote_retrieve_body( $result ), true );
-
-	if ( empty( $result['success'] ) && ! in_array( 'missing-input-secret', $result['error-codes'], true ) && ! in_array( 'invalid-input-secret', $result['error-codes'], true ) ) {
-		wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
-
-	// For v3, check the score.
-	$minimum_score = apply_filters( 'getpaid_recaptcha_minimum_score', 0.4 );
-	if ( 'v3' === getpaid_get_recaptcha_version() && ( empty( $result['score'] ) || $result['score'] < $minimum_score ) ) {
-		wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
+    // Check if reCAPTCHA is enabled.
+    if ( ! getpaid_is_recaptcha_enabled() ) {
+        return;
+    }
+
+    $token = $submission->get_field( 'g-recaptcha-response' );
+
+    // Abort if no token was provided.
+    if ( empty( $token ) ) {
+        wp_send_json_error( 'v2' === getpaid_get_recaptcha_version() ? __( 'Please confirm that you are not a robot.', 'invoicing' ) : __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
+
+    $result = wp_remote_post(
+        'https://www.google.com/recaptcha/api/siteverify',
+        array(
+            'body' => array(
+                'secret'   => getpaid_get_recaptcha_secret_key(),
+                'response' => $token,
+            ),
+        )
+    );
+
+    // Site not reachable, give benefit of doubt.
+    if ( is_wp_error( $result ) ) {
+        return;
+    }
+
+    $result = json_decode( wp_remote_retrieve_body( $result ), true );
+
+    if ( empty( $result['success'] ) && ! in_array( 'missing-input-secret', $result['error-codes'], true ) && ! in_array( 'invalid-input-secret', $result['error-codes'], true ) ) {
+        wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
+
+    // For v3, check the score.
+    $minimum_score = apply_filters( 'getpaid_recaptcha_minimum_score', 0.4 );
+    if ( 'v3' === getpaid_get_recaptcha_version() && ( empty( $result['score'] ) || $result['score'] < $minimum_score ) ) {
+        wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
 }
 add_action( 'getpaid_checkout_error_checks', 'getpaid_validate_recaptcha_response' );

includes/class-getpaid-template.php

Indentation +152 added lines, -152 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -20,29 +20,29 @@ 
     public $templates_url;
 
     /**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __construct() {
+     * Class constructor.
+     *
+     * @since 1.0.19
+     */
+    public function __construct() {
 
         $this->templates_dir = apply_filters( 'getpaid_default_templates_dir', WPINV_PLUGIN_DIR . 'templates' );
         $this->templates_url = apply_filters( 'getpaid_default_templates_url', WPINV_PLUGIN_URL . 'templates' );
 
         // Oxygen plugin
-		if ( defined( 'CT_VERSION' ) ) {
-			add_filter( 'wpinv_locate_template', array( $this, 'oxygen_override_template' ), 11, 4 );
-		}
+        if ( defined( 'CT_VERSION' ) ) {
+            add_filter( 'wpinv_locate_template', array( $this, 'oxygen_override_template' ), 11, 4 );
+        }
 
     }
 
     /**
-	 * Checks if this is a preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_preview() {
+     * Checks if this is a preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_preview() {
         return $this->is_divi_preview() ||
             $this->is_elementor_preview() ||
             $this->is_beaver_preview() ||
@@ -53,73 +53,73 @@ 
     }
 
     /**
-	 * Checks if this is an elementor preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_elementor_preview() {
-		return isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' );
-	}
-
-	/**
-	 * Checks if this is a DIVI preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_divi_preview() {
-		return isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'et_pb' );
-	}
-
-	/**
-	 * Checks if this is a beaver builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_beaver_preview() {
-		return isset( $_REQUEST['fl_builder'] );
-	}
-
-	/**
-	 * Checks if this is a siteorigin builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_siteorigin_preview() {
-		return ! empty( $_REQUEST['siteorigin_panels_live_editor'] );
-	}
-
-	/**
-	 * Checks if this is a cornerstone builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_cornerstone_preview() {
-		return ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint';
-	}
-
-	/**
-	 * Checks if this is a fusion builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_fusion_preview() {
-		return ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] );
-	}
-
-	/**
-	 * Checks if this is an oxygen builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_oxygen_preview() {
-		return ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === 'oxy_render_' || substr( $_REQUEST['action'], 0, 10 ) === 'ct_render_' ) );
+     * Checks if this is an elementor preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_elementor_preview() {
+        return isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' );
+    }
+
+    /**
+     * Checks if this is a DIVI preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_divi_preview() {
+        return isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'et_pb' );
+    }
+
+    /**
+     * Checks if this is a beaver builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_beaver_preview() {
+        return isset( $_REQUEST['fl_builder'] );
+    }
+
+    /**
+     * Checks if this is a siteorigin builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_siteorigin_preview() {
+        return ! empty( $_REQUEST['siteorigin_panels_live_editor'] );
+    }
+
+    /**
+     * Checks if this is a cornerstone builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_cornerstone_preview() {
+        return ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint';
+    }
+
+    /**
+     * Checks if this is a fusion builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_fusion_preview() {
+        return ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] );
+    }
+
+    /**
+     * Checks if this is an oxygen builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_oxygen_preview() {
+        return ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === 'oxy_render_' || substr( $_REQUEST['action'], 0, 10 ) === 'ct_render_' ) );
     }
 
     /**
@@ -129,7 +129,7 @@ 
      * @param string $template_path The template path relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function locate_template( $template_name, $template_path = '', $default_path = '' ) {
+    public function locate_template( $template_name, $template_path = '', $default_path = '' ) {
 
         // Load the defaults for the template path and default path.
         $template_path = empty( $template_path ) ? 'invoicing' : $template_path;
@@ -150,22 +150,22 @@ 
     }
 
     /**
-	 * Loads a template
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	protected function load_template( $template_name, $template_path, $args ) {
+     * Loads a template
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    protected function load_template( $template_name, $template_path, $args ) {
 
         if ( is_array( $args ) ) {
             extract( $args );
         }
 
         // Fires before loading a template.
-	    do_action( 'wpinv_before_template_part', $template_name, $template_path, $args );
+        do_action( 'wpinv_before_template_part', $template_name, $template_path, $args );
 
         // Load the template.
-	    include $template_path;
+        include $template_path;
 
         // Fires after loading a template.
         do_action( 'wpinv_after_template_part', $template_name, $template_path, $args );
@@ -182,7 +182,7 @@ 
      * @param string $template_path The templates directory relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function display_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
+    public function display_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
 
         // Locate the template.
         $located = $this->locate_template( $template_name, $template_path, $default_path );
@@ -207,74 +207,74 @@ 
      * @param string $template_path The templates directory relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
+    public function get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
         ob_start();
         $this->display_template( $template_name, $args, $template_path, $default_path );
         return ob_get_clean();
     }
 
     /**
-	 * Get the GetPaid templates theme path.
-	 *
-	 *
-	 * @return string Template path.
-	 */
-	public static function get_theme_template_path() {
-		$template   = get_template();
-		$theme_root = get_theme_root( $template );
-
-		return $theme_root . '/' . $template . '/' . untrailingslashit( wpinv_get_theme_template_dir_name() );
-
-	}
-
-	/**
-	 * Oxygen locate theme template.
-	 *
-	 * @param string $template The template.
-	 * @return string The theme template.
-	 */
-	public static function oxygen_locate_template( $template ) {
-
-		if ( empty( $template ) ) {
-			return '';
-		}
-
-		$has_filter = has_filter( 'template', 'ct_oxygen_template_name' );
-
-		// Remove template filter
-		if ( $has_filter ) {
-			remove_filter( 'template', 'ct_oxygen_template_name' );
-		}
-
-		$template = self::get_theme_template_path() . '/' . $template;
-
-		if ( ! file_exists( $template ) ) {
-			$template = '';
-		}
-
-		// Add template filter
-		if ( $has_filter ) {
-			add_filter( 'template', 'ct_oxygen_template_name' );
-		}
-
-		return $template;
-	}
-
-	/**
-	 * Oxygen override theme template.
-	 *
-	 * @param string $located Located template.
-	 * @param string $template_name Template name.
-	 * @return string Located template.
-	 */
-	public function oxygen_override_template( $located, $template_name ) {
+     * Get the GetPaid templates theme path.
+     *
+     *
+     * @return string Template path.
+     */
+    public static function get_theme_template_path() {
+        $template   = get_template();
+        $theme_root = get_theme_root( $template );
+
+        return $theme_root . '/' . $template . '/' . untrailingslashit( wpinv_get_theme_template_dir_name() );
+
+    }
+
+    /**
+     * Oxygen locate theme template.
+     *
+     * @param string $template The template.
+     * @return string The theme template.
+     */
+    public static function oxygen_locate_template( $template ) {
+
+        if ( empty( $template ) ) {
+            return '';
+        }
+
+        $has_filter = has_filter( 'template', 'ct_oxygen_template_name' );
+
+        // Remove template filter
+        if ( $has_filter ) {
+            remove_filter( 'template', 'ct_oxygen_template_name' );
+        }
+
+        $template = self::get_theme_template_path() . '/' . $template;
+
+        if ( ! file_exists( $template ) ) {
+            $template = '';
+        }
+
+        // Add template filter
+        if ( $has_filter ) {
+            add_filter( 'template', 'ct_oxygen_template_name' );
+        }
+
+        return $template;
+    }
+
+    /**
+     * Oxygen override theme template.
+     *
+     * @param string $located Located template.
+     * @param string $template_name Template name.
+     * @return string Located template.
+     */
+    public function oxygen_override_template( $located, $template_name ) {
 
         $oxygen_overide = self::oxygen_locate_template( $template_name );
-		if ( ! empty( $oxygen_overide ) ) {
-			return $oxygen_overide;
-		}
+        if ( ! empty( $oxygen_overide ) ) {
+            return $oxygen_overide;
+        }
 
-		return $located;
-	}
+        return $located;
+    }
 
 }

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +405 added lines, -405 removed lines

@@ -12,482 +12,482 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
-			wp_die( 'Invoice not paid via PayPal', 200 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN', false );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
-				return $invoice;
-			}
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.', false );
-		wp_die( 'Could not retrieve the associated invoice.', 200 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			$invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
-			wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
-			return true;
-		}
-
-		$invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
-
-		if ( is_wp_error( $response ) ) {
-			$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
-
-		$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
-
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
+            wp_die( 'Invoice not paid via PayPal', 200 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN', false );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
+                return $invoice;
+            }
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.', false );
+        wp_die( 'Could not retrieve the associated invoice.', 200 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            $invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
+            wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
+            return true;
+        }
+
+        $invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
+
+        if ( is_wp_error( $response ) ) {
+            $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
+
+        $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
+
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
-
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ), false, false, true );
-
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
-
-		wpinv_error_log( $currency, 'Validated IPN Currency', false );
-	}
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ), false, false, true );
+
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
+
+        wpinv_error_log( $currency, 'Validated IPN Currency', false );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ), false, false, true );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ), false, false, true );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount', false );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount', false );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = $this->gateway->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = $this->gateway->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
 
-		if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your PayPal email is {$paypal_email}." );
-
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ), false, false, true );
+        if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your PayPal email is {$paypal_email}." );
+
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ), false, false, true );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email PayPal is {$paypal_email}.", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email PayPal is {$paypal_email}.", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email', false );
-	}
-
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
+        wpinv_error_log( 'Validated PayPal Email', false );
+    }
+
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
 
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
 
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		$invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
+        $invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
 
-		// Process a refund.
-		if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
+        // Process a refund.
+        if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], false );
-		}
+            return wpinv_error_log( $posted['reason_code'], false );
+        }
 
-		// Process payments.
-		if ( 'completed' === $payment_status ) {
+        // Process payments.
+        if ( 'completed' === $payment_status ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
+            $note = '';
 
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', false );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.', false );
 
-		}
+        }
 
-		// Pending payments.
-		if ( 'pending' === $payment_status ) {
+        // Pending payments.
+        if ( 'pending' === $payment_status ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
-			$invoice->add_note( wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ), false, false, true );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            $invoice->add_note( wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ), false, false, true );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".', false );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".', false );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup', false );
+        wpinv_error_log( 'Processing subscription signup', false );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.', false );
-	}
+        wpinv_error_log( 'Subscription started.', false );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// PayPal sends a subscr_payment for the first payment too.
-		$date_completed = getpaid_format_date( $invoice->get_date_completed() );
-		$date_created   = getpaid_format_date( $invoice->get_date_created() );
-		$today_date     = getpaid_format_date( current_time( 'mysql' ) );
-		$payment_date   = getpaid_format_date( $posted['payment_date'] );
-		$subscribe_date = getpaid_format_date( $subscription->get_date_created() );
-		$dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
+        // PayPal sends a subscr_payment for the first payment too.
+        $date_completed = getpaid_format_date( $invoice->get_date_completed() );
+        $date_created   = getpaid_format_date( $invoice->get_date_created() );
+        $today_date     = getpaid_format_date( current_time( 'mysql' ) );
+        $payment_date   = getpaid_format_date( $posted['payment_date'] );
+        $subscribe_date = getpaid_format_date( $subscription->get_date_created() );
+        $dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
 
-		foreach ( $dates as $date ) {
+        foreach ( $dates as $date ) {
 
-			if ( $date !== $today_date && $date !== $payment_date ) {
-				continue;
-			}
+            if ( $date !== $today_date && $date !== $payment_date ) {
+                continue;
+            }
 
-			if ( ! empty( $posted['txn_id'] ) ) {
-				$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
-				$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
-			}
+            if ( ! empty( $posted['txn_id'] ) ) {
+                $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
+                $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
+            }
 
-			return $invoice->mark_paid();
-
-		}
+            return $invoice->mark_paid();
+
+        }
 
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
-
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
-		}
-
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
+
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
+        }
+
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
 
-		if ( empty( $invoice ) ) {
-			return;
-		}
+        if ( empty( $invoice ) ) {
+            return;
+        }
 
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.', false );
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.', false );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.', false );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription suspensions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
+    /**
+     * Handles subscription suspensions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
-	}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
+    }
 
 }

includes/gateways/class-getpaid-paypal-gateway.php

Indentation +404 added lines, -404 removed lines

@@ -13,97 +13,97 @@ 
 class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'paypal';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox', 'single_subscription_group' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 1;
 
     /**
-	 * Stores line items to send to PayPal.
-	 *
-	 * @var array
-	 */
+     * Stores line items to send to PayPal.
+     *
+     * @var array
+     */
     protected $line_items = array();
 
     /**
-	 * Endpoint for requests from PayPal.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to PayPal.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from PayPal.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to PayPal.
+     *
+     * @var string
+     */
     protected $endpoint;
 
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s';
 
     /**
-	 * URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
+     * URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'PayPal Standard', 'invoicing' );
         $this->method_title         = __( 'PayPal Standard', 'invoicing' );
         $this->checkout_button_text = __( 'Proceed to PayPal', 'invoicing' );
         $this->notify_url           = wpinv_get_ipn_url( $this->id );
 
-		add_filter( 'wpinv_subscription_cancel_url', array( $this, 'filter_cancel_subscription_url' ), 10, 2 );
-		add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
+        add_filter( 'wpinv_subscription_cancel_url', array( $this, 'filter_cancel_subscription_url' ), 10, 2 );
+        add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
         add_filter( 'getpaid_paypal_sandbox_notice', array( $this, 'sandbox_notice' ) );
-		add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 );
-		add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) );
-		add_action( 'wpinv_paypal_connect', array( $this, 'display_connect_buttons' ) );
-		parent::__construct();
+        add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 );
+        add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) );
+        add_action( 'wpinv_paypal_connect', array( $this, 'display_connect_buttons' ) );
+        parent::__construct();
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Get redirect url.
         $paypal_redirect = $this->get_request_url( $invoice );
@@ -126,15 +126,15 @@ 
     }
 
     /**
-	 * Get the PayPal request URL for an invoice.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_request_url( $invoice ) {
+     * Get the PayPal request URL for an invoice.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_request_url( $invoice ) {
 
         // Endpoint for this request
-		$this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
+        $this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
 
         // Retrieve paypal args.
         $paypal_args       = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' );
@@ -147,45 +147,45 @@ 
 
         return add_query_arg( $paypal_args, $this->endpoint );
 
-	}
+    }
 
     /**
-	 * Get PayPal Args for passing to PP.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_paypal_args( $invoice ) {
+     * Get PayPal Args for passing to PP.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_paypal_args( $invoice ) {
 
         // Whether or not to send the line items as one item.
-		$force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', true, $invoice );
-
-		if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
-			$force_one_line_item = true;
-		}
-
-		$paypal_args = apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, $force_one_line_item )
-			),
-			$invoice
-		);
-
-		return $this->fix_request_length( $invoice, $paypal_args );
+        $force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', true, $invoice );
+
+        if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
+            $force_one_line_item = true;
+        }
+
+        $paypal_args = apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, $force_one_line_item )
+            ),
+            $invoice
+        );
+
+        return $this->fix_request_length( $invoice, $paypal_args );
     }
 
     /**
-	 * Get transaction args for paypal request.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_transaction_args( $invoice ) {
-
-		$email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
-		return array(
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
+
+        $email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
+        return array(
             'cmd'           => '_cart',
             'business'      => $email,
             'no_shipping'   => '1',
@@ -210,16 +210,16 @@ 
     }
 
     /**
-	 * Get line item args for paypal request.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @param  bool     $force_one_line_item Create only one item for this invoice.
-	 * @return array
-	 */
-	protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
+     * Get line item args for paypal request.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @param  bool     $force_one_line_item Create only one item for this invoice.
+     * @return array
+     */
+    protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
 
         // Maybe send invoice as a single item.
-		if ( $force_one_line_item ) {
+        if ( $force_one_line_item ) {
             return $this->get_line_item_args_single_item( $invoice );
         }
 
@@ -239,134 +239,134 @@ 
             $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 );
         }
 
-		return array_merge( $line_item_args, $this->get_line_items() );
+        return array_merge( $line_item_args, $this->get_line_items() );
 
     }
 
     /**
-	 * Get line item args for paypal request as a single line item.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_line_item_args_single_item( $invoice ) {
-		$this->delete_line_items();
+     * Get line item args for paypal request as a single line item.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_line_item_args_single_item( $invoice ) {
+        $this->delete_line_items();
 
         $item_name = wp_sprintf( __( 'Invoice %s', 'invoicing' ), $invoice->get_number() );
-		$this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() );
+        $this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() );
 
-		return $this->get_line_items();
+        return $this->get_line_items();
     }
 
     /**
-	 * Return all line items.
-	 */
-	protected function get_line_items() {
-		return $this->line_items;
-	}
+     * Return all line items.
+     */
+    protected function get_line_items() {
+        return $this->line_items;
+    }
 
     /**
-	 * Remove all line items.
-	 */
-	protected function delete_line_items() {
-		$this->line_items = array();
+     * Remove all line items.
+     */
+    protected function delete_line_items() {
+        $this->line_items = array();
     }
 
     /**
-	 * Prepare line items to send to paypal.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 */
-	protected function prepare_line_items( $invoice ) {
-		$this->delete_line_items();
-
-		// Items.
-		foreach ( $invoice->get_items() as $item ) {
-			$amount   = $item->get_price();
-			$quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
-			$this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
+     * Prepare line items to send to paypal.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     */
+    protected function prepare_line_items( $invoice ) {
+        $this->delete_line_items();
+
+        // Items.
+        foreach ( $invoice->get_items() as $item ) {
+            $amount   = $item->get_price();
+            $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
+            $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
         }
 
         // Fees.
-		foreach ( $invoice->get_fees() as $fee => $data ) {
+        foreach ( $invoice->get_fees() as $fee => $data ) {
             $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) );
         }
 
     }
 
     /**
-	 * Add PayPal Line Item.
-	 *
-	 * @param  string $item_name Item name.
-	 * @param  float    $quantity Item quantity.
-	 * @param  float  $amount Amount.
-	 * @param  string $item_number Item number.
-	 */
-	protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
-		$index = ( count( $this->line_items ) / 4 ) + 1;
-
-		/**
-		 * Prevent error "Things don't appear to be working at the moment. (https://www.sandbox.paypal.com/webapps/hermes/error)"
-		 */
-		$item_name = str_replace( "#", "", $item_name );
-
-		$item = apply_filters(
-			'getpaid_paypal_line_item',
-			array(
-				'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
-				'quantity'    => (float) $quantity,
-				'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
-				'item_number' => $item_number,
-			),
-			$item_name,
-			$quantity,
-			$amount,
-			$item_number
-		);
-
-		$this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
+     * Add PayPal Line Item.
+     *
+     * @param  string $item_name Item name.
+     * @param  float    $quantity Item quantity.
+     * @param  float  $amount Amount.
+     * @param  string $item_number Item number.
+     */
+    protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
+        $index = ( count( $this->line_items ) / 4 ) + 1;
+
+        /**
+         * Prevent error "Things don't appear to be working at the moment. (https://www.sandbox.paypal.com/webapps/hermes/error)"
+         */
+        $item_name = str_replace( "#", "", $item_name );
+
+        $item = apply_filters(
+            'getpaid_paypal_line_item',
+            array(
+                'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
+                'quantity'    => (float) $quantity,
+                'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
+                'item_number' => $item_number,
+            ),
+            $item_name,
+            $quantity,
+            $amount,
+            $item_number
+        );
+
+        $this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
         $this->line_items[ 'quantity_' . $index ]    = $item['quantity'];
 
         // The price or amount of the product, service, or contribution, not including shipping, handling, or tax.
-		$this->line_items[ 'amount_' . $index ]      = $item['amount'] * $item['quantity'];
-		$this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
+        $this->line_items[ 'amount_' . $index ]      = $item['amount'] * $item['quantity'];
+        $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
     }
 
     /**
-	 * If the default request with line items is too long, generate a new one with only one line item.
-	 *
-	 * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
-	 * @param array    $paypal_args Arguments sent to Paypal in the request.
-	 * @return array
-	 */
-	protected function fix_request_length( $invoice, $paypal_args ) {
-		$max_paypal_length = 2083;
-		$query_candidate   = http_build_query( $paypal_args, '', '&' );
-
-		if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
-			return $paypal_args;
-		}
-
-		return apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, true )
-			),
-			$invoice
-		);
+     * If the default request with line items is too long, generate a new one with only one line item.
+     *
+     * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
+     *
+     * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
+     * @param array    $paypal_args Arguments sent to Paypal in the request.
+     * @return array
+     */
+    protected function fix_request_length( $invoice, $paypal_args ) {
+        $max_paypal_length = 2083;
+        $query_candidate   = http_build_query( $paypal_args, '', '&' );
+
+        if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
+            return $paypal_args;
+        }
+
+        return apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, true )
+            ),
+            $invoice
+        );
 
     }
 
     /**
-	 * Processes recurring invoices.
-	 *
-	 * @param  array $paypal_args PayPal args.
-	 * @param  WPInv_Invoice    $invoice Invoice object.
-	 */
-	public function process_subscription( $paypal_args, $invoice ) {
+     * Processes recurring invoices.
+     *
+     * @param  array $paypal_args PayPal args.
+     * @param  WPInv_Invoice    $invoice Invoice object.
+     */
+    public function process_subscription( $paypal_args, $invoice ) {
 
         // Make sure this is a subscription.
         if ( ! $invoice->is_recurring() || ! $subscription = getpaid_get_invoice_subscription( $invoice ) ) {
@@ -387,21 +387,21 @@ 
         $recurring_amount       = (float) wpinv_sanitize_amount( $invoice->get_recurring_total(), 2 );
         $subscription_item      = $invoice->get_recurring( true );
 
-		// Convert 365 days to 1 year.
-		if ( 'D' == $period && 365 == $interval ) {
-			$period = 'Y';
-			$interval = 1;
-		}
+        // Convert 365 days to 1 year.
+        if ( 'D' == $period && 365 == $interval ) {
+            $period = 'Y';
+            $interval = 1;
+        }
 
         if ( $subscription_item->has_free_trial() ) {
 
             $paypal_args['a1'] = 0 == $initial_amount ? 0 : $initial_amount;
 
-			// Trial period length.
-			$paypal_args['p1'] = $subscription_item->get_trial_interval();
+            // Trial period length.
+            $paypal_args['p1'] = $subscription_item->get_trial_interval();
 
-			// Trial period.
-			$paypal_args['t1'] = $subscription_item->get_trial_period();
+            // Trial period.
+            $paypal_args['t1'] = $subscription_item->get_trial_period();
 
         } elseif ( $initial_amount != $recurring_amount ) {
 
@@ -424,40 +424,40 @@ 
         }
 
         // We have a recurring payment
-		if ( ! isset( $param_number ) || 1 == $param_number ) {
+        if ( ! isset( $param_number ) || 1 == $param_number ) {
 
-			// Subscription price
-			$paypal_args['a3'] = $recurring_amount;
+            // Subscription price
+            $paypal_args['a3'] = $recurring_amount;
 
-			// Subscription duration
-			$paypal_args['p3'] = $interval;
+            // Subscription duration
+            $paypal_args['p3'] = $interval;
 
-			// Subscription period
-			$paypal_args['t3'] = $period;
+            // Subscription period
+            $paypal_args['t3'] = $period;
 
         }
 
         // Recurring payments
-		if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
+        if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
 
-			// Non-recurring payments
-			$paypal_args['src'] = 0;
+            // Non-recurring payments
+            $paypal_args['src'] = 0;
 
-		} else {
+        } else {
 
-			$paypal_args['src'] = 1;
+            $paypal_args['src'] = 1;
 
-			if ( $bill_times > 0 ) {
+            if ( $bill_times > 0 ) {
 
-				// An initial period is being used to charge a sign-up fee
-				if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
-					$bill_times--;
-				}
+                // An initial period is being used to charge a sign-up fee
+                if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
+                    $bill_times--;
+                }
 
                 // Make sure it's not over the max of 52
                 $paypal_args['srt'] = ( $bill_times <= 52 ? absint( $bill_times ) : 52 );
 
-			}
+            }
         }
 
         // Force return URL so that order description & instructions display
@@ -472,19 +472,19 @@ 
 }
 
         return apply_filters(
-			'getpaid_paypal_subscription_args',
-			$paypal_args,
-			$invoice
+            'getpaid_paypal_subscription_args',
+            $paypal_args,
+            $invoice
         );
 
     }
 
     /**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
         new GetPaid_Paypal_Gateway_IPN_Handler( $this );
     }
 
@@ -494,19 +494,19 @@ 
     public function sandbox_notice() {
 
         return sprintf(
-			__( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %1$sPayPal Sandbox Testing Guide%2$s for more details.', 'invoicing' ),
-			'<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
-			'</a>'
-		);
+            __( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %1$sPayPal Sandbox Testing Guide%2$s for more details.', 'invoicing' ),
+            '<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
+            '</a>'
+        );
 
     }
 
-	/**
-	 * Filters the gateway settings.
-	 *
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
+    /**
+     * Filters the gateway settings.
+     *
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
 
         $currencies = sprintf(
             __( 'Supported Currencies: %s', 'invoicing' ),
@@ -516,66 +516,66 @@ 
         $admin_settings['paypal_active']['desc'] .= " ($currencies)";
         $admin_settings['paypal_desc']['std']     = __( 'Pay via PayPal: you can pay with your credit card if you don\'t have a PayPal account.', 'invoicing' );
 
-		// Access tokens.
-		$live_email      = wpinv_get_option( 'paypal_email' );
-		$sandbox_email   = wpinv_get_option( 'paypal_sandbox_email' );
+        // Access tokens.
+        $live_email      = wpinv_get_option( 'paypal_email' );
+        $sandbox_email   = wpinv_get_option( 'paypal_sandbox_email' );
 
-		$admin_settings['paypal_connect'] = array(
-			'type' => 'hook',
-			'id'   => 'paypal_connect',
-			'name' => __( 'Connect to PayPal', 'invoicing' ),
-		);
+        $admin_settings['paypal_connect'] = array(
+            'type' => 'hook',
+            'id'   => 'paypal_connect',
+            'name' => __( 'Connect to PayPal', 'invoicing' ),
+        );
 
         $admin_settings['paypal_email'] = array(
             'type'  => 'text',
-			'class' => 'live-auth-data',
+            'class' => 'live-auth-data',
             'id'    => 'paypal_email',
             'name'  => __( 'Live Email Address', 'invoicing' ),
             'desc'  => __( 'The email address of your PayPal account.', 'invoicing' ),
         );
 
-		$admin_settings['paypal_sandbox_email'] = array(
+        $admin_settings['paypal_sandbox_email'] = array(
             'type'  => 'text',
-			'class' => 'sandbox-auth-data',
+            'class' => 'sandbox-auth-data',
             'id'    => 'paypal_sandbox_email',
             'name'  => __( 'Sandbox Email Address', 'invoicing' ),
             'desc'  => __( 'The email address of your sandbox PayPal account.', 'invoicing' ),
-			'std'   => wpinv_get_option( 'paypal_email', '' ),
+            'std'   => wpinv_get_option( 'paypal_email', '' ),
+        );
+
+        // Client ID and secret.
+        $admin_settings['paypal_client_id'] = array(
+            'type'  => 'text',
+            'class' => 'live-auth-data',
+            'id'    => 'paypal_client_id',
+            'name'  => __( 'Live Client ID', 'invoicing' ),
+            'desc'  => __( 'The client ID of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+        );
+
+        $admin_settings['paypal_sandbox_client_id'] = array(
+            'type'  => 'text',
+            'class' => 'sandbox-auth-data',
+            'id'    => 'paypal_sandbox_client_id',
+            'name'  => __( 'Sandbox Client ID', 'invoicing' ),
+            'desc'  => __( 'The client ID of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+            'std'   => wpinv_get_option( 'paypal_client_id', '' ),
         );
 
-		// Client ID and secret.
-		$admin_settings['paypal_client_id'] = array(
-			'type'  => 'text',
-			'class' => 'live-auth-data',
-			'id'    => 'paypal_client_id',
-			'name'  => __( 'Live Client ID', 'invoicing' ),
-			'desc'  => __( 'The client ID of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-		);
-
-		$admin_settings['paypal_sandbox_client_id'] = array(
-			'type'  => 'text',
-			'class' => 'sandbox-auth-data',
-			'id'    => 'paypal_sandbox_client_id',
-			'name'  => __( 'Sandbox Client ID', 'invoicing' ),
-			'desc'  => __( 'The client ID of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-			'std'   => wpinv_get_option( 'paypal_client_id', '' ),
-		);
-
-		$admin_settings['paypal_secret'] = array(
-			'type'  => 'text',
-			'class' => 'live-auth-data',
-			'id'    => 'paypal_secret',
-			'name'  => __( 'Live Secret', 'invoicing' ),
-			'desc'  => __( 'The secret of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-		);
-
-		$admin_settings['paypal_sandbox_secret'] = array(
-			'type'  => 'text',
-			'class' => 'sandbox-auth-data',
-			'id'    => 'paypal_sandbox_secret',
-			'name'  => __( 'Sandbox Secret', 'invoicing' ),
-			'desc'  => __( 'The secret of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-		);
+        $admin_settings['paypal_secret'] = array(
+            'type'  => 'text',
+            'class' => 'live-auth-data',
+            'id'    => 'paypal_secret',
+            'name'  => __( 'Live Secret', 'invoicing' ),
+            'desc'  => __( 'The secret of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+        );
+
+        $admin_settings['paypal_sandbox_secret'] = array(
+            'type'  => 'text',
+            'class' => 'sandbox-auth-data',
+            'id'    => 'paypal_sandbox_secret',
+            'name'  => __( 'Sandbox Secret', 'invoicing' ),
+            'desc'  => __( 'The secret of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+        );
 
         $admin_settings['paypal_ipn_url'] = array(
             'type'     => 'ipn_url',
@@ -586,57 +586,57 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
-
-	/**
-	 * Retrieves the URL to cancel a subscription.
-	 *
-	 * @param string $url
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function filter_cancel_subscription_url( $url, $subscription ) {
-
-		if ( $this->id !== $subscription->get_gateway() ) {
-			return $url;
-		}
-
-		// Get the PayPal profile ID.
-		$profile_id = $subscription->get_profile_id();
-
-		// Bail if no profile ID.
-		if ( empty( $profile_id ) ) {
-			return $url;
-		}
-
-		$cancel_url = 'https://www.paypal.com/myaccount/autopay/connect/%s/cancel';
-		if ( $this->is_sandbox( $subscription->get_parent_payment() ) ) {
-			$cancel_url = 'https://www.sandbox.paypal.com/myaccount/autopay/connect/%s/cancel';
-		}
-
-		return sprintf( $cancel_url, $profile_id );
-	}
-
-	/**
-	 * Retrieves the PayPal connect URL when using the setup wizzard.
-	 *
-	 *
+        return $admin_settings;
+    }
+
+    /**
+     * Retrieves the URL to cancel a subscription.
+     *
+     * @param string $url
+     * @param WPInv_Subscription $subscription
+     */
+    public function filter_cancel_subscription_url( $url, $subscription ) {
+
+        if ( $this->id !== $subscription->get_gateway() ) {
+            return $url;
+        }
+
+        // Get the PayPal profile ID.
+        $profile_id = $subscription->get_profile_id();
+
+        // Bail if no profile ID.
+        if ( empty( $profile_id ) ) {
+            return $url;
+        }
+
+        $cancel_url = 'https://www.paypal.com/myaccount/autopay/connect/%s/cancel';
+        if ( $this->is_sandbox( $subscription->get_parent_payment() ) ) {
+            $cancel_url = 'https://www.sandbox.paypal.com/myaccount/autopay/connect/%s/cancel';
+        }
+
+        return sprintf( $cancel_url, $profile_id );
+    }
+
+    /**
+     * Retrieves the PayPal connect URL when using the setup wizzard.
+     *
+     *
      * @param array $data
      * @return string
-	 */
-	public static function maybe_get_connect_url( $url = '', $data = array() ) {
-		return self::get_connect_url( false, urldecode( $data['redirect'] ) );
-	}
-
-	/**
-	 * Retrieves the PayPal connect URL.
-	 *
-	 *
+     */
+    public static function maybe_get_connect_url( $url = '', $data = array() ) {
+        return self::get_connect_url( false, urldecode( $data['redirect'] ) );
+    }
+
+    /**
+     * Retrieves the PayPal connect URL.
+     *
+     *
      * @param bool $is_sandbox
-	 * @param string $redirect
+     * @param string $redirect
      * @return string
-	 */
-	public static function get_connect_url( $is_sandbox, $redirect = '' ) {
+     */
+    public static function get_connect_url( $is_sandbox, $redirect = '' ) {
 
         $redirect_url = add_query_arg(
             array(
@@ -646,7 +646,7 @@ 
                 'tab'                  => 'gateways',
                 'section'              => 'paypal',
                 'getpaid-nonce'        => wp_create_nonce( 'getpaid-nonce' ),
-				'redirect'             => urlencode( $redirect ),
+                'redirect'             => urlencode( $redirect ),
             ),
             admin_url( 'admin.php' )
         );
@@ -661,12 +661,12 @@ 
 
     }
 
-	/**
-	 * Generates settings page js.
-	 *
+    /**
+     * Generates settings page js.
+     *
      * @return void
-	 */
-	public static function display_connect_buttons() {
+     */
+    public static function display_connect_buttons() {
 
         ?>
 			<div class="wpinv-paypal-connect-live">
@@ -708,70 +708,70 @@ 
         <?php
     }
 
-	/**
-	 * Connects to PayPal.
-	 *
-	 * @param array $data Connection data.
-	 * @return void
-	 */
-	public function connect_paypal( $data ) {
-
-		$sandbox      = $this->is_sandbox();
-		$data         = wp_unslash( $data );
-		$access_token = empty( $data['access_token'] ) ? '' : sanitize_text_field( $data['access_token'] );
-
-		if ( isset( $data['live_mode'] ) ) {
-			$sandbox = empty( $data['live_mode'] );
-		}
-
-		wpinv_update_option( 'paypal_sandbox', (int) $sandbox );
-		wpinv_update_option( 'paypal_active', 1 );
-
-		if ( ! empty( $data['error_description'] ) ) {
-			getpaid_admin()->show_error( wp_kses_post( urldecode( $data['error_description'] ) ) );
-		} else {
-
-			// Retrieve the user info.
-			$user_info = wp_remote_get(
-				! $sandbox ? 'https://api-m.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1' : 'https://api-m.sandbox.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1',
-				array(
-
-					'headers' => array(
-						'Authorization' => 'Bearer ' . $access_token,
-						'Content-type'  => 'application/json',
-					),
-
-				)
-			);
-
-			if ( is_wp_error( $user_info ) ) {
-				getpaid_admin()->show_error( wp_kses_post( $user_info->get_error_message() ) );
-			} else {
-
-				// Create application.
-				$user_info = json_decode( wp_remote_retrieve_body( $user_info ) );
-
-				if ( $sandbox ) {
-					wpinv_update_option( 'paypal_sandbox_email', sanitize_email( $user_info->emails[0]->value ) );
-					wpinv_update_option( 'paypal_sandbox_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
-					set_transient( 'getpaid_paypal_sandbox_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
-					getpaid_admin()->show_success( __( 'Successfully connected your PayPal sandbox account', 'invoicing' ) );
-				} else {
-					wpinv_update_option( 'paypal_email', sanitize_email( $user_info->emails[0]->value ) );
-					wpinv_update_option( 'paypal_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
-					set_transient( 'getpaid_paypal_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
-					getpaid_admin()->show_success( __( 'Successfully connected your PayPal account', 'invoicing' ) );
-				}
+    /**
+     * Connects to PayPal.
+     *
+     * @param array $data Connection data.
+     * @return void
+     */
+    public function connect_paypal( $data ) {
+
+        $sandbox      = $this->is_sandbox();
+        $data         = wp_unslash( $data );
+        $access_token = empty( $data['access_token'] ) ? '' : sanitize_text_field( $data['access_token'] );
+
+        if ( isset( $data['live_mode'] ) ) {
+            $sandbox = empty( $data['live_mode'] );
+        }
+
+        wpinv_update_option( 'paypal_sandbox', (int) $sandbox );
+        wpinv_update_option( 'paypal_active', 1 );
+
+        if ( ! empty( $data['error_description'] ) ) {
+            getpaid_admin()->show_error( wp_kses_post( urldecode( $data['error_description'] ) ) );
+        } else {
+
+            // Retrieve the user info.
+            $user_info = wp_remote_get(
+                ! $sandbox ? 'https://api-m.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1' : 'https://api-m.sandbox.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1',
+                array(
+
+                    'headers' => array(
+                        'Authorization' => 'Bearer ' . $access_token,
+                        'Content-type'  => 'application/json',
+                    ),
+
+                )
+            );
+
+            if ( is_wp_error( $user_info ) ) {
+                getpaid_admin()->show_error( wp_kses_post( $user_info->get_error_message() ) );
+            } else {
+
+                // Create application.
+                $user_info = json_decode( wp_remote_retrieve_body( $user_info ) );
+
+                if ( $sandbox ) {
+                    wpinv_update_option( 'paypal_sandbox_email', sanitize_email( $user_info->emails[0]->value ) );
+                    wpinv_update_option( 'paypal_sandbox_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
+                    set_transient( 'getpaid_paypal_sandbox_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
+                    getpaid_admin()->show_success( __( 'Successfully connected your PayPal sandbox account', 'invoicing' ) );
+                } else {
+                    wpinv_update_option( 'paypal_email', sanitize_email( $user_info->emails[0]->value ) );
+                    wpinv_update_option( 'paypal_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
+                    set_transient( 'getpaid_paypal_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
+                    getpaid_admin()->show_success( __( 'Successfully connected your PayPal account', 'invoicing' ) );
+                }
 }
 }
 
-		$redirect = empty( $data['redirect'] ) ? admin_url( 'admin.php?page=wpinv-settings&tab=gateways&section=paypal' ) : urldecode( $data['redirect'] );
+        $redirect = empty( $data['redirect'] ) ? admin_url( 'admin.php?page=wpinv-settings&tab=gateways&section=paypal' ) : urldecode( $data['redirect'] );
 
-		if ( isset( $data['step'] ) ) {
-			$redirect = add_query_arg( 'step', $data['step'], $redirect );
-		}
-		wp_redirect( $redirect );
-		exit;
-	}
+        if ( isset( $data['step'] ) ) {
+            $redirect = add_query_arg( 'step', $data['step'], $redirect );
+        }
+        wp_redirect( $redirect );
+        exit;
+    }
 
 }

includes/admin/html-admin-page-addons.php

Indentation +75 added lines, -75 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 add_ThickBox();
 ?>
@@ -14,18 +14,18 @@ 
 	<?php if ( $tabs ) { ?>
 		<nav class="nav-tab-wrapper wpi-nav-tab-wrapper">
 			<?php
-			foreach ( $tabs as $name => $label ) {
-				echo '<a href="' . esc_url( admin_url( 'admin.php?page=wpi-addons&tab=' . $name ) ) . '" class="nav-tab ' . ( $current_tab == $name ? 'nav-tab-active' : '' ) . '">' . esc_html( $label ) . '</a>';
-			}
-			do_action( 'wpi_addons_tabs' );
-			?>
+            foreach ( $tabs as $name => $label ) {
+                echo '<a href="' . esc_url( admin_url( 'admin.php?page=wpi-addons&tab=' . $name ) ) . '" class="nav-tab ' . ( $current_tab == $name ? 'nav-tab-active' : '' ) . '">' . esc_html( $label ) . '</a>';
+            }
+            do_action( 'wpi_addons_tabs' );
+            ?>
 		</nav>
 
 		<?php
 
-		if ( $current_tab == 'membership' ) {
+        if ( $current_tab == 'membership' ) {
 
-			?>
+            ?>
 
 			<div class="wpi-membership-tab-conatiner">
 				<div class="membership-content">
@@ -36,9 +36,9 @@ 
 					<h2><?php esc_html_e( 'Have a membership key?', 'invoicing' ); ?></h2>
 					<p>
 						<?php
-						$wpeu_admin = new External_Updates_Admin( 'wpinvoicing.com', '1' );
-						echo $wpeu_admin->render_licence_actions( 'wpinvoicing.com', 'membership', array( 95, 106, 108, 12351 ) );
-						?>
+                        $wpeu_admin = new External_Updates_Admin( 'wpinvoicing.com', '1' );
+                        echo $wpeu_admin->render_licence_actions( 'wpinvoicing.com', 'membership', array( 95, 106, 108, 12351 ) );
+                        ?>
 					</p>
 				<?php } ?>
 
@@ -48,13 +48,13 @@ 
 							<div class="feature-list">
 								<ul>
 									<?php
-									$addon_obj = new WPInv_Admin_Addons();
-									if ( $addons = $addon_obj->get_section_data( 'addons' ) ) {
-										foreach ( $addons as $addon ) {
-											echo '<li><i class="far fa-check-circle fa-sm"></i> ' . esc_html( $addon->info->title ) . '</li>';
-										}
-									}
-									?>
+                                    $addon_obj = new WPInv_Admin_Addons();
+                                    if ( $addons = $addon_obj->get_section_data( 'addons' ) ) {
+                                        foreach ( $addons as $addon ) {
+                                            echo '<li><i class="far fa-check-circle fa-sm"></i> ' . esc_html( $addon->info->title ) . '</li>';
+                                        }
+                                    }
+                                    ?>
 									</ul>
 
 									<div class="feature-cta">
@@ -65,12 +65,12 @@ 
 									<h3><?php esc_html_e( 'Included Gateways:', 'invoicing' ); ?></h3>
 									<ul>
 										<?php
-										if ( $addons = $addon_obj->get_section_data( 'gateways' ) ) {
-											foreach ( $addons as $addon ) {
-												echo '<li><i class="far fa-check-circle fa-sm"></i> ' . esc_html( $addon->info->title ) . '</li>';
-											}
-										}
-										?>
+                                        if ( $addons = $addon_obj->get_section_data( 'gateways' ) ) {
+                                            foreach ( $addons as $addon ) {
+                                                echo '<li><i class="far fa-check-circle fa-sm"></i> ' . esc_html( $addon->info->title ) . '</li>';
+                                            }
+                                        }
+                                        ?>
 								</ul>
 							</div>
 
@@ -81,8 +81,8 @@ 
 						<div class="testimonial-content">
 							<div class="t-image">
 								<?php
-									echo '<img src="' . esc_url( plugins_url( 'images/t-image2.png', dirname( __FILE__ ) ) ) . '" > ';
-								?>
+                                    echo '<img src="' . esc_url( plugins_url( 'images/t-image2.png', dirname( __FILE__ ) ) ) . '" > ';
+                                ?>
 							</div>
 							<div class="t-content">
 								<p>
@@ -101,8 +101,8 @@ 
 						<div class="testimonial-content">
 							<div class="t-image">
 								<?php
-									echo '<img src="' . esc_url( plugins_url( 'images/t-image1.png', dirname( __FILE__ ) ) ) . '" > ';
-								?>
+                                    echo '<img src="' . esc_url( plugins_url( 'images/t-image1.png', dirname( __FILE__ ) ) ) . '" > ';
+                                ?>
 							</div>
 							<div class="t-content">
 								<p>
@@ -126,26 +126,26 @@ 
 			</div>
 		</div>
 			<?php
-		} else {
-			$installed_plugins = get_plugins();
+        } else {
+            $installed_plugins = get_plugins();
             $addon_obj = new WPInv_Admin_Addons();
-			if ( $addons = $addon_obj->get_section_data( $current_tab ) ) :
-				//print_r($addons);
-				?>
+            if ( $addons = $addon_obj->get_section_data( $current_tab ) ) :
+                //print_r($addons);
+                ?>
 				<ul class="wpi-products">
                 <?php
                 foreach ( $addons as $addon ) :
                         if ( 965 == $addon->info->id ) {
 continue;}// don't show quote add on
-						?>
+                        ?>
                         <li class="wpi-product">
 								<div class="wpi-product-title">
 									<h3>
                                     <?php
-										if ( ! empty( $addon->info->excerpt ) ) {
-										wpi_help_tip( $addon->info->excerpt, false, false, true );
-										}
-										echo esc_html( $addon->info->title );
+                                        if ( ! empty( $addon->info->excerpt ) ) {
+                                        wpi_help_tip( $addon->info->excerpt, false, false, true );
+                                        }
+                                        echo esc_html( $addon->info->title );
                                         ?>
                                         </h3>
 								</div>
@@ -156,40 +156,40 @@ 
 									<?php
                                     endif;
 
-									if ( 'stripe-payment-gateway' == $addon->info->slug ) {
-										$addon->info->slug = 'getpaid-stripe-payments';
-										$addon->info->link = 'https://wordpress.org/plugins/getpaid-stripe-payments/';
-									}
+                                    if ( 'stripe-payment-gateway' == $addon->info->slug ) {
+                                        $addon->info->slug = 'getpaid-stripe-payments';
+                                        $addon->info->link = 'https://wordpress.org/plugins/getpaid-stripe-payments/';
+                                    }
                                     elseif( 'wallet' == $addon->info->slug ){
-										$addon->info->slug = 'getpaid-wallet';
-										$addon->info->link = 'https://wordpress.org/plugins/getpaid-wallet/';
-									}
+                                        $addon->info->slug = 'getpaid-wallet';
+                                        $addon->info->link = 'https://wordpress.org/plugins/getpaid-wallet/';
+                                    }
                                     elseif( 'item-inventory' == $addon->info->slug ){
-										$addon->info->slug = 'getpaid-item-inventory';
-										$addon->info->link = 'https://wordpress.org/plugins/getpaid-item-inventory/';
-									}
-
-									if ( isset( $addon->info->link ) && substr( $addon->info->link, 0, 21 ) === 'https://wordpress.org' ) {
-										echo '<a href="' . esc_url( admin_url( '/plugin-install.php?tab=plugin-information&plugin=' . $addon->info->slug ) ) . '&width=770&height=660&TB_iframe=true" class="thickbox" >';
-										echo '<span class="wpi-product-info">' . esc_html__( 'More info', 'invoicing' ) . '</span>';
-										echo '</a>';
-									} elseif ( isset( $addon->info->link ) && ( substr( $addon->info->link, 0, 23 ) === 'https://wpinvoicing.com' || substr( $addon->info->link, 0, 21 ) === 'https://wpgetpaid.com' ) ) {
-										if ( defined( 'WP_EASY_UPDATES_ACTIVE' ) ) {
-											$url = admin_url( '/plugin-install.php?tab=plugin-information&plugin=' . $addon->info->slug . '&width=770&height=660&item_id=' . $addon->info->id . '&update_url=https://wpgetpaid.com&TB_iframe=true' );
-										} else {
-											// if installed show activation link
-											if ( isset( $installed_plugins['wp-easy-updates/external-updates.php'] ) ) {
-												$url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-activation';
-											} else {
-												$url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-for-external';
-											}
-										}
-										echo '<a href="' . esc_url( $url ) . '" class="thickbox">';
-										echo '<span class="wpi-product-info">' . esc_html__( 'More info', 'invoicing' ) . '</span>';
-										echo '</a>';
-									}
-
-									?>
+                                        $addon->info->slug = 'getpaid-item-inventory';
+                                        $addon->info->link = 'https://wordpress.org/plugins/getpaid-item-inventory/';
+                                    }
+
+                                    if ( isset( $addon->info->link ) && substr( $addon->info->link, 0, 21 ) === 'https://wordpress.org' ) {
+                                        echo '<a href="' . esc_url( admin_url( '/plugin-install.php?tab=plugin-information&plugin=' . $addon->info->slug ) ) . '&width=770&height=660&TB_iframe=true" class="thickbox" >';
+                                        echo '<span class="wpi-product-info">' . esc_html__( 'More info', 'invoicing' ) . '</span>';
+                                        echo '</a>';
+                                    } elseif ( isset( $addon->info->link ) && ( substr( $addon->info->link, 0, 23 ) === 'https://wpinvoicing.com' || substr( $addon->info->link, 0, 21 ) === 'https://wpgetpaid.com' ) ) {
+                                        if ( defined( 'WP_EASY_UPDATES_ACTIVE' ) ) {
+                                            $url = admin_url( '/plugin-install.php?tab=plugin-information&plugin=' . $addon->info->slug . '&width=770&height=660&item_id=' . $addon->info->id . '&update_url=https://wpgetpaid.com&TB_iframe=true' );
+                                        } else {
+                                            // if installed show activation link
+                                            if ( isset( $installed_plugins['wp-easy-updates/external-updates.php'] ) ) {
+                                                $url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-activation';
+                                            } else {
+                                                $url = '#TB_inline?width=600&height=50&inlineId=wpi-wpeu-required-for-external';
+                                            }
+                                        }
+                                        echo '<a href="' . esc_url( $url ) . '" class="thickbox">';
+                                        echo '<span class="wpi-product-info">' . esc_html__( 'More info', 'invoicing' ) . '</span>';
+                                        echo '</a>';
+                                    }
+
+                                    ?>
 
 								</span>
 
@@ -197,15 +197,15 @@ 
 								<span class="wpi-product-button">
 									<?php
                                     $addon_obj->output_button( $addon );
-									?>
+                                    ?>
 								</span>
 
 								<span class="wpi-price"><?php //print_r($addon); //echo wp_kses_post( $addon->price ); ?></span></li><?php endforeach; ?></ul>
 			<?php
             endif;
-		}
+        }
 }
-	?>
+    ?>
 
 
 	<div class="clearfix" ></div>
@@ -224,8 +224,8 @@ 
 			<input class="wpeu-licence-key" type="text" placeholder="<?php esc_attr_e( 'Enter your licence key', 'invoicing' ); ?>"> <button class="button-primary wpeu-licence-popup-button" ><?php esc_html_e( 'Install', 'invoicing' ); ?></button>
 			<br>
 			<?php
-			printf( esc_html__( '%1$sFind your licence key here%2$s OR %3$sBuy one here%4$s', 'invoicing' ), '<a href="https://wpinvoicing.com/your-account/" target="_blank">', '</a>', '<a class="wpeu-licence-link" href="https://wpinvoicing.com/downloads/category/addons/" target="_blank">', '</a>' );
-			?>
+            printf( esc_html__( '%1$sFind your licence key here%2$s OR %3$sBuy one here%4$s', 'invoicing' ), '<a href="https://wpinvoicing.com/your-account/" target="_blank">', '</a>', '<a class="wpeu-licence-link" href="https://wpinvoicing.com/downloads/category/addons/" target="_blank">', '</a>' );
+            ?>
 		</span>
 	</div>
 

includes/class-wpinv-addons.php

Indentation +210 added lines, -210 removed lines

@@ -6,7 +6,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,94 +15,94 @@ 
 class WPInv_Admin_Addons extends Ayecode_Addons {
 
 
-	/**
-	 * Get the extensions page tabs.
-	 *
-	 * @return array of tabs.
-	 */
-	public function get_tabs() {
-		$tabs = array(
-			'addons'              => __( 'Addons', 'invoicing' ),
+    /**
+     * Get the extensions page tabs.
+     *
+     * @return array of tabs.
+     */
+    public function get_tabs() {
+        $tabs = array(
+            'addons'              => __( 'Addons', 'invoicing' ),
             'gateways'            => __( 'Payment Gateways', 'invoicing' ),
             'recommended_plugins' => __( 'Recommended plugins', 'invoicing' ),
             'membership'          => __( 'Membership', 'invoicing' ),
-		);
-
-		return $tabs;
-	}
-
-	/**
-	 * Get section content for the addons screen.
-	 *
-	 * @param  string $section_id
-	 *
-	 * @return array
-	 */
-	public function get_section_data( $section_id ) {
-		$section      = self::get_tab( $section_id );
-		$api_url = 'https://wpinvoicing.com/edd-api/v2/products/';
-		$section_data = new stdClass();
-
-		if ( $section_id == 'recommended_plugins' ) {
-			$section_data->products = self::get_recommend_wp_plugins_edd_formatted();
-		} elseif ( ! empty( $section ) ) {
-			if ( false === ( $section_data = get_transient( 'wpi_addons_section_' . $section_id ) ) ) { //@todo restore after testing
-			//if ( 1==1) {
-
-				$query_args = array(
-					'category' => $section_id,
-					'number'   => 100,
-				);
-				$query_args = apply_filters( 'wpeu_edd_api_query_args', $query_args, $api_url, $section_id );
-
-				$raw_section = wp_safe_remote_get(
+        );
+
+        return $tabs;
+    }
+
+    /**
+     * Get section content for the addons screen.
+     *
+     * @param  string $section_id
+     *
+     * @return array
+     */
+    public function get_section_data( $section_id ) {
+        $section      = self::get_tab( $section_id );
+        $api_url = 'https://wpinvoicing.com/edd-api/v2/products/';
+        $section_data = new stdClass();
+
+        if ( $section_id == 'recommended_plugins' ) {
+            $section_data->products = self::get_recommend_wp_plugins_edd_formatted();
+        } elseif ( ! empty( $section ) ) {
+            if ( false === ( $section_data = get_transient( 'wpi_addons_section_' . $section_id ) ) ) { //@todo restore after testing
+            //if ( 1==1) {
+
+                $query_args = array(
+                    'category' => $section_id,
+                    'number'   => 100,
+                );
+                $query_args = apply_filters( 'wpeu_edd_api_query_args', $query_args, $api_url, $section_id );
+
+                $raw_section = wp_safe_remote_get(
                     esc_url_raw( add_query_arg( $query_args, $api_url ) ),
                     array(
-						'user-agent' => 'Invoicing Addons Page',
-						'timeout'    => 15,
+                        'user-agent' => 'Invoicing Addons Page',
+                        'timeout'    => 15,
                     )
                 );
 
-				if ( ! is_wp_error( $raw_section ) ) {
-					$section_data = json_decode( wp_remote_retrieve_body( $raw_section ) );
+                if ( ! is_wp_error( $raw_section ) ) {
+                    $section_data = json_decode( wp_remote_retrieve_body( $raw_section ) );
 
-					if ( ! empty( $section_data->products ) ) {
-						set_transient( 'wpi_addons_section_' . $section_id, $section_data, DAY_IN_SECONDS );
-					}
-				}
-			}
+                    if ( ! empty( $section_data->products ) ) {
+                        set_transient( 'wpi_addons_section_' . $section_id, $section_data, DAY_IN_SECONDS );
+                    }
+                }
+            }
 }
 
-		$products = isset( $section_data->products ) ? $section_data->products : array();
-		if ( 'addons' == $section_id ) {
-
-			$quotes = new stdClass();
-			$quotes->info = new stdClass();
-			$quotes->info->id = '';
-			$quotes->info->slug = 'invoicing-quotes';
-			$quotes->info->title = __( 'Quotes', 'invoicing' );
-			$quotes->info->excerpt = __( 'Create quotes and estimates', 'invoicing' );
-			$quotes->info->link = 'https://wordpress.org/plugins/invoicing-quotes/';
-			$quotes->info->thumbnail = WPINV_PLUGIN_URL . 'assets/images/Quotes-1-768x384.png';
-
-			$products[] = $quotes;
-		}
-
-		return apply_filters( 'wpi_addons_section_data', $products, $section_id );
-	}
-
-	/**
-	 * Outputs a button.
-	 *ccc
-	 * @param string $url
-	 * @param string $text
-	 * @param string $theme
-	 * @param string $plugin
-	 */
-	public function output_button( $addon ) {
+        $products = isset( $section_data->products ) ? $section_data->products : array();
+        if ( 'addons' == $section_id ) {
+
+            $quotes = new stdClass();
+            $quotes->info = new stdClass();
+            $quotes->info->id = '';
+            $quotes->info->slug = 'invoicing-quotes';
+            $quotes->info->title = __( 'Quotes', 'invoicing' );
+            $quotes->info->excerpt = __( 'Create quotes and estimates', 'invoicing' );
+            $quotes->info->link = 'https://wordpress.org/plugins/invoicing-quotes/';
+            $quotes->info->thumbnail = WPINV_PLUGIN_URL . 'assets/images/Quotes-1-768x384.png';
+
+            $products[] = $quotes;
+        }
+
+        return apply_filters( 'wpi_addons_section_data', $products, $section_id );
+    }
+
+    /**
+     * Outputs a button.
+     *ccc
+     * @param string $url
+     * @param string $text
+     * @param string $theme
+     * @param string $plugin
+     */
+    public function output_button( $addon ) {
 
 //        print_r($addon);
-		$current_tab     = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] );
+        $current_tab     = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] );
 //		$button_text = __('Free','invoicing');
 //		$licensing = false;
 //		$installed = false;
@@ -114,128 +114,128 @@ 
 //		$install_status = 'get';
 //		$onclick = '';
 
-		$wp_org_themes = array( 'supreme-directory', 'directory-starter' );
-
-		$button_args = array(
-			'type'           => ($current_tab == 'addons' || $current_tab == 'gateways') ? 'addons' : $current_tab,
-			'id'             => isset( $addon->info->id ) ? absint( $addon->info->id ) : '',
-			'title'          => isset( $addon->info->title ) ? $addon->info->title : '',
-			'button_text'    => __( 'Free', 'invoicing' ),
-			'price_text'     => __( 'Free', 'invoicing' ),
-			'link'           => isset( $addon->info->link ) ? $addon->info->link : '', // link to product
-			'url'            => isset( $addon->info->link ) ? $addon->info->link : '', // button url
-			'class'          => 'button-primary',
-			'install_status' => 'get',
-			'installed'      => false,
-			'price'          => '',
-			'licensing'      => isset( $addon->licensing->enabled ) && $addon->licensing->enabled ? true : false,
-			'license'        => isset( $addon->licensing->license ) && $addon->licensing->license ? $addon->licensing->license : '',
-			'onclick'        => '',
-			'slug'           => isset( $addon->info->slug ) ? $addon->info->slug : '',
-			'active'         => false,
-			'file'           => '',
-			'update_url'     => '',
-		);
-
-		if ( 'invoicing-quotes' == $addon->info->slug || 'getpaid-stripe-payments' == $addon->info->slug || ( $current_tab == 'recommended_plugins' && isset( $addon->info->slug ) && $addon->info->slug ) ) {
-			include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api..
-			$status = install_plugin_install_status(
+        $wp_org_themes = array( 'supreme-directory', 'directory-starter' );
+
+        $button_args = array(
+            'type'           => ($current_tab == 'addons' || $current_tab == 'gateways') ? 'addons' : $current_tab,
+            'id'             => isset( $addon->info->id ) ? absint( $addon->info->id ) : '',
+            'title'          => isset( $addon->info->title ) ? $addon->info->title : '',
+            'button_text'    => __( 'Free', 'invoicing' ),
+            'price_text'     => __( 'Free', 'invoicing' ),
+            'link'           => isset( $addon->info->link ) ? $addon->info->link : '', // link to product
+            'url'            => isset( $addon->info->link ) ? $addon->info->link : '', // button url
+            'class'          => 'button-primary',
+            'install_status' => 'get',
+            'installed'      => false,
+            'price'          => '',
+            'licensing'      => isset( $addon->licensing->enabled ) && $addon->licensing->enabled ? true : false,
+            'license'        => isset( $addon->licensing->license ) && $addon->licensing->license ? $addon->licensing->license : '',
+            'onclick'        => '',
+            'slug'           => isset( $addon->info->slug ) ? $addon->info->slug : '',
+            'active'         => false,
+            'file'           => '',
+            'update_url'     => '',
+        );
+
+        if ( 'invoicing-quotes' == $addon->info->slug || 'getpaid-stripe-payments' == $addon->info->slug || ( $current_tab == 'recommended_plugins' && isset( $addon->info->slug ) && $addon->info->slug ) ) {
+            include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api..
+            $status = install_plugin_install_status(
                 array(
-					'slug'    => $button_args['slug'],
-					'version' => '',
+                    'slug'    => $button_args['slug'],
+                    'version' => '',
                 )
             );
-			$button_args['install_status'] = isset( $status['status'] ) ? $status['status'] : 'install';
-			$button_args['file'] = isset( $status['file'] ) ? $status['file'] : '';
-		} elseif ( ($current_tab == 'addons' || $current_tab == 'gateways') && isset( $addon->info->id ) && $addon->info->id ) {
-			include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api..
-			if ( ! empty( $addon->licensing->edd_slug ) ) {
+            $button_args['install_status'] = isset( $status['status'] ) ? $status['status'] : 'install';
+            $button_args['file'] = isset( $status['file'] ) ? $status['file'] : '';
+        } elseif ( ($current_tab == 'addons' || $current_tab == 'gateways') && isset( $addon->info->id ) && $addon->info->id ) {
+            include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api..
+            if ( ! empty( $addon->licensing->edd_slug ) ) {
 $button_args['slug'] = $addon->licensing->edd_slug;}
-			$status = self::install_plugin_install_status( $addon );
-			$button_args['file'] = isset( $status['file'] ) ? $status['file'] : '';
-			if ( isset( $status['status'] ) ) {
+            $status = self::install_plugin_install_status( $addon );
+            $button_args['file'] = isset( $status['file'] ) ? $status['file'] : '';
+            if ( isset( $status['status'] ) ) {
 $button_args['install_status'] = $status['status'];}
-			$button_args['update_url'] = 'https://wpinvoicing.com';
-		} elseif ( $current_tab == 'themes' && isset( $addon->info->id ) && $addon->info->id ) {
-			if ( ! empty( $addon->licensing->edd_slug ) ) {
+            $button_args['update_url'] = 'https://wpinvoicing.com';
+        } elseif ( $current_tab == 'themes' && isset( $addon->info->id ) && $addon->info->id ) {
+            if ( ! empty( $addon->licensing->edd_slug ) ) {
 $button_args['slug'] = $addon->licensing->edd_slug;}
-			$button_args['installed'] = self::is_theme_installed( $addon );
-			if ( ! in_array( $button_args['slug'], $wp_org_themes ) ) {
-				$button_args['update_url'] = 'https://wpinvoicing.com';
-			}
-		}
-
-		// set price
-		if ( isset( $addon->pricing ) && ! empty( $addon->pricing ) ) {
-			if ( is_object( $addon->pricing ) ) {
-				$prices = (array)$addon->pricing;
-				$button_args['price'] = reset( $prices );
-			} elseif ( isset( $addon->pricing ) ) {
-				$button_args['price'] = $addon->pricing;
-			}
-		}
-
-		// set price text
-		if ( $button_args['price'] && $button_args['price'] != '0.00' ) {
-			$button_args['price_text'] = sprintf( __( 'From: $%d', 'invoicing' ), $button_args['price'] );
-		}
-
-		// set if installed
-		if ( in_array( $button_args['install_status'], array( 'installed', 'latest_installed', 'update_available', 'newer_installed' ) ) ) {
-			$button_args['installed'] = true;
-		}
+            $button_args['installed'] = self::is_theme_installed( $addon );
+            if ( ! in_array( $button_args['slug'], $wp_org_themes ) ) {
+                $button_args['update_url'] = 'https://wpinvoicing.com';
+            }
+        }
+
+        // set price
+        if ( isset( $addon->pricing ) && ! empty( $addon->pricing ) ) {
+            if ( is_object( $addon->pricing ) ) {
+                $prices = (array)$addon->pricing;
+                $button_args['price'] = reset( $prices );
+            } elseif ( isset( $addon->pricing ) ) {
+                $button_args['price'] = $addon->pricing;
+            }
+        }
+
+        // set price text
+        if ( $button_args['price'] && $button_args['price'] != '0.00' ) {
+            $button_args['price_text'] = sprintf( __( 'From: $%d', 'invoicing' ), $button_args['price'] );
+        }
+
+        // set if installed
+        if ( in_array( $button_args['install_status'], array( 'installed', 'latest_installed', 'update_available', 'newer_installed' ) ) ) {
+            $button_args['installed'] = true;
+        }
 
 //		print_r($button_args);
-		// set if active
-		if ( $button_args['installed'] && ($button_args['file'] || $button_args['type'] == 'themes') ) {
-			if ( $button_args['type'] != 'themes' ) {
-				$button_args['active'] = is_plugin_active( $button_args['file'] );
-			} else {
-				$button_args['active'] = self::is_theme_active( $addon );
-			}
-		}
-
-		// set button text and class
-		if ( $button_args['active'] ) {
-			$button_args['button_text'] = __( 'Active', 'invoicing' );
-			$button_args['class'] = ' button-secondary disabled ';
-		} elseif ( $button_args['installed'] ) {
-			$button_args['button_text'] = __( 'Activate', 'invoicing' );
-
-			if ( $button_args['type'] != 'themes' ) {
-				if ( current_user_can( 'manage_options' ) ) {
-					$button_args['url'] = wp_nonce_url( admin_url( 'plugins.php?action=activate&plugin=' . $button_args['file'] ), 'activate-plugin_' . $button_args['file'] );
-				} else {
-					$button_args['url'] = '#';
-				}
-			} else {
-				if ( current_user_can( 'switch_themes' ) ) {
-					$button_args['url'] = self::get_theme_activation_url( $addon );
-				} else {
-					$button_args['url'] = '#';
-				}
-			}
+        // set if active
+        if ( $button_args['installed'] && ($button_args['file'] || $button_args['type'] == 'themes') ) {
+            if ( $button_args['type'] != 'themes' ) {
+                $button_args['active'] = is_plugin_active( $button_args['file'] );
+            } else {
+                $button_args['active'] = self::is_theme_active( $addon );
+            }
+        }
+
+        // set button text and class
+        if ( $button_args['active'] ) {
+            $button_args['button_text'] = __( 'Active', 'invoicing' );
+            $button_args['class'] = ' button-secondary disabled ';
+        } elseif ( $button_args['installed'] ) {
+            $button_args['button_text'] = __( 'Activate', 'invoicing' );
+
+            if ( $button_args['type'] != 'themes' ) {
+                if ( current_user_can( 'manage_options' ) ) {
+                    $button_args['url'] = wp_nonce_url( admin_url( 'plugins.php?action=activate&plugin=' . $button_args['file'] ), 'activate-plugin_' . $button_args['file'] );
+                } else {
+                    $button_args['url'] = '#';
+                }
+            } else {
+                if ( current_user_can( 'switch_themes' ) ) {
+                    $button_args['url'] = self::get_theme_activation_url( $addon );
+                } else {
+                    $button_args['url'] = '#';
+                }
+            }
         } else {
-			if ( $button_args['type'] == 'recommended_plugins' ) {
-				$button_args['button_text'] = __( 'Install', 'invoicing' );
-					} else {
-				$button_args['button_text'] = __( 'Get it', 'invoicing' );
+            if ( $button_args['type'] == 'recommended_plugins' ) {
+                $button_args['button_text'] = __( 'Install', 'invoicing' );
+                    } else {
+                $button_args['button_text'] = __( 'Get it', 'invoicing' );
 
-				/*if($button_args['type'] == 'themes' && in_array($button_args['slug'],$wp_org_themes) ){
+                /*if($button_args['type'] == 'themes' && in_array($button_args['slug'],$wp_org_themes) ){
 			$button_args['button_text'] = __('Install','invoicing');
 			$button_args['url'] = self::get_theme_install_url($button_args['slug']);
 			$button_args['onclick'] = 'gd_set_button_installing(this);';
 				}*/
 
-					}
-		}
+                    }
+        }
 
-		// filter the button arguments
-		$button_args = apply_filters( 'edd_api_button_args', $button_args );
+        // filter the button arguments
+        $button_args = apply_filters( 'edd_api_button_args', $button_args );
 //		print_r($button_args);
-		// set price text
-		if ( isset( $button_args['price_text'] ) ) {
-			?>
+        // set price text
+        if ( isset( $button_args['price_text'] ) ) {
+            ?>
 			<a
 				target="_blank"
 				class="addons-price-text"
@@ -243,9 +243,9 @@ 
 				<?php echo esc_html( $button_args['price_text'] ); ?>
 			</a>
 			<?php
-		}
+        }
 
-		?>
+        ?>
 		<a
 			data-licence="<?php echo esc_attr( $button_args['license'] ); ?>"
 			data-licensing="<?php echo $button_args['licensing'] ? 1 : 0; ?>"
@@ -269,33 +269,33 @@ 
 		</a>
 		<?php
 
-	}
-
-
-	/**
-	 * Handles output of the addons page in admin.
-	 */
-	public function output() {
-		$tabs            = self::get_tabs();
-		$sections        = self::get_sections();
-		$theme           = wp_get_theme();
-		$section_keys    = array_keys( $sections );
-		$current_section = isset( $_GET['section'] ) ? sanitize_text_field( $_GET['section'] ) : current( $section_keys );
-		$current_tab     = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] );
-		include_once WPINV_PLUGIN_DIR . '/includes/admin/html-admin-page-addons.php';
-	}
-
-	/**
-	 * A list of recommended wp.org plugins.
-	 * @return array
-	 */
-	public function get_recommend_wp_plugins() {
-		$plugins = array(
+    }
+
+
+    /**
+     * Handles output of the addons page in admin.
+     */
+    public function output() {
+        $tabs            = self::get_tabs();
+        $sections        = self::get_sections();
+        $theme           = wp_get_theme();
+        $section_keys    = array_keys( $sections );
+        $current_section = isset( $_GET['section'] ) ? sanitize_text_field( $_GET['section'] ) : current( $section_keys );
+        $current_tab     = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] );
+        include_once WPINV_PLUGIN_DIR . '/includes/admin/html-admin-page-addons.php';
+    }
+
+    /**
+     * A list of recommended wp.org plugins.
+     * @return array
+     */
+    public function get_recommend_wp_plugins() {
+        $plugins = array(
             'invoicing-quotes' => array(
                 'url'       => 'https://wordpress.org/plugins/invoicing-quotes/',
                 'slug'      => 'invoicing-quotes',
-				'name'      => 'Quotes',
-				'thumbnail' => 'https://ps.w.org/invoicing-quotes/assets/banner-772x250.png',
+                'name'      => 'Quotes',
+                'thumbnail' => 'https://ps.w.org/invoicing-quotes/assets/banner-772x250.png',
                 'desc'      => __( 'Allows you to create quotes, send them to clients and convert them to Invoices when accepted by the customer.', 'invoicing' ),
             ),
             'geodirectory'     => array(
@@ -310,8 +310,8 @@ 
                 'name' => 'UsersWP',
                 'desc' => __( 'Allow frontend user login and registration as well as have slick profile pages.', 'invoicing' ),
             ),
-		);
+        );
 
-		return $plugins;
-	}
+        return $plugins;
+    }
 }

vendor/ayecode/wp-ayecode-ui/includes/class-aui.php

Indentation +295 added lines, -295 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,299 +11,299 @@ 
  */
 class AUI {
 
-	/**
-	 * Holds the class instance.
-	 *
-	 * @since 1.0.0
-	 * @var null
-	 */
-	private static $instance = null;
-
-	/**
-	 * Holds the current AUI version number.
-	 *
-	 * @var string $ver The current version number.
-	 */
-	public static $ver = '0.1.72';
-
-	public static $options = null;
-
-	/**
-	 * There can be only one.
-	 *
-	 * @since 1.0.0
-	 * @return AUI|null
-	 */
-	public static function instance() {
-		if ( self::$instance == null ) {
-			self::$instance = new AUI();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * AUI constructor.
-	 *
-	 * @since 1.0.0
-	 */
-	private function __construct() {
-		if ( function_exists( "__autoload" ) ) {
-			spl_autoload_register( "__autoload" );
-		}
-		spl_autoload_register( array( $this, 'autoload' ) );
-
-		// load options
-		self::$options = get_option('aui_options');
-	}
-
-	/**
-	 * Autoload any components on the fly.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param $classname
-	 */
-	private function autoload( $classname ) {
-		$class     = str_replace( '_', '-', strtolower( $classname ) );
-		$file_path = trailingslashit( dirname( __FILE__ ) ) . "components/class-" . $class . '.php';
-		if ( $file_path && is_readable( $file_path ) ) {
-			include_once( $file_path );
-		}
-	}
-
-	/**
-	 * Get the AUI options.
-	 *
-	 * @param $option
-	 *
-	 * @return string|void
-	 */
-	public function get_option( $option ){
-		$result = isset(self::$options[$option]) ? esc_attr(self::$options[$option]) : '';
-
-		if ( ! $result && $option) {
-			if( $option == 'color_primary' ){
-				$result = AUI_PRIMARY_COLOR;
-			}elseif( $option == 'color_secondary' ){
-				$result = AUI_SECONDARY_COLOR;
-			}
-		}
-		return $result;
-	}
-
-	public function render( $items = array(), $echo = false ) {
-		$output = '';
-
-		if ( ! empty( $items ) ) {
-			foreach ( $items as $args ) {
-				$render = isset( $args['render'] ) ? $args['render'] : '';
-				if ( $render && method_exists( __CLASS__, $render ) ) {
-					$output .= $this->$render( $args );
-				}
-			}
-		}
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-
-	}
-
-	/**
-	 * Render and return a bootstrap alert component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function alert( $args = array(), $echo = false ) {
-		$output = AUI_Component_Alert::get( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap input component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function input( $args = array(), $echo = false ) {
-		$output = AUI_Component_Input::input( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap textarea component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function textarea( $args = array(), $echo = false ) {
-		$output = AUI_Component_Input::textarea( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap button component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function button( $args = array(), $echo = false ) {
-		$output = AUI_Component_Button::get( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap button component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function badge( $args = array(), $echo = false ) {
-		$defaults = array(
-			'class' => 'badge badge-primary align-middle',
-		);
-
-		// maybe set type.
-		if ( empty( $args['href'] ) ) {
-			$defaults['type'] = 'badge';
-		}
-
-		/**
-		 * Parse incoming $args into an array and merge it with $defaults
-		 */
-		$args = wp_parse_args( $args, $defaults );
-
-		$output = AUI_Component_Button::get( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap dropdown component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function dropdown( $args = array(), $echo = false ) {
-		$output = AUI_Component_Dropdown::get( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap select component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function select( $args = array(), $echo = false ) {
-		$output = AUI_Component_Input::select( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap radio component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function radio( $args = array(), $echo = false ) {
-		$output = AUI_Component_Input::radio( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
-
-	/**
-	 * Render and return a bootstrap pagination component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $args The function arguments.
-	 * @param bool  $echo If we should return or echo.
-	 *
-	 * @return string The rendered component.
-	 */
-	public function pagination( $args = array(), $echo = false ) {
-		$output = AUI_Component_Pagination::get( $args );
-
-		if ( $echo ) {
-			echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-		}else{
-			return $output;
-		}
-	}
+    /**
+     * Holds the class instance.
+     *
+     * @since 1.0.0
+     * @var null
+     */
+    private static $instance = null;
+
+    /**
+     * Holds the current AUI version number.
+     *
+     * @var string $ver The current version number.
+     */
+    public static $ver = '0.1.72';
+
+    public static $options = null;
+
+    /**
+     * There can be only one.
+     *
+     * @since 1.0.0
+     * @return AUI|null
+     */
+    public static function instance() {
+        if ( self::$instance == null ) {
+            self::$instance = new AUI();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * AUI constructor.
+     *
+     * @since 1.0.0
+     */
+    private function __construct() {
+        if ( function_exists( "__autoload" ) ) {
+            spl_autoload_register( "__autoload" );
+        }
+        spl_autoload_register( array( $this, 'autoload' ) );
+
+        // load options
+        self::$options = get_option('aui_options');
+    }
+
+    /**
+     * Autoload any components on the fly.
+     *
+     * @since 1.0.0
+     *
+     * @param $classname
+     */
+    private function autoload( $classname ) {
+        $class     = str_replace( '_', '-', strtolower( $classname ) );
+        $file_path = trailingslashit( dirname( __FILE__ ) ) . "components/class-" . $class . '.php';
+        if ( $file_path && is_readable( $file_path ) ) {
+            include_once( $file_path );
+        }
+    }
+
+    /**
+     * Get the AUI options.
+     *
+     * @param $option
+     *
+     * @return string|void
+     */
+    public function get_option( $option ){
+        $result = isset(self::$options[$option]) ? esc_attr(self::$options[$option]) : '';
+
+        if ( ! $result && $option) {
+            if( $option == 'color_primary' ){
+                $result = AUI_PRIMARY_COLOR;
+            }elseif( $option == 'color_secondary' ){
+                $result = AUI_SECONDARY_COLOR;
+            }
+        }
+        return $result;
+    }
+
+    public function render( $items = array(), $echo = false ) {
+        $output = '';
+
+        if ( ! empty( $items ) ) {
+            foreach ( $items as $args ) {
+                $render = isset( $args['render'] ) ? $args['render'] : '';
+                if ( $render && method_exists( __CLASS__, $render ) ) {
+                    $output .= $this->$render( $args );
+                }
+            }
+        }
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+
+    }
+
+    /**
+     * Render and return a bootstrap alert component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function alert( $args = array(), $echo = false ) {
+        $output = AUI_Component_Alert::get( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap input component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function input( $args = array(), $echo = false ) {
+        $output = AUI_Component_Input::input( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap textarea component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function textarea( $args = array(), $echo = false ) {
+        $output = AUI_Component_Input::textarea( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap button component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function button( $args = array(), $echo = false ) {
+        $output = AUI_Component_Button::get( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap button component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function badge( $args = array(), $echo = false ) {
+        $defaults = array(
+            'class' => 'badge badge-primary align-middle',
+        );
+
+        // maybe set type.
+        if ( empty( $args['href'] ) ) {
+            $defaults['type'] = 'badge';
+        }
+
+        /**
+         * Parse incoming $args into an array and merge it with $defaults
+         */
+        $args = wp_parse_args( $args, $defaults );
+
+        $output = AUI_Component_Button::get( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap dropdown component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function dropdown( $args = array(), $echo = false ) {
+        $output = AUI_Component_Dropdown::get( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap select component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function select( $args = array(), $echo = false ) {
+        $output = AUI_Component_Input::select( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap radio component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function radio( $args = array(), $echo = false ) {
+        $output = AUI_Component_Input::radio( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
+
+    /**
+     * Render and return a bootstrap pagination component.
+     *
+     * @since 1.0.0
+     *
+     * @param array $args The function arguments.
+     * @param bool  $echo If we should return or echo.
+     *
+     * @return string The rendered component.
+     */
+    public function pagination( $args = array(), $echo = false ) {
+        $output = AUI_Component_Pagination::get( $args );
+
+        if ( $echo ) {
+            echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+        }else{
+            return $output;
+        }
+    }
 
 }
\ No newline at end of file

vendor/ayecode/wp-ayecode-ui/example-plugin.php

Indentation +212 added lines, -212 removed lines

@@ -16,222 +16,222 @@
 
 // If this file is called directly, abort.
 if ( ! defined( 'WPINC' ) ) {
-	die;
+    die;
 }
 
 class AyeCode_UI_Plugin {
 
-	/**
-	 * AUI Plugin constructor.
-	 *
-	 * @since 1.0.0
-	 */
-	public function __construct() {
-
-		// load AUI
-		require_once( dirname( __FILE__ ) . '/ayecode-ui-loader.php' );
-
-		// Maybe show example page
-		add_action( 'template_redirect', array( $this,'maybe_show_examples' ) );
-	}
-
-	public function maybe_show_examples(){
-		if ( current_user_can( 'manage_options' ) && isset( $_REQUEST['preview-aui'] ) ) {
-			echo "<head>";
-			wp_head();
-			echo "</head>";
-			echo "<body class='bsui'>";
-			echo $this->get_examples(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-			wp_footer();
-			echo "</body>";
-			exit;
-		}
-	}
-
-	public function get_examples(){
-		$output = '';
-
-		// open form
-		$output .= "<form class='p-5 m-5 border rounded bg-white'>";
-
-		$output .= aui()->input(
-			array(
-				'type'             => 'datepicker',
-				'id'               => 'date_example_sm',
-				'size'             => 'sm',
-				'name'             => 'date_example_sm',
-				'label'            => 'Date Input Label (small)',
-				'help_text'        => 'help text',
-				'label_type'       => 'top',
-				'placeholder'      => 'YYYY-MM-DD 00:00',
-				'value'            => '',
-				'extra_attributes' => array(
-					'data-enable-time' => 'true',
-					'data-time_24hr'   => 'true',
-					'data-allow-input' => 'true',
-				),
-			)
-		);
-
-		$output .= aui()->input(
-			array(
-				'type'             => 'datepicker',
-				'id'               => 'date_example',
-				//'size'             => 'smx',
-				'name'             => 'date_example',
-				'label'            => 'Date Input Label',
-				'help_text'        => 'help text',
-				'label_type'       => 'top',
-				'placeholder'      => 'YYYY-MM-DD 00:00',
-				'value'            => '',
-				'extra_attributes' => array(
-					'data-enable-time' => 'true',
-					'data-time_24hr'   => 'true',
-					'data-allow-input' => 'true',
-				),
-			)
-		);
-
-		$output .= aui()->input(
-			array(
-				'type'             => 'datepicker',
-				'id'               => 'date_example_lg',
-				'size'             => 'lg',
-				'name'             => 'date_example_lg',
-				'label'            => 'Date Input Label (large)',
-				'help_text'        => 'help text',
-				'label_type'       => 'top',
-				'placeholder'      => 'YYYY-MM-DD 00:00',
-				'value'            => '',
-				'extra_attributes' => array(
-					'data-enable-time' => 'true',
-					'data-time_24hr'   => 'true',
-					//'data-allow-input' => 'true',
-				),
-			)
-		);
-
-		// input example
-		$output .= aui()->input(
-			array(
-				'type'  =>  'text',
-				'id'    =>  'text-example',
-				'size'             => 'sm',
-				//'clear_icon'    => true,
-				'name'    =>  'text-example',
-				'placeholder'   => 'text placeholder',
-				'title'   => 'Text input example',
-				'value' =>  '',
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Text input example label',
-				'label_type' => 'top'
-			)
-		);
-
-		$output .= aui()->input(
-			array(
-				'type'  =>  'search',
-				'id'    =>  'text-example',
-				'size'             => 'sm',
-				//'clear_icon'    => true,
-				'name'    =>  'text-example',
-				'placeholder'   => 'text placeholder',
-				'title'   => 'Text input example',
-				'value' =>  '',
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Text input example label',
-				'label_type' => 'top'
-			)
-		);
-
-		// input example
-		$output .= aui()->input(
-			array(
-				'type'  =>  'url',
-				'id'    =>  'text-example2',
-				'name'    =>  'text-example',
-				'placeholder'   => 'url placeholder',
-				'title'   => 'Text input example',
-				'value' =>  '',
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Text input example label'
-			)
-		);
-
-		// checkbox example
-		$output .= aui()->input(
-			array(
-				'type'  =>  'checkbox',
-				'id'    =>  'checkbox-example',
-				'name'    =>  'checkbox-example',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Checkbox example',
-				'value' =>  '1',
-				'checked'   => true,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Checkbox checked'
-			)
-		);
-
-		// checkbox example
-		$output .= aui()->input(
-			array(
-				'type'  =>  'checkbox',
-				'id'    =>  'checkbox-example2',
-				'name'    =>  'checkbox-example2',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Checkbox example',
-				'value' =>  '1',
-				'checked'   => false,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Checkbox un-checked'
-			)
-		);
-
-		// switch example
-		$output .= aui()->input(
-			array(
-				'type'  =>  'checkbox',
-				'id'    =>  'switch-example',
-				'name'    =>  'switch-example',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Switch example',
-				'value' =>  '1',
-				'checked'   => true,
-				'switch'    => true,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Switch on'
-			)
-		);
-
-		// switch example
-		$output .= aui()->input(
-			array(
-				'type'  =>  'checkbox',
-				'id'    =>  'switch-example2',
-				'name'    =>  'switch-example2',
-				'placeholder'   => 'checkbox-example',
-				'title'   => 'Switch example',
-				'value' =>  '1',
-				'checked'   => false,
-				'switch'    => true,
-				'required'  => false,
-				'help_text' => 'help text',
-				'label' => 'Switch off'
-			)
-		);
-
-		// close form
-		$output .= "</form>";
-
-		return $output;
-	}
+    /**
+     * AUI Plugin constructor.
+     *
+     * @since 1.0.0
+     */
+    public function __construct() {
+
+        // load AUI
+        require_once( dirname( __FILE__ ) . '/ayecode-ui-loader.php' );
+
+        // Maybe show example page
+        add_action( 'template_redirect', array( $this,'maybe_show_examples' ) );
+    }
+
+    public function maybe_show_examples(){
+        if ( current_user_can( 'manage_options' ) && isset( $_REQUEST['preview-aui'] ) ) {
+            echo "<head>";
+            wp_head();
+            echo "</head>";
+            echo "<body class='bsui'>";
+            echo $this->get_examples(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+            wp_footer();
+            echo "</body>";
+            exit;
+        }
+    }
+
+    public function get_examples(){
+        $output = '';
+
+        // open form
+        $output .= "<form class='p-5 m-5 border rounded bg-white'>";
+
+        $output .= aui()->input(
+            array(
+                'type'             => 'datepicker',
+                'id'               => 'date_example_sm',
+                'size'             => 'sm',
+                'name'             => 'date_example_sm',
+                'label'            => 'Date Input Label (small)',
+                'help_text'        => 'help text',
+                'label_type'       => 'top',
+                'placeholder'      => 'YYYY-MM-DD 00:00',
+                'value'            => '',
+                'extra_attributes' => array(
+                    'data-enable-time' => 'true',
+                    'data-time_24hr'   => 'true',
+                    'data-allow-input' => 'true',
+                ),
+            )
+        );
+
+        $output .= aui()->input(
+            array(
+                'type'             => 'datepicker',
+                'id'               => 'date_example',
+                //'size'             => 'smx',
+                'name'             => 'date_example',
+                'label'            => 'Date Input Label',
+                'help_text'        => 'help text',
+                'label_type'       => 'top',
+                'placeholder'      => 'YYYY-MM-DD 00:00',
+                'value'            => '',
+                'extra_attributes' => array(
+                    'data-enable-time' => 'true',
+                    'data-time_24hr'   => 'true',
+                    'data-allow-input' => 'true',
+                ),
+            )
+        );
+
+        $output .= aui()->input(
+            array(
+                'type'             => 'datepicker',
+                'id'               => 'date_example_lg',
+                'size'             => 'lg',
+                'name'             => 'date_example_lg',
+                'label'            => 'Date Input Label (large)',
+                'help_text'        => 'help text',
+                'label_type'       => 'top',
+                'placeholder'      => 'YYYY-MM-DD 00:00',
+                'value'            => '',
+                'extra_attributes' => array(
+                    'data-enable-time' => 'true',
+                    'data-time_24hr'   => 'true',
+                    //'data-allow-input' => 'true',
+                ),
+            )
+        );
+
+        // input example
+        $output .= aui()->input(
+            array(
+                'type'  =>  'text',
+                'id'    =>  'text-example',
+                'size'             => 'sm',
+                //'clear_icon'    => true,
+                'name'    =>  'text-example',
+                'placeholder'   => 'text placeholder',
+                'title'   => 'Text input example',
+                'value' =>  '',
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Text input example label',
+                'label_type' => 'top'
+            )
+        );
+
+        $output .= aui()->input(
+            array(
+                'type'  =>  'search',
+                'id'    =>  'text-example',
+                'size'             => 'sm',
+                //'clear_icon'    => true,
+                'name'    =>  'text-example',
+                'placeholder'   => 'text placeholder',
+                'title'   => 'Text input example',
+                'value' =>  '',
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Text input example label',
+                'label_type' => 'top'
+            )
+        );
+
+        // input example
+        $output .= aui()->input(
+            array(
+                'type'  =>  'url',
+                'id'    =>  'text-example2',
+                'name'    =>  'text-example',
+                'placeholder'   => 'url placeholder',
+                'title'   => 'Text input example',
+                'value' =>  '',
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Text input example label'
+            )
+        );
+
+        // checkbox example
+        $output .= aui()->input(
+            array(
+                'type'  =>  'checkbox',
+                'id'    =>  'checkbox-example',
+                'name'    =>  'checkbox-example',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Checkbox example',
+                'value' =>  '1',
+                'checked'   => true,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Checkbox checked'
+            )
+        );
+
+        // checkbox example
+        $output .= aui()->input(
+            array(
+                'type'  =>  'checkbox',
+                'id'    =>  'checkbox-example2',
+                'name'    =>  'checkbox-example2',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Checkbox example',
+                'value' =>  '1',
+                'checked'   => false,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Checkbox un-checked'
+            )
+        );
+
+        // switch example
+        $output .= aui()->input(
+            array(
+                'type'  =>  'checkbox',
+                'id'    =>  'switch-example',
+                'name'    =>  'switch-example',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Switch example',
+                'value' =>  '1',
+                'checked'   => true,
+                'switch'    => true,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Switch on'
+            )
+        );
+
+        // switch example
+        $output .= aui()->input(
+            array(
+                'type'  =>  'checkbox',
+                'id'    =>  'switch-example2',
+                'name'    =>  'switch-example2',
+                'placeholder'   => 'checkbox-example',
+                'title'   => 'Switch example',
+                'value' =>  '1',
+                'checked'   => false,
+                'switch'    => true,
+                'required'  => false,
+                'help_text' => 'help text',
+                'label' => 'Switch off'
+            )
+        );
+
+        // close form
+        $output .= "</form>";
+
+        return $output;
+    }
 }
 
 new AyeCode_UI_Plugin();
\ No newline at end of file