Moved common methods to ToolKit; renamed get_plugin_option()

Author: dmhendricks

app/Core.php

@@ -10,7 +10,7 @@ function __construct() {
     add_filter( 'body_class', array( &$this, 'add_body_classes' ) );
 
     // Example - Remove Emoji code from header
-    if( $this->get_plugin_option( 'remove_header_emojicons' ) ) {
+    if( $this->get_carbon_plugin_option( 'remove_header_emojicons' ) ) {
       if(!$this->is_ajax()) add_filter( 'init', array( $this, 'disable_wp_emojicons' ) );
     }
 
@@ -21,7 +21,7 @@ function __construct() {
       *    logged in, you would need to uncommend the 'wp_ajax_nopriv_clear_object_cache_ajax'
       *    hook.
       */
-    if( current_user_can( 'manage_options' ) && $this->get_plugin_option( 'admin_bar_add_clear_cache' ) ) {
+    if( current_user_can( 'manage_options' ) && $this->get_carbon_plugin_option( 'admin_bar_add_clear_cache' ) ) {
       add_action( 'admin_bar_menu', array( $this, 'admin_bar_add_clear_cache' ), 900 );
       //add_action( 'wp_ajax_nopriv_clear_object_cache_ajax', array( self::$cache, 'flush' ) );
       add_action( 'wp_ajax_clear_object_cache_ajax', array( self::$cache, 'flush' ) );

app/EnqueueScripts.php

@@ -14,7 +14,7 @@ function __construct() {
     $this->inject_javascript_settings();
 
     // Example - Load Font Awesome from CDN, if enabled in Settings Page
-    $enqueue_font_awesome = $this->get_plugin_option( 'enqueue_font_awesome' );
+    $enqueue_font_awesome = $this->get_carbon_plugin_option( 'enqueue_font_awesome' );
     if( $enqueue_font_awesome ) {
       if( in_array( 'frontend', $enqueue_font_awesome) )
         add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_font_awesome' ) );
@@ -94,7 +94,7 @@ private function inject_javascript_settings() {
     );
 
     $values = array(
-      'admin_bar_add_clear_cache' => $this->get_plugin_option( 'admin_bar_add_clear_cache' ),
+      'admin_bar_add_clear_cache' => $this->get_carbon_plugin_option( 'admin_bar_add_clear_cache' ),
       'admin_bar_add_clear_cache_success' => __( 'WordPress cache has been cleared.', self::$textdomain ),
       'show_clear_cache_link' => current_user_can( 'manage_options' ),
     );

app/Plugin.php

@@ -2,37 +2,33 @@
 namespace VendorName\PluginName;
 use WordPress_ToolKit\ObjectCache;
 use WordPress_ToolKit\ConfigRegistry;
-use WordPress_ToolKit\PluginTools;
 use WordPress_ToolKit\Helpers\ArrayHelper;
 use Carbon_Fields\Container;
 use Carbon_Fields\Field;
-use Config;
 
 class Plugin extends \WordPress_ToolKit\ToolKit {
 
   public static $textdomain;
-  public static $config;
   protected static $cache;
 
   function __construct() {
 
-    // Get plugin properties and meta data
-    $plugin_obj = new PluginTools( __DIR__ );
-    $plugin_data = $plugin_obj->get_current_plugin_data( ARRAY_A );
+    // Load plugin configuration
+    $this->init( dirname( __DIR__ ), trailingslashit( dirname( __DIR__ ) ) . 'plugin.json' );
+    self::$config->merge( new ConfigRegistry( [ 'plugin' => $this->get_current_plugin_meta( ARRAY_A ) ] ) );
 
-    self::$config = new ConfigRegistry( $plugin_data['path'] . 'plugin.json' );
-    self::$config = self::$config->merge( new ConfigRegistry( [ 'plugin' => $plugin_data ] ) );
+    // Set Text Domain
     self::$textdomain = self::$config->get( 'plugin/meta/TextDomain' ) ?: self::$config->get( 'plugin/slug' );
 
-    // Define plugin VERSION constant
+    // Define plugin version
     if ( !defined( __NAMESPACE__ . '\VERSION' ) ) define( __NAMESPACE__ . '\VERSION', self::$config->get( 'plugin/meta/Version' ) );
 
     // Initialize ObjectCache
     self::$cache = new ObjectCache( self::$config );
 
-    // Verify dependecies and load plugin logic
+    // Load dependecies and load plugin logic
     register_activation_hook( self::$config->get( 'plugin/identifier' ), array( $this, 'activate' ) );
-    add_action( 'plugins_loaded', array( $this, 'init' ) );
+    add_action( 'plugins_loaded', array( $this, 'load_dependencies' ) );
 
   }
 
@@ -91,7 +87,7 @@ public function activate() {
     *
     * @since 0.2.0
     */
-  public function init() {
+  public function load_dependencies() {
 
     if( class_exists( 'Carbon_Fields\\Carbon_Fields' ) ) {
       add_action( 'after_setup_theme', array( 'Carbon_Fields\\Carbon_Fields', 'boot' ) );
@@ -197,7 +193,7 @@ private function verify_dependencies( $deps = true, $args = array() ) {
     * @since 0.2.0
     *
     */
-  public static function get_plugin_option( $key, $cache = true ) {
+  public static function get_carbon_plugin_option( $key, $cache = true ) {
 
     $key = self::prefix( $key );
 
@@ -245,16 +241,4 @@ public static function get_wpsac_plugin_option( $key, $group_id = 'options', $ca
 
   }
 
-  /**
-    * Returns true if WP_ENV is anything other than 'development' or 'staging'.
-    *   Useful for determining whether or not to enqueue a minified or non-
-    *   minified script (which can be useful for debugging via browser).
-    *
-    * @return bool
-    * @since 0.1.0
-    */
-  public static function is_production() {
-    return ( !defined( 'WP_ENV' ) || ( defined('WP_ENV' ) && !in_array( WP_ENV, array( 'development', 'staging' ) ) ) );
-  }
-
 }

app/Settings/Carbon_Page.php

@@ -27,7 +27,7 @@ public function __construct() {
     $this->create_tabbed_options_page();
 
     // Register uninstall hook to delete settings
-    if( $this->get_plugin_option( 'uninstall_remove_settings' ) ) {
+    if( $this->get_carbon_plugin_option( 'uninstall_remove_settings' ) ) {
       register_uninstall_hook( self::$config->get( 'plugin/identifier' ), array( $this, 'plugin_settings_uninstall' ) );
     }