eventespresso / event-espresso-core

core/services/json/JsonDataNode.php

Indentation +246 added lines, -246 removed lines

@@ -19,250 +19,250 @@
 abstract class JsonDataNode implements JsonDataNodeInterface
 {
 
-    /**
-     * @var JsonDataNodeValidator
-     */
-    protected $validator;
-
-    /**
-     * @var array
-     */
-    private $data = [];
-
-    /**
-     * @var string
-     */
-    private $domain = '';
-
-    /**
-     * @var boolean
-     */
-    private $initialized = false;
-
-    /**
-     * @var string
-     */
-    private $node_name = '';
-
-    /**
-     * @var int
-     */
-    private $order = 50;
-
-
-    /**
-     * @param JsonDataNodeValidator $validator
-     * @throws DomainException
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        $this->validator = $validator;
-    }
-
-
-    /**
-     * for adding primitive data like arrays, integers, or strings
-     *
-     * @param string $key
-     * @param mixed  $data
-     * @throws DomainException
-     */
-    protected function addData(string $key, $data)
-    {
-        if ($this->validator->propertyNotSet($this->data, $key)) {
-            $this->data[ $key ] = $data;
-        }
-    }
-
-
-    /**
-     * for setting value of the entire data array for the node
-     *
-     * @param array $data
-     * @throws DomainException
-     */
-    protected function setDataArray(array $data)
-    {
-        if ($this->validator->dataArrayEmpty($this)) {
-            $this->data = $data;
-        }
-    }
-
-
-    /**
-     * for embedding other JsonDataNode objects within this one
-     *
-     * @param JsonDataNode $data_node
-     * @throws DomainException
-     */
-    public function addDataNode(JsonDataNode $data_node)
-    {
-        if ($data_node->isNotInitialized()) {
-            // $data_node->initialize();
-            $key = $data_node->nodeName();
-            $this->addData($key, $data_node);
-            // if the node being added specifies a domain (use case)
-            // and this is the primary data node, then set the domain
-            if ($this instanceof PrimaryJsonDataNode && $data_node->domain()) {
-                $this->setDomain($data_node->domain());
-            }
-        }
-    }
-
-
-    /**
-     * sets the domain (use case) that this data node provides data for
-     *
-     * @param string $domain
-     * @throws DomainException
-     */
-    protected function setDomain(string $domain)
-    {
-        if ($this->domain !== '') {
-            $this->validator->overwriteError($domain, 'domain route');
-        }
-        $this->domain = $domain;
-    }
-
-
-    /**
-     * used to mark the data node as having been processed
-     *
-     * @param bool $initialized
-     */
-    protected function setInitialized(bool $initialized)
-    {
-        $this->initialized = filter_var($initialized, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * self explanatory (i hope)
-     *
-     * @param string $node_name
-     * @throws DomainException
-     */
-    protected function setNodeName(string $node_name)
-    {
-        $this->validator->validateCriticalProperty($node_name, 'node name');
-        $this->node_name = $node_name;
-        // by default set the data node order property by the alphabetical position of the first letter of its name
-        // we do this by passing the node name (in UPPERCASE) to ord() to get its ASCII position
-        // then we subtract 64 (cuz A has a position of 65) then multiply by 10 just to space things out a bit.
-        // this allows a data node to set its order upon construction to some other value
-        // so that it can squeak into whatever position it needs to be in, like 55
-        $this->setOrder((ord(strtoupper($this->node_name)) - 64) * 10);
-    }
-
-
-    /**
-     * the actual data in key value array format
-     *
-     * @param bool $sort
-     * @return array
-     */
-    public function data(bool $sort = false): array
-    {
-        if ($sort) {
-            // check if data array has non-numerical keys and use a custom sort algorithm, else sort by keys
-            EEH_Array::is_associative_array($this->data)
-                ? uasort(
-                $this->data,
-                function ($a, $b) {
-                    // check if each incoming argument is a node and if they have an order set
-                    // if so, then use that for our sorting comparison. otherwise use the node's name...
-                    // unless it's NOT a node, in which case use the arg value if it is scalar, or 0 if not.
-                    if ($a instanceof JsonDataNode) {
-                        $a_ord = $a->order() ?: $a->nodeName();
-                    } else {
-                        $a_ord = is_scalar($a) ?: 0;
-                    }
-                    if ($b instanceof JsonDataNode) {
-                        $b_ord = $b->order() ?: $b->nodeName();
-                    } else {
-                        $b_ord = is_scalar($b) ?: 0;
-                    }
-                    return $a_ord <=> $b_ord;
-                }
-            )
-                // sort numerically indexed arrays by their keys
-                : ksort($this->data);
-        }
-        return $this->data;
-    }
-
-
-    /**
-     * the domain (use case) that this data node provides data for
-     *
-     * @return string
-     */
-    public function domain(): string
-    {
-        return $this->domain;
-    }
-
-
-    /**
-     * true if the data node has been initialized,
-     * which entails retrieving the required data and adding it to the data node data array
-     *
-     * @return bool
-     */
-    public function isInitialized(): bool
-    {
-        return $this->initialized;
-    }
-
-
-    /**
-     * true if the data node has NOT been initialized
-     *
-     * @return bool
-     */
-    public function isNotInitialized(): bool
-    {
-        return ! $this->initialized;
-    }
-
-
-    /**
-     * Specify data which should be serialized to JSON
-     *
-     * @link  https://php.net/manual/en/jsonserializable.jsonserialize.php
-     * @return array data which can be serialized by json_encode
-     */
-    public function jsonSerialize(): array
-    {
-        return $this->data;
-    }
-
-
-    /**
-     * self explanatory (i hope)
-     *
-     * @return string
-     */
-    public function nodeName(): string
-    {
-        return $this->node_name;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order(): ?int
-    {
-        return $this->order;
-    }
-
-
-    /**
-     * @param int $order
-     */
-    protected function setOrder(int $order): void
-    {
-        $this->order = absint($order);
-    }
+	/**
+	 * @var JsonDataNodeValidator
+	 */
+	protected $validator;
+
+	/**
+	 * @var array
+	 */
+	private $data = [];
+
+	/**
+	 * @var string
+	 */
+	private $domain = '';
+
+	/**
+	 * @var boolean
+	 */
+	private $initialized = false;
+
+	/**
+	 * @var string
+	 */
+	private $node_name = '';
+
+	/**
+	 * @var int
+	 */
+	private $order = 50;
+
+
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 * @throws DomainException
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		$this->validator = $validator;
+	}
+
+
+	/**
+	 * for adding primitive data like arrays, integers, or strings
+	 *
+	 * @param string $key
+	 * @param mixed  $data
+	 * @throws DomainException
+	 */
+	protected function addData(string $key, $data)
+	{
+		if ($this->validator->propertyNotSet($this->data, $key)) {
+			$this->data[ $key ] = $data;
+		}
+	}
+
+
+	/**
+	 * for setting value of the entire data array for the node
+	 *
+	 * @param array $data
+	 * @throws DomainException
+	 */
+	protected function setDataArray(array $data)
+	{
+		if ($this->validator->dataArrayEmpty($this)) {
+			$this->data = $data;
+		}
+	}
+
+
+	/**
+	 * for embedding other JsonDataNode objects within this one
+	 *
+	 * @param JsonDataNode $data_node
+	 * @throws DomainException
+	 */
+	public function addDataNode(JsonDataNode $data_node)
+	{
+		if ($data_node->isNotInitialized()) {
+			// $data_node->initialize();
+			$key = $data_node->nodeName();
+			$this->addData($key, $data_node);
+			// if the node being added specifies a domain (use case)
+			// and this is the primary data node, then set the domain
+			if ($this instanceof PrimaryJsonDataNode && $data_node->domain()) {
+				$this->setDomain($data_node->domain());
+			}
+		}
+	}
+
+
+	/**
+	 * sets the domain (use case) that this data node provides data for
+	 *
+	 * @param string $domain
+	 * @throws DomainException
+	 */
+	protected function setDomain(string $domain)
+	{
+		if ($this->domain !== '') {
+			$this->validator->overwriteError($domain, 'domain route');
+		}
+		$this->domain = $domain;
+	}
+
+
+	/**
+	 * used to mark the data node as having been processed
+	 *
+	 * @param bool $initialized
+	 */
+	protected function setInitialized(bool $initialized)
+	{
+		$this->initialized = filter_var($initialized, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * self explanatory (i hope)
+	 *
+	 * @param string $node_name
+	 * @throws DomainException
+	 */
+	protected function setNodeName(string $node_name)
+	{
+		$this->validator->validateCriticalProperty($node_name, 'node name');
+		$this->node_name = $node_name;
+		// by default set the data node order property by the alphabetical position of the first letter of its name
+		// we do this by passing the node name (in UPPERCASE) to ord() to get its ASCII position
+		// then we subtract 64 (cuz A has a position of 65) then multiply by 10 just to space things out a bit.
+		// this allows a data node to set its order upon construction to some other value
+		// so that it can squeak into whatever position it needs to be in, like 55
+		$this->setOrder((ord(strtoupper($this->node_name)) - 64) * 10);
+	}
+
+
+	/**
+	 * the actual data in key value array format
+	 *
+	 * @param bool $sort
+	 * @return array
+	 */
+	public function data(bool $sort = false): array
+	{
+		if ($sort) {
+			// check if data array has non-numerical keys and use a custom sort algorithm, else sort by keys
+			EEH_Array::is_associative_array($this->data)
+				? uasort(
+				$this->data,
+				function ($a, $b) {
+					// check if each incoming argument is a node and if they have an order set
+					// if so, then use that for our sorting comparison. otherwise use the node's name...
+					// unless it's NOT a node, in which case use the arg value if it is scalar, or 0 if not.
+					if ($a instanceof JsonDataNode) {
+						$a_ord = $a->order() ?: $a->nodeName();
+					} else {
+						$a_ord = is_scalar($a) ?: 0;
+					}
+					if ($b instanceof JsonDataNode) {
+						$b_ord = $b->order() ?: $b->nodeName();
+					} else {
+						$b_ord = is_scalar($b) ?: 0;
+					}
+					return $a_ord <=> $b_ord;
+				}
+			)
+				// sort numerically indexed arrays by their keys
+				: ksort($this->data);
+		}
+		return $this->data;
+	}
+
+
+	/**
+	 * the domain (use case) that this data node provides data for
+	 *
+	 * @return string
+	 */
+	public function domain(): string
+	{
+		return $this->domain;
+	}
+
+
+	/**
+	 * true if the data node has been initialized,
+	 * which entails retrieving the required data and adding it to the data node data array
+	 *
+	 * @return bool
+	 */
+	public function isInitialized(): bool
+	{
+		return $this->initialized;
+	}
+
+
+	/**
+	 * true if the data node has NOT been initialized
+	 *
+	 * @return bool
+	 */
+	public function isNotInitialized(): bool
+	{
+		return ! $this->initialized;
+	}
+
+
+	/**
+	 * Specify data which should be serialized to JSON
+	 *
+	 * @link  https://php.net/manual/en/jsonserializable.jsonserialize.php
+	 * @return array data which can be serialized by json_encode
+	 */
+	public function jsonSerialize(): array
+	{
+		return $this->data;
+	}
+
+
+	/**
+	 * self explanatory (i hope)
+	 *
+	 * @return string
+	 */
+	public function nodeName(): string
+	{
+		return $this->node_name;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order(): ?int
+	{
+		return $this->order;
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	protected function setOrder(int $order): void
+	{
+		$this->order = absint($order);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
     protected function addData(string $key, $data)
     {
         if ($this->validator->propertyNotSet($this->data, $key)) {
-            $this->data[ $key ] = $data;
+            $this->data[$key] = $data;
         }
     }
 
@@ -168,7 +168,7 @@ 
             EEH_Array::is_associative_array($this->data)
                 ? uasort(
                 $this->data,
-                function ($a, $b) {
+                function($a, $b) {
                     // check if each incoming argument is a node and if they have an order set
                     // if so, then use that for our sorting comparison. otherwise use the node's name...
                     // unless it's NOT a node, in which case use the arg value if it is scalar, or 0 if not.

core/services/json/JsonDataNodeHandler.php

Indentation +123 added lines, -123 removed lines

@@ -18,127 +18,127 @@
 class JsonDataNodeHandler
 {
 
-    /**
-     * @var PrimaryJsonDataNode $primary_data_node
-     */
-    private $primary_data_node;
-
-    /**
-     * @var JsonDataNodeValidator $validator
-     */
-    private $validator;
-
-
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        $this->validator = $validator;
-    }
-
-
-    /**
-     * @param JsonDataNode $data_node
-     * @throws DomainException
-     */
-    public function addDataNode(JsonDataNode $data_node)
-    {
-        if ($data_node->isNotInitialized()) {
-            $this->validatePrimaryDataNode($data_node);
-            $this->primary_data_node->addDataNode($data_node);
-        }
-    }
-
-
-    /**
-     * @param PrimaryJsonDataNode $primary_data_node
-     */
-    public function setPrimaryDataNode(PrimaryJsonDataNode $primary_data_node)
-    {
-        $this->primary_data_node = $primary_data_node;
-    }
-
-
-    /**
-     * @param JsonDataNode $data_node
-     * @param int                $depth
-     * @return array
-     */
-    private function initializeDataNodes(JsonDataNode $data_node, int $depth = 0): array
-    {
-        $depth++;
-        $data = [];
-        // initialize the data node if not done already
-        if ($data_node->isNotInitialized()) {
-            $data_node->initialize();
-            // loop thru the data node's data array
-            foreach ($data_node->data(true) as $child_node_name => $child_node) {
-                // don't parse node if it's the primary, OR if depth has exceeded wp_json_encode() limit
-                if ($child_node instanceof PrimaryJsonDataNode || $depth > 512) {
-                    continue;
-                }
-                $data[ $child_node_name ] = $child_node instanceof JsonDataNode
-                    // feed data node back into this function
-                    ? $this->initializeDataNodes($child_node, $depth)
-                    // or assign data directly
-                    : $child_node;
-            }
-        }
-        return $data;
-    }
-
-
-    /**
-     * @throws DomainException
-     */
-    public function printDataNode()
-    {
-        if (!$this->primary_data_node instanceof PrimaryJsonDataNode) {
-            return;
-        }
-        // validate that the domain, node name, and target script are set
-        $domain = $this->primary_data_node->domain();
-        $node_name = $this->primary_data_node->nodeName();
-        $data_valid =  $this->validator->validateCriticalProperty($domain, 'domain route', false)
-                       && $this->validator->validateCriticalProperty($node_name, 'node name', false);
-        if (! $data_valid) {
-            return;
-        }
-        // initialize and parse data from primary data node
-        $data = $this->initializeDataNodes($this->primary_data_node);
-        // this prepends the current domain "use case" to the front of the array
-        $data = ['domain' => $domain] + $data;
-        // add legacy i18n strings
-        $data['eei18n'] = EE_Registry::$i18n_js_strings;
-        // and finally, print the JSON encoded data to the DOM
-        printf(
-            "<script type='text/javascript' id='%s'>\nvar %s = %s\n</script>\n",
-            $node_name,
-            $node_name,
-            json_encode($data)
-        );
-    }
-
-
-    /**
-     * @param JsonDataNode $data_node
-     * @throws DomainException
-     */
-    private function validatePrimaryDataNode(JsonDataNode $data_node)
-    {
-        // set primary data node if that's what the incoming node is
-        if ($data_node instanceof PrimaryJsonDataNode) {
-            $this->setPrimaryDataNode($data_node);
-        }
-        // and don't allow other nodes to be set until a primary is set
-        if (! $this->primary_data_node instanceof PrimaryJsonDataNode) {
-            throw new DomainException(
-                esc_html__(
-                    'A PrimaryJsonDataNode needs to be set before data nodes can be added.',
-                    'event_espresso'
-                )
-            );
-        }
-    }
+	/**
+	 * @var PrimaryJsonDataNode $primary_data_node
+	 */
+	private $primary_data_node;
+
+	/**
+	 * @var JsonDataNodeValidator $validator
+	 */
+	private $validator;
+
+
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		$this->validator = $validator;
+	}
+
+
+	/**
+	 * @param JsonDataNode $data_node
+	 * @throws DomainException
+	 */
+	public function addDataNode(JsonDataNode $data_node)
+	{
+		if ($data_node->isNotInitialized()) {
+			$this->validatePrimaryDataNode($data_node);
+			$this->primary_data_node->addDataNode($data_node);
+		}
+	}
+
+
+	/**
+	 * @param PrimaryJsonDataNode $primary_data_node
+	 */
+	public function setPrimaryDataNode(PrimaryJsonDataNode $primary_data_node)
+	{
+		$this->primary_data_node = $primary_data_node;
+	}
+
+
+	/**
+	 * @param JsonDataNode $data_node
+	 * @param int                $depth
+	 * @return array
+	 */
+	private function initializeDataNodes(JsonDataNode $data_node, int $depth = 0): array
+	{
+		$depth++;
+		$data = [];
+		// initialize the data node if not done already
+		if ($data_node->isNotInitialized()) {
+			$data_node->initialize();
+			// loop thru the data node's data array
+			foreach ($data_node->data(true) as $child_node_name => $child_node) {
+				// don't parse node if it's the primary, OR if depth has exceeded wp_json_encode() limit
+				if ($child_node instanceof PrimaryJsonDataNode || $depth > 512) {
+					continue;
+				}
+				$data[ $child_node_name ] = $child_node instanceof JsonDataNode
+					// feed data node back into this function
+					? $this->initializeDataNodes($child_node, $depth)
+					// or assign data directly
+					: $child_node;
+			}
+		}
+		return $data;
+	}
+
+
+	/**
+	 * @throws DomainException
+	 */
+	public function printDataNode()
+	{
+		if (!$this->primary_data_node instanceof PrimaryJsonDataNode) {
+			return;
+		}
+		// validate that the domain, node name, and target script are set
+		$domain = $this->primary_data_node->domain();
+		$node_name = $this->primary_data_node->nodeName();
+		$data_valid =  $this->validator->validateCriticalProperty($domain, 'domain route', false)
+					   && $this->validator->validateCriticalProperty($node_name, 'node name', false);
+		if (! $data_valid) {
+			return;
+		}
+		// initialize and parse data from primary data node
+		$data = $this->initializeDataNodes($this->primary_data_node);
+		// this prepends the current domain "use case" to the front of the array
+		$data = ['domain' => $domain] + $data;
+		// add legacy i18n strings
+		$data['eei18n'] = EE_Registry::$i18n_js_strings;
+		// and finally, print the JSON encoded data to the DOM
+		printf(
+			"<script type='text/javascript' id='%s'>\nvar %s = %s\n</script>\n",
+			$node_name,
+			$node_name,
+			json_encode($data)
+		);
+	}
+
+
+	/**
+	 * @param JsonDataNode $data_node
+	 * @throws DomainException
+	 */
+	private function validatePrimaryDataNode(JsonDataNode $data_node)
+	{
+		// set primary data node if that's what the incoming node is
+		if ($data_node instanceof PrimaryJsonDataNode) {
+			$this->setPrimaryDataNode($data_node);
+		}
+		// and don't allow other nodes to be set until a primary is set
+		if (! $this->primary_data_node instanceof PrimaryJsonDataNode) {
+			throw new DomainException(
+				esc_html__(
+					'A PrimaryJsonDataNode needs to be set before data nodes can be added.',
+					'event_espresso'
+				)
+			);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -78,7 +78,7 @@ 
                 if ($child_node instanceof PrimaryJsonDataNode || $depth > 512) {
                     continue;
                 }
-                $data[ $child_node_name ] = $child_node instanceof JsonDataNode
+                $data[$child_node_name] = $child_node instanceof JsonDataNode
                     // feed data node back into this function
                     ? $this->initializeDataNodes($child_node, $depth)
                     // or assign data directly
@@ -94,15 +94,15 @@ 
      */
     public function printDataNode()
     {
-        if (!$this->primary_data_node instanceof PrimaryJsonDataNode) {
+        if ( ! $this->primary_data_node instanceof PrimaryJsonDataNode) {
             return;
         }
         // validate that the domain, node name, and target script are set
         $domain = $this->primary_data_node->domain();
         $node_name = $this->primary_data_node->nodeName();
-        $data_valid =  $this->validator->validateCriticalProperty($domain, 'domain route', false)
+        $data_valid = $this->validator->validateCriticalProperty($domain, 'domain route', false)
                        && $this->validator->validateCriticalProperty($node_name, 'node name', false);
-        if (! $data_valid) {
+        if ( ! $data_valid) {
             return;
         }
         // initialize and parse data from primary data node
@@ -132,7 +132,7 @@ 
             $this->setPrimaryDataNode($data_node);
         }
         // and don't allow other nodes to be set until a primary is set
-        if (! $this->primary_data_node instanceof PrimaryJsonDataNode) {
+        if ( ! $this->primary_data_node instanceof PrimaryJsonDataNode) {
             throw new DomainException(
                 esc_html__(
                     'A PrimaryJsonDataNode needs to be set before data nodes can be added.',

core/helpers/EEH_Array.helper.php

Indentation +199 added lines, -199 removed lines

@@ -13,203 +13,203 @@
 {
 
 
-    /**
-     * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
-     * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
-     *
-     * @uses array_udiff core php function for setting up our own array comparison
-     * @uses self::_compare_objects as the custom method for array_udiff
-     * @param  array $array1 an array of objects
-     * @param  array $array2 an array of objects
-     * @return array         an array of objects found in array 1 that aren't found in array 2.
-     */
-    public static function object_array_diff($array1, $array2)
-    {
-        return array_udiff($array1, $array2, array('self', '_compare_objects'));
-    }
-
-    /**
-     * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
-     *
-     * @param array $array
-     * @return boolean
-     */
-    public static function is_associative_array(array $array): bool
-    {
-        return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
-    }
-
-    /**
-     * Gets an item from the array and leave the array intact. Use in place of end()
-     * when you don't want to change the array
-     *
-     * @param array $arr
-     * @return mixed what ever is in the array
-     */
-    public static function get_one_item_from_array($arr)
-    {
-        $item = end($arr);
-        reset($arr);
-        return $item;
-    }
-
-    /**
-     * Detects if this is a multi-dimensional array (meaning that the top-level
-     * values are themselves array. Eg array(array(...),...)
-     *
-     * @param mixed $arr
-     * @return boolean
-     */
-    public static function is_multi_dimensional_array($arr)
-    {
-        if (is_array($arr)) {
-            $first_item = reset($arr);
-            if (is_array($first_item)) {
-                return true;// yep, there's at least 2 levels to this array
-            } else {
-                return false;// nope, only 1 level
-            }
-        } else {
-            return false;// its not an array at all!
-        }
-    }
-
-    /**
-     * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
-     *
-     * @param array $arr
-     * @param mixed $index
-     * @param mixed $default
-     * @return mixed
-     */
-    public static function is_set($arr, $index, $default)
-    {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
-    }
-
-    /**
-     * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
-     *
-     * @param mixed $value usually a string, but could be an array or object
-     * @return mixed the UN-serialized data
-     */
-    public static function maybe_unserialize($value)
-    {
-        $data = maybe_unserialize($value);
-        // it's possible that this still has serialized data if its the session.  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesnt' unserialize this automatically.
-        $token = 'C';
-        $data = is_string($data) ? trim($data) : $data;
-        if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
-            return unserialize($data);
-        } else {
-            return $data;
-        }
-    }
-
-
-    /**
-     * insert_into_array
-     *
-     * @param array        $target_array the array to insert new data into
-     * @param array        $array_to_insert the new data to be inserted
-     * @param int | string $offset a known key within $target_array where new data will be inserted
-     * @param bool         $add_before whether to add new data before or after the offset key
-     * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
-     * @return array
-     */
-    public static function insert_into_array(
-        $target_array = array(),
-        $array_to_insert = array(),
-        $offset = null,
-        $add_before = true,
-        $preserve_keys = true
-    ) {
-        // ensure incoming arrays are actually arrays
-        $target_array = (array) $target_array;
-        $array_to_insert = (array) $array_to_insert;
-        // if no offset key was supplied
-        if (empty($offset)) {
-            // use start or end of $target_array based on whether we are adding before or not
-            $offset = $add_before ? 0 : count($target_array);
-        }
-        // if offset key is a string, then find the corresponding numeric location for that element
-        $offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
-        // add one to the offset if adding after
-        $offset = $add_before ? $offset : $offset + 1;
-        // but ensure offset does not exceed the length of the array
-        $offset = $offset > count($target_array) ? count($target_array) : $offset;
-        // reindex array ???
-        if ($preserve_keys) {
-            // take a slice of the target array from the beginning till the offset,
-            // then add the new data
-            // then add another slice that starts at the offset and goes till the end
-            return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
-                $target_array,
-                $offset,
-                null,
-                true
-            );
-        } else {
-            // since we don't want to preserve keys, we can use array_splice
-            array_splice($target_array, $offset, 0, $array_to_insert);
-            return $target_array;
-        }
-    }
-
-
-    /**
-     * array_merge() is slow and should never be used while looping over data
-     * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
-     * so really this acts more like array_replace( $array1, $array2 )
-     * or a union with the arrays flipped ( $array2 + $array1 )
-     * this saves a few lines of code and improves readability
-     *
-     * @param array $array1
-     * @param array $array2
-     * @return array
-     */
-    public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
-    {
-        foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
-        }
-        return $array1;
-    }
-
-
-    /**
-     * given a flat array like $array = array('A', 'B', 'C')
-     * will convert into a multidimensional array like $array[A][B][C]
-     * if $final_value is provided and is anything other than null,
-     * then that will be set as the value for the innermost array key
-     * like so: $array[A][B][C] = $final_value
-     *
-     * @param array $flat_array
-     * @param mixed $final_value
-     * @return array
-     */
-    public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
-    {
-        $multidimensional = array();
-        $reference = &$multidimensional;
-        foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
-        }
-        if ($final_value !== null) {
-            $reference = $final_value;
-        }
-        return $multidimensional;
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    public static function is_array_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
-    }
+	/**
+	 * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
+	 * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
+	 *
+	 * @uses array_udiff core php function for setting up our own array comparison
+	 * @uses self::_compare_objects as the custom method for array_udiff
+	 * @param  array $array1 an array of objects
+	 * @param  array $array2 an array of objects
+	 * @return array         an array of objects found in array 1 that aren't found in array 2.
+	 */
+	public static function object_array_diff($array1, $array2)
+	{
+		return array_udiff($array1, $array2, array('self', '_compare_objects'));
+	}
+
+	/**
+	 * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	public static function is_associative_array(array $array): bool
+	{
+		return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
+	}
+
+	/**
+	 * Gets an item from the array and leave the array intact. Use in place of end()
+	 * when you don't want to change the array
+	 *
+	 * @param array $arr
+	 * @return mixed what ever is in the array
+	 */
+	public static function get_one_item_from_array($arr)
+	{
+		$item = end($arr);
+		reset($arr);
+		return $item;
+	}
+
+	/**
+	 * Detects if this is a multi-dimensional array (meaning that the top-level
+	 * values are themselves array. Eg array(array(...),...)
+	 *
+	 * @param mixed $arr
+	 * @return boolean
+	 */
+	public static function is_multi_dimensional_array($arr)
+	{
+		if (is_array($arr)) {
+			$first_item = reset($arr);
+			if (is_array($first_item)) {
+				return true;// yep, there's at least 2 levels to this array
+			} else {
+				return false;// nope, only 1 level
+			}
+		} else {
+			return false;// its not an array at all!
+		}
+	}
+
+	/**
+	 * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
+	 *
+	 * @param array $arr
+	 * @param mixed $index
+	 * @param mixed $default
+	 * @return mixed
+	 */
+	public static function is_set($arr, $index, $default)
+	{
+		return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+	}
+
+	/**
+	 * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
+	 *
+	 * @param mixed $value usually a string, but could be an array or object
+	 * @return mixed the UN-serialized data
+	 */
+	public static function maybe_unserialize($value)
+	{
+		$data = maybe_unserialize($value);
+		// it's possible that this still has serialized data if its the session.  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesnt' unserialize this automatically.
+		$token = 'C';
+		$data = is_string($data) ? trim($data) : $data;
+		if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
+			return unserialize($data);
+		} else {
+			return $data;
+		}
+	}
+
+
+	/**
+	 * insert_into_array
+	 *
+	 * @param array        $target_array the array to insert new data into
+	 * @param array        $array_to_insert the new data to be inserted
+	 * @param int | string $offset a known key within $target_array where new data will be inserted
+	 * @param bool         $add_before whether to add new data before or after the offset key
+	 * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
+	 * @return array
+	 */
+	public static function insert_into_array(
+		$target_array = array(),
+		$array_to_insert = array(),
+		$offset = null,
+		$add_before = true,
+		$preserve_keys = true
+	) {
+		// ensure incoming arrays are actually arrays
+		$target_array = (array) $target_array;
+		$array_to_insert = (array) $array_to_insert;
+		// if no offset key was supplied
+		if (empty($offset)) {
+			// use start or end of $target_array based on whether we are adding before or not
+			$offset = $add_before ? 0 : count($target_array);
+		}
+		// if offset key is a string, then find the corresponding numeric location for that element
+		$offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
+		// add one to the offset if adding after
+		$offset = $add_before ? $offset : $offset + 1;
+		// but ensure offset does not exceed the length of the array
+		$offset = $offset > count($target_array) ? count($target_array) : $offset;
+		// reindex array ???
+		if ($preserve_keys) {
+			// take a slice of the target array from the beginning till the offset,
+			// then add the new data
+			// then add another slice that starts at the offset and goes till the end
+			return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
+				$target_array,
+				$offset,
+				null,
+				true
+			);
+		} else {
+			// since we don't want to preserve keys, we can use array_splice
+			array_splice($target_array, $offset, 0, $array_to_insert);
+			return $target_array;
+		}
+	}
+
+
+	/**
+	 * array_merge() is slow and should never be used while looping over data
+	 * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
+	 * so really this acts more like array_replace( $array1, $array2 )
+	 * or a union with the arrays flipped ( $array2 + $array1 )
+	 * this saves a few lines of code and improves readability
+	 *
+	 * @param array $array1
+	 * @param array $array2
+	 * @return array
+	 */
+	public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
+	{
+		foreach ($array2 as $key => $value) {
+			$array1[ $key ] = $value;
+		}
+		return $array1;
+	}
+
+
+	/**
+	 * given a flat array like $array = array('A', 'B', 'C')
+	 * will convert into a multidimensional array like $array[A][B][C]
+	 * if $final_value is provided and is anything other than null,
+	 * then that will be set as the value for the innermost array key
+	 * like so: $array[A][B][C] = $final_value
+	 *
+	 * @param array $flat_array
+	 * @param mixed $final_value
+	 * @return array
+	 */
+	public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
+	{
+		$multidimensional = array();
+		$reference = &$multidimensional;
+		foreach ($flat_array as $key) {
+			$reference[ $key ] = array();
+			$reference = &$reference[ $key ];
+		}
+		if ($final_value !== null) {
+			$reference = $final_value;
+		}
+		return $multidimensional;
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	public static function is_array_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
+	}
 }