ProcessWire v3.0.33 RC1 primarily prepares all of ProcessWire's core …

…files to reflect a non-development version. This also contains improvements to documentation in several files.
ryancramerdesign · Sep 2, 2016 · e4c8339 · e4c8339
1 parent 8f92484
commit e4c8339
Show file tree

Hide file tree

Showing 234 changed files with 1,121 additions and 904 deletions.
diff --git a/README-PW.md b/README-PW.md
diff --git a/README.md b/README.md
diff --git a/index.php b/index.php
@@ -10,7 +10,7 @@
  * do so after you have installed the site, as the installer is not informed
  * of any changes made in this file. 
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  * @version 3.0

diff --git a/install.php b/install.php
@@ -11,7 +11,7 @@
  * If that file exists, the installer will not run. So if you need to re-run this installer for any
  * reason, then you'll want to delete that file. This was implemented just in case someone doesn't delete the installer.
  * 
- * ProcessWire 3.x (development), Copyright 2016 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  * 
  */

diff --git a/site-beginner/config.php b/site-beginner/config.php
@@ -17,7 +17,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/site-blank/config.php b/site-blank/config.php
@@ -17,7 +17,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/site-classic/config.php b/site-classic/config.php
@@ -17,7 +17,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/site-default/config.php b/site-default/config.php
@@ -17,7 +17,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/site-default/modules/Helloworld.module b/site-default/modules/Helloworld.module
@@ -10,7 +10,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/site-languages/config.php b/site-languages/config.php
@@ -17,7 +17,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/wire/config.php b/wire/config.php
@@ -12,7 +12,7 @@
  * You may also make up your own configuration options by assigning them 
  * in /site/config.php 
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  * 

diff --git a/wire/core/AdminTheme.php b/wire/core/AdminTheme.php
@@ -10,10 +10,13 @@
  * This file is licensed under the MIT license. 
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  * 
  * @property int|string $version Current admin theme version
+ * 
+ * @method void install()
+ * @method void uninstall()
  *
  */
 
@@ -248,7 +251,7 @@ public function preRenderURL($url = '') {
 		if(!empty($url)) $this->preRenderURLs[] = $url;
 		return $this->preRenderURLs;
 	}
-
+	
 	public function ___uninstall() { 
 
 		/*

diff --git a/wire/core/Breadcrumbs.php b/wire/core/Breadcrumbs.php
@@ -8,7 +8,7 @@
  * This file is licensed under the MIT license.
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  *

diff --git a/wire/core/CacheFile.php b/wire/core/CacheFile.php
@@ -12,7 +12,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */
@@ -218,6 +218,8 @@ public function remove() {
 
 	/**
 	 * Removes just the given file, as opposed to remove() which removes the entire cache for primaryID
+	 * 
+	 * @param string $filename
 	 *
 	 */
 	protected function removeFilename($filename) {

diff --git 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 (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  * 
  * #pw-summary Holds ProcessWire configuration settings as defined in /wire/config.php and /site/config.php. 

diff --git a/wire/core/ConfigurableModule.php b/wire/core/ConfigurableModule.php
@@ -8,7 +8,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  * 

diff --git a/wire/core/Database.php b/wire/core/Database.php
@@ -8,7 +8,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  *

diff --git a/wire/core/DatabaseQuery.php b/wire/core/DatabaseQuery.php
@@ -10,7 +10,7 @@
  * of what other methods/objects have done to it. It also means being able
  * to build a complex query without worrying about correct syntax placement.
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  * This file is licensed under the MIT license

diff --git a/wire/core/DatabaseQuerySelect.php b/wire/core/DatabaseQuerySelect.php
@@ -12,7 +12,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  * 
  * @property array $select

diff --git a/wire/core/DatabaseQuerySelectFulltext.php b/wire/core/DatabaseQuerySelectFulltext.php
@@ -20,7 +20,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  *

diff --git a/wire/core/DatabaseStopwords.php b/wire/core/DatabaseStopwords.php
@@ -5,7 +5,7 @@
  *
  * MySQL stopwords, primarily for use with filtering fulltext queries
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  *
@@ -54,6 +54,8 @@ class DatabaseStopwords {
 
 	/**
 	 * Get all stopwords
+	 * 
+	 * @return array
 	 *
 	 */
 	static public function getAll() {
@@ -62,6 +64,9 @@ static public function getAll() {
 
 	/**
 	 * Is the provided word a stopword?
+	 * 
+	 * @param string $word
+	 * @return bool
 	 *
 	 */
 	static public function has($word) {
@@ -70,6 +75,8 @@ static public function has($word) {
 
 	/**
 	 * Add a stopword to the list
+	 * 
+	 * @param string $word
 	 *
 	 */
 	static public function add($word) {
@@ -78,6 +85,8 @@ static public function add($word) {
 
 	/**
 	 * Remove a word from the stopwords
+	 * 
+	 * @param string $word
 	 *
 	 */
 	static public function remove($word) {

diff --git a/wire/core/Debug.php b/wire/core/Debug.php
@@ -10,17 +10,35 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */
 
 class Debug {
-
+
+	/**
+	 * Current timers
+	 * 
+	 * @var array
+	 * 
+	 */
 	static protected $timers = array();
-
+
+	/**
+	 * Timers that have been saved
+	 * 
+	 * @var array
+	 * 
+	 */
 	static protected $savedTimers = array();
-
+
+	/**
+	 * Notes for saved timers
+	 * 
+	 * @var array
+	 * 
+	 */
 	static protected $savedTimerNotes = array();
 
 	/**
@@ -108,6 +126,9 @@ static public function getSavedTimers() {
 
 	/**
 	 * Reset a timer so that it starts timing again from right now
+	 * 
+	 * @param string $key
+	 * @return string|int
 	 *
 	 */
 	static public function resetTimer($key) {
@@ -117,6 +138,8 @@ static public function resetTimer($key) {
 
 	/**
 	 * Remove a timer completely
+	 * 
+	 * @param string $key
 	 *
 	 */
 	static public function removeTimer($key) {

diff --git a/wire/core/Exceptions.php b/wire/core/Exceptions.php
@@ -8,7 +8,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  */

diff --git a/wire/core/Field.php b/wire/core/Field.php
@@ -10,7 +10,7 @@
  * #pw-body Field objects are managed by the `$fields` API variable. 
  * #pw-use-constants
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  *
  * @property int $id Numeric ID of field in the database #pw-group-properties
@@ -524,14 +524,17 @@ public function setImportData(array $data) {
 	public function setName($name) {
 		$name = $this->wire('sanitizer')->fieldName($name);
 
-		if(Fields::isNativeName($name))
+		if($this->wire('fields')->isNative($name)) {
 			throw new WireException("Field may not be named '$name' because it is a reserved word");
+		}
 
-		if($this->wire('fields') && ($f = $this->wire('fields')->get($name)) && $f->id != $this->id)
+		if($this->wire('fields') && ($f = $this->wire('fields')->get($name)) && $f->id != $this->id) {
 			throw new WireException("Field may not be named '$name' because it is already used by another field");
+		}
 
-		if(strpos($name, '__') !== false)
+		if(strpos($name, '__') !== false) {
 			throw new WireException("Field name '$name' may not have double underscores because this usage is reserved by the core");
+		}
 
 		if($this->settings['name'] != $name) {
 			if($this->settings['name'] && ($this->settings['flags'] & Field::flagSystem)) {
@@ -542,6 +545,7 @@ public function setName($name) {
 		}
 
 		$this->settings['name'] = $name;
+
 		return $this;
 	}
 

diff --git a/wire/core/FieldSelectorInfo.php b/wire/core/FieldSelectorInfo.php
@@ -13,7 +13,7 @@
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  * 
  */

diff --git a/wire/core/Fieldgroup.php b/wire/core/Fieldgroup.php
@@ -13,7 +13,7 @@
  * are separated in the API in case want want to have fieldgroups used by 
  * multiple templates in the future (like ProcessWire 1.x).
  * 
- * ProcessWire 3.x (development), Copyright 2015 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
  * https://processwire.com
  * 
  * @property int $id Fieldgroup database ID #pw-group-retrieval
@@ -176,7 +176,6 @@ public function remove($field) {
 	 * 
 	 * #pw-internal
 	 * 
-	 * @internal
 	 * @param Field $field
 	 * @return bool
 	 *