eventespresso / event-espresso-core

core/domain/entities/routing/data_nodes/core/CurrentUser.php

Indentation +35 added lines, -35 removed lines

@@ -16,43 +16,43 @@
  */
 class CurrentUser extends JsonDataNode
 {
-    const NODE_NAME = 'currentUser';
+	const NODE_NAME = 'currentUser';
 
 
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        if (! class_exists('WPGraphQL')) {
-            require_once EE_THIRD_PARTY . 'wp-graphql/wp-graphql.php';
-        }
-        parent::__construct($validator);
-        $this->setNodeName(CurrentUser::NODE_NAME);
-    }
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		if (! class_exists('WPGraphQL')) {
+			require_once EE_THIRD_PARTY . 'wp-graphql/wp-graphql.php';
+		}
+		parent::__construct($validator);
+		$this->setNodeName(CurrentUser::NODE_NAME);
+	}
 
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $current_user = wp_get_current_user();
-        if (! $current_user instanceof WP_User) {
-            $current_user = new WP_User();
-        }
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$current_user = wp_get_current_user();
+		if (! $current_user instanceof WP_User) {
+			$current_user = new WP_User();
+		}
 
-        $this->addData('id', Relay::toGlobalId('user', $current_user->ID));
-        $this->addData('databaseId', $current_user->ID);
-        $this->addData('description', $current_user->description);
-        $this->addData('email', $current_user->user_email);
-        $this->addData('firstName', $current_user->first_name);
-        $this->addData('lastName', $current_user->last_name);
-        $this->addData('locale', get_user_locale($current_user->ID));
-        $this->addData('name', $current_user->display_name);
-        $this->addData('nicename', $current_user->user_nicename);
-        $this->addData('nickname', $current_user->nickname);
-        $this->addData('username', $current_user->user_login);
-        $this->addData('__typename', 'User');
-        $this->setInitialized(true);
-    }
+		$this->addData('id', Relay::toGlobalId('user', $current_user->ID));
+		$this->addData('databaseId', $current_user->ID);
+		$this->addData('description', $current_user->description);
+		$this->addData('email', $current_user->user_email);
+		$this->addData('firstName', $current_user->first_name);
+		$this->addData('lastName', $current_user->last_name);
+		$this->addData('locale', get_user_locale($current_user->ID));
+		$this->addData('name', $current_user->display_name);
+		$this->addData('nicename', $current_user->user_nicename);
+		$this->addData('nickname', $current_user->nickname);
+		$this->addData('username', $current_user->user_login);
+		$this->addData('__typename', 'User');
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/routing/data_nodes/core/GeneralSettings.php

Indentation +24 added lines, -24 removed lines

@@ -15,28 +15,28 @@
 class GeneralSettings extends JsonDataNode
 {
 
-    const NODE_NAME = 'generalSettings';
-
-
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->setNodeName(GeneralSettings::NODE_NAME);
-    }
-
-
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $this->addData('dateFormat', get_option('date_format'));
-        $this->addData('timeFormat', get_option('time_format'));
-        $this->addData('timezone', get_option('timezone_string'));
-        $this->addData('__typename', 'GeneralSettings');
-        $this->setInitialized(true);
-    }
+	const NODE_NAME = 'generalSettings';
+
+
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->setNodeName(GeneralSettings::NODE_NAME);
+	}
+
+
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$this->addData('dateFormat', get_option('date_format'));
+		$this->addData('timeFormat', get_option('time_format'));
+		$this->addData('timezone', get_option('timezone_string'));
+		$this->addData('__typename', 'GeneralSettings');
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/routing/data_nodes/core/SiteUrls.php

Indentation +22 added lines, -22 removed lines

@@ -16,26 +16,26 @@
 class SiteUrls extends JsonDataNode
 {
 
-    const NODE_NAME = 'siteUrls';
-
-
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->setNodeName(SiteUrls::NODE_NAME);
-    }
-
-
-    /**
-     * @since $VID:$
-     */
-    public function initialize()
-    {
-        $this->addData('admin', admin_url('/'));
-        $this->addData('home', site_url('/'));
-        $this->setInitialized(true);
-    }
+	const NODE_NAME = 'siteUrls';
+
+
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->setNodeName(SiteUrls::NODE_NAME);
+	}
+
+
+	/**
+	 * @since $VID:$
+	 */
+	public function initialize()
+	{
+		$this->addData('admin', admin_url('/'));
+		$this->addData('home', site_url('/'));
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/routing/data_nodes/core/Locale.php

Indentation +23 added lines, -23 removed lines

@@ -17,30 +17,30 @@
 class Locale extends JsonDataNode
 {
 
-    const NODE_NAME = 'locale';
+	const NODE_NAME = 'locale';
 
 
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->setNodeName(Locale::NODE_NAME);
-    }
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->setNodeName(Locale::NODE_NAME);
+	}
 
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $this->addData('user', get_user_locale());
-        $this->addData('site', get_locale());
-        $this->addData('siteTimezone', [
-            'city'   => EEH_DTT_Helper::get_timezone_string_for_display(),
-            'name'   => get_option('timezone_string'),
-            'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-        ]);
-        $this->setInitialized(true);
-    }
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$this->addData('user', get_user_locale());
+		$this->addData('site', get_locale());
+		$this->addData('siteTimezone', [
+			'city'   => EEH_DTT_Helper::get_timezone_string_for_display(),
+			'name'   => get_option('timezone_string'),
+			'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+		]);
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/routing/data_nodes/core/Api.php

Indentation +28 added lines, -28 removed lines

@@ -19,32 +19,32 @@
 class Api extends JsonDataNode
 {
 
-    const NODE_NAME = 'api';
-
-
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->setNodeName(Api::NODE_NAME);
-    }
-
-
-    /**
-     * @throws DomainException
-     * @since $VID:$
-     */
-    public function initialize()
-    {
-        $this->addData('restApiNonce', wp_create_nonce('wp_rest'));
-        $this->addData('restApiBaseUrl', rest_url());
-        $this->addData('restApiRouteUrl', rest_url('ee/v4.8.36/'));
-        $this->addData('restApiCollectionEndpoints', EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName());
-        $this->addData('restApiPrimaryKeys', EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName());
-        $graphqlEndpoint = class_exists('WPGraphQL') ? trailingslashit(site_url()) . Router::$route : '';
-        $this->addData('graphqlEndpoint', esc_url($graphqlEndpoint));
-        $this->setInitialized(true);
-    }
+	const NODE_NAME = 'api';
+
+
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->setNodeName(Api::NODE_NAME);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @since $VID:$
+	 */
+	public function initialize()
+	{
+		$this->addData('restApiNonce', wp_create_nonce('wp_rest'));
+		$this->addData('restApiBaseUrl', rest_url());
+		$this->addData('restApiRouteUrl', rest_url('ee/v4.8.36/'));
+		$this->addData('restApiCollectionEndpoints', EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName());
+		$this->addData('restApiPrimaryKeys', EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName());
+		$graphqlEndpoint = class_exists('WPGraphQL') ? trailingslashit(site_url()) . Router::$route : '';
+		$this->addData('graphqlEndpoint', esc_url($graphqlEndpoint));
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/routing/data_nodes/EventEspressoData.php

Indentation +38 added lines, -38 removed lines

@@ -21,49 +21,49 @@
 class EventEspressoData extends PrimaryJsonDataNode
 {
 
-    const NODE_NAME = 'eventEspressoData';
+	const NODE_NAME = 'eventEspressoData';
 
-    /**
-     * @var Api $api
-     */
-    private $api;
+	/**
+	 * @var Api $api
+	 */
+	private $api;
 
-    /**
-     * @var Config $config
-     */
-    private $config;
+	/**
+	 * @var Config $config
+	 */
+	private $config;
 
-    /**
-     * @var JedLocaleData $jed_locale
-     */
-    private $jed_locale;
+	/**
+	 * @var JedLocaleData $jed_locale
+	 */
+	private $jed_locale;
 
 
-    /**
-     * @param Api $api
-     * @param Config $config
-     * @param JedLocaleData         $jed_locale
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(Api $api, Config $config, JedLocaleData $jed_locale, JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->api = $api;
-        $this->config = $config;
-        $this->jed_locale = $jed_locale;
-        $this->setNodeName(EventEspressoData::NODE_NAME);
-    }
+	/**
+	 * @param Api $api
+	 * @param Config $config
+	 * @param JedLocaleData         $jed_locale
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(Api $api, Config $config, JedLocaleData $jed_locale, JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->api = $api;
+		$this->config = $config;
+		$this->jed_locale = $jed_locale;
+		$this->setNodeName(EventEspressoData::NODE_NAME);
+	}
 
 
-    /**
-     * @throws DomainException
-     * @since $VID:$
-     */
-    public function initialize()
-    {
-        $this->addDataNode($this->api);
-        $this->addDataNode($this->config);
-        $this->addData('i18n', $this->jed_locale->getData('event_espresso'));
-        $this->setInitialized(true);
-    }
+	/**
+	 * @throws DomainException
+	 * @since $VID:$
+	 */
+	public function initialize()
+	{
+		$this->addDataNode($this->api);
+		$this->addDataNode($this->config);
+		$this->addData('i18n', $this->jed_locale->getData('event_espresso'));
+		$this->setInitialized(true);
+	}
 }

core/services/json/JsonDataNodeHandler.php

Indentation +126 added lines, -126 removed lines

@@ -18,130 +18,130 @@
 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 mixed
-     * @since $VID:$
-     */
-    private function initializeDataNodes(JsonDataNode $data_node, $depth = 0)
-    {
-        $depth++;
-        $data = [];
-        // initialize the data node if not done already
-        if ($data_node->isNotInitialized()) {
-            $data_node->initialize();
-            // grab the data node's data array
-            $data_node_data = $data_node->data();
-            foreach ($data_node_data 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;
-                }
-                if ($child_node instanceof JsonDataNode) {
-                    // feed data node back into this function
-                    $data[ $child_node_name ] = $this->initializeDataNodes($child_node, $depth);
-                } else {
-                    // or assign data directly
-                    $data[ $child_node_name ] = $child_node;
-                }
-            }
-        }
-        return $data;
-    }
-
-
-    /**
-     * @throws DomainException
-     * @since $VID:$
-     */
-    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();
-        $target_script = $this->primary_data_node->targetScript();
-        $data_valid =  $this->validator->validateCriticalProperty($domain, 'domain route', false)
-                       && $this->validator->validateCriticalProperty($node_name, 'node name', false)
-                       && $this->validator->validateCriticalProperty($target_script, 'target script', 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 JSON encode the data and attach to the target script
-        $data = json_encode($data);
-        wp_add_inline_script($target_script, "var {$node_name}={$data};", 'before');
-    }
-
-
-    /**
-     * @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 mixed
+	 * @since $VID:$
+	 */
+	private function initializeDataNodes(JsonDataNode $data_node, $depth = 0)
+	{
+		$depth++;
+		$data = [];
+		// initialize the data node if not done already
+		if ($data_node->isNotInitialized()) {
+			$data_node->initialize();
+			// grab the data node's data array
+			$data_node_data = $data_node->data();
+			foreach ($data_node_data 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;
+				}
+				if ($child_node instanceof JsonDataNode) {
+					// feed data node back into this function
+					$data[ $child_node_name ] = $this->initializeDataNodes($child_node, $depth);
+				} else {
+					// or assign data directly
+					$data[ $child_node_name ] = $child_node;
+				}
+			}
+		}
+		return $data;
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @since $VID:$
+	 */
+	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();
+		$target_script = $this->primary_data_node->targetScript();
+		$data_valid =  $this->validator->validateCriticalProperty($domain, 'domain route', false)
+					   && $this->validator->validateCriticalProperty($node_name, 'node name', false)
+					   && $this->validator->validateCriticalProperty($target_script, 'target script', 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 JSON encode the data and attach to the target script
+		$data = json_encode($data);
+		wp_add_inline_script($target_script, "var {$node_name}={$data};", 'before');
+	}
+
+
+	/**
+	 * @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 +6 added lines, -6 removed lines

@@ -82,10 +82,10 @@ 
                 }
                 if ($child_node instanceof JsonDataNode) {
                     // feed data node back into this function
-                    $data[ $child_node_name ] = $this->initializeDataNodes($child_node, $depth);
+                    $data[$child_node_name] = $this->initializeDataNodes($child_node, $depth);
                 } else {
                     // or assign data directly
-                    $data[ $child_node_name ] = $child_node;
+                    $data[$child_node_name] = $child_node;
                 }
             }
         }
@@ -99,17 +99,17 @@ 
      */
     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();
         $target_script = $this->primary_data_node->targetScript();
-        $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)
                        && $this->validator->validateCriticalProperty($target_script, 'target script', false);
-        if (! $data_valid) {
+        if ( ! $data_valid) {
             return;
         }
         // initialize and parse data from primary data node
@@ -135,7 +135,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/services/json/JsonDataNode.php

Indentation +177 added lines, -177 removed lines

@@ -18,181 +18,181 @@
 abstract class JsonDataNode implements JsonDataNodeInterface
 {
 
-    /**
-     * @var JsonDataNodeValidator $validator
-     */
-    protected $validator;
-
-    /**
-     * @var array $data
-     */
-    private $data = [];
-
-    /**
-     * @var string $domain
-     */
-    private $domain;
-
-    /**
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-    /**
-     * @var string $node_name
-     */
-    private $node_name;
-
-
-    /**
-     * @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($key, $data)
-    {
-        if ($this->validator->propertyNotSet($this->data, $key)) {
-            $this->data[ $key ] = $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() !== null) {
-                $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($domain)
-    {
-        if ($this->domain !== null) {
-            $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($initialized)
-    {
-        $this->initialized = filter_var($initialized, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * self explanatory (i hope)
-     *
-     * @param string $node_name
-     * @throws DomainException
-     */
-    protected function setNodeName($node_name)
-    {
-        $this->validator->validateCriticalProperty($node_name, 'node name');
-        $this->node_name = $node_name;
-    }
-
-
-    /**
-     * the actual data in key value array format
-     *
-     * @return array
-     */
-    public function data()
-    {
-        return $this->data;
-    }
-
-
-    /**
-     * the domain (use case) that this data node provides data for
-     *
-     * @return string
-     */
-    public function domain()
-    {
-        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()
-    {
-        return $this->initialized;
-    }
-
-
-    /**
-     * true if the data node has NOT been initialized
-     *
-     * @return bool
-     */
-    public function isNotInitialized()
-    {
-        return ! $this->initialized;
-    }
-
-
-    /**
-     * Specify data which should be serialized to JSON
-     *
-     * @link  https://php.net/manual/en/jsonserializable.jsonserialize.php
-     * @return mixed data which can be serialized by json_encode
-     */
-    public function jsonSerialize()
-    {
-        return $this->data;
-    }
-
-
-    /**
-     * self explanatory (i hope)
-     *
-     * @return string
-     */
-    public function nodeName()
-    {
-        return $this->node_name;
-    }
+	/**
+	 * @var JsonDataNodeValidator $validator
+	 */
+	protected $validator;
+
+	/**
+	 * @var array $data
+	 */
+	private $data = [];
+
+	/**
+	 * @var string $domain
+	 */
+	private $domain;
+
+	/**
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+	/**
+	 * @var string $node_name
+	 */
+	private $node_name;
+
+
+	/**
+	 * @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($key, $data)
+	{
+		if ($this->validator->propertyNotSet($this->data, $key)) {
+			$this->data[ $key ] = $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() !== null) {
+				$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($domain)
+	{
+		if ($this->domain !== null) {
+			$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($initialized)
+	{
+		$this->initialized = filter_var($initialized, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * self explanatory (i hope)
+	 *
+	 * @param string $node_name
+	 * @throws DomainException
+	 */
+	protected function setNodeName($node_name)
+	{
+		$this->validator->validateCriticalProperty($node_name, 'node name');
+		$this->node_name = $node_name;
+	}
+
+
+	/**
+	 * the actual data in key value array format
+	 *
+	 * @return array
+	 */
+	public function data()
+	{
+		return $this->data;
+	}
+
+
+	/**
+	 * the domain (use case) that this data node provides data for
+	 *
+	 * @return string
+	 */
+	public function domain()
+	{
+		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()
+	{
+		return $this->initialized;
+	}
+
+
+	/**
+	 * true if the data node has NOT been initialized
+	 *
+	 * @return bool
+	 */
+	public function isNotInitialized()
+	{
+		return ! $this->initialized;
+	}
+
+
+	/**
+	 * Specify data which should be serialized to JSON
+	 *
+	 * @link  https://php.net/manual/en/jsonserializable.jsonserialize.php
+	 * @return mixed data which can be serialized by json_encode
+	 */
+	public function jsonSerialize()
+	{
+		return $this->data;
+	}
+
+
+	/**
+	 * self explanatory (i hope)
+	 *
+	 * @return string
+	 */
+	public function nodeName()
+	{
+		return $this->node_name;
+	}
 }

core/services/routing/RouteHandler.php

Indentation +117 added lines, -117 removed lines

@@ -20,124 +20,124 @@
 class RouteHandler
 {
 
-    /**
-     * @var JsonDataNodeHandler $data_node_handler
-     */
-    private $data_node_handler;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var RouteCollection $routes
-     */
-    private $routes;
-
-
-    /**
-     * RouteHandler constructor.
-     *
-     * @param JsonDataNodeHandler $data_node_handler
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     * @param RouteCollection $routes
-     */
-    public function __construct(
-        JsonDataNodeHandler $data_node_handler,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        RouteCollection $routes
-    ) {
-        $this->data_node_handler = $data_node_handler;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->routes = $routes;
-        if (! $this->request->isActivation()) {
-            add_action('admin_footer', [$this->data_node_handler, 'printDataNode']);
-            add_action('wp_footer', [$this->data_node_handler, 'printDataNode']);
-        }
-    }
-
-
-    /**
-     * @param string $fqcn   Fully Qualified Class Name for Route
-     * @param bool   $handle if true [default] will immediately call RouteInterface::handleRequest() after adding
-     * @throws Exception
-     * @since $VID:$
-     */
-    public function addRoute($fqcn, $handle = true)
-    {
-        try {
-            if ($this->request->isActivation()) {
-                return;
-            }
-            $route = $this->loader->getShared($fqcn);
-            $this->validateRoute($route, $fqcn);
-            $this->routes->add($route);
-            $this->handle($route, $handle);
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * @param RouteInterface $route
-     * @param bool $handle if true [default] will immediately call RouteInterface::handleRequest()
-     */
-    public function handle(RouteInterface $route, $handle = true)
-    {
-        if ($handle && $route->isNotHandled()) {
-            $route->handleRequest();
-            $data_node = $route->dataNode();
-            if ($data_node instanceof JsonDataNode) {
-                $this->data_node_handler->addDataNode($data_node);
-            }
-        }
-    }
-
-
-    /**
-     * calls RouteInterface::handleRequest() on all Routes that
-     *      - match current request
-     *      - have yet to be handled
-     *
-     * @return void
-     */
-    public function handleRoutesForCurrentRequest()
-    {
-        $this->routes->handleRoutesForCurrentRequest();
-    }
-
-
-    /**
-     * @param RouteInterface $route
-     * @param string         $fqcn
-     * @since $VID:$
-     */
-    private function validateRoute($route, $fqcn)
-    {
-        if (! $route instanceof RouteInterface) {
-            throw new InvalidClassException(
-                sprintf(
-                    /*
+	/**
+	 * @var JsonDataNodeHandler $data_node_handler
+	 */
+	private $data_node_handler;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var RouteCollection $routes
+	 */
+	private $routes;
+
+
+	/**
+	 * RouteHandler constructor.
+	 *
+	 * @param JsonDataNodeHandler $data_node_handler
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 * @param RouteCollection $routes
+	 */
+	public function __construct(
+		JsonDataNodeHandler $data_node_handler,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		RouteCollection $routes
+	) {
+		$this->data_node_handler = $data_node_handler;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->routes = $routes;
+		if (! $this->request->isActivation()) {
+			add_action('admin_footer', [$this->data_node_handler, 'printDataNode']);
+			add_action('wp_footer', [$this->data_node_handler, 'printDataNode']);
+		}
+	}
+
+
+	/**
+	 * @param string $fqcn   Fully Qualified Class Name for Route
+	 * @param bool   $handle if true [default] will immediately call RouteInterface::handleRequest() after adding
+	 * @throws Exception
+	 * @since $VID:$
+	 */
+	public function addRoute($fqcn, $handle = true)
+	{
+		try {
+			if ($this->request->isActivation()) {
+				return;
+			}
+			$route = $this->loader->getShared($fqcn);
+			$this->validateRoute($route, $fqcn);
+			$this->routes->add($route);
+			$this->handle($route, $handle);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * @param RouteInterface $route
+	 * @param bool $handle if true [default] will immediately call RouteInterface::handleRequest()
+	 */
+	public function handle(RouteInterface $route, $handle = true)
+	{
+		if ($handle && $route->isNotHandled()) {
+			$route->handleRequest();
+			$data_node = $route->dataNode();
+			if ($data_node instanceof JsonDataNode) {
+				$this->data_node_handler->addDataNode($data_node);
+			}
+		}
+	}
+
+
+	/**
+	 * calls RouteInterface::handleRequest() on all Routes that
+	 *      - match current request
+	 *      - have yet to be handled
+	 *
+	 * @return void
+	 */
+	public function handleRoutesForCurrentRequest()
+	{
+		$this->routes->handleRoutesForCurrentRequest();
+	}
+
+
+	/**
+	 * @param RouteInterface $route
+	 * @param string         $fqcn
+	 * @since $VID:$
+	 */
+	private function validateRoute($route, $fqcn)
+	{
+		if (! $route instanceof RouteInterface) {
+			throw new InvalidClassException(
+				sprintf(
+					/*
                      * translators:
                      * The supplied FQCN (Fully\Qualified\Class\Name) must be an instance of RouteInterface.
                     */
-                    esc_html__(
-                        'The supplied FQCN (%1$s) must be an instance of RouteInterface.',
-                        'event_espresso'
-                    ),
-                    $fqcn
-                )
-            );
-        }
-    }
+					esc_html__(
+						'The supplied FQCN (%1$s) must be an instance of RouteInterface.',
+						'event_espresso'
+					),
+					$fqcn
+				)
+			);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
         $this->loader = $loader;
         $this->request = $request;
         $this->routes = $routes;
-        if (! $this->request->isActivation()) {
+        if ( ! $this->request->isActivation()) {
             add_action('admin_footer', [$this->data_node_handler, 'printDataNode']);
             add_action('wp_footer', [$this->data_node_handler, 'printDataNode']);
         }
@@ -124,7 +124,7 @@ 
      */
     private function validateRoute($route, $fqcn)
     {
-        if (! $route instanceof RouteInterface) {
+        if ( ! $route instanceof RouteInterface) {
             throw new InvalidClassException(
                 sprintf(
                     /*