OptinForm::instantiate_field() - Code Metrics - Inspection of "7.0.0" - yikesinc/yikes-inc-easy-mailchimp-extender - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — staging (#840)

unknown

created 2019-12-11 23:34 UTC

OptinForm::instantiate_field() A

↳ Parent: OptinForm

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	4
nop	1
dl	0
loc	41
rs	9.264
c	0
b	0
f	0

<?php
/**
 * YIKES Inc. Easy Forms.
 *
 * @package   YIKES\EasyForms
 * @author    Freddie Mixell
 * @license   GPL2
 */

namespace YIKES\EasyForms\Form;

use YIKES\EasyForms\Exception\InvalidClass;
use YIKES\EasyForms\Exception\InvalidField;
use YIKES\EasyForms\Field\Field;
use YIKES\EasyForms\Field\Hidden;
use YIKES\EasyForms\Field\Types;
use YIKES\EasyForms\Renderable;
use YIKES\EasyForms\Assets\AssetsAware;
use YIKES\EasyForms\Assets\AssetsAwareness;
use YIKES\EasyForms\Assets\ScriptAsset;
use YIKES\EasyForms\Service;
use YIKES\EasyForms\Model\OptinForm as EasyFormsModel;
use YIKES\EasyForms\Model\Recaptcha as RecaptchaModel;
use YIKES\EasyForms\Model\OptinMeta as Meta;

/**
 * Class OptinForm
 *
 * @since   %VERSION%
 * @package YIKES\EasyForms
 *
 * @property Field[] fields        The array of field objects.
 * @property array   field_classes The array of classes used for field objects.
 * @property array   form_classes  The array of classes used for the main form element.
 */
final class OptinForm {

	use FormHelper;
	use FieldBuilder;
	use SubmitButton;
	/**
	 * The Optin Form object.
	 *
	 * @since %VERSION%
	 * @var EasyFormsModel
	 */
	private $form_data;

	/**
	 * Field Count
	 */
	private $field_count = 0;

	/**
	 * Hidden Label Count
	 */
	private $hidden_label_count = 0;

	/**
	 * Whether the form has any errors.
	 *
	 * @since %VERSION%
	 * @var bool
	 */
	private $has_errors = false;

	/**
	 * Whether the form has been submitted.
	 *
	 * @since %VERSION%
	 * @var bool
	 */
	private $is_submitted = false;

	/**
	 * The ID of the form.
	 *
	 * @since %VERSION%
	 * @var int
	 */
	private $form_id = 0;

	/**
	 * The data submitted with this form.
	 *
	 * @since %VERSION%
	 * @var array
	 */
	private $submitted_data = [];

	/**
	 * The validated data for this form.
	 *
	 * @since %VERSION%
	 * @var array
	 */
	private $valid_data = [];

	/**
	 * Admin CSS Class
	 *
	 * @since %VERSION%
	 * @var string
	 */
	private $admin_class = '';

	public $recaptcha;

	public $form_inline = false;

	/**
	 * OptinForm constructor.
	 *
	 * @param int            $form_id     The ID the optin form is for.
	 * @param EasyFormsModel $form_data   The optin form object.
	 */
	public function __construct( $form_id = 0, $form_data = array(), $attr = array() ) {
		$this->form_id           = $form_id;
		$this->form_data         = $form_data;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		$this->field_count       = $this->set_field_count();
		$this->form_inline       = $form_data['form_settings']['yikes-easy-mc-inline-form'];
		$this->recaptcha         = ( new RecaptchaModel() )->setup( $attr );
	}

	/**
	 * Admin CSS Class
	 *
	 * @return string
	 */
	private function admin_class() {

		$is_admin = is_user_logged_in() && current_user_can(
			apply_filters( 'yikes-mailchimp-user-role-access' , 'manage_options' )
		);
		return $is_admin ? ' admin-logged-in' : '';
	}

	/**
	 * Utilized for reading data from inaccessible members.
	 *
	 * @param string $name The property to retrieve.
	 *
	 * @return mixed
	 */
	public function __get( $name ) {
		switch ( $name ) {
			case 'fields':
				$this->create_fields();
				return $this->fields;

			default:
				$message = sprintf( 'Undefined property: %s::$%s', static::class, $name );
				trigger_error( esc_html( $message ), E_USER_NOTICE );

				return null;
		}
	}

	/**
	 * Create the array of fields.
	 *
	 * @since %VERSION%
	 */
	private function create_fields() {
		$fields = [];

		// // Manually add the hidden nonce and referrer fields.
		// $fields[] = new Hidden( "yikes_easy_mc_new_subscriber", wp_create_nonce( 'yikes_easy_mc_form_submit' ), $this->form_id );
		// $fields[] = new Hidden( '_wp_http_referer', wp_unslash( $_SERVER['REQUEST_URI'] ), $this->form_id );

		// // Honeypot Trap field.
		// $fields[] = new Hidden( 'yikes-mailchimp-honeypot', $this->form_data['list_id'], $this->form_id );

		// // List ID field.
		// $fields[] = new Hidden( 'yikes-mailchimp-associated-list-id', $this->form_data['list_id'], $this->form_id );

		// // The form that is being submitted! Used to display error/success messages above the correct form.
		// $fields[] = new Hidden( 'yikes-mailchimp-submitted-form', $this->form_id, $this->form_id );

		// Add all of the active fields.
		foreach ( $this->form_data['fields'] as $field ) {
			if ( isset( $field['hide'] ) && (string) $field['hide'] === '1' ) {
				$this->reduce_field_count();
			}

			$fields = array_merge( $fields, $this->instantiate_field( $field ) );
		}

		$this->fields = $fields;
	}

	/**
	 * Render the form fields.
	 *
	 * @since %VERSION%
	 */
	public function render( array $context = [] ) {

		foreach ( $this->fields as $field ) {
			$field->render();
		}
	}

	/**
	 * Set the submission data.
	 *
	 * @since %VERSION%
	 *
	 * @param array $data Submitted data.
	 */
	public function set_submission( array $data ) {
		$this->is_submitted   = true;
		$this->submitted_data = $data;
	}

	/**
	 * Determine whether the form has errors.
	 *
	 * @since %VERSION%
	 * @return bool
	 */
	public function has_errors() {
		return $this->is_submitted && $this->has_errors;
	}

	/**
	 * Validate the submission.
	 *
	 * @since %VERSION%
	 */
	public function validate_submission() {
		$valid = [];
		foreach ( $this->fields as $field ) {
			try {
				$submitted = array_key_exists( $field->get_id(), $this->submitted_data )
					? $this->submitted_data[ $field->get_id() ]
					: '';

				$field->set_submission( $submitted );
				$valid[ $field->get_id() ] = $field->get_sanitized_value();
			} catch ( InvalidField $e ) {
				$this->has_errors = true;
			}
		}

		$this->valid_data = $valid;
	}

	/**
	 * Get the class type for a particular field.
	 *
	 * @since 1.0.0
	 *
	 * @param string $field The field name.
	 *
	 * @return string The class name to instantiate that field.
	 * @throws InvalidClass When a field type is returned to the filter that doesn't implement Field.
	 */
	private function get_field_type( $field ) {

		$type = array_key_exists( $field['type'], Meta::FIELD_MAP ) ? Meta::FIELD_MAP[ $field['type'] ] : Types::TEXT;

		/**
		 * Filter the class used to instantiate the field.
		 *
		 * @param string $type  The field class name. Must extend implment the Field interface.
		 * @param string $field The field name.
		 */
		$type = apply_filters( 'easy_forms_field_type', $type, $field );

		// Ensure that the field implements the Field interface..
		$implements = class_implements( $type );
		if ( ! isset( $implements[ Field::class ] ) ) {
			throw InvalidClass::from_interface( $type, Field::class );
		}

		return $type;
	}

	/**
	 * Instantiate a field.
	 *
	 * @since %SINCE%
	 *
	 * @param string $field The raw field name.
	 *
	 * @return Field[] Array of Field objects.
	 */
	private function instantiate_field( $field ) {
		/**
		 * Short-circuit the instantiation of a field object.
		 *
		 * To effectively short-circuit normal instantiation, an array of Field objects must be returned.
		 *
		 * @param array|null     $pre         Array of Field objects or null.
		 * @param string         $field       The raw field name.
		 * @param EasyFormsModel $form_data The form object.
		 */
		$pre = apply_filters( 'yikes_easy_forms_instantiate_field', null, $field, $this->form_data );
		if ( is_array( $pre ) ) {
			foreach ( $pre as $object ) {
				$this->validate_is_field( $object );
			}
			return $pre;
		}

		$label       = $this->get_label( $field );
		$value       = $this->get_value( $field );
		$type        = $this->get_field_type( $field );
		$classes     = $this->get_field_classes( $field );
		$placeholder = $this->get_placeholder( $field );
		$description = $this->get_description( $field );
		$merge       = $field['merge'];
		$hidden      = $this->get_hidden( $field );
		$required    = isset( $field['require'] ) ? true : false;
		return [
			new $type(
				$classes,
				$placeholder,
				$label,
				$value,
				$description,
				$merge,
				$this->form_id,
				$hidden,
				$required
			),
		];
	}

	/**
	 * Validate that the given object is a Field.
	 *
	 * @since %SINCE%
	 *
	 * @param object $maybe_field The object to validate.
	 *
	 * @throws InvalidClass When the object isn't a Field object.
	 */
	private function validate_is_field( $maybe_field ) {
		if ( ! $maybe_field instanceof Field ) {
			throw InvalidClass::from_interface( get_class( $maybe_field ), Field::class );
		}
	}
}


1			<?php
2			/**
3			* YIKES Inc. Easy Forms.
4			*
5			* @package YIKES\EasyForms
6			* @author Freddie Mixell
7			* @license GPL2
8			*/
9
10			namespace YIKES\EasyForms\Form;
11
12			use YIKES\EasyForms\Exception\InvalidClass;
13			use YIKES\EasyForms\Exception\InvalidField;
14			use YIKES\EasyForms\Field\Field;
15			use YIKES\EasyForms\Field\Hidden;
16			use YIKES\EasyForms\Field\Types;
17			use YIKES\EasyForms\Renderable;
18			use YIKES\EasyForms\Assets\AssetsAware;
19			use YIKES\EasyForms\Assets\AssetsAwareness;
20			use YIKES\EasyForms\Assets\ScriptAsset;
21			use YIKES\EasyForms\Service;
22			use YIKES\EasyForms\Model\OptinForm as EasyFormsModel;
23			use YIKES\EasyForms\Model\Recaptcha as RecaptchaModel;
24			use YIKES\EasyForms\Model\OptinMeta as Meta;
25
26			/**
27			* Class OptinForm
28			*
29			* @since %VERSION%
30			* @package YIKES\EasyForms
31			*
32			* @property Field[] fields The array of field objects.
33			* @property array field_classes The array of classes used for field objects.
34			* @property array form_classes The array of classes used for the main form element.
35			*/
36			final class OptinForm {
37
38			use FormHelper;
39			use FieldBuilder;
40			use SubmitButton;
41			/**
42			* The Optin Form object.
43			*
44			* @since %VERSION%
45			* @var EasyFormsModel
46			*/
47			private $form_data;
48
49			/**
50			* Field Count
51			*/
52			private $field_count = 0;
53
54			/**
55			* Hidden Label Count
56			*/
57			private $hidden_label_count = 0;
58
59			/**
60			* Whether the form has any errors.
61			*
62			* @since %VERSION%
63			* @var bool
64			*/
65			private $has_errors = false;
66
67			/**
68			* Whether the form has been submitted.
69			*
70			* @since %VERSION%
71			* @var bool
72			*/
73			private $is_submitted = false;
74
75			/**
76			* The ID of the form.
77			*
78			* @since %VERSION%
79			* @var int
80			*/
81			private $form_id = 0;
82
83			/**
84			* The data submitted with this form.
85			*
86			* @since %VERSION%
87			* @var array
88			*/
89			private $submitted_data = [];
90
91			/**
92			* The validated data for this form.
93			*
94			* @since %VERSION%
95			* @var array
96			*/
97			private $valid_data = [];
98
99			/**
100			* Admin CSS Class
101			*
102			* @since %VERSION%
103			* @var string
104			*/
105			private $admin_class = '';
106
107			public $recaptcha;
108
109			public $form_inline = false;
110
111			/**
112			* OptinForm constructor.
113			*
114			* @param int $form_id The ID the optin form is for.
115			* @param EasyFormsModel $form_data The optin form object.
116			*/
117			public function __construct( $form_id = 0, $form_data = array(), $attr = array() ) {
118			$this->form_id = $form_id;
119			$this->form_data = $form_data;
			0 ignored issues – show Documentation Bug introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report It seems like `$form_data` can also be of type `array`. However, the property `$form_data` is declared as type `object<YIKES\EasyForms\Model\OptinForm>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
120			$this->field_count = $this->set_field_count();
121			$this->form_inline = $form_data['form_settings']['yikes-easy-mc-inline-form'];
122			$this->recaptcha = ( new RecaptchaModel() )->setup( $attr );
123			}
124
125			/**
126			* Admin CSS Class
127			*
128			* @return string
129			*/
130			private function admin_class() {
			0 ignored issues – show Unused Code introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
131			$is_admin = is_user_logged_in() && current_user_can(
132			apply_filters( 'yikes-mailchimp-user-role-access' , 'manage_options' )
133			);
134			return $is_admin ? ' admin-logged-in' : '';
135			}
136
137			/**
138			* Utilized for reading data from inaccessible members.
139			*
140			* @param string $name The property to retrieve.
141			*
142			* @return mixed
143			*/
144			public function __get( $name ) {
145			switch ( $name ) {
146			case 'fields':
147			$this->create_fields();
148			return $this->fields;
149
150			default:
151			$message = sprintf( 'Undefined property: %s::$%s', static::class, $name );
152			trigger_error( esc_html( $message ), E_USER_NOTICE );
153
154			return null;
155			}
156			}
157
158			/**
159			* Create the array of fields.
160			*
161			* @since %VERSION%
162			*/
163			private function create_fields() {
164			$fields = [];
165
166			// // Manually add the hidden nonce and referrer fields.
167			// $fields[] = new Hidden( "yikes_easy_mc_new_subscriber", wp_create_nonce( 'yikes_easy_mc_form_submit' ), $this->form_id );
168			// $fields[] = new Hidden( '_wp_http_referer', wp_unslash( $_SERVER['REQUEST_URI'] ), $this->form_id );
169
170			// // Honeypot Trap field.
171			// $fields[] = new Hidden( 'yikes-mailchimp-honeypot', $this->form_data['list_id'], $this->form_id );
172
173			// // List ID field.
174			// $fields[] = new Hidden( 'yikes-mailchimp-associated-list-id', $this->form_data['list_id'], $this->form_id );
175
176			// // The form that is being submitted! Used to display error/success messages above the correct form.
177			// $fields[] = new Hidden( 'yikes-mailchimp-submitted-form', $this->form_id, $this->form_id );
178
179			// Add all of the active fields.
180			foreach ( $this->form_data['fields'] as $field ) {
181			if ( isset( $field['hide'] ) && (string) $field['hide'] === '1' ) {
182			$this->reduce_field_count();
183			}
184
185			$fields = array_merge( $fields, $this->instantiate_field( $field ) );
186			}
187
188			$this->fields = $fields;
189			}
190
191			/**
192			* Render the form fields.
193			*
194			* @since %VERSION%
195			*/
196			public function render( array $context = [] ) {
			0 ignored issues – show Unused Code introduced 2019-12-10 15:01 UTC by Report Bug Copy Issue Report The parameter `$context` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
197			foreach ( $this->fields as $field ) {
198			$field->render();
199			}
200			}
201
202			/**
203			* Set the submission data.
204			*
205			* @since %VERSION%
206			*
207			* @param array $data Submitted data.
208			*/
209			public function set_submission( array $data ) {
210			$this->is_submitted = true;
211			$this->submitted_data = $data;
212			}
213
214			/**
215			* Determine whether the form has errors.
216			*
217			* @since %VERSION%
218			* @return bool
219			*/
220			public function has_errors() {
221			return $this->is_submitted && $this->has_errors;
222			}
223
224			/**
225			* Validate the submission.
226			*
227			* @since %VERSION%
228			*/
229			public function validate_submission() {
230			$valid = [];
231			foreach ( $this->fields as $field ) {
232			try {
233			$submitted = array_key_exists( $field->get_id(), $this->submitted_data )
234			? $this->submitted_data[ $field->get_id() ]
235			: '';
236
237			$field->set_submission( $submitted );
238			$valid[ $field->get_id() ] = $field->get_sanitized_value();
239			} catch ( InvalidField $e ) {
240			$this->has_errors = true;
241			}
242			}
243
244			$this->valid_data = $valid;
245			}
246
247			/**
248			* Get the class type for a particular field.
249			*
250			* @since 1.0.0
251			*
252			* @param string $field The field name.
253			*
254			* @return string The class name to instantiate that field.
255			* @throws InvalidClass When a field type is returned to the filter that doesn't implement Field.
256			*/
257			private function get_field_type( $field ) {
258
259			$type = array_key_exists( $field['type'], Meta::FIELD_MAP ) ? Meta::FIELD_MAP[ $field['type'] ] : Types::TEXT;
260
261			/**
262			* Filter the class used to instantiate the field.
263			*
264			* @param string $type The field class name. Must extend implment the Field interface.
265			* @param string $field The field name.
266			*/
267			$type = apply_filters( 'easy_forms_field_type', $type, $field );
268
269			// Ensure that the field implements the Field interface..
270			$implements = class_implements( $type );
271			if ( ! isset( $implements[ Field::class ] ) ) {
272			throw InvalidClass::from_interface( $type, Field::class );
273			}
274
275			return $type;
276			}
277
278			/**
279			* Instantiate a field.
280			*
281			* @since %SINCE%
282			*
283			* @param string $field The raw field name.
284			*
285			* @return Field[] Array of Field objects.
286			*/
287			private function instantiate_field( $field ) {
288			/**
289			* Short-circuit the instantiation of a field object.
290			*
291			* To effectively short-circuit normal instantiation, an array of Field objects must be returned.
292			*
293			* @param array\|null $pre Array of Field objects or null.
294			* @param string $field The raw field name.
295			* @param EasyFormsModel $form_data The form object.
296			*/
297			$pre = apply_filters( 'yikes_easy_forms_instantiate_field', null, $field, $this->form_data );
298			if ( is_array( $pre ) ) {
299			foreach ( $pre as $object ) {
300			$this->validate_is_field( $object );
301			}
302			return $pre;
303			}
304
305			$label = $this->get_label( $field );
306			$value = $this->get_value( $field );
307			$type = $this->get_field_type( $field );
308			$classes = $this->get_field_classes( $field );
309			$placeholder = $this->get_placeholder( $field );
310			$description = $this->get_description( $field );
311			$merge = $field['merge'];
312			$hidden = $this->get_hidden( $field );
313			$required = isset( $field['require'] ) ? true : false;
314			return [
315			new $type(
316			$classes,
317			$placeholder,
318			$label,
319			$value,
320			$description,
321			$merge,
322			$this->form_id,
323			$hidden,
324			$required
325			),
326			];
327			}
328
329			/**
330			* Validate that the given object is a Field.
331			*
332			* @since %SINCE%
333			*
334			* @param object $maybe_field The object to validate.
335			*
336			* @throws InvalidClass When the object isn't a Field object.
337			*/
338			private function validate_is_field( $maybe_field ) {
339			if ( ! $maybe_field instanceof Field ) {
340			throw InvalidClass::from_interface( get_class( $maybe_field ), Field::class );
341			}
342			}
343			}
344

yikesinc / yikes-inc-easy-mailchimp-extender

Pull Request — staging (#840)

OptinForm::instantiate_field() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like