update plugin files to meet new phpcs standards + version bump

Author: scarstens

README.md

@@ -12,10 +12,18 @@ performance matters...).
 
 4. Generate New Plugin or access resource guides.
 
-### Offline Development Mode
+## UPDATING `/lib` files
+
+Lib files come from composer, but you need to ensure you run the command without the composer autoloader:
+```
+composer update --no-dev --no-autoloader
+```
+
+## Offline Development Mode
 
 The plugin uses the GitHub API to fetch the latest copy of the Abstract Plugin Base to include in the plugin. You can alternatively set:
 ```php
 define( 'WP_DEV_KIT_AIRPLANE_MODE', true )
 ```
 to pull the ABP powering this plugin for internet-less development.
+

app/boilerplates/simple/app/admin/class-app.php

@@ -1,41 +1,52 @@
 <?php
+/**
+ * Main App File
+ *
+ * @package    WordPress
+ * @subpackage <%= PKG %>
+ */
 
-namespace <%= PRIMARY_NAMESPACE %>\<%= SECONDARY_NAMESPACE %>\Admin;
+namespace < %= PRIMARY_NAMESPACE %>\< %= SECONDARY_NAMESPACE %>\Admin;
 
 /**
  * Class App
- * @package <%= PKG %>
  */
 class App {
 
 	/**
-	 * @var string
+	 * Plugins class object installed directory on the server
+	 *
+	 * @var string $installed_dir Installed server directory
 	 */
 	public $installed_dir;
 
 	/**
-	 * @var string
+	 * Plugins URL for access to any static files or assets like css, js, or media
+	 *
+	 * @var string $installed_url Installed URL
 	 */
 	public $installed_url;
 
 	/**
-	 * @var string
+	 * If plugin_data is built, this represents the version number defined the the main plugin file meta
+	 *
+	 * @var string $version Version
 	 */
 	public $version;
 
 	/**
 	 * Add auth'd/admin functionality via new Class() instantiation, add_action() and add_filter() in this method.
 	 *
-	 * @param string $installed_dir
-	 * @param string $installed_url
-	 * @param string $version
+	 * @param string $installed_dir Installed server directory
+	 * @param string $installed_url Installed URL
+	 * @param string $version       Version
 	 */
 	function __construct( $installed_dir, $installed_url, $version ) {
 		$this->installed_dir = $installed_dir;
 		$this->installed_url = $installed_url;
 		$this->version       = $version;
 
-		// put your new Class() or add_action() here.
+		// Put your new Class() or add_action() here.
 	}
 
 }

app/boilerplates/simple/app/class-plugin.php

@@ -1,8 +1,14 @@
 <?php
+/**
+ * Plugin <%= SECONDARY_NAMESPACE %>
+ *
+ * @package WordPress
+ * @subpackage <%= PKG %>
+ */
 
 namespace <%= PRIMARY_NAMESPACE %>\<%= SECONDARY_NAMESPACE %>;
 
-use <%= PRIMARY_NAMESPACE %>\<%= SECONDARY_NAMESPACE %>\Admin;
+use <%= PRIMARY_NAMESPACE %>\< %= SECONDARY_NAMESPACE %>\Admin;;
 use <%= ABSTRACT_PLUGIN_NAMESPACE %>\Abstract_Plugin;
 
 if ( ! function_exists( 'add_filter' ) ) {
@@ -13,38 +19,38 @@
 
 /**
  * Class Plugin
- * @package <%= PKG %>
  */
 class Plugin extends Abstract_Plugin {
 
 	/**
-	 * @var string
+	 * Use magic constant to tell abstract class current namespace as prefix for all other namespaces in the plugin.
+	 *
+	 * @var string $autoload_class_prefix magic constant
 	 */
 	public static $autoload_class_prefix = __NAMESPACE__;
 
 	/**
-	 * @var string
-	 */
-	public static $autoload_type = 'psr-4';
-
-	/**
-	 * @var int
-	 */
-	public static $autoload_ns_match_depth = 2;
-
-	/**
+	 * Action prefix is used to automatically and dynamically assign a prefix to all action hooks.
+	 *
 	 * @var string
 	 */
 	public static $action_prefix = '<%= US_SLUG %>_';
 
 	/**
-	 * @var string
+	 * Magic constant trick that allows extended classes to pull actual server file location, copy into subclass.
+	 *
+	 * @var string $current_file
 	 */
 	protected static $current_file = __FILE__;
 
 
 	/**
-	 * @param mixed $instance
+	 * Initialize the plugin - for public (front end)
+	 *
+	 * @param mixed $instance Parent instance passed through to child.
+	 *
+	 * @since   0.1
+	 * @return  void
 	 */
 	public function onload( $instance ) {
 	}
@@ -64,7 +70,7 @@ public function init() {
 	public function authenticated_init() {
 		if ( is_user_logged_in() ) {
 			do_action( static::$action_prefix . 'before_authenticated_init' );
-			// $this->admin is in the abstract plugin base class
+			// Object $this->admin is in the abstract plugin base class.
 			$this->admin = new Admin\App(
 				$this->installed_dir,
 				$this->installed_url,

app/boilerplates/simple/composer.json

@@ -22,10 +22,5 @@
   },
   "config": {
 	"vendor-dir": "lib"
-  },
-  "autoload": {
-	"classmap": [
-	  "/"
-	]
   }
 }

app/boilerplates/simple/main.php

@@ -3,14 +3,15 @@
  * <%= NAME %>
  *
  * @wordpress-plugin
- * @package     <%= PKG %>
- * @author      <%= AUTHORS %><%= TEAM %>
- * @license     <%= LICENSE_TEXT %>
- * @link        <%= URL %>
- * @version     <%= VERSION %>
+ * @package        WordPress
+ * @subpackage     <%= PKG %>
+ * @author         <%= AUTHORS %><%= TEAM %>
+ * @license        <%= LICENSE_TEXT %>
+ * @link           <%= URL %>
+ * @version        <%= VERSION %>
  *
  * Built with WP PHX WordPress Development Toolkit v<%= GENERATOR_VERSION %> on <%= CURRENT_TIME %>
- * @link https://github.com/WordPress-Phoenix/wordpress-development-toolkit
+ * @link           https://github.com/WordPress-Phoenix/wordpress-development-toolkit
  *
  * Plugin Name: <%= NAME %>
  * Plugin URI: <%= URL %>
@@ -42,5 +43,4 @@
  */
 include_once $current_dir . 'app/class-plugin.php';
 
-<%= PRIMARY_NAMESPACE %>\<%= SECONDARY_NAMESPACE %>\Plugin::run( __FILE__ );
-// Please don't edit below this line.
+< %= PRIMARY_NAMESPACE %>\< %= SECONDARY_NAMESPACE %>\Plugin::run( __FILE__ );

app/class-plugin.php

@@ -1,67 +1,83 @@
 <?php
+/**
+ * Main Plugin Class
+ *
+ * @package WordPress
+ */
 
 namespace PHX_WP_DEVKIT\V_3_0;
 
 use PHX_WP_DEVKIT\V_3_0\Admin;
-use WPAZ_Plugin_Base\V_2_6\Abstract_Plugin as Base;
+use WPAZ_Plugin_Base\V_2_6\Abstract_Plugin;
 
 /**
  * Class Plugin
+ *
  * @package Wordpress_development_toolkit
  */
-class Plugin extends Base {
+class Plugin extends Abstract_Plugin {
 
 	/**
-	 * @var string
+	 * Use magic constant to tell abstract class current namespace as prefix for all other namespaces in the plugin.
+	 *
+	 * @var string $autoload_class_prefix magic constant
 	 */
 	public static $autoload_class_prefix = __NAMESPACE__;
 
 	/**
-	 * @var string
-	 */
-	public static $autoload_type = 'psr-4';
-
-	/**
-	 * @var int
-	 */
-	public static $autoload_ns_match_depth = 2;
-
-	/**
-	 * @var string
+	 * Magic constant trick that allows extended classes to pull actual server file location, copy into subclass.
+	 *
+	 * @var string $current_file
 	 */
 	protected static $current_file = __FILE__;
 
 	/**
-	 * @param mixed $instance
+	 * Initialize the plugin - for public (front end)
+	 *
+	 * @param mixed $instance Parent instance passed through to child.
+	 *
+	 * @return  void
 	 */
 	public function onload( $instance ) {
 	}
 
 	/**
-	 * Initialize public / shared functionality
+	 * Initialize the plugin - for public (front end)
+	 * Example of building a module of the plugin into init
+	 * ```$this->modules->FS_Mail = new FS_Mail( $this, $this->plugin_object_basedir );```
+	 *
+	 * @since   0.1
+	 * @return  void
 	 */
 	public function init() {
 		do_action( get_called_class() . '_before_init' );
-		// silence is golden :)
+		// Add hooks and filters, or other init scopped code here.
 		do_action( get_called_class() . '_after_init' );
 	}
 
 	/**
-	 * Initialize functionality only loaded for logged-in users
+	 * Initialize the plugin - for admin (back end)
+	 * You would expected this to be handled on action admin_init, but it does not properly handle
+	 * the use case for all logged in user actions. Always keep is_user_logged_in() wrapper within
+	 * this function for proper usage.
+	 *
+	 * @return  void
 	 */
 	public function authenticated_init() {
 		if ( is_user_logged_in() ) {
 			do_action( get_called_class() . '_before_authenticated_init' );
 			new Admin\Init(
-					trailingslashit( $this->installed_dir ),
-					trailingslashit( $this->installed_url ),
-					$this->version
-				);
+				trailingslashit( $this->installed_dir ),
+				trailingslashit( $this->installed_url ),
+				$this->version
+			);
 			do_action( get_called_class() . '_after_authenticated_init' );
 		}
 	}
 
 	/**
+	 * Enforce that the plugin prepare any defines or globals in a standard location.
+	 *
 	 * @return mixed|void
 	 */
 	protected function defines_and_globals() {