Give_DB_Form_Meta

Complexity

Total Complexity

21

Size/Duplication

Total Lines	267
Duplicated Lines	100 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	15	15	1
A	get_columns()	8	8	1
B	get_meta()	22	22	4
A	add_meta()	10	10	2
A	update_meta()	10	10	2
A	delete_meta()	10	10	2
A	create_table()	20	20	1
B	__call()	42	42	6
A	is_form()	3	3	2

<?php
/**
 * Form Meta DB class
 *
 * @package     Give
 * @subpackage  Classes/DB Form Meta
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       2.0
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class Give_DB_Form_Meta
 *
 * This class is for interacting with the form meta database table.
 *
 * @since 2.0
 */
class Give_DB_Form_Meta extends Give_DB {

This class seems to be duplicated in your project.

	/**
	 * Flag to handle result type
	 *
	 * @since 2.0
	 * @access private
	 */
	private $raw_result = false;

	/**
	 * Give_DB_Form_Meta constructor.
	 *
	 * @access  public
	 * @since   2.0
	 */
	public function __construct() {
		/* @var WPDB $wpdb */
		global $wpdb;

		$wpdb->formmeta    = $this->table_name = $wpdb->prefix . 'give_formmeta';
		$this->primary_key = 'meta_id';
		$this->version     = '1.0';

		$this->register_table();

		add_filter( 'add_post_metadata', array( $this, '__add_meta' ), 0, 4 );
		add_filter( 'get_post_metadata', array( $this, '__get_meta' ), 0, 4 );
		add_filter( 'update_post_metadata', array( $this, '__update_meta' ), 0, 4 );
		add_filter( 'delete_post_metadata', array( $this, '__delete_meta' ), 0, 4 );
	}

	/**
	 * Get table columns and data types.
	 *
	 * @access  public
	 * @since   2.0
	 *
	 * @return  array  Columns and formats.
	 */
	public function get_columns() {
		return array(
			'meta_id'    => '%d',
			'form_id'    => '%d',
			'meta_key'   => '%s',

Detected usage of meta_key, possible slow query.

			'meta_value' => '%s',

Detected usage of meta_value, possible slow query.

		);
	}

	/**
	 * Retrieve form meta field for a form.
	 *
	 * For internal use only. Use Give_Form->get_meta() for public usage.
	 *
	 * @access  public
	 * @since   2.0
	 *
	 * @param   int    $form_id  Form ID.
	 * @param   string $meta_key The meta key to retrieve.
	 * @param   bool   $single   Whether to return a single value.
	 *
	 * @return  mixed                 Will be an array if $single is false. Will be value of meta data field if $single is true.
	 */
	public function get_meta( $form_id = 0, $meta_key = '', $single = false ) {
		$form_id = $this->sanitize_id( $form_id );

		// Bailout.
		if ( ! $this->is_form( $form_id ) ) {
			return null;
		}

		if( $this->raw_result ) {

Space after opening control structure is required

No space before opening parenthesis is prohibited

			if( ! ( $value = get_metadata( 'form', $form_id, $meta_key, false ) ) ) {

Space after opening control structure is required

No space before opening parenthesis is prohibited

				$value = '';
			}

			// Reset flag.
			$this->raw_result = false;

		}else {
			$value = get_metadata( 'form', $form_id, $meta_key, $single );
		}

		return $value;
	}

	/**
	 * Add meta data field to a form.
	 *
	 * For internal use only. Use Give_Form->add_meta() for public usage.
	 *
	 * @access  private
	 * @since   2.0
	 *
	 * @param   int    $form_id    Form ID.
	 * @param   string $meta_key   Metadata name.
	 * @param   mixed  $meta_value Metadata value.
	 * @param   bool   $unique     Optional, default is false. Whether the same key should not be added.
	 *
	 * @return  bool                  False for failure. True for success.
	 */
	public function add_meta( $form_id = 0, $meta_key = '', $meta_value, $unique = false ) {
		$form_id = $this->sanitize_id( $form_id );

		// Bailout.
		if ( ! $this->is_form( $form_id ) ) {
			return null;
		}

		return add_metadata( 'form', $form_id, $meta_key, $meta_value, $unique );
	}

	/**
	 * Update form meta field based on Form ID.
	 *
	 * For internal use only. Use Give_Form->update_meta() for public usage.
	 *
	 * Use the $prev_value parameter to differentiate between meta fields with the
	 * same key and Form ID.
	 *
	 * If the meta field for the form does not exist, it will be added.
	 *
	 * @access  public
	 * @since   2.0
	 *
	 * @param   int    $form_id    Form ID.
	 * @param   string $meta_key   Metadata key.
	 * @param   mixed  $meta_value Metadata value.
	 * @param   mixed  $prev_value Optional. Previous value to check before removing.
	 *
	 * @return  bool                  False on failure, true if success.
	 */
	public function update_meta( $form_id = 0, $meta_key = '', $meta_value, $prev_value = '' ) {
		$form_id = $this->sanitize_id( $form_id );

		// Bailout.
		if ( ! $this->is_form( $form_id ) ) {
			return null;
		}

		return update_metadata( 'form', $form_id, $meta_key, $meta_value, $prev_value );
	}

	/**
	 * Remove metadata matching criteria from a form.
	 *
	 * You can match based on the key, or key and value. Removing based on key and
	 * value, will keep from removing duplicate metadata with the same key. It also
	 * allows removing all metadata matching key, if needed.
	 *
	 * @access  public
	 * @since   2.0
	 *
	 * @param   int    $form_id    Form ID.
	 * @param   string $meta_key   Metadata name.
	 * @param   mixed  $meta_value Optional. Metadata value.
	 *
	 * @return  bool                  False for failure. True for success.
	 */
	public function delete_meta( $form_id = 0, $meta_key = '', $meta_value = '' ) {
		$form_id = $this->sanitize_id( $form_id );

		// Bailout.
		if ( ! $this->is_form( $form_id ) ) {
			return null;
		}

		return delete_metadata( 'form', $form_id, $meta_key, $meta_value );
	}

	/**
	 * Create the table
	 *
	 * @access public
	 * @since  2.0
	 *
	 * @return void
	 */
	public function create_table() {
		global $wpdb;

		$charset_collate = $wpdb->get_charset_collate();

		$sql = "CREATE TABLE {$this->table_name} (
			meta_id bigint(20) NOT NULL AUTO_INCREMENT,
			form_id bigint(20) NOT NULL,
			meta_key varchar(255) DEFAULT NULL,
			meta_value longtext,
			PRIMARY KEY  (meta_id),
			KEY form_id (form_id),
			KEY meta_key (meta_key)
			) {$charset_collate};";

		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
		dbDelta( $sql );

		update_option( $this->table_name . '_db_version', $this->version );
	}

	/**
	 * Add support for hidden functions.
	 *
	 * @since  2.0
	 * @access public
	 *
	 * @param $name
	 * @param $arguments
	 *
	 * @return mixed
	 */
	public function __call( $name, $arguments ) {
		// Bailout.
		if( ! give_has_upgrade_completed('v20_move_metadata_into_new_table') ) {

Space after opening control structure is required

No space before opening parenthesis is prohibited

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			return;
		}

		switch ( $name ) {
			case '__add_meta':
				$check      = $arguments[0];

$check is not used, you could remove the assignment.

				$log_id     = $arguments[1];
				$meta_key   = $arguments[2];
				$meta_value = $arguments[3];
				$unique     = $arguments[4];

				return $this->add_meta( $log_id, $meta_key, $meta_value, $unique );

			case '__get_meta':
				$check    = $arguments[0];

$check is not used, you could remove the assignment.

				$log_id   = $arguments[1];
				$meta_key = $arguments[2];
				$single   = $arguments[3];

				$this->raw_result = true;
				return $this->get_meta( $log_id, $meta_key, $single );

			case '__update_meta':
				$check      = $arguments[0];

$check is not used, you could remove the assignment.

				$log_id     = $arguments[1];
				$meta_key   = $arguments[2];
				$meta_value = $arguments[3];

				return $this->update_meta( $log_id, $meta_key, $meta_value );

			case '__delete_meta':
				$check      = $arguments[0];

$check is not used, you could remove the assignment.

				$log_id     = $arguments[1];
				$meta_key   = $arguments[2];
				$meta_value = $arguments[3];

				return $this->delete_meta( $log_id, $meta_key, $meta_value );
		}
	}


	/**
	 * Check if current id of donation form type or not
	 *
	 * @since  2.0
	 * @access private
	 *
	 * @param $ID
	 *
	 * @return bool
	 */
	private function is_form( $ID ) {
		return $ID && ( 'give_forms' === get_post_type( $ID ) );
	}
}