Merge pull request #29 from WebDevStudios/feature/coding-standards-fixes

Clean up some things, update docblocks, etc

Author: aubreypwd

wds-required-plugins.php

@@ -30,7 +30,7 @@
  * @subpackage Project
  * @since      Unknown
  */
-class WDS_Required_Plugins {
+final class WDS_Required_Plugins {
 
 	/**
 	 * Instance of this class.
@@ -45,7 +45,7 @@ class WDS_Required_Plugins {
 	/**
 	 * Whether text-domain has been registered.
 	 *
-	 * @var boolean
+	 * @var bool
 	 *
 	 * @author Justin Sternberg
 	 * @since  Unknown
@@ -83,7 +83,7 @@ class WDS_Required_Plugins {
 	 *
 	 * @var array
 	 */
-	public $incompatibilities = array();
+	public $incompatibilities = [];
 
 	/**
 	 * Creates or returns an instance of this class.
@@ -107,27 +107,26 @@ public static function init() {
 	 * @since 0.1.0
 	 * @author  Unknown
 	 *
-	 * @return void
 	 */
 	private function __construct() {
 		if ( $this->incompatible() ) {
 			return;
 		}
 
 		// Attempt activation + load text domain in the admin.
-		add_action( 'admin_init', array( $this, 'activate_if_not' ) );
-		add_action( 'admin_init', array( $this, 'required_text_markup' ) );
-		add_filter( 'extra_plugin_headers', array( $this, 'add_required_plugin_header' ) );
+		add_action( 'admin_init', [ $this, 'activate_if_not' ] );
+		add_action( 'admin_init', [ $this, 'required_text_markup' ] );
+		add_filter( 'extra_plugin_headers', [ $this, 'add_required_plugin_header' ] );
 
 		// Filter plugin links to remove deactivate option.
-		add_filter( 'plugin_action_links', array( $this, 'filter_plugin_links' ), 10, 2 );
-		add_filter( 'network_admin_plugin_action_links', array( $this, 'filter_plugin_links' ), 10, 2 );
+		add_filter( 'plugin_action_links', [ $this, 'filter_plugin_links' ], 10, 2 );
+		add_filter( 'network_admin_plugin_action_links', [ $this, 'filter_plugin_links' ], 10, 2 );
 
 		// Remove plugins from the plugins.
-		add_filter( 'all_plugins', array( $this, 'maybe_remove_plugins_from_list' ) );
+		add_filter( 'all_plugins', [ $this, 'maybe_remove_plugins_from_list' ] );
 
 		// Load text domain.
-		add_action( 'plugins_loaded', array( $this, 'l10n' ) );
+		add_action( 'plugins_loaded', [ $this, 'l10n' ] );
 	}
 
 	/**
@@ -136,18 +135,18 @@ private function __construct() {
 	 * @author Aubrey Portwood
 	 * @since  1.0.0
 	 *
-	 * @return boolean True if we are incompatible with something, false if not.
+	 * @return bool True if we are incompatible with something, false if not.
 	 */
 	public function incompatible() {
 
 		// Our tests.
-		$this->incompatibilities = array(
+		$this->incompatibilities = [
 
 			/*
 			 * WP Migrate DB Pro is performing an AJAX migration.
 			 */
 			(bool) $this->is_wpmdb(),
-		);
+		];
 
 		/**
 		 * Add or filter your incompatibility tests here.
@@ -177,7 +176,7 @@ public function incompatible() {
 	 * @author Aubrey Portwood
 	 * @since  1.0.0
 	 *
-	 * @return boolean True if we find wpmdb set as the action.
+	 * @return bool True if we find wpmdb set as the action.
 	 */
 	public function is_wpmdb() {
 
@@ -190,7 +189,6 @@ public function is_wpmdb() {
 	 *
 	 * @since 0.1.1
 	 * @author Unknown
-	 * @return void Early bails when we don't need to activate it.
 	 */
 	public function activate_if_not() {
 
@@ -225,10 +223,8 @@ public function activate_if_not() {
 	 * @author Aubrey Portwood <aubrey@webdevstudios.com>
 	 * @since 1.0.1 Added Exception if plugin not found.
 	 *
-	 * @param  string  $plugin  The plugin to activate.
-	 * @param  boolean $network Whether we are activating a network-required plugin.
-	 *
-	 * @return void
+	 * @param string $plugin  The plugin to activate.
+	 * @param bool   $network Whether we are activating a network-required plugin.
 	 *
 	 * @throws Exception If we can't activate a required plugin.
 	 */
@@ -243,9 +239,9 @@ public function maybe_activate_plugin( $plugin, $network = false ) {
 		 * @author  Justin Sternberg
 		 * @since   Unknown
 		 *
-		 * @param boolean $auto_activate Should we auto-activate the plugin, true by default.
-		 * @param string  $plugin        The plugin being activated.
-		 * @param string  $network       On what network?
+		 * @param bool   $auto_activate Should we auto-activate the plugin, true by default.
+		 * @param string $plugin        The plugin being activated.
+		 * @param string $network       On what network?
 		 */
 		$auto_activate = apply_filters( 'wds_required_plugin_auto_activate', true, $plugin, $network );
 		if ( ! $auto_activate ) {
@@ -260,9 +256,9 @@ public function maybe_activate_plugin( $plugin, $network = false ) {
 		 * @author  Justin Sternberg
 		 * @since   Unknown
 		 *
-		 * @param boolean $is_multisite The value of is_multisite().
-		 * @param string  $plugin       The plugin being activated.
-		 * @param string  $network      The network.
+		 * @param bool   $is_multisite The value of is_multisite().
+		 * @param string $plugin       The plugin being activated.
+		 * @param string $network      The network.
 		 */
 		$is_multisite = apply_filters( 'wds_required_plugin_network_activate', is_multisite(), $plugin, $network );
 
@@ -306,10 +302,10 @@ public function maybe_activate_plugin( $plugin, $network = false ) {
 		 * @author  Justin Sternberg
 		 * @since   Unknown
 		 *
-		 * @param boolean $log_not_found Whether the plugin is indeed found or not,
-		 *                               default to true in the normal case. Set to false
-		 *                               if you would like to override that and not log it,
-		 *                               for instance, if it's intentional.
+		 * @param bool $log_not_found Whether the plugin is indeed found or not,
+		 *                            default to true in the normal case. Set to false
+		 *                            if you would like to override that and not log it,
+		 *                            for instance, if it's intentional.
 		 */
 		$log_not_found = apply_filters( 'wds_required_plugin_log_if_not_found', true, $plugin, $result, $network );
 
@@ -335,7 +331,7 @@ public function maybe_activate_plugin( $plugin, $network = false ) {
 		 * @since  1.1.0
 		 * @author Aubrey Portwood <aubrey@webdevstudios.com>
 		 *
-		 * @param boolean $stop_not_found Set to false to not halt execution if a plugin is not found.
+		 * @param bool $stop_not_found Set to false to not halt execution if a plugin is not found.
 		 */
 		$stop_not_found = apply_filters( 'wds_required_plugin_stop_if_not_found', false, $plugin, $result, $network );
 
@@ -383,25 +379,25 @@ public function required_text_markup() {
 	 *
 	 * @since 0.1.0
 	 *
-	 * @param array  $actions  Array of actions avaible.
-	 * @param string $plugin   Slug of plugin.
+	 * @param array  $actions Array of actions avaible.
+	 * @param string $plugin  Slug of plugin.
 	 *
 	 * @author Justin Sternberg
 	 * @author Brad Parbs
 	 * @author Aubrey Portwood Added documentation for filters.
 	 *
 	 * @return array
 	 */
-	public function filter_plugin_links( $actions = array(), $plugin ) {
+	public function filter_plugin_links( $actions = [], $plugin ) {
 
 		// Get our required plugins for network + normal.
 		$required_plugins = array_unique( array_merge( $this->get_required_plugins(), $this->get_network_required_plugins() ) );
 
 		// Replace these action keys with what we have set for required text.
-		$action_keys = array(
+		$action_keys = [
 			'deactivate',
 			'network_active',
-		);
+		];
 
 		foreach ( $action_keys as $key ) {
 
@@ -414,8 +410,8 @@ public function filter_plugin_links( $actions = array(), $plugin ) {
 				 * @author  Brad Parbs
 				 * @since   Unknown
 				 *
-				 * @param boolean $remove Should we remove it? Default to true.
-				 * @param string  $plugin What plugin we're talking about.
+				 * @param bool   $remove Should we remove it? Default to true.
+				 * @param string $plugin What plugin we're talking about.
 				 */
 				$wds_required_plugin_network_activate = apply_filters( 'wds_required_plugin_network_activate', true, $plugin );
 
@@ -440,8 +436,8 @@ public function filter_plugin_links( $actions = array(), $plugin ) {
 	 * @author  Brad Parbs
 	 * @author  Aubrey Portwood Made it so mu-plugins are also unseen.
 	 *
-	 * @param   array $plugins Array of plugins.
-	 * @return  array          Array of plugins.
+	 * @param  array $plugins Array of plugins.
+	 * @return array Array of plugins.
 	 */
 	public function maybe_remove_plugins_from_list( $plugins ) {
 
@@ -512,11 +508,11 @@ public function get_required_plugins() {
 		 *
 		 * @var array
 		 */
-		$required_plugins = apply_filters( 'wds_required_plugins', array() );
+		$required_plugins = apply_filters( 'wds_required_plugins', [] );
 		if ( ! is_array( $required_plugins ) ) {
 
 			// The person who filtered this broke it.
-			return array();
+			return [];
 		}
 
 		$required_plugins = array_merge( $required_plugins, $this->get_header_required_plugins() );
@@ -559,11 +555,11 @@ public function get_network_required_plugins() {
 		 *
 		 * @var array
 		 */
-		$required_plugins = apply_filters( 'wds_network_required_plugins', array() );
+		$required_plugins = apply_filters( 'wds_network_required_plugins', [] );
 		if ( ! is_array( $required_plugins ) ) {
 
 			// The person who filtered this broke it.
-			return array();
+			return [];
 		}
 
 		return $required_plugins;
@@ -576,7 +572,6 @@ public function get_network_required_plugins() {
 	 * @author Brad Parbs
 	 * @since  0.1.1
 	 *
-	 * @return void Early bails when it's un-necessary.
 	 */
 	public function l10n() {
 
@@ -620,7 +615,7 @@ public function l10n() {
 
 		// If we still didn't load, assume our text domain is right where we are.
 		$locale = apply_filters( 'plugin_locale', get_locale(), 'wds-required-plugins' );
-		$mofile = dirname( __FILE__ ) . '/languages/wds-required-plugins-' . $locale . '.mo';
+		$mofile = __DIR__ . '/languages/wds-required-plugins-' . $locale . '.mo';
 		load_textdomain( 'wds-required-plugins', $mofile );
 		self::$l10n_done = true;
 	}
@@ -631,7 +626,7 @@ public function l10n() {
 	 * @since 1.2.0
 	 * @author Zach Owen
 	 *
-	 * @param array $extra_headers Extra headers filtered in WP core.
+	 * @param  array $extra_headers Extra headers filtered in WP core.
 	 * @return array
 	 */
 	public function add_required_plugin_header( $extra_headers ) {