gravityview / GravityView

includes/extensions/entry-notes/class-gravityview-field-notes.php

Spacing +81 added lines, -81 removed lines

@@ -63,19 +63,19 @@ 
 
 		add_shortcode( 'gv_note_add', array( 'GravityView_Field_Notes', 'get_add_note_part' ) );
 
-		add_action( 'wp', array( $this, 'maybe_delete_notes'), 1000 );
-		add_action( 'wp_ajax_nopriv_gv_delete_notes', array( $this, 'maybe_delete_notes') );
-		add_action( 'wp_ajax_gv_delete_notes', array( $this, 'maybe_delete_notes') );
+		add_action( 'wp', array( $this, 'maybe_delete_notes' ), 1000 );
+		add_action( 'wp_ajax_nopriv_gv_delete_notes', array( $this, 'maybe_delete_notes' ) );
+		add_action( 'wp_ajax_gv_delete_notes', array( $this, 'maybe_delete_notes' ) );
 
-		add_action( 'wp', array( $this, 'maybe_add_note'), 1000 );
-		add_action( 'wp_ajax_nopriv_gv_note_add', array( $this, 'maybe_add_note') );
-		add_action( 'wp_ajax_gv_note_add', array( $this, 'maybe_add_note') );
+		add_action( 'wp', array( $this, 'maybe_add_note' ), 1000 );
+		add_action( 'wp_ajax_nopriv_gv_note_add', array( $this, 'maybe_add_note' ) );
+		add_action( 'wp_ajax_gv_note_add', array( $this, 'maybe_add_note' ) );
 
 		// add template path to check for field
 		add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) );
 		add_filter( 'gravityview/template/fields_template_paths', array( $this, 'add_template_path' ) );
 
-		add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts') );
+		add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts' ) );
 		add_action( 'gravityview/field/notes/scripts', array( $this, 'enqueue_scripts' ) );
 		
 		add_filter( 'gravityview_entry_default_fields', array( $this, 'add_entry_default_field' ), 10, 3 );
@@ -97,8 +97,8 @@ 
 	 */
 	public function add_entry_default_field( $entry_default_fields, $form, $zone ) {
 
-		if( in_array( $zone, array( 'directory', 'single' ) ) ) {
-			$entry_default_fields['notes'] = array(
+		if ( in_array( $zone, array( 'directory', 'single' ) ) ) {
+			$entry_default_fields[ 'notes' ] = array(
 				'label' => __( 'Entry Notes', 'gravityview' ),
 				'type'  => 'notes',
 				'desc'  => __( 'Display, add, and delete notes for an entry.', 'gravityview' ),
@@ -131,23 +131,23 @@ 
 	public function enqueue_scripts() {
 		global $wp_actions;
 
-		if( ! wp_script_is( 'gravityview-notes', 'enqueued' ) ) {
+		if ( ! wp_script_is( 'gravityview-notes', 'enqueued' ) ) {
 			wp_enqueue_style( 'gravityview-notes' );
 			wp_enqueue_script( 'gravityview-notes' );
 		}
 
-		if( ! wp_script_is( 'gravityview-notes', 'done' ) ) {
+		if ( ! wp_script_is( 'gravityview-notes', 'done' ) ) {
 
 			$strings = self::strings();
 
 			wp_localize_script( 'gravityview-notes', 'GVNotes', array(
 				'ajaxurl' => admin_url( 'admin-ajax.php' ),
 				'text' => array(
-					'processing' => $strings['processing'],
-					'delete_confirm' => $strings['delete-confirm'],
-					'note_added' => $strings['added-note'],
-					'error_invalid' => $strings['error-invalid'],
-					'error_empty_note' => $strings['error-empty-note'],
+					'processing' => $strings[ 'processing' ],
+					'delete_confirm' => $strings[ 'delete-confirm' ],
+					'note_added' => $strings[ 'added-note' ],
+					'error_invalid' => $strings[ 'error-invalid' ],
+					'error_empty_note' => $strings[ 'error-empty-note' ],
 				),
 			) );
 		}
@@ -164,31 +164,31 @@ 
 	 */
 	function maybe_add_note() {
 
-		if( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) {
+		if ( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) {
 			gravityview()->log->error( 'The user isnt allowed to add entry notes.' );
 			return;
 		}
 
-		if( ! isset( $_POST['action'] ) ) {
+		if ( ! isset( $_POST[ 'action' ] ) ) {
 			return;
 		}
 
-		if( 'gv_note_add' === $_POST['action'] ) {
+		if ( 'gv_note_add' === $_POST[ 'action' ] ) {
 
-            if( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) {
+            if ( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) {
                 do_action( 'gravityview_log_error', __METHOD__ . ': The user isnt allowed to add entry notes.' );
                 return;
             }
 
 			$post = wp_unslash( $_POST );
 
-			if( $this->doing_ajax ) {
-				parse_str( $post['data'], $data );
+			if ( $this->doing_ajax ) {
+				parse_str( $post[ 'data' ], $data );
 			} else {
 				$data = $post;
 			}
 
-			$this->process_add_note( (array) $data );
+			$this->process_add_note( (array)$data );
 		}
 	}
 
@@ -215,23 +215,23 @@ 
 		$error = false;
 		$success = false;
 
-		if( empty( $data['entry-slug'] ) ) {
+		if ( empty( $data[ 'entry-slug' ] ) ) {
 
-			$error = self::strings('error-invalid');
+			$error = self::strings( 'error-invalid' );
 			gravityview()->log->error( 'The note is missing an Entry ID.' );
 
 		} else {
 
-			$valid = wp_verify_nonce( $data['gv_note_add'], 'gv_note_add_' . $data['entry-slug'] );
+			$valid = wp_verify_nonce( $data[ 'gv_note_add' ], 'gv_note_add_' . $data[ 'entry-slug' ] );
 			
 			$has_cap = GVCommon::has_cap( 'gravityview_add_entry_notes' );
 
-			if( ! $has_cap ) {
+			if ( ! $has_cap ) {
 				$error = self::strings( 'error-cap-add' );
 				gravityview()->log->error( 'Adding a note failed: the user does not have the "gravityview_add_entry_notes" capability.' );
 			} elseif ( $valid ) {
 
-				$entry = gravityview_get_entry( $data['entry-slug'], true, false );
+				$entry = gravityview_get_entry( $data[ 'entry-slug' ], true, false );
 
 				$added = $this->add_note( $entry, $data );
 
@@ -249,22 +249,22 @@ 
 					$this->maybe_send_entry_notes( $note, $entry, $data );
 
 					if ( $note ) {
-						$success = self::display_note( $note, ! empty( $data['show-delete'] ) );
+						$success = self::display_note( $note, ! empty( $data[ 'show-delete' ] ) );
 						gravityview()->log->debug( 'The note was successfully created', array( 'data' => compact( 'note', 'data' ) ) );
 					} else {
-						$error = self::strings('error-add-note');
+						$error = self::strings( 'error-add-note' );
 						gravityview()->log->error( 'The note was not successfully created', array( 'data' => compact( 'note', 'data' ) ) );
 					}
 				}
 			} else {
-				$error = self::strings('error-invalid');
+				$error = self::strings( 'error-invalid' );
 				gravityview()->log->error( 'Nonce validation failed; the note was not created' );
 			}
 		}
 
 
-		if( $this->doing_ajax ) {
-			if( $success ) {
+		if ( $this->doing_ajax ) {
+			if ( $success ) {
 				wp_send_json_success( array( 'html' => $success ) );
 			} else {
 				$error = $error ? $error : self::strings( 'error-invalid' );
@@ -290,11 +290,11 @@ 
 			return;
 		}
 
-		if ( isset( $_POST['action'] ) && 'gv_delete_notes' === $_POST['action'] ) {
+		if ( isset( $_POST[ 'action' ] ) && 'gv_delete_notes' === $_POST[ 'action' ] ) {
 
 			$post = wp_unslash( $_POST );
 			if ( $this->doing_ajax ) {
-				parse_str( $post['data'], $data );
+				parse_str( $post[ 'data' ], $data );
 			} else {
 				$data = $post;
 			}
@@ -325,18 +325,18 @@ 
 	 */
 	function process_delete_notes( $data ) {
 
-		$valid = wp_verify_nonce( $data['gv_delete_notes'], 'gv_delete_notes_' . $data['entry-slug'] );
+		$valid = wp_verify_nonce( $data[ 'gv_delete_notes' ], 'gv_delete_notes_' . $data[ 'entry-slug' ] );
 		$has_cap = GVCommon::has_cap( 'gravityview_delete_entry_notes' );
 		$success = false;
 
 		if ( $valid && $has_cap ) {
-			GravityView_Entry_Notes::delete_notes( $data['note'] );
+			GravityView_Entry_Notes::delete_notes( $data[ 'note' ] );
 			$success = true;
 		}
 
-		if( $this->doing_ajax ) {
+		if ( $this->doing_ajax ) {
 
-			if( $success ) {
+			if ( $success ) {
 				wp_send_json_success();
 			} else {
 				if ( ! $valid ) {
@@ -369,13 +369,13 @@ 
 
 	public function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
 
-		unset( $field_options['show_as_link'] );
+		unset( $field_options[ 'show_as_link' ] );
 
 		$notes_options = array(
 			'notes' => array(
 				'type' => 'checkboxes',
-				'label' => __('Note Settings', 'gravityview'),
-				'desc' => sprintf( _x('Only users with specific capabilities will be able to view, add and delete notes. %sRead more%s.', '%s is opening and closing HTML link', 'gravityview' ), '<a href="https://docs.gravityview.co/article/311-gravityview-capabilities">', '</a>' ),
+				'label' => __( 'Note Settings', 'gravityview' ),
+				'desc' => sprintf( _x( 'Only users with specific capabilities will be able to view, add and delete notes. %sRead more%s.', '%s is opening and closing HTML link', 'gravityview' ), '<a href="https://docs.gravityview.co/article/311-gravityview-capabilities">', '</a>' ),
 				'options' => array(
 					'view' => array(
 						'label' => __( 'Display notes?', 'gravityview' ),
@@ -427,7 +427,7 @@ 
 			'processing' => __( 'Processing&hellip;', 'gravityview' ),
 			'other-email' => __( 'Other email address', 'gravityview' ),
 			'email-label' => __( 'Email address', 'gravityview' ),
-			'email-placeholder' => _x('you@example.com', 'Example email address used as a placeholder', 'gravityview'),
+			'email-placeholder' => _x( 'you@example.com', 'Example email address used as a placeholder', 'gravityview' ),
 			'subject-label' => __( 'Subject', 'gravityview' ),
 			'subject' => __( 'Email subject', 'gravityview' ),
 			'default-email-subject' => __( 'New entry note', 'gravityview' ),
@@ -447,7 +447,7 @@ 
 		 */
 		$strings = gv_map_deep( apply_filters( 'gravityview/field/notes/strings', $strings ), 'esc_html' );
 
-		if( $key ) {
+		if ( $key ) {
 			return isset( $strings[ $key ] ) ? $strings[ $key ] : '';
 		}
 
@@ -469,7 +469,7 @@ 
 	 */
 	static public function display_note( $note, $show_delete = false, $context = null ) {
 
-		if( ! is_object( $note ) ) {
+		if ( ! is_object( $note ) ) {
 			return '';
 		}
 
@@ -524,7 +524,7 @@ 
 		}
 
 		$replacements = array(
-			'{note_id}' => $note_content['note_id'],
+			'{note_id}' => $note_content[ 'note_id' ],
 			'{row_class}' => 'gv-note',
 			'{note_detail}' => $note_detail_html
 		);
@@ -556,13 +556,13 @@ 
 
 		$user_data = get_userdata( $current_user->ID );
 
-		$note_content = trim( $data['gv-note-content'] );
+		$note_content = trim( $data[ 'gv-note-content' ] );
 
-		if( empty( $note_content ) ) {
+		if ( empty( $note_content ) ) {
 			return new WP_Error( 'gv-add-note-empty', __( 'The note is empty.', 'gravityview' ) );
 		}
 
-		$return = GravityView_Entry_Notes::add_note( $entry['id'], $user_data->ID, $user_data->display_name, $note_content, 'gravityview/field/notes' );
+		$return = GravityView_Entry_Notes::add_note( $entry[ 'id' ], $user_data->ID, $user_data->display_name, $note_content, 'gravityview/field/notes' );
 
 		return $return;
 	}
@@ -582,7 +582,7 @@ 
 
 		$atts = shortcode_atts( array( 'entry' => null ), $atts );
 
-		if( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) {
+		if ( ! GVCommon::has_cap( 'gravityview_add_entry_notes' ) ) {
 			gravityview()->log->error( 'User does not have permission to add entry notes ("gravityview_add_entry_notes").' );
 			return '';
 		}
@@ -604,8 +604,8 @@ 
 
 			$visibility_settings = $gravityview_view->getCurrentFieldSetting( 'notes' );
 
-			if ( $atts['entry'] ) {
-				$entry = GFAPI::get_entry( $atts['entry'] );
+			if ( $atts[ 'entry' ] ) {
+				$entry = GFAPI::get_entry( $atts[ 'entry' ] );
 			}
 
 			if ( ! isset( $entry ) || ! $entry ) {
@@ -615,19 +615,19 @@ 
 
 		// Strip extra whitespace in template
 		$add_note_html = gravityview_strip_whitespace( $add_note_html );
-		$entry_slug = GravityView_API::get_entry_slug( $entry['id'], $entry );
+		$entry_slug = GravityView_API::get_entry_slug( $entry[ 'id' ], $entry );
 		$nonce_field = wp_nonce_field( 'gv_note_add_' . $entry_slug, 'gv_note_add', false, false );
 
 		// Only generate the dropdown if the field settings allow it
 		$email_fields = '';
-		if( ! empty( $visibility_settings['email'] ) ) {
+		if ( ! empty( $visibility_settings[ 'email' ] ) ) {
 			$email_fields = self::get_note_email_fields( $entry_slug );
 		}
 
 		$add_note_html = str_replace( '{entry_slug}', $entry_slug, $add_note_html );
 		$add_note_html = str_replace( '{nonce_field}', $nonce_field, $add_note_html );
-		$add_note_html = str_replace( '{show_delete}', intval( empty( $visibility_settings['delete'] ) ? 0 : $visibility_settings['delete'] ), $add_note_html );
-		$add_note_html   = str_replace( '{email_fields}', $email_fields, $add_note_html );
+		$add_note_html = str_replace( '{show_delete}', intval( empty( $visibility_settings[ 'delete' ] ) ? 0 : $visibility_settings[ 'delete' ] ), $add_note_html );
+		$add_note_html = str_replace( '{email_fields}', $email_fields, $add_note_html );
 		$add_note_html = str_replace( '{url}', esc_url_raw( add_query_arg( array() ) ), $add_note_html );
 
 		return $add_note_html;
@@ -652,8 +652,8 @@ 
 		$note_emails = array();
 
 		foreach ( $email_fields as $email_field ) {
-			if ( ! empty( $entry["{$email_field->id}"] ) && is_email( $entry["{$email_field->id}"] ) ) {
-				$note_emails[] = $entry["{$email_field->id}"];
+			if ( ! empty( $entry[ "{$email_field->id}" ] ) && is_email( $entry[ "{$email_field->id}" ] ) ) {
+				$note_emails[ ] = $entry[ "{$email_field->id}" ];
 			}
 		}
 
@@ -665,7 +665,7 @@ 
 		 */
 		$note_emails = apply_filters( 'gravityview/field/notes/emails', $note_emails, $entry );
 
-		return (array) $note_emails;
+		return (array)$note_emails;
 	}
 
 	/**
@@ -681,7 +681,7 @@ 
 	 */
 	private static function get_note_email_fields( $entry_slug = '' ) {
 
-		if( ! GVCommon::has_cap( 'gravityview_email_entry_notes' ) ) {
+		if ( ! GVCommon::has_cap( 'gravityview_email_entry_notes' ) ) {
 			gravityview()->log->error( 'User does not have permission to email entry notes ("gravityview_email_entry_notes").' );
 			return '';
 		}
@@ -703,27 +703,27 @@ 
 
 		if ( ! empty( $note_emails ) || $include_custom ) { ?>
 			<div class="gv-note-email-container">
-				<label for="gv-note-email-to-<?php echo $entry_slug_esc; ?>" class="screen-reader-text"><?php echo $strings['also-email'];  ?></label>
+				<label for="gv-note-email-to-<?php echo $entry_slug_esc; ?>" class="screen-reader-text"><?php echo $strings[ 'also-email' ]; ?></label>
 				<select class="gv-note-email-to" name="gv-note-to" id="gv-note-email-to-<?php echo $entry_slug_esc; ?>">
-					<option value=""><?php echo $strings['also-email'];  ?></option>
+					<option value=""><?php echo $strings[ 'also-email' ]; ?></option>
 					<?php foreach ( $note_emails as  $email ) {
 						?>
 						<option value="<?php echo esc_attr( $email ); ?>"><?php echo esc_html( $email ); ?></option>
 					<?php }
-					if( $include_custom ) { ?>
-					<option value="custom"><?php echo self::strings('other-email'); ?></option>
+					if ( $include_custom ) { ?>
+					<option value="custom"><?php echo self::strings( 'other-email' ); ?></option>
 					<?php } ?>
 				</select>
 				<fieldset class="gv-note-to-container">
-					<?php if( $include_custom ) { ?>
+					<?php if ( $include_custom ) { ?>
 					<div class='gv-note-to-custom-container'>
-						<label for="gv-note-email-to-custom-<?php echo $entry_slug_esc; ?>"><?php echo $strings['email-label']; ?></label>
-						<input type="text" name="gv-note-to-custom" placeholder="<?php echo $strings['email-placeholder']; ?>" id="gv-note-to-custom-<?php echo $entry_slug_esc; ?>" value="" />
+						<label for="gv-note-email-to-custom-<?php echo $entry_slug_esc; ?>"><?php echo $strings[ 'email-label' ]; ?></label>
+						<input type="text" name="gv-note-to-custom" placeholder="<?php echo $strings[ 'email-placeholder' ]; ?>" id="gv-note-to-custom-<?php echo $entry_slug_esc; ?>" value="" />
 					</div>
 					<?php } ?>
 		            <div class='gv-note-subject-container'>
-		                <label for="gv-note-subject-<?php echo $entry_slug_esc; ?>"><?php echo $strings['subject-label']; ?></label>
-		                <input type="text" name="gv-note-subject" placeholder="<?php echo $strings['subject']; ?>" id="gv-note-subject-<?php echo $entry_slug_esc; ?>" value="" />
+		                <label for="gv-note-subject-<?php echo $entry_slug_esc; ?>"><?php echo $strings[ 'subject-label' ]; ?></label>
+		                <input type="text" name="gv-note-subject" placeholder="<?php echo $strings[ 'subject' ]; ?>" id="gv-note-subject-<?php echo $entry_slug_esc; ?>" value="" />
 		            </div>
 				</fieldset>
 			</div>
@@ -746,7 +746,7 @@ 
 	 */
 	private function maybe_send_entry_notes( $note = false, $entry, $data ) {
 
-		if( ! $note || ! GVCommon::has_cap('gravityview_email_entry_notes') ) {
+		if ( ! $note || ! GVCommon::has_cap( 'gravityview_email_entry_notes' ) ) {
 			gravityview()->log->debug( 'User doesn\'t have "gravityview_email_entry_notes" cap, or $note is empty', array( 'data' => $note ) );
 			return;
 		}
@@ -754,7 +754,7 @@ 
 		gravityview()->log->debug( '$data', array( 'data' => $data ) );
 
 		//emailing notes if configured
-		if ( ! empty( $data['gv-note-to'] ) ) {
+		if ( ! empty( $data[ 'gv-note-to' ] ) ) {
 
 			$default_data = array(
 				'gv-note-to' => '',
@@ -764,11 +764,11 @@ 
                 'current-url' => '',
 			);
 
-			$current_user  = wp_get_current_user();
+			$current_user = wp_get_current_user();
 			$email_data = wp_parse_args( $data, $default_data );
 
-			$from    = $current_user->user_email;
-			$to = $email_data['gv-note-to'];
+			$from = $current_user->user_email;
+			$to = $email_data[ 'gv-note-to' ];
 
 			/**
 			 * Documented in get_note_email_fields
@@ -776,8 +776,8 @@ 
 			 */
 			$include_custom = apply_filters( 'gravityview/field/notes/custom-email', true );
 
-			if( 'custom' === $to && $include_custom ) {
-				$to = $email_data['gv-note-to-custom'];
+			if ( 'custom' === $to && $include_custom ) {
+				$to = $email_data[ 'gv-note-to-custom' ];
 				gravityview()->log->debug( 'Sending note to a custom email address: {to}' . array( 'to' => $to ) );
 			}
 
@@ -788,13 +788,13 @@ 
 
 			$bcc = false;
 			$reply_to = $from;
-			$subject = trim( $email_data['gv-note-subject'] );
+			$subject = trim( $email_data[ 'gv-note-subject' ] );
 
 			// We use empty() here because GF uses empty to check against, too. `0` isn't a valid subject to GF
 			$subject = empty( $subject ) ? self::strings( 'default-email-subject' ) : $subject;
-			$message = $email_data['gv-note-content'];
+			$message = $email_data[ 'gv-note-content' ];
 			$email_footer = self::strings( 'email-footer' );
-			$from_name     = $current_user->display_name;
+			$from_name = $current_user->display_name;
 			$message_format = 'html';
 
 			/**
@@ -825,7 +825,7 @@ 
 
 			GVCommon::send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name, $message_format, '', $entry, false );
 
-			$form  = isset( $entry['form_id'] ) ? GFAPI::get_form( $entry['form_id'] ) : array();
+			$form = isset( $entry[ 'form_id' ] ) ? GFAPI::get_form( $entry[ 'form_id' ] ) : array();
 
 			/**
 			 * @see https://www.gravityhelp.com/documentation/article/10146-2/ It's here for compatibility with Gravity Forms
@@ -851,7 +851,7 @@ 
 
 	    $output = '';
 
-		if( ! empty( $email_footer ) ) {
+		if ( ! empty( $email_footer ) ) {
 		    $url = \GV\Utils::get( $email_data, 'current-url' );
 			$url = html_entity_decode( $url );
 			$url = site_url( $url );