From ba2edc94cc3336d9bd3e9f0fd3b8790c043e9813 Mon Sep 17 00:00:00 2001
From: Ryan Cramer <ryan@processwire.com>
Date: Fri, 26 Feb 2021 10:31:31 -0500
Subject: [PATCH] Update $config API to have $config->jsConfig() method for
 JS-exclusive config settings. Different from $config->js() in that the data
 is completely independent of PHP config.

---
 wire/core/Config.php | 68 ++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 66 insertions(+), 2 deletions(-)

diff --git a/wire/core/Config.php b/wire/core/Config.php
index 88ddc51a..23c59850 100644
--- a/wire/core/Config.php
+++ b/wire/core/Config.php
@@ -8,7 +8,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x, Copyright 2019 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2021 by Ryan Cramer
  * https://processwire.com
  * 
  * #pw-summary Holds ProcessWire configuration settings as defined in /wire/config.php and /site/config.php. 
@@ -435,11 +435,23 @@ class Config extends WireData {
 	 *
 	 */
 	protected $jsFields = array();
+	
+	/**
+	 * Values $config->jsConfig()
+	 *
+	 * @var array
+	 *
+	 */
+	protected $jsData = array();
 
 	/**
 	 * Set or retrieve a config value to be shared with javascript
 	 * 
-	 * Values are set to the Javascript variable `ProcessWire.config[key]`. 
+	 * Values are set to the Javascript variable `ProcessWire.config[key]`.
+	 * 
+	 * Note: In ProcessWire 3.0.173+ when setting new values, it is preferable to use 
+	 * `$config->jsConfig()` instead, unless your intended use is to share an 
+	 * existing $config property with JS. 
 	 * 
 	 * 1. Specify a $key and $value to set a JS config value. 
 	 *
@@ -483,6 +495,7 @@ class Config extends WireData {
 			foreach($this->jsFields as $field) {
 				$data[$field] = $this->get($field); 
 			}
+			$data = array_merge($data, $this->jsData);
 			return $data; 
 
 		} else if(is_null($value)) {
@@ -496,6 +509,7 @@ class Config extends WireData {
 				return $a;
 			} else {
 				// return value for just one key
+				if(isset($this->jsData[$key])) return $this->jsData[$key];
 				return in_array($key, $this->jsFields) ? $this->get($key) : null;
 			}
 			
@@ -519,6 +533,56 @@ class Config extends WireData {
 		$this->jsFields[] = $key; 
 		return parent::set($key, $value); 
 	}
+
+	/**
+	 * Set or retrieve a config value exclusive to Javascript (ProcessWire.config)
+	 *
+	 * Values are set to the Javascript variable `ProcessWire.config[key]`.
+	 * 
+	 * Unlike `$config->js()`, values get or set are exclusive to JS config only. 
+	 * 
+	 * Values set with this method can be retrieved via `$config->js()` or `$config->jsConfig()`,
+	 * but they cannot be retrieved from $config->['key'] or $config->get('key').
+	 * 
+	 * If setting a new property for the JS config it is recommended that you use this
+	 * method rather than $config->js() in ProcessWire 3.0.173+. If backwards compatibility
+	 * is needed then you should still use $config->js().
+	 *
+	 * 1. Specify a $key and $value to set a JS config value.
+	 *
+	 * 2. Specify only a $key and omit the $value in order to retrieve an existing set value.
+	 *
+	 * 3. Specify no params to retrieve in array of all existing set values.
+	 *
+	 * ~~~~~
+	 * // Set a property from PHP
+	 * $config->jsConfig('mySettings', [
+	 *   'foo' => 'bar',
+	 *   'bar' => 123,
+	 * ]);
+	 *
+	 * // Get a property (from PHP)
+	 * $mySettings = $config->jsConfig('mySettings');
+	 * ~~~~~
+	 * ~~~~~
+	 * // Get a property (from Javascript):
+	 * var mySettings = ProcessWire.config.mySettings;
+	 * console.log(mySettings.foo);
+	 * console.log(mySettings.bar);
+	 * ~~~~~
+	 *
+	 * @param string $key Name of property to get or set or omit to return all data
+	 * @param mixed|null $value Specify value to set or omit (null) to get
+	 * @return mixed|null|array|self Returns null if $key not found, value when getting, self when setting, or array when getting all
+	 * @since 3.0.173
+	 *
+	 */
+	public function jsConfig($key = null, $value = null) {
+		if($key === null) return $this->jsData; // get all
+		if($value === null) return isset($this->jsData[$key]) ? $this->jsData[$key] : null; // get property
+		$this->jsData[$key] = $value; // set property
+		return $this;
+	}
 	
 	/**
 	 * Allow for getting/setting config properties via method call