' . __( 'It appears that Better Font Awesome is missing it\'s core library, which typically occurs when cloning the Git repository and failing to run composer install. Please refer to the plugin\'s installation instructions for details on how to properly install Better Font Awesome via Git. If you installed from within WordPress, or via the wordpress.org repo, then chances are the install failed and you can try again. If the issue persists, please create a new topic on the plugin\'s support forum or file an issue on the Github repo.' , 'better-font-awesome' ) . '
' . __( 'Back to the plugins page →', 'better-font-awesome' ) . '
'; - - wp_die( $message ); - - } - - /** - * Include required files. - * - * @since 0.10.0 - */ - private function includes() { - - // Better Font Awesome Library. - require_once $this->bfa_lib_file_path; - - } - - /** - * Get plugin options, or initialize with default values. - * - * @since 0.10.0 - * - * @return array Plugin options. - */ - private function initialize_options( $option_name ) { - - /** - * Get plugin options. - * - * Run maybe_unserialize() in case we're updating from the old - * serialized Titan Framwork option to a new, array-based options. - */ - $this->options = maybe_unserialize( get_option( $option_name ) ); - - // Initialize the plugin options with defaults if they're not set. - if ( empty( $this->options ) ) { - update_option( $option_name, $this->option_defaults ); - } - - } - - /** - * Initialize the Better Font Awesome Library object. - * - * @since 0.9.0 - * - * @param array $options Plugin options. - */ - private function initialize_better_font_awesome_library( $options ) { - - // Hide admin notices if setting is checked. - if ( true == $options['hide_admin_notices'] ) { - add_filter( 'bfa_show_errors', '__return_false' ); - } - - // Initialize BFA library. - $args = array( - 'version' => isset( $options['version'] ) ? $options['version'] : $this->option_defaults['version'], - 'minified' => isset( $options['minified'] ) ? $options['minified'] : '', - 'remove_existing_fa' => isset( $options['remove_existing_fa'] ) ? $options['remove_existing_fa'] :'', - 'load_styles' => true, - 'load_admin_styles' => true, - 'load_shortcode' => true, - 'load_tinymce_plugin' => true, - ); - - $this->bfa_lib = Better_Font_Awesome_Library::get_instance( $args ); - - } - - /** - * Load plugin text domain. - * - * @since 0.10.0 - */ - function load_text_domain() { - load_plugin_textdomain( self::SLUG, false, dirname( plugin_basename( __FILE__ ) ) . '/languages' ); - } - - /** - * Generate admin notices. - * - * @since 1.7.3 + /** + * Plugin slug. + * + * @since 0.9.0 + * + * @var string + */ + const SLUG = 'better-font-awesome'; + + /** + * Plugin version. + * + * @since 2.0.0 + * + * @var string + */ + const VERSION = '2.0.0'; + + /** + * The Better Font Awesome Library object. + * + * @since 0.1.0 + * + * @var Better_Font_Awesome_Library + */ + private $bfa_lib; + + /** + * Path to the Better Font Awesome Library main file. + * + * @since 0.1.0 + * + * @var Better_Font_Awesome_Library + */ + private $bfa_lib_file_path; + + /** + * Plugin display name. + * + * @since 0.9.0 + * + * @var string */ - public function do_admin_notices() { + private $plugin_display_name; - $user_dismissed_option_data = $this->get_dismissed_admin_notice_testing_data(); + /** + * Plugin option name. + * + * @since 0.9.0 + * + * @var string + */ + protected $option_name; + + /** + * Plugin options. + * + * @since 0.9.0 + * + * @var string + */ + protected $options; - if ( - !isset( $user_dismissed_option_data->{get_current_user_id()} ) || - true !== $user_dismissed_option_data->{get_current_user_id()} - ) : + /** + * Default options. + * + * Used for setting uninitialized plugin options. + * + * @since 0.9.0 + * + * @var array + */ + protected $option_defaults = array( + 'include_v4_shim' => '', + 'remove_existing_fa' => '', + 'hide_admin_notices' => '', + ); + + /** + * Instance of this class. + * + * @since 0.9.0 + * + * @var Better_Font_Awesome_Plugin + */ + protected static $instance = null; + + + /** + * Returns the instance of this class, and initializes the instance if it + * doesn't already exist. + * + * @param array $args Args to instantiate BFA object. + * + * @return Better_Font_Awesome The BFA object. + */ + public static function get_instance( $args = array() ) { + + // If the single instance hasn't been set, set it now. + // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison + if ( null == self::$instance ) { + self::$instance = new self( $args ); + } + + return self::$instance; + } + + /** + * Better Font Awesome Plugin constructor. + * + * @since 0.9.0 + */ + protected function __construct() { + + // Perform plugin initialization actions. + $this->initialize(); + + // Stop if the Better Font Awesome Library isn't included. + if ( ! $this->bfal_exists() ) { + add_action( 'admin_init', array( $this, 'deactivate' ) ); + return false; + } + + // Include required files. + $this->includes(); + + // Initialize the Better Font Awesome Library. + $this->initialize_better_font_awesome_library( $this->options ); + + // Load the plugin text domain. + $this->load_text_domain(); + + // Set up the admin settings page. + add_action( 'admin_menu', array( $this, 'add_settings_page' ) ); + add_action( 'admin_init', array( $this, 'add_settings' ) ); + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); + + // Handle saving options via AJAX. + add_action( 'wp_ajax_bfa_save_options', array( $this, 'save_options' ) ); + } + + /** + * Do necessary initialization actions. + * + * @since 0.10.0 + */ + private function initialize() { + + // Set display name. + $this->plugin_display_name = __( 'Better Font Awesome', 'better-font-awesome' ); + + // Set options name. + $this->option_name = self::SLUG . '_options'; + + // Set up main Better Font Awesome Library file path. + $this->bfa_lib_file_path = plugin_dir_path( __FILE__ ) . 'vendor/mickey-kay/better-font-awesome-library/better-font-awesome-library.php'; + + // Get plugin options, and populate defaults as needed. + $this->initialize_options( $this->option_name ); + } + + /** + * Get class prop. + * + * @since 1.7.0 + * + * @param string $prop Prop to fetch. + * + * @return mixed Value of the prop. + */ + public function get( $prop ) { + return $this->$prop; + } + + /** + * Check if the Better Font Awesome Library is included. + * + * @since 0.10.0 + */ + public function bfal_exists() { + if ( ! is_readable( $this->bfa_lib_file_path ) ) { + return false; + } else { + return true; + } + } + + /** + * Get BFAL instance. + * + * @since 2.0.0 + * + * @return Object BFAL instance. + */ + public function get_bfa_lib_instance() { + return $this->bfa_lib; + } + + /** + * Deactivate and display an error if the BFAL isn't included. + * + * @since 0.10.0 + */ + public function deactivate() { + deactivate_plugins( plugin_basename( __FILE__ ) ); + + $message = '' . __( 'It appears that Better Font Awesome is missing it\'s core library, which typically occurs when cloning the Git repository and failing to run composer install. Please refer to the plugin\'s installation instructions for details on how to properly install Better Font Awesome via Git. If you installed from within WordPress, or via the wordpress.org repo, then chances are the install failed and you can try again. If the issue persists, please create a new topic on the plugin\'s support forum or file an issue on the Github repo.', 'better-font-awesome' ) . '
' . __( 'Back to the plugins page →', 'better-font-awesome' ) . '
'; + + wp_die( wp_kses_post( $message ) ); + } + + /** + * Include required files. + * + * @since 0.10.0 + */ + private function includes() { + + // Better Font Awesome Library. + require_once $this->bfa_lib_file_path; + } + + /** + * Get plugin options, or initialize with default values. + * + * @since 0.10.0 + * + * @param string $option_name Name/slug for the plugin options object. + */ + private function initialize_options( $option_name ) { + /** + * Get plugin options. + * + * Run maybe_unserialize() in case we're updating from the old + * serialized Titan Framwork option to a new, array-based options. + */ + $this->options = maybe_unserialize( get_option( $option_name ) ); + + // Initialize the plugin options with defaults if they're not set. + if ( empty( $this->options ) ) { + update_option( $option_name, $this->option_defaults ); + } + + /** + * Set v4 shim option to true if this is the first time the + * option is present, indicating an update from legacy v4 + * support and will need shim support. + */ + if ( ! empty( $this->options ) && ! isset( $this->options['include_v4_shim'] ) ) { + $this->options['include_v4_shim'] = 1; + update_option( $option_name, $this->options ); + } + } + + /** + * Initialize the Better Font Awesome Library object. + * + * @since 0.9.0 + * + * @param array $options Plugin options. + */ + private function initialize_better_font_awesome_library( $options ) { + + // Hide admin notices if setting is checked. + // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison + if ( $options && true == $options['hide_admin_notices'] ) { + add_filter( 'bfa_show_errors', '__return_false' ); + } + + // Initialize BFA library. + $args = array( + 'include_v4_shim' => isset( $options['include_v4_shim'] ) ? $options['include_v4_shim'] : '', + 'remove_existing_fa' => isset( $options['remove_existing_fa'] ) ? $options['remove_existing_fa'] : '', + 'load_styles' => true, + 'load_admin_styles' => true, + 'load_shortcode' => true, + 'load_tinymce_plugin' => true, + ); + + $this->bfa_lib = Better_Font_Awesome_Library::get_instance( $args ); + } + + /** + * Load plugin text domain. + * + * @since 0.10.0 + */ + public function load_text_domain() { + load_plugin_textdomain( self::SLUG, false, dirname( plugin_basename( __FILE__ ) ) . '/languages' ); + } + + /** + * Create the plugin settings page. + */ + public function add_settings_page() { + add_options_page( + $this->plugin_display_name, + $this->plugin_display_name, + 'manage_options', + self::SLUG, + array( $this, 'create_admin_page' ) + ); + } + + /** + * Output the plugin settings page contents. + * + * @since 0.10.0 + */ + public function create_admin_page() { + ?> +' . esc_html__( 'Settings saved.', 'better-font-awesome' ) . '
' . esc_html( 'Settings saved.', 'better-font-awesome' ) . '