Current File : /home/kelaby89/sergio-cuchi.tattoo/wp-content/plugins/envira-gallery-lite/includes/admin/notice.php |
<?php
/**
* Notices admin class.
*
* Handles retrieving whether a particular notice has been dismissed or not,
* as well as marking a notice as dismissed.
*
* @since 1.3.5
*
* @package Envira_Gallery
* @author Envira Team
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Notice Helper Class
*
* @since 1.0.0
*/
class Envira_Gallery_Notice_Admin {
/**
* Holds the class object.
*
* @since 1.3.5
*
* @var object
*/
public static $instance;
/**
* Path to the file.
*
* @since 1.3.5
*
* @var string
*/
public $file = __FILE__;
/**
* Holds the base class object.
*
* @since 1.3.5
*
* @var object
*/
public $base;
/**
* Holds all dismissed notices
*
* @since 1.3.5
*
* @var array
*/
public $notices;
/**
* Primary class constructor.
*
* @since 1.3.5
*/
public function __construct() {
// Populate $notices.
$this->notices = get_option( 'envira_gallery_notices' );
if ( ! is_array( $this->notices ) ) {
$this->notices = [];
}
}
/**
* Checks if a given notice has been dismissed or not
*
* @since 1.3.5
*
* @param string $notice Programmatic Notice Name.
* @return bool Notice Dismissed
*/
public function is_dismissed( $notice ) {
if ( ! isset( $this->notices[ $notice ] ) ) {
return false;
}
return true;
}
/**
* Marks the given notice as dismissed
*
* @since 1.3.5
*
* @param string $notice Programmatic Notice Name.
* @return void
*/
public function dismiss( $notice ) {
$this->notices[ $notice ] = true;
update_option( 'envira_gallery_notices', $this->notices );
}
/**
* Marks a notice as not dismissed
*
* @since 1.3.5
*
* @param string $notice Programmatic Notice Name.
* @return void
*/
public function undismiss( $notice ) {
unset( $this->notices[ $notice ] );
update_option( 'envira_gallery_notices', $this->notices );
}
/**
* Displays an inline notice with some Envira styling.
*
* @since 1.3.5
*
* @param string $notice Programmatic Notice Name.
* @param string $title Title.
* @param string $message Message.
* @param string $type Message Type (updated|warning|error) - green, yellow/orange and red respectively.
* @param string $button_text Button Text (optional).
* @param string $button_url Button URL (optional).
* @param bool $is_dismissible User can Dismiss Message (default: true).
*/
public function display_inline_notice( $notice, $title, $message, $type = 'success', $button_text = '', $button_url = '', $is_dismissible = true ) {
// Check if the notice is dismissible, and if so has been dismissed.
if ( $is_dismissible && $this->is_dismissed( $notice ) ) {
// Nothing to show here, return!
return;
}
// Display inline notice.
?>
<div class="envira-notice <?php echo esc_attr( $type ) . ( $is_dismissible ? ' is-dismissible' : '' ); ?>" data-notice="<?php echo esc_attr( $notice ); ?>">
<?php
// Title.
if ( ! empty( $title ) ) {
?>
<p class="envira-intro"><?php echo esc_html( $title ); ?></p>
<?php
}
// Message.
if ( ! empty( $message ) ) {
?>
<p><?php echo $message; // @codingStandardsIgnoreLine ?></p>
<?php
}
// Button.
if ( ! empty( $button_text ) && ! empty( $button_url ) ) {
?>
<a href="<?php echo esc_url( $button_url ); ?>" target="_blank" class="button button-primary"><?php echo esc_html( $button_text ); ?></a>
<?php
}
// Dismiss Button.
if ( $is_dismissible ) {
?>
<button type="button" class="notice-dismiss">
<span class="screen-reader-text">
<?php esc_html_e( 'Dismiss this notice', 'envira-gallery-lite' ); ?>
</span>
</button>
<?php
}
?>
</div>
<?php
}
/**
* Returns the singleton instance of the class.
*
* @since 1.3.5
*
* @return object The Envira_Gallery_Notice_Admin object.
*/
public static function get_instance() {
if ( ! isset( self::$instance ) && ! ( self::$instance instanceof Envira_Gallery_Notice_Admin ) ) {
self::$instance = new Envira_Gallery_Notice_Admin();
}
return self::$instance;
}
}
// Load the notice admin class.
$envira_gallery_notice_admin = Envira_Gallery_Notice_Admin::get_instance();