• File: class-fusion-patcher-admin-notices.php
  • Full Path: /home/docteuh/www/plugins/fusion-builder/inc/lib/inc/class-fusion-patcher-admin-notices.php
  • Date Modified: 11/20/2023 6:12 PM
  • File size: 2.8 KB
  • MIME-type: text/x-php
  • Charset: utf-8
<?php
/**
 * Handles Admin notices for the patcher.
 *
 * @package Fusion-Library
 * @subpackage Fusion-Patcher
 */

/**
 * Takes care of adding the admin notices.
 * This class works in conjunction with Fusion_Patcher_Admin_Screen
 *
 * @since 1.0.0
 */
class Fusion_Patcher_Admin_Notices {

	/**
	 * The option name.
	 * We'll be using an option to store the messages.
	 *
	 * @static
	 * @access private
	 * @var string
	 */
	public static $option_name = 'fusion_patcher_messages';

	/**
	 * The context/ID of the message.
	 * This is used to avoid multiple occurences of the same message.
	 *
	 * @access private
	 * @since 5.0.0
	 * @var string
	 */
	private $context = '';

	/**
	 * The message to add.
	 *
	 * @access private
	 * @since 5.0.0
	 * @var string
	 */
	private $message = '';

	/**
	 * Constructor.
	 *
	 * @access public
	 * @since 5.0.0
	 * @param string $context The context/ID of the message to be added.
	 * @param string $message The message we want to display.
	 */
	public function __construct( $context = '', $message = '' ) {

		// No reason to continue if the message is empty.
		if ( empty( $message ) ) {
			return;
		}

		// Add the message.
		$this->context = $context;
		$this->message = $message;
		$this->add_message();
	}

	/**
	 * Adds the message to an option.
	 * This option will later be deleted as soon as it's displayed.
	 *
	 * @access private
	 * @since 5.0.0
	 * @see Fusion_Patcher_Admin_Screen::form for the option deletion process.
	 * @return void
	 */
	private function add_message() {
		// Get the option.
		$messages = self::get_messages();
		// Add the message to the array of messages to display.
		if ( ! isset( $messages[ $this->context ] ) ) {
			$messages[ $this->context ] = $this->message;
		}
		// Update the option.
		update_site_option( self::$option_name, $messages );
	}

	/**
	 * Gets an array of all messages.
	 *
	 * @static
	 * @access public
	 * @return array
	 */
	public static function get_messages() {
		// Get the option.
		$messages = get_site_option( self::$option_name, [] );
		// Make sure the option is formatted as an array.
		// If not an array, then return an empty array to avoid errors.
		if ( ! is_array( $messages ) ) {
			return [];
		}
		return $messages;
	}

	/**
	 * Deletes the messages option.
	 *
	 * @static
	 * @access public
	 * @since 5.0.0
	 * @param string|false $context Since 5.0.2 the message to be removed.
	 * @return void
	 */
	public static function remove_messages_option( $context = false ) {

		// If context is false, then delete everything.
		if ( false === $context ) {
			delete_site_option( self::$option_name );
			return;
		}
		$options = get_site_option( self::$option_name, [] );
		if ( is_array( $options ) && isset( $options[ $context ] ) ) {
			unset( $options[ $context ] );
		}
		update_site_option( self::$option_name, $options );

	}
}