GF_Form::from_form() - Code Metrics - Inspection of "Add da_DK translation file" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c04cf6...7b9575 )

by Zack

created 2020-04-08 21:18 UTC

GF_Form::from_form() A

↳ Parent: GF_Form

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	11
ccs	0
cts	7
cp	0
crap	6
rs	9.9
c	0
b	0
f	0

<?php
namespace GV;

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

/**
 * The Gravity Forms Form class implementation.
 *
 * Accessible as an array for back-compatibility.
 */
class GF_Form extends Form implements \ArrayAccess {


	/**
	 * @var string The identifier of the backend used for this form.
	 * @api
	 * @since 2.0
	 */
	public static $backend = self::BACKEND_GRAVITYFORMS;

	/**
	 * Initialization.
	 */
	private function __construct() {
		if ( ! class_exists( 'GFAPI' ) ) {
			gravityview()->log->error( 'Gravity Forms plugin is not active.' );
		}
	}

	/**
	 * Construct a \GV\GF_Form instance by ID.
	 *
	 * @param int|string $form_id The internal form ID.
	 *
	 * @api
	 * @since 2.0
	 * @return \GV\GF_Form|null An instance of this form or null if not found.
	 */
	public static function by_id( $form_id ) {

		$form = wp_cache_get( 'gf_form_' . $form_id, 'gravityview' );

		if ( ! $form ) {
			$form = \GFAPI::get_form( $form_id );
		}

		if ( ! $form ) {
			return null;
		}

		wp_cache_set( 'gf_form_' . $form_id, $form, 'gravityview' );

		$self = new self();
		$self->form = $form;


		$self->ID = intval( $self->form['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.");
        }
    }

}

		return $self;
	}

	/**
	 * Construct a \GV\Form instance from a Gravity Forms form array.
	 *
	 * @since 2.0.7
	 *
	 * @param array $form The form array
	 *
	 * @return \GV\GF_Form|null An instance of this form or null if not found.
	 */
	public static function from_form( $form ) {
		if ( empty( $form['id'] ) ) {
			return null;
		}

		$self = new self();
		$self->form = $form;

		$self->ID = $self->form['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.");
        }
    }

}

		return $self;
	}

	/**
	 * Get all entries for this form.
	 *
	 * @api
	 * @since 2.0
	 *
	 * @return \GV\Entry_Collection The \GV\Entry_Collection
	 */
	public function get_entries() {
		$entries = new \GV\Entry_Collection();

		$form = &$this;

		/** Add the fetcher lazy callback. */
		$entries->add_fetch_callback( function( $filters, $sorts, $offset ) use ( $form ) {
			$entries = new \GV\Entry_Collection();

			$search_criteria = array();
			$sorting = array();
			$paging = array();

			/** Apply the filters */
			foreach ( $filters as $filter ) {
				$search_criteria = $filter::merge_search_criteria( $search_criteria, $filter->as_search_criteria() );
			}

			/** Apply the sorts */
			foreach ( $sorts as $sort ) {
				/** Gravity Forms does not have multi-sorting, so just overwrite. */
				$sorting = array(
					'key' => $sort->field->ID,
					'direction' => $sort->direction,
					'is_numeric' => $sort->mode == Entry_Sort::NUMERIC,
				);
			}

			/** The offset and limit */
			if ( ! empty( $offset->limit ) ) {
				$paging['page_size'] = $offset->limit;
			}

			if ( ! empty( $offset->offset ) ) {
				$paging['offset'] = $offset->offset;
			}

			foreach ( \GFAPI::get_entries( $form->ID, $search_criteria, $sorting, $paging ) as $entry ) {
				$entries->add( \GV\GF_Entry::from_entry( $entry ) );
			}

			return $entries;
		} );

		/** Add the counter lazy callback. */
		$entries->add_count_callback( function( $filters ) use ( $form ) {
			$search_criteria = array();
			$sorting = array();

			/** Apply the filters */
			/** @var \GV\GF_Entry_Filter|\GV\Entry_Filter $filter */
			foreach ( $filters as $filter ) {
				$search_criteria = $filter::merge_search_criteria( $search_criteria, $filter->as_search_criteria() );
			}

			return \GFAPI::count_entries( $form->ID, $search_criteria );
		} );

		return $entries;
	}

	/**
	 * Get a \GV\Field by Form and Field ID for this data source.
	 *
	 * @param \GV\GF_Form $form The Gravity Form form ID.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param int $field_id The Gravity Form field ID for the $form_id.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 *
	 * @return \GV\Field|null The requested field or null if not found.
	 */
	public static function get_field( /** varargs */ ) {
		$args = func_get_args();

		if ( ! is_array( $args ) || count( $args ) != 2 ) {
			gravityview()->log->error( '{source} expects 2 arguments for ::get_field ($form, $field_id)', array( 'source' => __CLASS__ ) );
			return null;
		}

		/** Unwrap the arguments. */
		list( $form, $field_id ) = $args;

		/** Wrap it up into a \GV\Field. */
		return GF_Field::by_id( $form, $field_id );
	}

	/**
	 * Get an array of GV Fields for this data source
	 *
	 * @return \GV\Field[]|array Empty array if no fields
	 */
	public function get_fields() {
		$fields = array();
		foreach ( $this['fields'] as $field ) {
			foreach ( empty( $field['inputs'] ) ? array( $field['id'] ) : wp_list_pluck( $field['inputs'], 'id' ) as $id ) {
				if ( is_numeric( $id ) ) {
					$fields[ $id ] = self::get_field( $this, $id );
				} else {
					$fields[ $id ] = Internal_Field::by_id( $id );
				}
			}
		}

		return array_filter( $fields );
	}

	/**
	 * Proxies.
	 *
	 * @param string $key The property to get.
	 *
	 * @return mixed
	 */
	public function __get( $key ) {
		switch ( $key ) {
			case 'fields':
				return $this->get_fields();
			default:
				return parent::__get( $key );
		}
	}

	/**
	 * ArrayAccess compatibility layer with a Gravity Forms form array.
	 *
	 * @internal
	 * @deprecated
	 * @since 2.0
	 * @return bool Whether the offset exists or not.
	 */
	public function offsetExists( $offset ) {
		return isset( $this->form[$offset] );
<?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.");
        }
    }

}
	}

	/**
	 * ArrayAccess compatibility layer with a Gravity Forms form array.
	 *
	 * Maps the old keys to the new data;
	 *
	 * @internal
	 * @deprecated
	 * @since 2.0
	 *
	 * @return mixed The value of the requested form data.
	 */
	public function offsetGet( $offset ) {
		return $this->form[$offset];
<?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.");
        }
    }

}
	}

	/**
	 * ArrayAccess compatibility layer with a Gravity Forms form array.
	 *
	 * @internal
	 * @deprecated
	 * @since 2.0
	 *
	 * @return void
	 */
	public function offsetSet( $offset, $value ) {
		gravityview()->log->error( 'The underlying Gravity Forms form is immutable. This is a \GV\Form object and should not be accessed as an array.' );
	}

	/**
	 * ArrayAccess compatibility layer with a Gravity Forms form array.
	 *
	 * @internal
	 * @deprecated
	 * @since 2.0
	 * @return void
	 */
	public function offsetUnset( $offset ) {
		gravityview()->log->error( 'The underlying Gravity Forms form is immutable. This is a \GV\Form object and should not be accessed as an array.' );
	}
}


1		<?php
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 Form class implementation.
11		*
12		* Accessible as an array for back-compatibility.
13		*/
14		class GF_Form extends Form implements \ArrayAccess {
		0 ignored issues – show Coding Style introduced 2017-03-29 06:38 UTC by Report Bug Copy Issue Report Since you have declared the constructor as private, maybe you should also declare the class as final. Loading history...
15
16		/**
17		* @var string The identifier of the backend used for this form.
18		* @api
19		* @since 2.0
20		*/
21		public static $backend = self::BACKEND_GRAVITYFORMS;
22
23		/**
24		* Initialization.
25		*/
26	181	private function __construct() {
27	181	if ( ! class_exists( 'GFAPI' ) ) {
28		gravityview()->log->error( 'Gravity Forms plugin is not active.' );
29		}
30	181	}
31
32		/**
33		* Construct a \GV\GF_Form instance by ID.
34		*
35		* @param int\|string $form_id The internal form ID.
36		*
37		* @api
38		* @since 2.0
39		* @return \GV\GF_Form\|null An instance of this form or null if not found.
40		*/
41	182	public static function by_id( $form_id ) {
42
43	182	$form = wp_cache_get( 'gf_form_' . $form_id, 'gravityview' );
44
45	182	if ( ! $form ) {
46	182	$form = \GFAPI::get_form( $form_id );
47		}
48
49	182	if ( ! $form ) {
50	9	return null;
51		}
52
53	182	wp_cache_set( 'gf_form_' . $form_id, $form, 'gravityview' );
54
55	182	$self = new self();
56	182	$self->form = $form;
		0 ignored issues – show Bug introduced 2017-03-29 06:38 UTC by Report Bug Copy Issue Report The property `form` cannot be accessed from this context as it is declared `private` in class `GV\Form`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
57
58	182	$self->ID = intval( $self->form['id'] );
		0 ignored issues – show Documentation introduced 2018-06-13 04:44 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...
59
60	182	return $self;
61		}
62
63		/**
64		* Construct a \GV\Form instance from a Gravity Forms form array.
65		*
66		* @since 2.0.7
67		*
68		* @param array $form The form array
69		*
70		* @return \GV\GF_Form\|null An instance of this form or null if not found.
71		*/
72		public static function from_form( $form ) {
73		if ( empty( $form['id'] ) ) {
74		return null;
75		}
76
77		$self = new self();
78		$self->form = $form;
		0 ignored issues – show Bug introduced 2018-05-23 23:24 UTC by Report Bug Copy Issue Report The property `form` cannot be accessed from this context as it is declared `private` in class `GV\Form`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
79		$self->ID = $self->form['id'];
		0 ignored issues – show Documentation introduced 2018-05-23 23:24 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...
80
81		return $self;
82		}
83
84		/**
85		* Get all entries for this form.
86		*
87		* @api
88		* @since 2.0
89		*
90		* @return \GV\Entry_Collection The \GV\Entry_Collection
91		*/
92		public function get_entries() {
93		$entries = new \GV\Entry_Collection();
94
95		$form = &$this;
96
97		/** Add the fetcher lazy callback. */
98		$entries->add_fetch_callback( function( $filters, $sorts, $offset ) use ( $form ) {
99		$entries = new \GV\Entry_Collection();
100
101		$search_criteria = array();
102		$sorting = array();
103		$paging = array();
104
105		/** Apply the filters */
106		foreach ( $filters as $filter ) {
107		$search_criteria = $filter::merge_search_criteria( $search_criteria, $filter->as_search_criteria() );
108		}
109
110		/** Apply the sorts */
111		foreach ( $sorts as $sort ) {
112		/** Gravity Forms does not have multi-sorting, so just overwrite. */
113		$sorting = array(
114		'key' => $sort->field->ID,
115		'direction' => $sort->direction,
116		'is_numeric' => $sort->mode == Entry_Sort::NUMERIC,
117		);
118		}
119
120		/** The offset and limit */
121		if ( ! empty( $offset->limit ) ) {
122		$paging['page_size'] = $offset->limit;
123		}
124
125		if ( ! empty( $offset->offset ) ) {
126		$paging['offset'] = $offset->offset;
127		}
128
129		foreach ( \GFAPI::get_entries( $form->ID, $search_criteria, $sorting, $paging ) as $entry ) {
130		$entries->add( \GV\GF_Entry::from_entry( $entry ) );
131		}
132
133		return $entries;
134		} );
135
136		/** Add the counter lazy callback. */
137		$entries->add_count_callback( function( $filters ) use ( $form ) {
138		$search_criteria = array();
139		$sorting = array();
140
141		/** Apply the filters */
142		/** @var \GV\GF_Entry_Filter\|\GV\Entry_Filter $filter */
143		foreach ( $filters as $filter ) {
144		$search_criteria = $filter::merge_search_criteria( $search_criteria, $filter->as_search_criteria() );
145		}
146
147		return \GFAPI::count_entries( $form->ID, $search_criteria );
148		} );
149
150		return $entries;
151		}
152
153		/**
154		* Get a \GV\Field by Form and Field ID for this data source.
155		*
156		* @param \GV\GF_Form $form The Gravity Form form ID.
		0 ignored issues – show Bug introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report There is no parameter named `$form`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
157		* @param int $field_id The Gravity Form field ID for the $form_id.
		0 ignored issues – show Bug introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report There is no parameter named `$field_id`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
158		*
159		* @return \GV\Field\|null The requested field or null if not found.
160		*/
161	3	public static function get_field( /** varargs */ ) {
162	3	$args = func_get_args();
163
164	3	if ( ! is_array( $args ) \|\| count( $args ) != 2 ) {
165	1	gravityview()->log->error( '{source} expects 2 arguments for ::get_field ($form, $field_id)', array( 'source' => __CLASS__ ) );
166	1	return null;
167		}
168
169		/** Unwrap the arguments. */
170	3	list( $form, $field_id ) = $args;
171
172		/** Wrap it up into a \GV\Field. */
173	3	return GF_Field::by_id( $form, $field_id );
174		}
175
176		/**
177		* Get an array of GV Fields for this data source
178		*
179		* @return \GV\Field[]\|array Empty array if no fields
180		*/
181		public function get_fields() {
182		$fields = array();
183		foreach ( $this['fields'] as $field ) {
184		foreach ( empty( $field['inputs'] ) ? array( $field['id'] ) : wp_list_pluck( $field['inputs'], 'id' ) as $id ) {
185		if ( is_numeric( $id ) ) {
186		$fields[ $id ] = self::get_field( $this, $id );
187		} else {
188		$fields[ $id ] = Internal_Field::by_id( $id );
189		}
190		}
191		}
192
193		return array_filter( $fields );
194		}
195
196		/**
197		* Proxies.
198		*
199		* @param string $key The property to get.
200		*
201		* @return mixed
202		*/
203		public function __get( $key ) {
204		switch ( $key ) {
205		case 'fields':
206		return $this->get_fields();
207		default:
208		return parent::__get( $key );
209		}
210		}
211
212		/**
213		* ArrayAccess compatibility layer with a Gravity Forms form array.
214		*
215		* @internal
216		* @deprecated
217		* @since 2.0
218		* @return bool Whether the offset exists or not.
219		*/
220	28	public function offsetExists( $offset ) {
221	28	return isset( $this->form[$offset] );
		0 ignored issues – show Documentation introduced 2017-03-29 06:38 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...
222		}
223
224		/**
225		* ArrayAccess compatibility layer with a Gravity Forms form array.
226		*
227		* Maps the old keys to the new data;
228		*
229		* @internal
230		* @deprecated
231		* @since 2.0
232		*
233		* @return mixed The value of the requested form data.
234		*/
235	21	public function offsetGet( $offset ) {
236	21	return $this->form[$offset];
		0 ignored issues – show Documentation introduced 2017-03-29 06:38 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...
237		}
238
239		/**
240		* ArrayAccess compatibility layer with a Gravity Forms form array.
241		*
242		* @internal
243		* @deprecated
244		* @since 2.0
245		*
246		* @return void
247		*/
248		public function offsetSet( $offset, $value ) {
249		gravityview()->log->error( 'The underlying Gravity Forms form is immutable. This is a \GV\Form object and should not be accessed as an array.' );
250		}
251
252		/**
253		* ArrayAccess compatibility layer with a Gravity Forms form array.
254		*
255		* @internal
256		* @deprecated
257		* @since 2.0
258		* @return void
259		*/
260		public function offsetUnset( $offset ) {
261		gravityview()->log->error( 'The underlying Gravity Forms form is immutable. This is a \GV\Form object and should not be accessed as an array.' );
262		}
263		}
264

gravityview / GravityView

Push — develop ( c04cf6...7b9575 )

GF_Form::from_form() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like