Strategy11 / formidable-forms

classes/helpers/FrmXMLHelper.php

Doc Comments +9 added lines, -2 removed lines

@@ -562,6 +562,7 @@ 
 	 * Also called during database migration in FrmMigrate.
 	 *
 	 * @since 4.0
+	 * @param string $type
 	 * @return array
 	 */
 	public static function migrate_field_placeholder( $field, $type ) {
@@ -1217,6 +1218,7 @@ 
 	 * The line endings may prevent html from being equal when it should
 	 *
 	 * @since 3.06
+	 * @param string $html_name
 	 */
 	private static function remove_default_html( $html_name, $defaults, &$options ) {
 		if ( ! isset( $options[ $html_name ] ) || ! isset( $defaults[ $html_name ] ) ) {
@@ -1290,6 +1292,7 @@ 
 	 * Migrate post settings to form action
 	 *
 	 * @param string $post_type
+	 * @param boolean $switch
 	 */
 	private static function migrate_post_settings_to_action( $form_options, $form_id, $post_type, &$imported, $switch ) {
 		if ( ! isset( $form_options['create_post'] ) || ! $form_options['create_post'] ) {
@@ -1368,8 +1371,8 @@ 
 	 * @since 2.0
 	 *
 	 * @param array $post_content - check for old field IDs
-	 * @param array $basic_fields - fields with string or int saved
-	 * @param array $array_fields - fields with arrays saved
+	 * @param string[] $basic_fields - fields with string or int saved
+	 * @param string[] $array_fields - fields with arrays saved
 	 *
 	 * @return string $post_content - new field IDs
 	 */
@@ -1404,6 +1407,10 @@ 
 		return $post_content;
 	}
 
+	/**
+	 * @param string $post_type
+	 * @param boolean $switch
+	 */
 	private static function migrate_email_settings_to_action( $form_options, $form_id, $post_type, &$imported, $switch ) {
 		// No old notifications or autoresponders to carry over
 		if ( ! isset( $form_options['auto_responder'] ) && ! isset( $form_options['notification'] ) && ! isset( $form_options['email_to'] ) ) {

Spacing +76 added lines, -76 removed lines

@@ -129,7 +129,7 @@ 
 
 			if ( $term && is_array( $term ) ) {
 				$imported['imported']['terms'] ++;
-				$imported['terms'][ (int) $t->term_id ] = $term['term_id'];
+				$imported['terms'][(int) $t->term_id] = $term['term_id'];
 			}
 
 			unset( $term, $t );
@@ -185,7 +185,7 @@ 
 					}
 
 					// Keep track of whether this specific form was updated or not.
-					$imported['form_status'][ $form_id ] = 'imported';
+					$imported['form_status'][$form_id] = 'imported';
 					self::track_imported_child_forms( (int) $form_id, $form['parent_form_id'], $child_forms );
 				}
 			}
@@ -197,7 +197,7 @@ 
 			// Update field ids/keys to new ones.
 			do_action( 'frm_after_duplicate_form', $form_id, $form, array( 'old_id' => $old_id ) );
 
-			$imported['forms'][ (int) $item->id ] = $form_id;
+			$imported['forms'][(int) $item->id] = $form_id;
 
 			// Send pre 2.0 form options through function that creates actions.
 			self::migrate_form_settings_to_actions( $form['options'], $form_id, $imported, true );
@@ -260,15 +260,15 @@ 
 		}
 
 		// Keep track of whether this specific form was updated or not
-		$imported['form_status'][ $form_id ] = 'updated';
+		$imported['form_status'][$form_id] = 'updated';
 	}
 
 	private static function get_form_fields( $form_id ) {
 		$form_fields = FrmField::get_all_for_form( $form_id, '', 'exclude', 'exclude' );
 		$old_fields  = array();
 		foreach ( $form_fields as $f ) {
-			$old_fields[ $f->id ]        = $f;
-			$old_fields[ $f->field_key ] = $f->id;
+			$old_fields[$f->id]        = $f;
+			$old_fields[$f->field_key] = $f->id;
 			unset( $f );
 		}
 		$form_fields = $old_fields;
@@ -325,7 +325,7 @@ 
 	 */
 	private static function track_imported_child_forms( $form_id, $parent_form_id, &$child_forms ) {
 		if ( $parent_form_id ) {
-			$child_forms[ $form_id ] = $parent_form_id;
+			$child_forms[$form_id] = $parent_form_id;
 		}
 	}
 
@@ -341,9 +341,9 @@ 
 	private static function maybe_update_child_form_parent_id( $imported_forms, $child_forms ) {
 		foreach ( $child_forms as $child_form_id => $old_parent_form_id ) {
 
-			if ( isset( $imported_forms[ $old_parent_form_id ] ) && $imported_forms[ $old_parent_form_id ] != $old_parent_form_id ) {
+			if ( isset( $imported_forms[$old_parent_form_id] ) && $imported_forms[$old_parent_form_id] != $old_parent_form_id ) {
 				// Update all children with this old parent_form_id
-				$new_parent_form_id = (int) $imported_forms[ $old_parent_form_id ];
+				$new_parent_form_id = (int) $imported_forms[$old_parent_form_id];
 
 				FrmForm::update( $child_form_id, array( 'parent_form_id' => $new_parent_form_id ) );
 			}
@@ -374,27 +374,27 @@ 
 
 			if ( ! empty( $this_form ) ) {
 				// check for field to edit by field id
-				if ( isset( $form_fields[ $f['id'] ] ) ) {
+				if ( isset( $form_fields[$f['id']] ) ) {
 					FrmField::update( $f['id'], $f );
 					$imported['updated']['fields'] ++;
 
-					unset( $form_fields[ $f['id'] ] );
+					unset( $form_fields[$f['id']] );
 
 					//unset old field key
-					if ( isset( $form_fields[ $f['field_key'] ] ) ) {
-						unset( $form_fields[ $f['field_key'] ] );
+					if ( isset( $form_fields[$f['field_key']] ) ) {
+						unset( $form_fields[$f['field_key']] );
 					}
-				} elseif ( isset( $form_fields[ $f['field_key'] ] ) ) {
-					$keys_by_original_field_id[ $f['id'] ] = $f['field_key'];
+				} elseif ( isset( $form_fields[$f['field_key']] ) ) {
+					$keys_by_original_field_id[$f['id']] = $f['field_key'];
 
 					// check for field to edit by field key
 					unset( $f['id'] );
 
-					FrmField::update( $form_fields[ $f['field_key'] ], $f );
+					FrmField::update( $form_fields[$f['field_key']], $f );
 					$imported['updated']['fields'] ++;
 
-					unset( $form_fields[ $form_fields[ $f['field_key'] ] ] ); //unset old field id
-					unset( $form_fields[ $f['field_key'] ] ); //unset old field key
+					unset( $form_fields[$form_fields[$f['field_key']]] ); //unset old field id
+					unset( $form_fields[$f['field_key']] ); //unset old field key
 				} else {
 					// if no matching field id or key in this form, create the field
 					self::create_imported_field( $f, $imported );
@@ -504,8 +504,8 @@ 
 		if ( $f['type'] == 'form' || ( $f['type'] == 'divider' && FrmField::is_option_true( $f['field_options'], 'repeat' ) ) ) {
 			if ( FrmField::is_option_true( $f['field_options'], 'form_select' ) ) {
 				$form_select = (int) $f['field_options']['form_select'];
-				if ( isset( $imported['forms'][ $form_select ] ) ) {
-					$f['field_options']['form_select'] = $imported['forms'][ $form_select ];
+				if ( isset( $imported['forms'][$form_select] ) ) {
+					$f['field_options']['form_select'] = $imported['forms'][$form_select];
 				}
 			}
 		}
@@ -526,8 +526,8 @@ 
 
 		if ( FrmField::is_option_true_in_array( $f['field_options'], 'get_values_form' ) ) {
 			$old_form = $f['field_options']['get_values_form'];
-			if ( isset( $imported['forms'][ $old_form ] ) ) {
-				$f['field_options']['get_values_form'] = $imported['forms'][ $old_form ];
+			if ( isset( $imported['forms'][$old_form] ) ) {
+				$f['field_options']['get_values_form'] = $imported['forms'][$old_form];
 			}
 		}
 	}
@@ -548,12 +548,12 @@ 
 	private static function migrate_placeholders( &$f ) {
 		$update_values = self::migrate_field_placeholder( $f, 'clear_on_focus' );
 		foreach ( $update_values as $k => $v ) {
-			$f[ $k ] = $v;
+			$f[$k] = $v;
 		}
 
 		$update_values = self::migrate_field_placeholder( $f, 'default_blank' );
 		foreach ( $update_values as $k => $v ) {
-			$f[ $k ] = $v;
+			$f[$k] = $v;
 		}
 	}
 
@@ -567,7 +567,7 @@ 
 	public static function migrate_field_placeholder( $field, $type ) {
 		$field = (array) $field;
 		$field_options = $field['field_options'];
-		if ( empty( $field_options[ $type ] ) || empty( $field['default_value'] ) ) {
+		if ( empty( $field_options[$type] ) || empty( $field['default_value'] ) ) {
 			return array();
 		}
 
@@ -593,7 +593,7 @@ 
 				}
 
 				if ( $opt == $default_value ) {
-					unset( $options[ $opt_key ] );
+					unset( $options[$opt_key] );
 					break;
 				}
 			}
@@ -788,17 +788,17 @@ 
 			self::update_postmeta( $post, $post_id );
 
 			$this_type = 'posts';
-			if ( isset( $post_types[ $post['post_type'] ] ) ) {
-				$this_type = $post_types[ $post['post_type'] ];
+			if ( isset( $post_types[$post['post_type']] ) ) {
+				$this_type = $post_types[$post['post_type']];
 			}
 
 			if ( isset( $post['ID'] ) && $post_id == $post['ID'] ) {
-				$imported['updated'][ $this_type ] ++;
+				$imported['updated'][$this_type] ++;
 			} else {
-				$imported['imported'][ $this_type ] ++;
+				$imported['imported'][$this_type] ++;
 			}
 
-			$imported['posts'][ (int) $old_id ] = $post_id;
+			$imported['posts'][(int) $old_id] = $post_id;
 
 			do_action( 'frm_after_import_view', $post_id, $post );
 
@@ -815,9 +815,9 @@ 
 			$post['attachment_url'] = (string) $item->attachment_url;
 		}
 
-		if ( $post['post_type'] == FrmFormActionsController::$action_post_type && isset( $imported['forms'][ (int) $post['menu_order'] ] ) ) {
+		if ( $post['post_type'] == FrmFormActionsController::$action_post_type && isset( $imported['forms'][(int) $post['menu_order']] ) ) {
 			// update to new form id
-			$post['menu_order'] = $imported['forms'][ (int) $post['menu_order'] ];
+			$post['menu_order'] = $imported['forms'][(int) $post['menu_order']];
 		}
 
 		// Don't allow default styles to take over a site's default style
@@ -844,8 +844,8 @@ 
 		);
 
 		//switch old form and field ids to new ones
-		if ( $m['key'] == 'frm_form_id' && isset( $imported['forms'][ (int) $m['value'] ] ) ) {
-			$m['value'] = $imported['forms'][ (int) $m['value'] ];
+		if ( $m['key'] == 'frm_form_id' && isset( $imported['forms'][(int) $m['value']] ) ) {
+			$m['value'] = $imported['forms'][(int) $m['value']];
 		} else {
 			$m['value'] = FrmAppHelper::maybe_json_decode( $m['value'] );
 
@@ -856,15 +856,15 @@ 
 				} elseif ( $m['key'] == 'frm_options' ) {
 
 					foreach ( array( 'date_field_id', 'edate_field_id' ) as $setting_name ) {
-						if ( isset( $m['value'][ $setting_name ] ) && is_numeric( $m['value'][ $setting_name ] ) && isset( $frm_duplicate_ids[ $m['value'][ $setting_name ] ] ) ) {
-							$m['value'][ $setting_name ] = $frm_duplicate_ids[ $m['value'][ $setting_name ] ];
+						if ( isset( $m['value'][$setting_name] ) && is_numeric( $m['value'][$setting_name] ) && isset( $frm_duplicate_ids[$m['value'][$setting_name]] ) ) {
+							$m['value'][$setting_name] = $frm_duplicate_ids[$m['value'][$setting_name]];
 						}
 					}
 
 					$check_dup_array = array();
 					if ( isset( $m['value']['order_by'] ) && ! empty( $m['value']['order_by'] ) ) {
-						if ( is_numeric( $m['value']['order_by'] ) && isset( $frm_duplicate_ids[ $m['value']['order_by'] ] ) ) {
-							$m['value']['order_by'] = $frm_duplicate_ids[ $m['value']['order_by'] ];
+						if ( is_numeric( $m['value']['order_by'] ) && isset( $frm_duplicate_ids[$m['value']['order_by']] ) ) {
+							$m['value']['order_by'] = $frm_duplicate_ids[$m['value']['order_by']];
 						} elseif ( is_array( $m['value']['order_by'] ) ) {
 							$check_dup_array[] = 'order_by';
 						}
@@ -875,9 +875,9 @@ 
 					}
 
 					foreach ( $check_dup_array as $check_k ) {
-						foreach ( (array) $m['value'][ $check_k ] as $mk => $mv ) {
-							if ( isset( $frm_duplicate_ids[ $mv ] ) ) {
-								$m['value'][ $check_k ][ $mk ] = $frm_duplicate_ids[ $mv ];
+						foreach ( (array) $m['value'][$check_k] as $mk => $mv ) {
+							if ( isset( $frm_duplicate_ids[$mv] ) ) {
+								$m['value'][$check_k][$mk] = $frm_duplicate_ids[$mv];
 							}
 							unset( $mk, $mv );
 						}
@@ -890,7 +890,7 @@ 
 			$m['value'] = FrmAppHelper::maybe_json_decode( $m['value'] );
 		}
 
-		$post['postmeta'][ (string) $meta->meta_key ] = $m['value'];
+		$post['postmeta'][(string) $meta->meta_key] = $m['value'];
 	}
 
 	/**
@@ -918,11 +918,11 @@ 
 				$name = (string) $c;
 			}
 
-			if ( ! isset( $post['tax_input'][ $taxonomy ] ) ) {
-				$post['tax_input'][ $taxonomy ] = array();
+			if ( ! isset( $post['tax_input'][$taxonomy] ) ) {
+				$post['tax_input'][$taxonomy] = array();
 			}
 
-			$post['tax_input'][ $taxonomy ][] = $name;
+			$post['tax_input'][$taxonomy][] = $name;
 			unset( $name );
 		}
 	}
@@ -1021,7 +1021,7 @@ 
 
 		$message = '<ul>';
 		foreach ( $result as $type => $results ) {
-			if ( ! isset( $t_strings[ $type ] ) ) {
+			if ( ! isset( $t_strings[$type] ) ) {
 				// only print imported and updated
 				continue;
 			}
@@ -1033,7 +1033,7 @@ 
 			}
 
 			if ( ! empty( $s_message ) ) {
-				$message .= '<li><strong>' . $t_strings[ $type ] . ':</strong> ';
+				$message .= '<li><strong>' . $t_strings[$type] . ':</strong> ';
 				$message .= implode( ', ', $s_message );
 				$message .= '</li>';
 			}
@@ -1073,7 +1073,7 @@ 
 			'actions' => sprintf( _n( '%1$s Form Action', '%1$s Form Actions', $m, 'formidable' ), $m ),
 		);
 
-		$s_message[] = isset( $strings[ $type ] ) ? $strings[ $type ] : ' ' . $m . ' ' . ucfirst( $type );
+		$s_message[] = isset( $strings[$type] ) ? $strings[$type] : ' ' . $m . ' ' . ucfirst( $type );
 	}
 
 	/**
@@ -1205,10 +1205,10 @@ 
 		$array_defaults = array_filter( $defaults, 'is_array' );
 		foreach ( $array_defaults as $d => $default ) {
 			// compare array defaults
-			if ( $default == $saved[ $d ] ) {
-				unset( $saved[ $d ] );
+			if ( $default == $saved[$d] ) {
+				unset( $saved[$d] );
 			}
-			unset( $defaults[ $d ] );
+			unset( $defaults[$d] );
 		}
 		$saved = array_diff_assoc( (array) $saved, $defaults );
 	}
@@ -1219,14 +1219,14 @@ 
 	 * @since 3.06
 	 */
 	private static function remove_default_html( $html_name, $defaults, &$options ) {
-		if ( ! isset( $options[ $html_name ] ) || ! isset( $defaults[ $html_name ] ) ) {
+		if ( ! isset( $options[$html_name] ) || ! isset( $defaults[$html_name] ) ) {
 			return;
 		}
 
-		$old_html     = str_replace( "\r\n", "\n", $options[ $html_name ] );
-		$default_html = $defaults[ $html_name ];
+		$old_html     = str_replace( "\r\n", "\n", $options[$html_name] );
+		$default_html = $defaults[$html_name];
 		if ( $old_html == $default_html ) {
-			unset( $options[ $html_name ] );
+			unset( $options[$html_name] );
 
 			return;
 		}
@@ -1234,7 +1234,7 @@ 
 		// Account for some of the older field default HTML.
 		$default_html = str_replace( ' id="frm_desc_field_[key]"', '', $default_html );
 		if ( $old_html == $default_html ) {
-			unset( $options[ $html_name ] );
+			unset( $options[$html_name] );
 		}
 	}
 
@@ -1320,8 +1320,8 @@ 
 		);
 
 		foreach ( $post_settings as $post_setting ) {
-			if ( isset( $form_options[ $post_setting ] ) ) {
-				$new_action['post_content'][ $post_setting ] = $form_options[ $post_setting ];
+			if ( isset( $form_options[$post_setting] ) ) {
+				$new_action['post_content'][$post_setting] = $form_options[$post_setting];
 			}
 			unset( $post_setting );
 		}
@@ -1391,11 +1391,11 @@ 
 		foreach ( $post_content as $key => $setting ) {
 			if ( ! is_array( $setting ) && in_array( $key, $basic_fields ) ) {
 				// Replace old IDs with new IDs
-				$post_content[ $key ] = str_replace( $old, $new, $setting );
+				$post_content[$key] = str_replace( $old, $new, $setting );
 			} elseif ( is_array( $setting ) && in_array( $key, $array_fields ) ) {
 				foreach ( $setting as $k => $val ) {
 					// Replace old IDs with new IDs
-					$post_content[ $key ][ $k ] = str_replace( $old, $new, $val );
+					$post_content[$key][$k] = str_replace( $old, $new, $val );
 				}
 			}
 			unset( $key, $setting );
@@ -1471,8 +1471,8 @@ 
 	private static function remove_deprecated_notification_settings( $form_id, $form_options ) {
 		$delete_settings = array( 'notification', 'autoresponder', 'email_to' );
 		foreach ( $delete_settings as $index ) {
-			if ( isset( $form_options[ $index ] ) ) {
-				unset( $form_options[ $index ] );
+			if ( isset( $form_options[$index] ) ) {
+				unset( $form_options[$index] );
 			}
 		}
 		FrmForm::update( $form_id, array( 'options' => $form_options ) );
@@ -1525,12 +1525,12 @@ 
 			'reply_to_name' => '',
 		);
 		foreach ( $reply_fields as $f => $val ) {
-			if ( isset( $notification[ $f ] ) ) {
-				$atts[ $f ] = $notification[ $f ];
-				if ( 'custom' == $notification[ $f ] ) {
-					$atts[ $f ] = $notification[ 'cust_' . $f ];
-				} elseif ( is_numeric( $atts[ $f ] ) && ! empty( $atts[ $f ] ) ) {
-					$atts[ $f ] = '[' . $atts[ $f ] . ']';
+			if ( isset( $notification[$f] ) ) {
+				$atts[$f] = $notification[$f];
+				if ( 'custom' == $notification[$f] ) {
+					$atts[$f] = $notification['cust_' . $f];
+				} elseif ( is_numeric( $atts[$f] ) && ! empty( $atts[$f] ) ) {
+					$atts[$f] = '[' . $atts[$f] . ']';
 				}
 			}
 			unset( $f, $val );
@@ -1561,13 +1561,13 @@ 
 		foreach ( $atts['email_to'] as $key => $email_field ) {
 
 			if ( is_numeric( $email_field ) ) {
-				$atts['email_to'][ $key ] = '[' . $email_field . ']';
+				$atts['email_to'][$key] = '[' . $email_field . ']';
 			}
 
 			if ( strpos( $email_field, '|' ) ) {
 				$email_opt = explode( '|', $email_field );
 				if ( isset( $email_opt[0] ) ) {
-					$atts['email_to'][ $key ] = '[' . $email_opt[0] . ' show=' . $email_opt[1] . ']';
+					$atts['email_to'][$key] = '[' . $email_opt[0] . ' show=' . $email_opt[1] . ']';
 				}
 				unset( $email_opt );
 			}
@@ -1588,12 +1588,12 @@ 
 		// Add more fields to the new notification
 		$add_fields = array( 'email_message', 'email_subject', 'plain_text', 'inc_user_info', 'conditions' );
 		foreach ( $add_fields as $add_field ) {
-			if ( isset( $notification[ $add_field ] ) ) {
-				$new_notification['post_content'][ $add_field ] = $notification[ $add_field ];
+			if ( isset( $notification[$add_field] ) ) {
+				$new_notification['post_content'][$add_field] = $notification[$add_field];
 			} elseif ( in_array( $add_field, array( 'plain_text', 'inc_user_info' ) ) ) {
-				$new_notification['post_content'][ $add_field ] = 0;
+				$new_notification['post_content'][$add_field] = 0;
 			} else {
-				$new_notification['post_content'][ $add_field ] = '';
+				$new_notification['post_content'][$add_field] = '';
 			}
 			unset( $add_field );
 		}
@@ -1617,7 +1617,7 @@ 
 		if ( isset( $post_content['conditions'] ) && is_array( $post_content['conditions'] ) ) {
 			foreach ( $post_content['conditions'] as $email_key => $val ) {
 				if ( is_numeric( $email_key ) ) {
-					$post_content['conditions'][ $email_key ] = self::switch_action_field_ids( $val, array( 'hide_field' ) );
+					$post_content['conditions'][$email_key] = self::switch_action_field_ids( $val, array( 'hide_field' ) );
 				}
 				unset( $email_key, $val );
 			}