PodsField_Currency

Complexity

Total Complexity

75

Size/Duplication

Total Lines	692
Duplicated Lines	32.95 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	options()	0	119	1
B	schema()	26	26	6
C	prepare()	33	33	7
C	display()	3	36	7
C	input()	39	39	8
C	regex()	31	44	8
C	validate()	31	59	9
C	pre_save()	31	70	13
A	ui()	0	5	1
C	format()	34	67	14

<?php

/**
 * @package Pods\Fields
 */
class PodsField_Currency extends PodsField {

	/**
	 * Field Type Group
	 *
	 * @var string
	 * @since 2.0
	 */
	public static $group = 'Number';

	/**
	 * Field Type Identifier
	 *
	 * @var string
	 * @since 2.0
	 */
	public static $type = 'currency';

	/**
	 * Field Type Label
	 *
	 * @var string
	 * @since 2.0
	 */
	public static $label = 'Currency';

	/**
	 * Field Type Preparation
	 *
	 * @var string
	 * @since 2.0
	 */
	public static $prepare = '%d';

	/**
	 * Currency Formats
	 *
	 * @var array
	 * @since 2.0
	 */
	public static $currencies = array(
		'usd' => '$',
		'euro' => '&euro;',
		'gbp' => '&pound;',
		'cad' => '$',
		'aud' => '$',
		'nzd' => '$',
		'rub' => '&#8381;',
		'chf' => 'CHF',
		'dkk' => 'kr',
		'nok' => 'kr',
		'sek' => 'kr',
		'zar' => 'R',
		'inr' => '&#x20B9;',
		'jpy' => '&yen;',
		'cny' => '&yen;',
		'sgd' => '$',
		'krw' => '&#8361;',
		'thb' => '&#x0E3F;',
		'trl' => '&#8378;',
		'vnd' => '&#8363;'
	);

	/**
	 * Do things like register/enqueue scripts and stylesheets
	 *
	 * @since 2.0
	 */
	public function __construct() {
		self::$label = __( 'Currency', 'pods' );
		self::$currencies = apply_filters( 'pods_form_ui_field_currency_currencies', self::$currencies );
	}

	/**
	 * Add options and set defaults to
	 *
	 * @return array
	 *
	 * @since 2.0
	 */
	public function options() {

		$options = array(
			self::$type . '_repeatable' => array(
				'label' => __( 'Repeatable Field', 'pods' ),
				'default' => 0,
				'type' => 'boolean',
				'help' => __( 'Making a field repeatable will add controls next to the field which allows users to Add/Remove/Reorder additional values. These values are saved in the database as an array, so searching and filtering by them may require further adjustments".', 'pods' ),
				'boolean_yes_label' => '',
				'dependency' => true,
				'developer_mode' => true
			),
			self::$type . '_format_type' => array(
				'label' => __( 'Input Type', 'pods' ),
				'default' => 'number',
				'type' => 'pick',
				'data' => array(
					'number' => __( 'Freeform Number', 'pods' ),
					'slider' => __( 'Slider', 'pods' )
				),
				'dependency' => true
			),
			self::$type . '_format_sign' => array(
				'label' => __( 'Currency Sign', 'pods' ),
				'default' => apply_filters( 'pods_form_ui_field_number_currency_default', 'usd' ),
				'type' => 'pick',
				'data' => apply_filters( 'pods_form_ui_field_number_currency_options', array(
						'usd' => '$ (USD)',
						'euro' => '&euro; (EUR)',
						'gbp' => '&pound; (GBP)',
						'aud' => 'Australian Dollar (AUD)',
						'cad' => 'Canadian Dollar (CAD)',
						'cny' => 'Chinese Yuan (CNY)',
						'dkk' => 'Danish Krone (DKK)',
						'inr' => 'Indian Rupee (INR)',
						'jpy' => 'Japanese Yen (JPY)',
						'krw' => 'Korean Won (KRW)',
						'nzd' => 'New Zealand Dollar (NZD)',
						'nok' => 'Norwegian Krone (NOK)',
						'rub' => 'Russian Ruble (RUB)',
						'sgd' => 'Singapore Dollar (SGD)',
						'zar' => 'South African Rand (ZAR)',
						'sek' => 'Swedish Krona (SEK)',
						'chf' => 'Swiss Franc (CHF)',
						'thb' => 'Thai Baht (THB)',
						'trl' => 'Turkish Lira (TRL)',
						'vnd' => 'Vietnamese Dong (VND)'
					) )
			),
			self::$type . '_format_placement' => array(
				'label' => __( 'Currency Placement', 'pods' ),
				'default' => apply_filters( 'pods_form_ui_field_number_currency_placement_default', 'before' ),
				'type' => 'pick',
				'data' => array(
					'before' => __( 'Before (ex. $100)', 'pods' ),
					'after' => __( 'After (ex. 100$)', 'pods' ),
					'none' => __( 'None (ex. 100)', 'pods' ),
					'beforeaftercode' => __( 'Before with Currency Code after (ex. $100 USD)', 'pods' )
				)
			),
			self::$type . '_format' => array(
				'label' => __( 'Format', 'pods' ),
				'default' => apply_filters( 'pods_form_ui_field_number_currency_format_default', 'i18n' ),
				'type' => 'pick',
				'data' => array(
					'i18n' => __( 'Localized Default', 'pods' ),
					'9,999.99' => '1,234.00',
					'9\'999.99' => '1\'234.00',
					'9.999,99' => '1.234,00',
					'9 999,99' => '1 234,00',
					'9999.99' => '1234.00',
					'9999,99' => '1234,00'
				)
			),
			self::$type . '_decimals' => array(
				'label' => __( 'Decimals', 'pods' ),
				'default' => 2,
				'type' => 'number'
			),
			self::$type . '_step' => array(
				'label' => __( 'Slider Increment (Step)', 'pods' ),
				'depends-on' => array( self::$type . '_format_type' => 'slider' ),
				'default' => 1,
				'type' => 'text'
			),
			self::$type . '_min' => array(
				'label' => __( 'Minimum Number', 'pods' ),
				'depends-on' => array( self::$type . '_format_type' => 'slider' ),
				'default' => 0,
				'type' => 'text'
			),
			self::$type . '_max' => array(
				'label' => __( 'Maximum Number', 'pods' ),
				'depends-on' => array( self::$type . '_format_type' => 'slider' ),
				'default' => 1000,
				'type' => 'text'
			),
			self::$type . '_max_length' => array(
				'label' => __( 'Maximum Length', 'pods' ),
				'default' => 12,
				'type' => 'number',
				'help' => __( 'Set to -1 for no limit', 'pods' )
			)
			/*,

53% of this comment could be valid code. Did you maybe forget this after debugging?

			self::$type . '_size' => array(
				'label' => __( 'Field Size', 'pods' ),
				'default' => 'medium',
				'type' => 'pick',
				'data' => array(
					'small' => __( 'Small', 'pods' ),
					'medium' => __( 'Medium', 'pods' ),
					'large' => __( 'Large', 'pods' )
				)
			)*/
		);

		return $options;

	}

	/**
	 * Define the current field's schema for DB table storage
	 *
	 * @param array $options
	 *
	 * @return array
	 * @since 2.0
	 */
	public function schema( $options = null ) {

This method seems to be duplicated in your project.

		$length = (int) pods_v( self::$type . '_max_length', $options, 12, true );

		if ( $length < 1 || 64 < $length ) {
			$length = 64;
		}

		$decimals = (int) pods_v( self::$type . '_decimals', $options, 2, true );

		if ( $decimals < 1 ) {
			$decimals = 0;
		}
		elseif ( 30 < $decimals ) {
			$decimals = 30;
		}

		if ( $length < $decimals ) {
			$decimals = $length;
		}

		$schema = 'DECIMAL(' . $length . ',' . $decimals . ')';

		return $schema;

	}

	/**
	 * Define the current field's preparation for sprintf
	 *
	 * @param array $options
	 *
	 * @return array
	 * @since 2.0
	 */
	public function prepare( $options = null ) {

This method seems to be duplicated in your project.

		$format = self::$prepare;

		$length = (int) pods_v( self::$type . '_max_length', $options, 12, true );

		if ( $length < 1 || 64 < $length ) {
			$length = 64;
		}

		$decimals = (int) pods_v( self::$type . '_decimals', $options, 2, true );

		if ( $decimals < 1 ) {
			$decimals = 0;
		}
		elseif ( 30 < $decimals ) {
			$decimals = 30;
		}

		if ( $length < $decimals ) {
			$decimals = $length;
		}

		if ( 0 < $decimals ) {
			$format = '%01.' . $decimals . 'F';
		}
		else {
			$format = '%d';
		}

		return $format;

	}

	/**
	 * Change the way the value of the field is displayed with Pods::get
	 *
	 * @param mixed $value
	 * @param string $name
	 * @param array $options
	 * @param array $pod
	 * @param int $id
	 *
	 * @return mixed|null|string
	 * @since 2.0
	 */
	public function display( $value = null, $name = null, $options = null, $pod = null, $id = null ) {

		$value = $this->format( $value, $name, $options, $pod, $id );

		$currency = 'usd';

		if ( isset( self::$currencies[ pods_v( self::$type . '_format_sign', $options, -1 ) ] ) ) {
			$currency = pods_v( self::$type . '_format_sign', $options );
		}

		$currency_sign = self::$currencies[ $currency ];

		$placement = pods_v( self::$type . '_format_placement', $options, 'before', true );

		// Currency placement policy
		// Single sign currencies: 100$, £100
		// Multiple sign currencies: 100 Fr, Kr 100
		$currency_gap = '';

		if ( strlen( $currency_sign ) > 1 && false === strpos( $currency_sign, '&' ) ) {
			$currency_gap = ' ';
		}

		if ( 'before' == $placement ) {
			$value = $currency_sign . $currency_gap . $value;
		}
		elseif ( 'after' == $placement ) {
			$value .= $currency_gap . $currency_sign;
		}
		elseif ( 'beforeaftercode' == $placement ) {
			$value = $currency_sign . $currency_gap . $value . ' ' . strtoupper( $currency );
		}

		return $value;

	}

	/**
	 * Customize output of the form field
	 *
	 * @param string $name
	 * @param mixed $value
	 * @param array $options
	 * @param array $pod
	 * @param int $id
	 *
	 * @since 2.0
	 */
	public function input( $name, $value = null, $options = null, $pod = null, $id = null ) {

This method seems to be duplicated in your project.

		$options = (array) $options;
		$form_field_type = PodsForm::$field_type;

The property field_type cannot be accessed from this context as it is declared private in class PodsForm.

		if ( is_array( $value ) ) {
			$value = implode( '', $value );
		}

		if ( 'slider' == pods_v( self::$type . '_format_type', $options, 'number' ) ) {
			$field_type = 'slider';
		}
		else {
			$field_type = 'currency';
		}

		if ( isset( $options[ 'name' ] ) && false === PodsForm::permission( self::$type, $options[ 'name' ], $options, null, $pod, $id ) ) {
			if ( pods_v( 'read_only', $options, false ) ) {
				$options[ 'readonly' ] = true;

				$field_type = 'text';

				$value = $this->format( $value, $name, $options, $pod, $id );
			}
			else {
				return;
			}
		}
		elseif ( !pods_has_permissions( $options ) && pods_v( 'read_only', $options, false ) ) {
			$options[ 'readonly' ] = true;

			$field_type = 'text';

			$value = $this->format( $value, $name, $options, $pod, $id );
		}

		pods_view( PODS_DIR . 'ui/fields/' . $field_type . '.php', compact( array_keys( get_defined_vars() ) ) );

	}

	/**
	 * Build regex necessary for JS validation
	 *
	 * @param mixed $value
	 * @param string $name
	 * @param array $options
	 * @param string $pod
	 * @param int $id
	 *
	 * @return bool|string
	 * @since 2.0
	 */
	public function regex( $value = null, $name = null, $options = null, $pod = null, $id = null ) {

		global $wp_locale;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		if ( '9.999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '.';
			$dot = ',';
		}
		elseif ( '9,999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ',';
			$dot = '.';
		}
		elseif ( '9\'999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '\'';
			$dot = '.';
		}
		elseif ( '9 999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ' ';
			$dot = ',';
		}
		elseif ( '9999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '';
			$dot = '.';
		}
		elseif ( '9999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '';
			$dot = ',';
		}
		else {
			$thousands = $wp_locale->number_format[ 'thousands_sep' ];
			$dot = $wp_locale->number_format[ 'decimal_point' ];
		}

		$currency = 'usd';

		if ( isset( self::$currencies[ pods_v( self::$type . '_format_sign', $options, -1 ) ] ) ) {
			$currency = pods_v( self::$type . '_format_sign', $options );
		}

		$currency_sign = self::$currencies[ $currency ];

		return '\-*\\' . $currency_sign . '*[0-9\\' . implode( '\\', array_filter( array( $dot, $thousands ) ) ) . ']+';

	}

	/**
	 * Validate a value before it's saved
	 *
	 * @param mixed $value
	 * @param string $name
	 * @param array $options
	 * @param array $fields
	 * @param array $pod
	 * @param int $id
	 * @param null $params
	 *
	 * @return bool|mixed
	 * @since 2.0
	 */
	public function validate( $value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) {

		global $wp_locale;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		if ( '9.999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '.';
			$dot = ',';
		}
		elseif ( '9,999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ',';
			$dot = '.';
		}
		elseif ( '9\'999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '\'';
			$dot = '.';
		}
		elseif ( '9 999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ' ';
			$dot = ',';
		}
		elseif ( '9999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ',';
			$dot = '.';
		}
		elseif ( '9999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '.';
			$dot = ',';
		}
		else {
			$thousands = $wp_locale->number_format[ 'thousands_sep' ];
			$dot = $wp_locale->number_format[ 'decimal_point' ];
		}

		$currency = 'usd';

		if ( isset( self::$currencies[ pods_v( self::$type . '_format_sign', $options, -1 ) ] ) ) {
			$currency = pods_v( self::$type . '_format_sign', $options );
		}

		$currency_sign = self::$currencies[ $currency ];

		$check = str_replace(
			array( $thousands, $dot, $currency_sign, html_entity_decode( $currency_sign ), html_entity_decode( $thousands ) ),
			array( '', '.', '', '', '' ),
			$value
		);
		$check = trim( $check );

		$check = preg_replace( '/[0-9\.\-\s]/', '', $check );

		$label = pods_v( 'label', $options, ucwords( str_replace( '_', ' ', $name ) ) );

		if ( 0 < strlen( $check ) ) {
			return sprintf( __( '%s is not numeric', 'pods' ), $label );
		}

		return true;

	}

	/**
	 * Change the value or perform actions after validation but before saving to the DB
	 *
	 * @param mixed $value
	 * @param int $id
	 * @param string $name
	 * @param array $options
	 * @param array $fields
	 * @param array $pod
	 * @param object $params
	 *
	 * @return mixed|string
	 * @since 2.0
	 */
	public function pre_save( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {

		global $wp_locale;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		if ( '9.999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '.';
			$dot = ',';
		}
		elseif ( '9,999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ',';
			$dot = '.';
		}
		elseif ( '9\'999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '\'';
			$dot = '.';
		}
		elseif ( '9 999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ' ';
			$dot = ',';
		}
		elseif ( '9999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ',';
			$dot = '.';
		}
		elseif ( '9999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '.';
			$dot = ',';
		}
		else {
			$thousands = $wp_locale->number_format[ 'thousands_sep' ];
			$dot = $wp_locale->number_format[ 'decimal_point' ];
		}

		$currency = 'usd';

		if ( isset( self::$currencies[ pods_v( self::$type . '_format_sign', $options, -1 ) ] ) ) {
			$currency = pods_v( self::$type . '_format_sign', $options );
		}

		$currency_sign = self::$currencies[ $currency ];

		$value = str_replace( array( $thousands, $dot, $currency_sign, html_entity_decode( $currency_sign ) ), array( '', '.', '', '' ), $value );
		$value = trim( $value );

		$value = preg_replace( '/[^0-9\.\-]/', '', $value );

		$length = (int) pods_v( self::$type . '_max_length', $options, 12, true );

		if ( $length < 1 || 64 < $length ) {
			$length = 64;
		}

		$decimals = (int) pods_v( self::$type . '_decimals', $options, 2, true );

		if ( $decimals < 1 ) {
			$decimals = 0;
		}
		elseif ( 30 < $decimals ) {
			$decimals = 30;
		}

		if ( $length < $decimals ) {
			$decimals = $length;
		}

		$value = number_format( (float) $value, $decimals, '.', '' );

		return $value;

	}

	/**
	 * Customize the Pods UI manage table column output
	 *
	 * @param int $id
	 * @param mixed $value
	 * @param string $name
	 * @param array $options
	 * @param array $fields
	 * @param array $pod
	 *
	 * @return mixed|null|string
	 * @since 2.0
	 */
	public function ui( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {

		return $this->display( $value, $name, $options, $pod, $id );

	}

	/**
	 * Reformat a number to the way the value of the field is displayed
	 *
	 * @param mixed $value
	 * @param string $name
	 * @param array $options
	 * @param array $pod
	 * @param int $id
	 *
	 * @return string
	 * @since 2.0
	 */
	public function format( $value = null, $name = null, $options = null, $pod = null, $id = null ) {

The parameter $name is not used and could be removed.

The parameter $pod is not used and could be removed.

The parameter $id is not used and could be removed.

		global $wp_locale;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		if ( null === $value ) {
			// Don't enforce a default value here
			return null;
		}

		if ( '9.999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '.';
			$dot = ',';
		}
		elseif ( '9,999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ',';
			$dot = '.';
		}
		elseif ( '9\'999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '\'';
			$dot = '.';
		}
		elseif ( '9 999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = ' ';
			$dot = ',';
		}
		elseif ( '9999.99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '';
			$dot = '.';
		}
		elseif ( '9999,99' == pods_v( self::$type . '_format', $options ) ) {
			$thousands = '';
			$dot = ',';
		}
		else {
			$thousands = $wp_locale->number_format[ 'thousands_sep' ];
			$dot = $wp_locale->number_format[ 'decimal_point' ];
		}

		$length = (int) pods_v( self::$type . '_max_length', $options, 12, true );

		if ( $length < 1 || 64 < $length ) {
			$length = 64;
		}

		$decimals = (int) pods_v( self::$type . '_decimals', $options, 2 );

		if ( $decimals < 1 ) {
			$decimals = 0;
		}
		elseif ( 30 < $decimals ) {
			$decimals = 30;
		}

		if ( $length < $decimals ) {
			$decimals = $length;
		}

		if ( 'i18n' == pods_v( self::$type . '_format', $options ) ) {
			$value = number_format_i18n( (float) $value, $decimals );
		}
		else {
			$value = number_format( (float) $value, $decimals, $dot, $thousands );
		}

		return $value;

	}
}