GF_Field::__get() - Code Metrics - Inspection of "Version 2.0.14" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1125)

by Zack

created 2018-07-10 01:01 UTC

GF_Field::__get() A

↳ Parent: GF_Field

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.0416

Importance

Changes

Metric	Value
cc	3
nc	3
nop	1
dl	0
loc	9
ccs	5
cts	6
cp	0.8333
crap	3.0416
rs	9.9666
c	0
b	0
f	0

<?php

namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
	die();
}

/**
 * The Gravity Forms \GF_Field field object wrapper.
 */
class GF_Field extends Field {
	
	/**
	 * @var \GF_Field The backing Gravity Forms field.
	 */
	public $field;

	/**
	 * Create self from a configuration array.
	 *
	 * @param array $configuration The configuration array.
	 * @see \GV\Field::as_configuration()
	 * @internal
	 * @since 2.0
	 *
	 * @return \GV\GF_Field|null The field implementation or null on error.
	 */
	public static function from_configuration( $configuration ) {
		if ( empty( $configuration['id'] ) || ! is_numeric( $configuration['id'] ) ) {
			gravityview()->log->error( 'Invalid configuration[id] supplied.' );
			return null;
		}

		if ( empty( $configuration['form_id'] ) || ! $form = \GV\GF_Form::by_id( $configuration['form_id'] )  ) {
			gravityview()->log->error( 'Invalid configuration[form_id] supplied.' );
			return null;
		}

		$field = self::by_id( $form, $configuration['id'] );

		if ( ! $field ) {
			gravityview()->log->error( 'Invalid configuration[id] supplied.' );
			return null;
		}

		$field->update_configuration( $configuration );
		return $field;
	}

	/**
	 * Get a \GV\GF_Field by \GV\GF_Form and Field ID.
	 *
	 * @param \GV\GF_Form $form The Gravity Form form.
	 * @param int $field_id The Gravity Form field ID for the $form.
	 *
	 * @return \GV\Field|null The requested field or null if not found.
	 */
	public static function by_id( $form, $field_id ) {

		if ( ! $form || ! is_object( $form ) || ! is_a( $form, '\GV\GF_Form' ) ) {
			gravityview()->log->error( '$form is not a \GV\GF_Form instance' );
			return null;
		}

		if ( empty( $form->form ) ) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			gravityview()->log->error( '$form is not initialized with a backing Gravity Forms form' );
			return null;
		}



		$gv_field = \GFFormsModel::get_field( $form->form, $field_id );
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		if ( ! $gv_field ) {
			gravityview()->log->error( 'Invalid $field_id #{field_id} for current source', array( 'field_id' => $field_id ) );
			return null;
		}

		$field = new self();
		$field->ID = $field_id;
		$field->field = $gv_field;

		return $field;
	}

	/**
	 * Retrieve the label for this field.
	 *
	 * Requires a \GV\GF_Form in this implementation.
	 *
	 * @param \GV\View $view The view for this context if applicable.
	 * @param \GV\Source $source The source (form) for this context if applicable.
	 * @param \GV\Entry $entry The entry for this context if applicable.
	 * @param \GV\Request $request The request for this context if applicable.
	 *
	 * @return string The label for this Gravity Forms field.
	 */
	public function get_label( View $view = null, Source $source = null, Entry $entry = null, Request $request = null ) {

		if ( ! $this->show_label ) {
			return '';
		}

		if ( $label = parent::get_label( $view, $source, $entry, $request ) ) {
			return $label;
		}

		if ( ! $source || ! is_object( $source ) || ! is_a( $source, '\GV\GF_Form' ) ) {
			gravityview()->log->error( '$source is not a valid \GV\GF_Form instance' );
			return null;
		}

		if ( $this->label ) {
			return $this->label;
		}

		/** This is a complex Gravity Forms input. */
		if ( $input = \GFFormsModel::get_input( $this->field, $this->ID ) ) {
			$label = ! empty( $input['customLabel'] ) ? $input['customLabel'] : $input['label'];
		} else {
			/** This is a field with one label. */
			$label = $this->field->get_field_label( true, $this->label );
		}

		return $label;
	}

	/**
	 * Retrieve the value for this field.
	 *
	 * Requires a \GV\GF_Entry in this implementation.
	 *
	 * @param \GV\View $view The view for this context if applicable.
	 * @param \GV\Source $source The source (form) for this context if applicable.
	 * @param \GV\Entry $entry The entry for this context if applicable.
	 * @param \GV\Request $request The request for this context if applicable.
	 *
	 * @return mixed The value for this field.
	 */
	public function get_value( View $view = null, Source $source = null, Entry $entry = null, Request $request = null ) {
		if ( ! $entry || ! is_object( $entry ) || ! is_a( $entry, '\GV\GF_Entry' ) ) {
			gravityview()->log->error( '$entry is not a valid \GV\GF_Entry instance' );
			return null;
		}

		$value = \RGFormsModel::get_lead_field_value( $entry->as_entry(), $this->field );
		
		/** Apply parent filters. */
		return $this->get_value_filters( $value, $view, $source, $entry, $request );
	}

	/**
	 * A proxy getter for the backing GravityView field.
	 *
	 * The view field configuration is checked first, though.
	 *
	 * @param string $key The property to get.
	 *
	 * @return mixed The value of the Gravity View field property, or null if not exists.
	 */
	public function __get( $key ) {
		if ( $value = parent::__get( $key ) ) {
			return $value;
		}

		if ( $this->field ) {
			return $this->field->$key;
		}
	}
}


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-29 18:22 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 12 and the first side effect is on line 6. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		namespace GV;
3
4		/** If this file is called directly, abort. */
5		if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
6		die();
7		}
8
9		/**
10		* The Gravity Forms \GF_Field field object wrapper.
11		*/
12		class GF_Field extends Field {
13
14		/**
15		* @var \GF_Field The backing Gravity Forms field.
16		*/
17		public $field;
18
19		/**
20		* Create self from a configuration array.
21		*
22		* @param array $configuration The configuration array.
23		* @see \GV\Field::as_configuration()
24		* @internal
25		* @since 2.0
26		*
27		* @return \GV\GF_Field\|null The field implementation or null on error.
28		*/
29	71	public static function from_configuration( $configuration ) {
30	71	if ( empty( $configuration['id'] ) \|\| ! is_numeric( $configuration['id'] ) ) {
31		gravityview()->log->error( 'Invalid configuration[id] supplied.' );
32		return null;
33		}
34
35	71	if ( empty( $configuration['form_id'] ) \|\| ! $form = \GV\GF_Form::by_id( $configuration['form_id'] ) ) {
36	1	gravityview()->log->error( 'Invalid configuration[form_id] supplied.' );
37	1	return null;
38		}
39
40	71	$field = self::by_id( $form, $configuration['id'] );
41
42	71	if ( ! $field ) {
43	4	gravityview()->log->error( 'Invalid configuration[id] supplied.' );
44	4	return null;
45		}
46
47	71	$field->update_configuration( $configuration );
48	71	return $field;
49		}
50
51		/**
52		* Get a \GV\GF_Field by \GV\GF_Form and Field ID.
53		*
54		* @param \GV\GF_Form $form The Gravity Form form.
55		* @param int $field_id The Gravity Form field ID for the $form.
56		*
57		* @return \GV\Field\|null The requested field or null if not found.
58		*/
59	71	public static function by_id( $form, $field_id ) {
60
61	71	if ( ! $form \|\| ! is_object( $form ) \|\| ! is_a( $form, '\GV\GF_Form' ) ) {
62		gravityview()->log->error( '$form is not a \GV\GF_Form instance' );
63		return null;
64		}
65
66	71	if ( empty( $form->form ) ) {
		0 ignored issues – show Documentation introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report The property `$form` is declared private in `GV\Form`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67		gravityview()->log->error( '$form is not initialized with a backing Gravity Forms form' );
68		return null;
69		}
70
		0 ignored issues – show Coding Style introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
71
72	71	$gv_field = \GFFormsModel::get_field( $form->form, $field_id );
		0 ignored issues – show Documentation introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report The property `$form` is declared private in `GV\Form`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
73
74	71	if ( ! $gv_field ) {
75	6	gravityview()->log->error( 'Invalid $field_id #{field_id} for current source', array( 'field_id' => $field_id ) );
76	6	return null;
77		}
78
79	71	$field = new self();
80	71	$field->ID = $field_id;
81	71	$field->field = $gv_field;
82
83	71	return $field;
84		}
85
86		/**
87		* Retrieve the label for this field.
88		*
89		* Requires a \GV\GF_Form in this implementation.
90		*
91		* @param \GV\View $view The view for this context if applicable.
92		* @param \GV\Source $source The source (form) for this context if applicable.
93		* @param \GV\Entry $entry The entry for this context if applicable.
94		* @param \GV\Request $request The request for this context if applicable.
95		*
96		* @return string The label for this Gravity Forms field.
97		*/
98	20	public function get_label( View $view = null, Source $source = null, Entry $entry = null, Request $request = null ) {
99
100	20	if ( ! $this->show_label ) {
101		return '';
102		}
103
104	20	if ( $label = parent::get_label( $view, $source, $entry, $request ) ) {
105	1	return $label;
106		}
107
108	19	if ( ! $source \|\| ! is_object( $source ) \|\| ! is_a( $source, '\GV\GF_Form' ) ) {
109		gravityview()->log->error( '$source is not a valid \GV\GF_Form instance' );
110		return null;
111		}
112
113	19	if ( $this->label ) {
114	19	return $this->label;
115		}
116
117		/** This is a complex Gravity Forms input. */
118		if ( $input = \GFFormsModel::get_input( $this->field, $this->ID ) ) {
119		$label = ! empty( $input['customLabel'] ) ? $input['customLabel'] : $input['label'];
120		} else {
121		/** This is a field with one label. */
122		$label = $this->field->get_field_label( true, $this->label );
123		}
124
125		return $label;
126		}
127
128		/**
129		* Retrieve the value for this field.
130		*
131		* Requires a \GV\GF_Entry in this implementation.
132		*
133		* @param \GV\View $view The view for this context if applicable.
134		* @param \GV\Source $source The source (form) for this context if applicable.
135		* @param \GV\Entry $entry The entry for this context if applicable.
136		* @param \GV\Request $request The request for this context if applicable.
137		*
138		* @return mixed The value for this field.
139		*/
140	43	public function get_value( View $view = null, Source $source = null, Entry $entry = null, Request $request = null ) {
141	43	if ( ! $entry \|\| ! is_object( $entry ) \|\| ! is_a( $entry, '\GV\GF_Entry' ) ) {
142		gravityview()->log->error( '$entry is not a valid \GV\GF_Entry instance' );
143		return null;
144		}
145
146	43	$value = \RGFormsModel::get_lead_field_value( $entry->as_entry(), $this->field );
147
148		/** Apply parent filters. */
149	43	return $this->get_value_filters( $value, $view, $source, $entry, $request );
150		}
151
152		/**
153		* A proxy getter for the backing GravityView field.
154		*
155		* The view field configuration is checked first, though.
156		*
157		* @param string $key The property to get.
158		*
159		* @return mixed The value of the Gravity View field property, or null if not exists.
160		*/
161	45	public function __get( $key ) {
162	45	if ( $value = parent::__get( $key ) ) {
163	13	return $value;
164		}
165
166	43	if ( $this->field ) {
167	43	return $this->field->$key;
168		}
169		}
170		}
171

gravityview / GravityView

Pull Request — master (#1125)

GF_Field::__get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like