Strategy11 / formidable-forms

classes/models/FrmField.php

Indentation +202 added lines, -202 removed lines

@@ -4,7 +4,7 @@ 
 }
 
 class FrmField {
-    static $use_cache = true;
+	static $use_cache = true;
 	static $transient_size = 200;
 
 	public static function field_selection() {
@@ -51,39 +51,39 @@ 
 		));
 	}
 
-    public static function create( $values, $return = true ) {
-        global $wpdb, $frm_duplicate_ids;
+	public static function create( $values, $return = true ) {
+		global $wpdb, $frm_duplicate_ids;
 
-        $new_values = array();
-        $key = isset($values['field_key']) ? $values['field_key'] : $values['name'];
+		$new_values = array();
+		$key = isset($values['field_key']) ? $values['field_key'] : $values['name'];
 		$new_values['field_key'] = FrmAppHelper::get_unique_key( $key, $wpdb->prefix . 'frm_fields', 'field_key' );
 
 		foreach ( array( 'name', 'description', 'type', 'default_value' ) as $col ) {
 			$new_values[ $col ] = $values[ $col ];
-        }
+		}
 
-        $new_values['options'] = $values['options'];
+		$new_values['options'] = $values['options'];
 
-        $new_values['field_order'] = isset($values['field_order']) ? (int) $values['field_order'] : null;
-        $new_values['required'] = isset($values['required']) ? (int) $values['required'] : 0;
-        $new_values['form_id'] = isset($values['form_id']) ? (int) $values['form_id'] : null;
-        $new_values['field_options'] = $values['field_options'];
-        $new_values['created_at'] = current_time('mysql', 1);
+		$new_values['field_order'] = isset($values['field_order']) ? (int) $values['field_order'] : null;
+		$new_values['required'] = isset($values['required']) ? (int) $values['required'] : 0;
+		$new_values['form_id'] = isset($values['form_id']) ? (int) $values['form_id'] : null;
+		$new_values['field_options'] = $values['field_options'];
+		$new_values['created_at'] = current_time('mysql', 1);
 
 		if ( isset( $values['id'] ) ) {
 			$frm_duplicate_ids[ $values['field_key'] ] = $new_values['field_key'];
-            $new_values = apply_filters('frm_duplicated_field', $new_values);
-        }
+			$new_values = apply_filters('frm_duplicated_field', $new_values);
+		}
 
 		foreach ( $new_values as $k => $v ) {
-            if ( is_array( $v ) ) {
+			if ( is_array( $v ) ) {
 				$new_values[ $k ] = serialize( $v );
 			}
-            unset( $k, $v );
-        }
+			unset( $k, $v );
+		}
 
-        //if(isset($values['id']) and is_numeric($values['id']))
-        //    $new_values['id'] = $values['id'];
+		//if(isset($values['id']) and is_numeric($values['id']))
+		//    $new_values['id'] = $values['id'];
 
 		$query_results = $wpdb->insert( $wpdb->prefix . 'frm_fields', $new_values );
 		$new_id = 0;
@@ -104,22 +104,22 @@ 
 		} else {
 			return false;
 		}
-    }
+	}
 
-    public static function duplicate( $old_form_id, $form_id, $copy_keys = false, $blog_id = false ) {
-        global $frm_duplicate_ids;
+	public static function duplicate( $old_form_id, $form_id, $copy_keys = false, $blog_id = false ) {
+		global $frm_duplicate_ids;
 
 		$where = array( array( 'or' => 1, 'fi.form_id' => $old_form_id, 'fr.parent_form_id' => $old_form_id ) );
 		$fields = self::getAll( $where, 'field_order', '', $blog_id );
 
-        foreach ( (array) $fields as $field ) {
-            $new_key = ($copy_keys) ? $field->field_key : '';
-            if ( $copy_keys && substr($field->field_key, -1) == 2 ) {
-                $new_key = rtrim($new_key, 2);
-            }
+		foreach ( (array) $fields as $field ) {
+			$new_key = ($copy_keys) ? $field->field_key : '';
+			if ( $copy_keys && substr($field->field_key, -1) == 2 ) {
+				$new_key = rtrim($new_key, 2);
+			}
 
-            $values = array();
-            FrmFieldsHelper::fill_field( $values, $field, $form_id, $new_key );
+			$values = array();
+			FrmFieldsHelper::fill_field( $values, $field, $form_id, $new_key );
 
 			// If this is a repeating section, create new form
 			if ( self::is_repeating_field( $field ) ) {
@@ -138,16 +138,16 @@ 
 				$values['form_id'] = $new_repeat_form_id;
 			}
 
-            $values = apply_filters('frm_duplicated_field', $values);
-            $new_id = self::create($values);
-            $frm_duplicate_ids[ $field->id ] = $new_id;
-            $frm_duplicate_ids[ $field->field_key ] = $new_id;
-            unset($field);
-        }
-    }
+			$values = apply_filters('frm_duplicated_field', $values);
+			$new_id = self::create($values);
+			$frm_duplicate_ids[ $field->id ] = $new_id;
+			$frm_duplicate_ids[ $field->field_key ] = $new_id;
+			unset($field);
+		}
+	}
 
 	public static function update( $id, $values ) {
-        global $wpdb;
+		global $wpdb;
 
 		$id = absint( $id );
 
@@ -155,9 +155,9 @@ 
 			$values['field_key'] = FrmAppHelper::get_unique_key( $values['field_key'], $wpdb->prefix . 'frm_fields', 'field_key', $id );
 		}
 
-        if ( isset($values['required']) ) {
-            $values['required'] = (int) $values['required'];
-        }
+		if ( isset($values['required']) ) {
+			$values['required'] = (int) $values['required'];
+		}
 
 		self::preserve_format_option_backslashes( $values );
 
@@ -174,41 +174,41 @@ 
 
 		$query_results = $wpdb->update( $wpdb->prefix . 'frm_fields', $values, array( 'id' => $id ) );
 
-        $form_id = 0;
+		$form_id = 0;
 		if ( isset( $values['form_id'] ) ) {
-            $form_id = absint( $values['form_id'] );
+			$form_id = absint( $values['form_id'] );
 		} else {
-            $field = self::getOne($id);
-            if ( $field ) {
-                $form_id = $field->form_id;
-            }
-            unset($field);
-        }
-        unset($values);
+			$field = self::getOne($id);
+			if ( $field ) {
+				$form_id = $field->form_id;
+			}
+			unset($field);
+		}
+		unset($values);
 
 		if ( $query_results ) {
-            wp_cache_delete( $id, 'frm_field' );
-            if ( $form_id ) {
-                self::delete_form_transient( $form_id );
-            }
-        }
+			wp_cache_delete( $id, 'frm_field' );
+			if ( $form_id ) {
+				self::delete_form_transient( $form_id );
+			}
+		}
 
-        return $query_results;
-    }
+		return $query_results;
+	}
 
 	/**
-	* Keep backslashes in the phone format option
-	*
-	* @since 2.0.8
-	* @param $values array - pass by reference
-	*/
+	 * Keep backslashes in the phone format option
+	 *
+	 * @since 2.0.8
+	 * @param $values array - pass by reference
+	 */
 	private static function preserve_format_option_backslashes( &$values ) {
 		if ( isset( $values['field_options']['format'] ) ) {
 			$values['field_options']['format'] = FrmAppHelper::preserve_backslashes( $values['field_options']['format'] );
 		}
 	}
 
-    public static function destroy( $id ) {
+	public static function destroy( $id ) {
 		global $wpdb;
 
 		do_action( 'frm_before_destroy_field', $id );
@@ -223,7 +223,7 @@ 
 
 		$wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_item_metas WHERE field_id=%d', $id ) );
 		return $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_fields WHERE id=%d', $id ) );
-    }
+	}
 
 	public static function delete_form_transient( $form_id ) {
 		$form_id = absint( $form_id );
@@ -237,11 +237,11 @@ 
 
 		FrmAppHelper::cache_delete_group( 'frm_field' );
 
-        $form = FrmForm::getOne($form_id);
-        if ( $form && $form->parent_form_id && $form->parent_form_id != $form_id ) {
-            self::delete_form_transient( $form->parent_form_id );
-        }
-    }
+		$form = FrmForm::getOne($form_id);
+		if ( $form && $form->parent_form_id && $form->parent_form_id != $form_id ) {
+			self::delete_form_transient( $form->parent_form_id );
+		}
+	}
 
 	/**
 	 * If $field is numeric, get the field object
@@ -257,131 +257,131 @@ 
 			return;
 		}
 
-        global $wpdb;
+		global $wpdb;
 
-        $where = is_numeric($id) ? 'id=%d' : 'field_key=%s';
+		$where = is_numeric($id) ? 'id=%d' : 'field_key=%s';
 		$query = $wpdb->prepare( 'SELECT * FROM ' . $wpdb->prefix . 'frm_fields WHERE ' . $where, $id );
 
-        $results = FrmAppHelper::check_cache( $id, 'frm_field', $query, 'get_row', 0 );
+		$results = FrmAppHelper::check_cache( $id, 'frm_field', $query, 'get_row', 0 );
 
-        if ( empty($results) ) {
-            return $results;
-        }
+		if ( empty($results) ) {
+			return $results;
+		}
 
-        if ( is_numeric($id) ) {
+		if ( is_numeric($id) ) {
 			FrmAppHelper::set_cache( $results->field_key, $results, 'frm_field' );
-        } else if ( $results ) {
+		} else if ( $results ) {
 			FrmAppHelper::set_cache( $results->id, $results, 'frm_field' );
-        }
+		}
 
 		self::prepare_options( $results );
 
-        return stripslashes_deep($results);
-    }
+		return stripslashes_deep($results);
+	}
 
-    /**
-     * Get the field type by key or id
-     * @param int|string The field id or key
+	/**
+	 * Get the field type by key or id
+	 * @param int|string The field id or key
 	 * @param mixed $col The name of the column in the fields database table
-     */
-    public static function &get_type( $id, $col = 'type' ) {
-        $field = FrmAppHelper::check_cache( $id, 'frm_field' );
-        if ( $field ) {
-            $type = $field->{$col};
-        } else {
-            $type = FrmDb::get_var( 'frm_fields', array( 'or' => 1, 'id' => $id, 'field_key' => $id ), $col );
-        }
-
-        return $type;
-    }
+	 */
+	public static function &get_type( $id, $col = 'type' ) {
+		$field = FrmAppHelper::check_cache( $id, 'frm_field' );
+		if ( $field ) {
+			$type = $field->{$col};
+		} else {
+			$type = FrmDb::get_var( 'frm_fields', array( 'or' => 1, 'id' => $id, 'field_key' => $id ), $col );
+		}
+
+		return $type;
+	}
 
 	public static function get_all_types_in_form( $form_id, $type, $limit = '', $inc_sub = 'exclude' ) {
-        if ( ! $form_id ) {
-            return array();
-        }
+		if ( ! $form_id ) {
+			return array();
+		}
 
 		$results = self::get_fields_from_transients( $form_id, array( 'inc_embed' => $inc_sub, 'inc_repeat' => $inc_sub ) );
 		if ( ! empty( $results ) ) {
-            $fields = array();
-            $count = 0;
-            foreach ( $results as $result ) {
-                if ( $type != $result->type ) {
-                    continue;
-                }
+			$fields = array();
+			$count = 0;
+			foreach ( $results as $result ) {
+				if ( $type != $result->type ) {
+					continue;
+				}
 
 				$fields[ $result->id ] = $result;
-                $count++;
-                if ( $limit == 1 ) {
-                    $fields = $result;
-                    break;
-                }
+				$count++;
+				if ( $limit == 1 ) {
+					$fields = $result;
+					break;
+				}
 
-                if ( ! empty($limit) && $count >= $limit ) {
-                    break;
-                }
+				if ( ! empty($limit) && $count >= $limit ) {
+					break;
+				}
 
-                unset($result);
-            }
-            return stripslashes_deep($fields);
-        }
+				unset($result);
+			}
+			return stripslashes_deep($fields);
+		}
 
-        self::$use_cache = false;
+		self::$use_cache = false;
 
 		$where = array( 'fi.form_id' => (int) $form_id, 'fi.type' => $type );
 		self::maybe_include_repeating_fields( $inc_sub, $where );
 		$results = self::getAll( $where, 'field_order', $limit );
-        self::$use_cache = true;
-        self::include_sub_fields($results, $inc_sub, $type);
+		self::$use_cache = true;
+		self::include_sub_fields($results, $inc_sub, $type);
 
-        return $results;
-    }
+		return $results;
+	}
 
 	public static function get_all_for_form( $form_id, $limit = '', $inc_embed = 'exclude', $inc_repeat = 'include' ) {
-        if ( ! (int) $form_id ) {
-            return array();
-        }
+		if ( ! (int) $form_id ) {
+			return array();
+		}
 
 		$results = self::get_fields_from_transients( $form_id, array( 'inc_embed' => $inc_embed, 'inc_repeat' => $inc_repeat ) );
 		if ( ! empty( $results ) ) {
-            if ( empty($limit) ) {
+			if ( empty($limit) ) {
 				return $results;
-            }
+			}
 
-            $fields = array();
-            $count = 0;
-            foreach ( $results as $result ) {
+			$fields = array();
+			$count = 0;
+			foreach ( $results as $result ) {
 				$fields[ $result->id ] = $result;
-                if ( ! empty($limit) && $count >= $limit ) {
-                    break;
-                }
-            }
+				if ( ! empty($limit) && $count >= $limit ) {
+					break;
+				}
+			}
 
 			return $fields;
-        }
+		}
 
-        self::$use_cache = false;
+		self::$use_cache = false;
 
 		$where = array( 'fi.form_id' => absint( $form_id ) );
 		self::maybe_include_repeating_fields( $inc_repeat, $where );
 		$results = self::getAll( $where, 'field_order', $limit );
 
-        self::$use_cache = true;
+		self::$use_cache = true;
 
 		self::include_sub_fields( $results, $inc_embed, 'all' );
 
-        if ( empty($limit) ) {
+		if ( empty($limit) ) {
 			self::set_field_transient( $results, $form_id, 0, array( 'inc_embed' => $inc_embed, 'inc_repeat' => $inc_repeat ) );
-        }
+		}
 
 		return $results;
-    }
+	}
 
 	/**
-	* If repeating fields should be included, adjust $where accordingly
-	*
-	* @param string $inc_repeat
-	* @param array $where - pass by reference
-	*/
+	 * If repeating fields should be included, adjust $where accordingly
+	 *
+	 * @param string $inc_repeat
+	 * @param array $where - pass by reference
+	 */
 	private static function maybe_include_repeating_fields( $inc_repeat, &$where ) {
 		if ( $inc_repeat == 'include' ) {
 			$form_id = $where['fi.form_id'];
@@ -392,77 +392,77 @@ 
 
 	public static function include_sub_fields( &$results, $inc_embed, $type = 'all' ) {
 		if ( 'include' != $inc_embed || empty( $results ) ) {
-            return;
-        }
+			return;
+		}
 
-        $form_fields = $results;
+		$form_fields = $results;
 		$index_offset = 1;
-        foreach ( $form_fields as $k => $field ) {
-            if ( 'form' != $field->type || ! isset($field->field_options['form_select']) ) {
-                continue;
-            }
-
-            if ( $type == 'all' ) {
-                $sub_fields = self::get_all_for_form( $field->field_options['form_select'] );
-            } else {
-                $sub_fields = self::get_all_types_in_form($field->form_id, $type);
-            }
-
-            if ( ! empty($sub_fields) ) {
+		foreach ( $form_fields as $k => $field ) {
+			if ( 'form' != $field->type || ! isset($field->field_options['form_select']) ) {
+				continue;
+			}
+
+			if ( $type == 'all' ) {
+				$sub_fields = self::get_all_for_form( $field->field_options['form_select'] );
+			} else {
+				$sub_fields = self::get_all_types_in_form($field->form_id, $type);
+			}
+
+			if ( ! empty($sub_fields) ) {
 				$index = $k + $index_offset;
 				$index_offset += count( $sub_fields );
 				array_splice($results, $index, 0, $sub_fields);
-            }
-            unset($field, $sub_fields);
-        }
-    }
+			}
+			unset($field, $sub_fields);
+		}
+	}
 
 	public static function getAll( $where = array(), $order_by = '', $limit = '', $blog_id = false ) {
 		$cache_key = maybe_serialize( $where ) . $order_by . 'l' . $limit . 'b' . $blog_id;
-        if ( self::$use_cache ) {
-            // make sure old cache doesn't get saved as a transient
-            $results = wp_cache_get($cache_key, 'frm_field');
-            if ( false !== $results ) {
-                return stripslashes_deep($results);
-            }
-        }
-
-        global $wpdb;
-
-        if ( $blog_id && is_multisite() ) {
-            global $wpmuBaseTablePrefix;
-            if ( $wpmuBaseTablePrefix ) {
+		if ( self::$use_cache ) {
+			// make sure old cache doesn't get saved as a transient
+			$results = wp_cache_get($cache_key, 'frm_field');
+			if ( false !== $results ) {
+				return stripslashes_deep($results);
+			}
+		}
+
+		global $wpdb;
+
+		if ( $blog_id && is_multisite() ) {
+			global $wpmuBaseTablePrefix;
+			if ( $wpmuBaseTablePrefix ) {
 				$prefix = $wpmuBaseTablePrefix . $blog_id . '_';
-            } else {
-                $prefix = $wpdb->get_blog_prefix( $blog_id );
-            }
+			} else {
+				$prefix = $wpdb->get_blog_prefix( $blog_id );
+			}
 
 			$table_name = $prefix . 'frm_fields';
 			$form_table_name = $prefix . 'frm_forms';
 		} else {
 			$table_name = $wpdb->prefix . 'frm_fields';
 			$form_table_name = $wpdb->prefix . 'frm_forms';
-        }
+		}
 
 		if ( ! empty( $order_by ) && strpos( $order_by, 'ORDER BY' ) === false ) {
 			$order_by = ' ORDER BY ' . $order_by;
 		}
 
-        $limit = FrmAppHelper::esc_limit($limit);
+		$limit = FrmAppHelper::esc_limit($limit);
 
-        $query = "SELECT fi.*, fr.name as form_name  FROM {$table_name} fi LEFT OUTER JOIN {$form_table_name} fr ON fi.form_id=fr.id";
-        $query_type = ( $limit == ' LIMIT 1' || $limit == 1 ) ? 'row' : 'results';
+		$query = "SELECT fi.*, fr.name as form_name  FROM {$table_name} fi LEFT OUTER JOIN {$form_table_name} fr ON fi.form_id=fr.id";
+		$query_type = ( $limit == ' LIMIT 1' || $limit == 1 ) ? 'row' : 'results';
 
-        if ( is_array($where) ) {
-            $results = FrmDb::get_var( $table_name . ' fi LEFT OUTER JOIN ' . $form_table_name . ' fr ON fi.form_id=fr.id', $where, 'fi.*, fr.name as form_name', array( 'order_by' => $order_by, 'limit' => $limit ), '', $query_type );
+		if ( is_array($where) ) {
+			$results = FrmDb::get_var( $table_name . ' fi LEFT OUTER JOIN ' . $form_table_name . ' fr ON fi.form_id=fr.id', $where, 'fi.*, fr.name as form_name', array( 'order_by' => $order_by, 'limit' => $limit ), '', $query_type );
 		} else {
 			// if the query is not an array, then it has already been prepared
-            $query .= FrmAppHelper::prepend_and_or_where(' WHERE ', $where) . $order_by . $limit;
+			$query .= FrmAppHelper::prepend_and_or_where(' WHERE ', $where) . $order_by . $limit;
 
 			$function_name = ( $query_type == 'row' ) ? 'get_row' : 'get_results';
 			$results = $wpdb->$function_name( $query );
-        }
-        unset( $where );
+		}
+		unset( $where );
 
 		self::format_field_results( $results );
 
@@ -561,21 +561,21 @@ 
 
 	public static function getIds( $where = '', $order_by = '', $limit = '' ) {
 		_deprecated_function( __FUNCTION__, '2.0' );
-        global $wpdb;
-        if ( ! empty($order_by) && ! strpos($order_by, 'ORDER BY') !== false ) {
+		global $wpdb;
+		if ( ! empty($order_by) && ! strpos($order_by, 'ORDER BY') !== false ) {
 			$order_by = ' ORDER BY ' . $order_by;
-        }
+		}
 
 		$query = 'SELECT fi.id  FROM ' . $wpdb->prefix . 'frm_fields fi ' .
 			'LEFT OUTER JOIN ' . $wpdb->prefix . 'frm_forms fr ON fi.form_id=fr.id' .
 			FrmAppHelper::prepend_and_or_where( ' WHERE ', $where ) . $order_by . $limit;
 
-        $method = ( $limit == ' LIMIT 1' || $limit == 1 ) ? 'get_var' : 'get_col';
+		$method = ( $limit == ' LIMIT 1' || $limit == 1 ) ? 'get_var' : 'get_col';
 		$cache_key = 'getIds_' . maybe_serialize( $where ) . $order_by . $limit;
-        $results = FrmAppHelper::check_cache($cache_key, 'frm_field', $query, $method);
+		$results = FrmAppHelper::check_cache($cache_key, 'frm_field', $query, $method);
 
-        return $results;
-    }
+		return $results;
+	}
 
 	public static function is_no_save_field( $type ) {
 		return in_array( $type, self::no_save_fields() );
@@ -718,8 +718,8 @@ 
 	}
 
 	/**
-	* @since 2.0.09
-	*/
+	 * @since 2.0.09
+	 */
 	public static function is_repeating_field( $field ) {
 		if ( is_array( $field ) ) {
 			$is_repeating_field = ( 'divider' == $field['type'] );
@@ -729,14 +729,14 @@ 
 		return ( $is_repeating_field && self::is_option_true( $field, 'repeat' ) );
 	}
 
-    /**
-     * @param string $key
-     * @return int field id
-     */
+	/**
+	 * @param string $key
+	 * @return int field id
+	 */
 	public static function get_id_by_key( $key ) {
-        $id = FrmDb::get_var( 'frm_fields', array( 'field_key' => sanitize_title( $key ) ) );
-        return $id;
-    }
+		$id = FrmDb::get_var( 'frm_fields', array( 'field_key' => sanitize_title( $key ) ) );
+		return $id;
+	}
 
 	/**
 	 * @param string $id