WordImpress / Give

includes/class-notices.php

Spacing +112 added lines, -113 removed lines

@@ -10,7 +10,7 @@ 
  */
 
 // Exit if accessed directly.
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -53,21 +53,21 @@ 
 	 * @since 1.8.9
 	 */
 	public function __construct() {
-		add_action( 'admin_notices', array( $this, 'render_admin_notices' ), 999 );
-		add_action( 'give_dismiss_notices', array( $this, 'dismiss_notices' ) );
+		add_action('admin_notices', array($this, 'render_admin_notices'), 999);
+		add_action('give_dismiss_notices', array($this, 'dismiss_notices'));
 
-		add_action( 'give_frontend_notices', array( $this, 'render_frontend_notices' ), 999 );
-		add_action( 'give_pre_form_output', array( $this, 'render_frontend_form_notices' ), 10, 1 );
-		add_action( 'give_ajax_donation_errors', array( $this, 'render_frontend_notices' ) );
+		add_action('give_frontend_notices', array($this, 'render_frontend_notices'), 999);
+		add_action('give_pre_form_output', array($this, 'render_frontend_form_notices'), 10, 1);
+		add_action('give_ajax_donation_errors', array($this, 'render_frontend_notices'));
 
 		/**
 		 * Backward compatibility for deprecated params.
 		 *
 		 * @since 1.8.14
 		 */
-		add_filter( 'give_register_notice_args', array( $this, 'bc_deprecated_params' ) );
-		add_filter( 'give_frontend_errors_args', array( $this, 'bc_deprecated_params' ) );
-		add_filter( 'give_frontend_notice_args', array( $this, 'bc_deprecated_params' ) );
+		add_filter('give_register_notice_args', array($this, 'bc_deprecated_params'));
+		add_filter('give_frontend_errors_args', array($this, 'bc_deprecated_params'));
+		add_filter('give_frontend_notice_args', array($this, 'bc_deprecated_params'));
 	}
 
 	/**
@@ -80,19 +80,19 @@ 
 	 *
 	 * @return array
 	 */
-	public function bc_deprecated_params( $args ) {
+	public function bc_deprecated_params($args) {
 		/**
 		 *  Param: auto_dismissible
 		 *  deprecated in 1.8.14
 		 *
 		 *  Check if auto_dismissible is set and it true then unset and change dismissible parameter value to auto
 		 */
-		if ( isset( $args['auto_dismissible'] ) ) {
-			if ( ! empty( $args['auto_dismissible'] ) ) {
+		if (isset($args['auto_dismissible'])) {
+			if ( ! empty($args['auto_dismissible'])) {
 				$args['dismissible'] = 'auto';
 			}
 			// unset auto_dismissible as it has been deprecated.
-			unset( $args['auto_dismissible'] );
+			unset($args['auto_dismissible']);
 		}
 
 		return $args;
@@ -108,9 +108,9 @@ 
 	 *
 	 * @return bool
 	 */
-	public function register_notice( $notice_args ) {
+	public function register_notice($notice_args) {
 		// Bailout.
-		if ( empty( $notice_args['id'] ) || array_key_exists( $notice_args['id'], self::$notices ) ) {
+		if (empty($notice_args['id']) || array_key_exists($notice_args['id'], self::$notices)) {
 			return false;
 		}
 
@@ -159,39 +159,39 @@ 
 		 *
 		 * @since 1.8.14
 		 */
-		$notice_args = apply_filters( 'give_register_notice_args', $notice_args );
+		$notice_args = apply_filters('give_register_notice_args', $notice_args);
 
 		// Set extra dismiss links if any.
-		if ( false !== strpos( $notice_args['description'], 'data-dismiss-interval' ) ) {
+		if (false !== strpos($notice_args['description'], 'data-dismiss-interval')) {
 
-			preg_match_all( "/data-([^\"]*)=\"([^\"]*)\"/", $notice_args['description'], $extra_notice_dismiss_link );
+			preg_match_all("/data-([^\"]*)=\"([^\"]*)\"/", $notice_args['description'], $extra_notice_dismiss_link);
 
-			if ( ! empty( $extra_notice_dismiss_link ) ) {
-				$extra_notice_dismiss_links = array_chunk( current( $extra_notice_dismiss_link ), 3 );
-				foreach ( $extra_notice_dismiss_links as $extra_notice_dismiss_link ) {
+			if ( ! empty($extra_notice_dismiss_link)) {
+				$extra_notice_dismiss_links = array_chunk(current($extra_notice_dismiss_link), 3);
+				foreach ($extra_notice_dismiss_links as $extra_notice_dismiss_link) {
 					// Create array og key ==> value by parsing query string created after renaming data attributes.
-					$data_attribute_query_str = str_replace( array( 'data-', '-', '"' ), array(
+					$data_attribute_query_str = str_replace(array('data-', '-', '"'), array(
 						'',
 						'_',
 						'',
-					), implode( '&', $extra_notice_dismiss_link ) );
+					), implode('&', $extra_notice_dismiss_link));
 
-					$notice_args['extra_links'][] = wp_parse_args( $data_attribute_query_str );
+					$notice_args['extra_links'][] = wp_parse_args($data_attribute_query_str);
 				}
 			}
 		}
 
 
-		self::$notices[ $notice_args['id'] ] = $notice_args;
+		self::$notices[$notice_args['id']] = $notice_args;
 
 		// Auto set show param if not already set.
-		if ( ! isset( self::$notices[ $notice_args['id'] ]['show'] ) ) {
-			self::$notices[ $notice_args['id'] ]['show'] = $this->is_notice_dismissed( $notice_args ) ? false : true;
+		if ( ! isset(self::$notices[$notice_args['id']]['show'])) {
+			self::$notices[$notice_args['id']]['show'] = $this->is_notice_dismissed($notice_args) ? false : true;
 		}
 
 		// Auto set time interval for shortly.
-		if ( 'shortly' === self::$notices[ $notice_args['id'] ]['dismiss_interval'] ) {
-			self::$notices[ $notice_args['id'] ]['dismiss_interval_time'] = DAY_IN_SECONDS;
+		if ('shortly' === self::$notices[$notice_args['id']]['dismiss_interval']) {
+			self::$notices[$notice_args['id']]['dismiss_interval_time'] = DAY_IN_SECONDS;
 		}
 
 		return true;
@@ -205,51 +205,51 @@ 
 	 */
 	public function render_admin_notices() {
 		// Bailout.
-		if ( empty( self::$notices ) ) {
+		if (empty(self::$notices)) {
 			return;
 		}
 
 		$output = '';
 
-		foreach ( self::$notices as $notice_id => $notice ) {
+		foreach (self::$notices as $notice_id => $notice) {
 			// Check flag set to true to show notice.
-			if ( ! $notice['show'] ) {
+			if ( ! $notice['show']) {
 				continue;
 			}
 
 
 			// Render custom html.
-			if( ! empty( $notice['description_html'] ) ) {
+			if ( ! empty($notice['description_html'])) {
 				$output .= "{$notice['description_html']} \n";
 				continue;
 			}
 
 			// Check if notice dismissible or not.
-			if ( ! self::$has_auto_dismissible_notice ) {
-				self::$has_auto_dismissible_notice = ( 'auto' === $notice['dismissible'] );
+			if ( ! self::$has_auto_dismissible_notice) {
+				self::$has_auto_dismissible_notice = ('auto' === $notice['dismissible']);
 			}
 
 			// Check if notice dismissible or not.
-			if ( ! self::$has_dismiss_interval_notice ) {
+			if ( ! self::$has_dismiss_interval_notice) {
 				self::$has_dismiss_interval_notice = $notice['dismiss_interval'];
 			}
 
-			$css_id = ( false === strpos( $notice['id'], 'give' ) ? "give-{$notice['id']}" : $notice['id'] );
+			$css_id = (false === strpos($notice['id'], 'give') ? "give-{$notice['id']}" : $notice['id']);
 
-			$css_class = 'give-notice notice ' . ( empty( $notice['dismissible'] ) ? 'non' : 'is' ) . "-dismissible {$notice['type']} notice-{$notice['type']}";
-			$output    .= sprintf(
-				'<div id="%1$s" class="%2$s" data-dismissible="%3$s" data-dismissible-type="%4$s" data-dismiss-interval="%5$s" data-notice-id="%6$s" data-security="%7$s" data-dismiss-interval-time="%8$s" style="display: none">' . " \n",
+			$css_class = 'give-notice notice '.(empty($notice['dismissible']) ? 'non' : 'is')."-dismissible {$notice['type']} notice-{$notice['type']}";
+			$output .= sprintf(
+				'<div id="%1$s" class="%2$s" data-dismissible="%3$s" data-dismissible-type="%4$s" data-dismiss-interval="%5$s" data-notice-id="%6$s" data-security="%7$s" data-dismiss-interval-time="%8$s" style="display: none">'." \n",
 				$css_id,
 				$css_class,
-				give_clean( $notice['dismissible'] ),
+				give_clean($notice['dismissible']),
 				$notice['dismissible_type'],
 				$notice['dismiss_interval'],
 				$notice['id'],
-				empty( $notice['dismissible_type'] ) ? '' : wp_create_nonce( "give_edit_{$notice_id}_notice" ),
+				empty($notice['dismissible_type']) ? '' : wp_create_nonce("give_edit_{$notice_id}_notice"),
 				$notice['dismiss_interval_time']
 			);
 
-			$output .= ( 0 === strpos( $notice['description'], '<div' ) || 0 === strpos( $notice['description'], '<p' ) ? $notice['description'] : "<p>{$notice['description']}</p>" );
+			$output .= (0 === strpos($notice['description'], '<div') || 0 === strpos($notice['description'], '<p') ? $notice['description'] : "<p>{$notice['description']}</p>");
 			$output .= "</div> \n";
 		}
 
@@ -267,18 +267,18 @@ 
 	 *
 	 * @param int $form_id
 	 */
-	public function render_frontend_notices( $form_id = 0 ) {
+	public function render_frontend_notices($form_id = 0) {
 		$errors = give_get_errors();
 
-		$request_form_id = isset( $_REQUEST['form-id'] ) ? absint( $_REQUEST['form-id'] ) : 0;
+		$request_form_id = isset($_REQUEST['form-id']) ? absint($_REQUEST['form-id']) : 0;
 
 		// Sanity checks first: Ensure that gateway returned errors display on the appropriate form.
-		if ( ! isset( $_POST['give_ajax'] ) && $request_form_id !== $form_id ) {
+		if ( ! isset($_POST['give_ajax']) && $request_form_id !== $form_id) {
 			return;
 		}
 
-		if ( $errors ) {
-			self::print_frontend_errors( $errors );
+		if ($errors) {
+			self::print_frontend_errors($errors);
 
 			give_clear_errors();
 		}
@@ -295,13 +295,13 @@ 
 	 *
 	 * @return void
 	 */
-	public function render_frontend_form_notices( $form_id ) {
-		$display_option = give_get_meta( $form_id, '_give_payment_display', true );
+	public function render_frontend_form_notices($form_id) {
+		$display_option = give_get_meta($form_id, '_give_payment_display', true);
 
-		if ( 'modal' === $display_option ) {
-			add_action( 'give_payment_mode_top', array( $this, 'render_frontend_notices' ) );
+		if ('modal' === $display_option) {
+			add_action('give_payment_mode_top', array($this, 'render_frontend_notices'));
 		} else {
-			add_action( 'give_pre_form', array( $this, 'render_frontend_notices' ), 11 );
+			add_action('give_pre_form', array($this, 'render_frontend_notices'), 11);
 		}
 	}
 
@@ -312,7 +312,7 @@ 
 	 * @access private
 	 */
 	private function print_js() {
-		if ( self::$has_auto_dismissible_notice ) :
+		if (self::$has_auto_dismissible_notice) :
 			?>
 			<script>
 				jQuery(document).ready(function () {
@@ -328,7 +328,7 @@ 
 			<?php
 		endif;
 
-		if ( self::$has_dismiss_interval_notice ) :
+		if (self::$has_dismiss_interval_notice) :
 			?>
 			<script>
 				jQuery(document).ready(function () {
@@ -407,36 +407,36 @@ 
 	 * @access public
 	 */
 	public function dismiss_notices() {
-		$_post     = give_clean( $_POST );
-		$notice_id = esc_attr( $_post['notice_id'] );
+		$_post     = give_clean($_POST);
+		$notice_id = esc_attr($_post['notice_id']);
 
 		// Bailout.
 		if (
-			empty( $notice_id ) ||
-			empty( $_post['dismissible_type'] ) ||
-			empty( $_post['dismiss_interval'] ) ||
-			! check_ajax_referer( "give_edit_{$notice_id}_notice", '_wpnonce' )
+			empty($notice_id) ||
+			empty($_post['dismissible_type']) ||
+			empty($_post['dismiss_interval']) ||
+			! check_ajax_referer("give_edit_{$notice_id}_notice", '_wpnonce')
 		) {
 			wp_send_json_error();
 		}
 
-		$notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'] );
-		if ( 'user' === $_post['dismissible_type'] ) {
+		$notice_key = Give()->notices->get_notice_key($notice_id, $_post['dismiss_interval']);
+		if ('user' === $_post['dismissible_type']) {
 			$current_user = wp_get_current_user();
-			$notice_key   = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'], $current_user->ID );
+			$notice_key   = Give()->notices->get_notice_key($notice_id, $_post['dismiss_interval'], $current_user->ID);
 		}
 
-		$notice_dismiss_time = ! empty( $_post['dismiss_interval_time'] ) ? $_post['dismiss_interval_time'] : null;
+		$notice_dismiss_time = ! empty($_post['dismiss_interval_time']) ? $_post['dismiss_interval_time'] : null;
 
 		// Save option to hide notice.
-		Give_Cache::set( $notice_key, true, $notice_dismiss_time, true );
+		Give_Cache::set($notice_key, true, $notice_dismiss_time, true);
 
 		/**
 		 * Fire the action when notice dismissed
 		 *
 		 * @since 2.2.0
 		 */
-		do_action( 'give_notice_dismissed', $_post );
+		do_action('give_notice_dismissed', $_post);
 
 		wp_send_json_success();
 	}
@@ -454,18 +454,18 @@ 
 	 *
 	 * @return string
 	 */
-	public function get_notice_key( $notice_id, $dismiss_interval = null, $user_id = 0 ) {
+	public function get_notice_key($notice_id, $dismiss_interval = null, $user_id = 0) {
 		$notice_key = "_give_notice_{$notice_id}";
 
-		if ( ! empty( $dismiss_interval ) ) {
+		if ( ! empty($dismiss_interval)) {
 			$notice_key .= "_{$dismiss_interval}";
 		}
 
-		if ( $user_id ) {
+		if ($user_id) {
 			$notice_key .= "_{$user_id}";
 		}
 
-		$notice_key = sanitize_key( $notice_key );
+		$notice_key = sanitize_key($notice_key);
 
 		return $notice_key;
 	}
@@ -478,11 +478,11 @@ 
 	 *
 	 * @return string
 	 */
-	public function get_dismiss_link( $notice_args ) {
+	public function get_dismiss_link($notice_args) {
 		$notice_args = wp_parse_args(
 			$notice_args,
 			array(
-				'title'                 => __( 'Click here', 'give' ),
+				'title'                 => __('Click here', 'give'),
 				'dismissible_type'      => '',
 				'dismiss_interval'      => '',
 				'dismiss_interval_time' => null,
@@ -509,31 +509,31 @@ 
 	 *
 	 * @return bool|null
 	 */
-	public function is_notice_dismissed( $notice ) {
-		$notice_key          = $this->get_notice_key( $notice['id'], $notice['dismiss_interval'] );
+	public function is_notice_dismissed($notice) {
+		$notice_key          = $this->get_notice_key($notice['id'], $notice['dismiss_interval']);
 		$is_notice_dismissed = false;
 
-		if ( 'user' === $notice['dismissible_type'] ) {
+		if ('user' === $notice['dismissible_type']) {
 			$current_user = wp_get_current_user();
-			$notice_key   = Give()->notices->get_notice_key( $notice['id'], $notice['dismiss_interval'], $current_user->ID );
+			$notice_key   = Give()->notices->get_notice_key($notice['id'], $notice['dismiss_interval'], $current_user->ID);
 		}
 
-		$notice_data = Give_Cache::get( $notice_key, true );
+		$notice_data = Give_Cache::get($notice_key, true);
 
 		// Find notice dismiss link status if notice has extra dismissible links.
-		if ( ( empty( $notice_data ) || is_wp_error( $notice_data ) ) && ! empty( $notice['extra_links'] ) ) {
+		if ((empty($notice_data) || is_wp_error($notice_data)) && ! empty($notice['extra_links'])) {
 
-			foreach ( $notice['extra_links'] as $extra_link ) {
-				$new_notice_data = wp_parse_args( $extra_link, $notice );
-				unset( $new_notice_data['extra_links'] );
+			foreach ($notice['extra_links'] as $extra_link) {
+				$new_notice_data = wp_parse_args($extra_link, $notice);
+				unset($new_notice_data['extra_links']);
 
-				if ( $is_notice_dismissed = $this->is_notice_dismissed( $new_notice_data ) ) {
+				if ($is_notice_dismissed = $this->is_notice_dismissed($new_notice_data)) {
 					return $is_notice_dismissed;
 				}
 			}
 		}
 
-		$is_notice_dismissed = ! empty( $notice_data ) && ! is_wp_error( $notice_data );
+		$is_notice_dismissed = ! empty($notice_data) && ! is_wp_error($notice_data);
 
 		return $is_notice_dismissed;
 	}
@@ -547,9 +547,9 @@ 
 	 *
 	 * @param array $errors
 	 */
-	public static function print_frontend_errors( $errors ) {
+	public static function print_frontend_errors($errors) {
 		// Bailout.
-		if ( ! $errors ) {
+		if ( ! $errors) {
 			return;
 		}
 
@@ -564,37 +564,37 @@ 
 		);
 
 		// Note: we will remove give_errors class in future.
-		$classes = apply_filters( 'give_error_class', array( 'give_notices', 'give_errors' ) );
+		$classes = apply_filters('give_error_class', array('give_notices', 'give_errors'));
 
-		echo sprintf( '<div class="%s">', implode( ' ', $classes ) );
+		echo sprintf('<div class="%s">', implode(' ', $classes));
 
 		// Loop error codes and display errors.
-		foreach ( $errors as $error_id => $error ) {
+		foreach ($errors as $error_id => $error) {
 			// Backward compatibility v<1.8.11
-			if ( is_string( $error ) ) {
+			if (is_string($error)) {
 				$error = array(
 					'message'     => $error,
 					'notice_args' => array(),
 				);
 			}
 
-			$notice_args = wp_parse_args( $error['notice_args'], $default_notice_args );
+			$notice_args = wp_parse_args($error['notice_args'], $default_notice_args);
 
 			/**
 			 * Filter to modify Frontend Errors args before errors is display.
 			 *
 			 * @since 1.8.14
 			 */
-			$notice_args = apply_filters( 'give_frontend_errors_args', $notice_args );
+			$notice_args = apply_filters('give_frontend_errors_args', $notice_args);
 
 			echo sprintf(
 				'<div class="give_error give_notice" id="give_error_%1$s" data-dismissible="%2$s" data-dismiss-interval="%3$d">
 						<p><strong>%4$s</strong>: %5$s</p>
 					</div>',
 				$error_id,
-				give_clean( $notice_args['dismissible'] ),
-				absint( $notice_args['dismiss_interval'] ),
-				esc_html__( 'Error', 'give' ),
+				give_clean($notice_args['dismissible']),
+				absint($notice_args['dismiss_interval']),
+				esc_html__('Error', 'give'),
 				$error['message']
 			);
 		}
@@ -616,8 +616,8 @@ 
 	 *
 	 * @return  string
 	 */
-	public static function print_frontend_notice( $message, $echo = true, $notice_type = 'warning', $notice_args = array() ) {
-		if ( empty( $message ) ) {
+	public static function print_frontend_notice($message, $echo = true, $notice_type = 'warning', $notice_args = array()) {
+		if (empty($message)) {
 			return '';
 		}
 
@@ -632,7 +632,7 @@ 
 			'dismiss_interval' => 5000,
 		);
 
-		$notice_args = wp_parse_args( $notice_args, $default_notice_args );
+		$notice_args = wp_parse_args($notice_args, $default_notice_args);
 
 		// Notice dismissible must be true for dismiss type.
 		$notice_args['dismiss_type'] = ! $notice_args['dismissible'] ? '' : $notice_args['dismiss_type'];
@@ -642,15 +642,14 @@ 
 		 *
 		 * @since 1.8.14
 		 */
-		$notice_args = apply_filters( 'give_frontend_notice_args', $notice_args );
+		$notice_args = apply_filters('give_frontend_notice_args', $notice_args);
 
 		$close_icon = 'manual' === $notice_args['dismiss_type'] ?
 			sprintf(
 				'<img class="notice-dismiss give-notice-close" src="%s" />',
-				esc_url( GIVE_PLUGIN_URL . 'assets/dist/images/close.svg' )
+				esc_url(GIVE_PLUGIN_URL.'assets/dist/images/close.svg')
 
-			) :
-			'';
+			) : '';
 
 		// Note: we will remove give_errors class in future.
 		$error = sprintf(
@@ -661,15 +660,15 @@ 
 						%6$s
 					</div>',
 			$notice_type,
-			give_clean( $notice_args['dismissible'] ),
-			absint( $notice_args['dismiss_interval'] ),
-			give_clean( $notice_args['dismiss_type'] ),
+			give_clean($notice_args['dismissible']),
+			absint($notice_args['dismiss_interval']),
+			give_clean($notice_args['dismiss_type']),
 			$message,
 			$close_icon
 
 		);
 
-		if ( ! $echo ) {
+		if ( ! $echo) {
 			return $error;
 		}
 
@@ -689,24 +688,24 @@ 
 	 *
 	 * @return string
 	 */
-	public function print_admin_notices( $notice_args = array() ) {
+	public function print_admin_notices($notice_args = array()) {
 		// Bailout.
-		if ( empty( $notice_args['description'] ) ) {
+		if (empty($notice_args['description'])) {
 			return '';
 		}
 
-		$defaults    = array(
+		$defaults = array(
 			'id'          => '',
 			'echo'        => true,
 			'notice_type' => 'warning',
 			'dismissible' => true,
 		);
-		$notice_args = wp_parse_args( $notice_args, $defaults );
+		$notice_args = wp_parse_args($notice_args, $defaults);
 
 		$output    = '';
-		$css_id    = ! empty( $notice_args['id'] ) ? $notice_args['id'] : uniqid( 'give-inline-notice-' );
+		$css_id    = ! empty($notice_args['id']) ? $notice_args['id'] : uniqid('give-inline-notice-');
 		$css_class = "notice-{$notice_args['notice_type']} give-notice notice inline";
-		$css_class .= ( $notice_args['dismissible'] ) ? ' is-dismissible' : '';
+		$css_class .= ($notice_args['dismissible']) ? ' is-dismissible' : '';
 		$output    .= sprintf(
 			'<div id="%1$s" class="%2$s"><p>%3$s</p></div>',
 			$css_id,
@@ -714,7 +713,7 @@ 
 			$notice_args['description']
 		);
 
-		if ( ! $notice_args['echo'] ) {
+		if ( ! $notice_args['echo']) {
 			return $output;
 		}