GravityView_Field_Unsubscribe::__construct() - Code Metrics - Inspection of "Merge pull request #1347 from gravityview/feature/..." - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 6ed4bc...bc44a9 )

by Zack

created 2019-11-21 01:10 UTC

GravityView_Field_Unsubscribe::__construct() A

↳ Parent: GravityView_Field_Unsubscribe

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php
/**
 * @file class-gravityview-field-unsubscribe.php
 * @since 2.5
 * @package GravityView
 * @subpackage includes\fields
 */

class GravityView_Field_Unsubscribe extends GravityView_Field {

	var $name = 'unsubscribe';

	var $group = 'gravityview';

	var $is_searchable = false;

	var $contexts = array( 'single', 'multiple' );

	public function __construct() {
		$this->label = esc_html__( 'Unsubscribe', 'gravityview' );
		$this->description =  esc_attr__( 'Unsubscribe from a Payment-based entry.', 'gravityview' );

		$this->add_hooks();

		parent::__construct();
	}

	/**
	 * Hooks called from constructor.
	 *
	 * @return void
	 */
	public function add_hooks() {
		add_filter( 'gravityview_entry_default_fields', array( $this, 'filter_gravityview_entry_default_field' ), 10, 3 );

		add_filter( 'gravityview/field/is_visible', array( $this, 'maybe_not_visible' ), 10, 2 );

		add_filter( 'gravityview_field_entry_value_unsubscribe', array( $this, 'modify_entry_value_unsubscribe' ), 10, 4 );
	}

	/**
	 * Configure the field options.
	 *
	 * Called from the `gravityview_entry_default_fields` filter.
	 *
	 * Remove the logged in, new window and show as link options.
	 * Add the allow unsubscribe for all admins option.
	 *
	 * @param array $field_options The options.
	 * @param string $template_id The template ID.
	 * @param int|string|float $field_id The field ID.
	 * @param string $context The configuration context (edit, single, etc.)
	 * @param string $input_type The input type.
	 * @param int $form_id The form ID.
	 *
	 * @return array The field options.
	 */
	public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {

		unset( $field_options['only_loggedin'] );

		unset( $field_options['new_window'] );

		unset( $field_options['show_as_link'] );

		$add_options['unsub_all'] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
			'type'       => 'checkbox',
			'label'      => __( 'Allow admins to unsubscribe', 'gravityview' ),
			'desc'       => __( 'Allow users with `gravityforms_edit_entries` to cancel subscriptions', 'gravityview' ),
			'value'      => false,
			'merge_tags' => false,
		);

		return $field_options + $add_options;
	}

	/**
	 * Hide the field from the renderer. Perhaps.
	 *
	 * Called from `gravityview/field/is_visible`
	 *
	 * Hide the field for non-logged in users for sure.
	 *
	 * @param bool $visible Consider visible or not.
	 * @param \GV\Field $field The field.
	 *
	 * @return bool Visible or not.
	 */
	public function maybe_not_visible( $visible, $field ) {

		return is_user_logged_in() ? $visible : false;
	}

	/**
	 * Add the unsubsribe to the configuration fields.
	 *
	 * Only if a subscription feed is active for the current form.
	 *
	 * Called from `gravityview_entry_default_fields`
	 *
	 * @param array $entry_default_fields An array of available for configuration.
	 * @param array $form The form.
	 * @param string $context The configuration context (edit, single, etc.)
	 *
	 * @return array The array of available default fields.
	 */
	public function filter_gravityview_entry_default_field( $entry_default_fields, $form, $context ) {

		$feeds = GFAPI::get_feeds( null, $form );

		if ( is_wp_error( $feeds ) ) {
			return $entry_default_fields;
		}

		static $subscription_addons;

		if ( is_null( $subscription_addons ) ) {

			$registered = GFAddon::get_registered_addons();

			foreach ( $registered as $addon ) {
				if ( method_exists( $addon, 'cancel_subscription' ) && is_callable( array( $addon, 'get_instance' ) ) ) {
					$addon = $addon::get_instance();
					$subscription_addons[ $addon->get_slug() ] = $addon;
				}
			}
		}

		if ( empty( $subscription_addons ) ) {
			return $entry_default_fields;
		}

		foreach ( $feeds as $feed ) {
			if ( isset( $subscription_addons[ $feed['addon_slug'] ] ) && 'subscription' === \GV\Utils::get( $feed, 'meta/transactionType' ) ) {
				if ( ! isset( $entry_default_fields["{$this->name}"] ) && 'edit' !== $context ) {
					$entry_default_fields["{$this->name}"] = array(
						'label' => $this->label,
						'desc'  => $this->description,
						'type'  => $this->name,
					);

					break; // Feed found, field added
				}
			}
		}

		return $entry_default_fields;
	}

	/**
	 * Modify the render content.
	 *
	 * Called from `gravityview_field_entry_value_unsubscribe`
	 *
	 * @param string $output The output.
	 * @param array $entry The entry.
	 * @param array $field_settings The field settings.
	 * @param \GV\Field $field The field.
	 *
	 * @return string The content.
	 */
	public function modify_entry_value_unsubscribe( $output, $entry, $field_settings, $field ) {

		if ( ! is_user_logged_in() ) {
			return $output;
		}

		$can_current_user_edit = is_numeric( $entry['created_by'] ) && ( wp_get_current_user()->ID === intval( $entry['created_by'] ) );

		if ( ! $can_current_user_edit ) {
			if ( empty( $field_settings['unsub_all'] ) || ! \GVCommon::has_cap( 'gravityforms_edit_entries', $entry['id'] ) ) {
				return $output;
			}
		}

		if ( ! $status = \GV\Utils::get( $entry, 'payment_status' ) ) {
			return $output;
		}

		// @todo Move to init, or AJAXify, but make sure that the entry is in the View before allowing
		// @todo Also make sure we check caps if moved from here
		// @todo Also make sure test_GravityView_Field_Unsubscribe_unsubscribe_permissions is rewritten
		if ( $entry = $this->maybe_unsubscribe( $entry ) ) {
			if ( $entry['payment_status'] !== $status ) {
				// @todo Probably __( 'Unsubscribed', 'gravityview' );
				return $entry['payment_status'];
			}
		}

		if ( 'active' !== mb_strtolower( $entry['payment_status'] ) ) {
			return $output;
		}

		global $wp;
		$current_url = add_query_arg( $wp->query_string, '', home_url( $wp->request ) );

		$link = add_query_arg( 'unsubscribe', wp_create_nonce( 'unsubscribe_' . $entry['id'] ), $current_url );
		$link = add_query_arg( 'uid', $entry['id'], $link );

		return sprintf( '<a href="%s">%s</a>', esc_url( $link ), esc_html__( 'Unsubscribe', 'gravityview' ) );
	}

	/**
	 * Try to unsubscribe from the entry.
	 *
	 * Called during a POST request. Checks nonce, feeds, entry ID.
	 * Does not check user permissions. This is left as an exercise for the caller.
	 *
	 * Entry View inclusion is checked ad-hoc during the rendering of the field.
	 * User permissions are also checked ad-hoc during the rendering process.
	 *
	 * @param array $entry The entry
	 *
	 * @return array $entry The entry
	 */
	private function maybe_unsubscribe( $entry ) {

		if ( ! wp_verify_nonce( \GV\Utils::_REQUEST( 'unsubscribe' ), 'unsubscribe_' . $entry['id'] ) ) {
			return $entry;
		}

		if ( ( ! $uid = \GV\Utils::_REQUEST( 'uid' ) ) || ! is_numeric( $uid ) || ( intval( $uid ) !== intval( $entry['id'] ) ) ) {
			return $entry;
		}

		if ( ! $feeds = gform_get_meta( $uid, 'processed_feeds' ) ) {
			return $entry;
		}

		static $subscription_addons;

		if ( is_null( $subscription_addons ) ) {

			$registered = GFAddon::get_registered_addons();

			foreach ( $registered as $addon ) {
				if ( method_exists( $addon, 'cancel_subscription' ) ) {
					$addon = $addon::get_instance();
					$subscription_addons[ $addon->get_slug() ] = $addon;
				}
			}
		}

		if ( empty( $subscription_addons ) ) {
			return $entry;
		}

		foreach ( $feeds as $slug => $feed_ids ) {

			if ( ! isset( $subscription_addons[ $slug ] ) ) {
				continue;
			}

			foreach ( $feed_ids as $feed_id ) {

				$feed = $subscription_addons[ $slug ]->get_feed( $feed_id );

				if ( $feed && 'subscription' === \GV\Utils::get( $feed, 'meta/transactionType' ) ) {

					if ( $subscription_addons[ $slug ]->cancel( $entry, $feed ) ) {

						$subscription_addons[ $slug ]->cancel_subscription( $entry, $feed );

						return \GFAPI::get_entry( $entry['id'] );
					}
				}
			}
		}

		return $entry;
	}
}

new GravityView_Field_Unsubscribe;


1			<?php
2			/**
3			* @file class-gravityview-field-unsubscribe.php
4			* @since 2.5
5			* @package GravityView
6			* @subpackage includes\fields
7			*/
8
9			class GravityView_Field_Unsubscribe extends GravityView_Field {
10
11			var $name = 'unsubscribe';
12
13			var $group = 'gravityview';
14
15			var $is_searchable = false;
16
17			var $contexts = array( 'single', 'multiple' );
18
19			public function __construct() {
20			$this->label = esc_html__( 'Unsubscribe', 'gravityview' );
21			$this->description = esc_attr__( 'Unsubscribe from a Payment-based entry.', 'gravityview' );
22
23			$this->add_hooks();
24
25			parent::__construct();
26			}
27
28			/**
29			* Hooks called from constructor.
30			*
31			* @return void
32			*/
33			public function add_hooks() {
34			add_filter( 'gravityview_entry_default_fields', array( $this, 'filter_gravityview_entry_default_field' ), 10, 3 );
35
36			add_filter( 'gravityview/field/is_visible', array( $this, 'maybe_not_visible' ), 10, 2 );
37
38			add_filter( 'gravityview_field_entry_value_unsubscribe', array( $this, 'modify_entry_value_unsubscribe' ), 10, 4 );
39			}
40
41			/**
42			* Configure the field options.
43			*
44			* Called from the `gravityview_entry_default_fields` filter.
45			*
46			* Remove the logged in, new window and show as link options.
47			* Add the allow unsubscribe for all admins option.
48			*
49			* @param array $field_options The options.
50			* @param string $template_id The template ID.
51			* @param int\|string\|float $field_id The field ID.
52			* @param string $context The configuration context (edit, single, etc.)
53			* @param string $input_type The input type.
54			* @param int $form_id The form ID.
55			*
56			* @return array The field options.
57			*/
58			public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {
59
60			unset( $field_options['only_loggedin'] );
61
62			unset( $field_options['new_window'] );
63
64			unset( $field_options['show_as_link'] );
65
66			$add_options['unsub_all'] = array(
			0 ignored issues – show Coding Style Comprehensibility introduced 2019-10-02 04:31 UTC by Report Bug Copy Issue Report `$add_options` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$add_options = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
67			'type' => 'checkbox',
68			'label' => __( 'Allow admins to unsubscribe', 'gravityview' ),
69			'desc' => __( 'Allow users with `gravityforms_edit_entries` to cancel subscriptions', 'gravityview' ),
70			'value' => false,
71			'merge_tags' => false,
72			);
73
74			return $field_options + $add_options;
75			}
76
77			/**
78			* Hide the field from the renderer. Perhaps.
79			*
80			* Called from `gravityview/field/is_visible`
81			*
82			* Hide the field for non-logged in users for sure.
83			*
84			* @param bool $visible Consider visible or not.
85			* @param \GV\Field $field The field.
86			*
87			* @return bool Visible or not.
88			*/
89			public function maybe_not_visible( $visible, $field ) {
			0 ignored issues – show Unused Code introduced 2019-10-02 04:31 UTC by Report Bug Copy Issue Report The parameter `$field` 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...
90			return is_user_logged_in() ? $visible : false;
91			}
92
93			/**
94			* Add the unsubsribe to the configuration fields.
95			*
96			* Only if a subscription feed is active for the current form.
97			*
98			* Called from `gravityview_entry_default_fields`
99			*
100			* @param array $entry_default_fields An array of available for configuration.
101			* @param array $form The form.
102			* @param string $context The configuration context (edit, single, etc.)
103			*
104			* @return array The array of available default fields.
105			*/
106			public function filter_gravityview_entry_default_field( $entry_default_fields, $form, $context ) {
107
108			$feeds = GFAPI::get_feeds( null, $form );
109
110			if ( is_wp_error( $feeds ) ) {
111			return $entry_default_fields;
112			}
113
114			static $subscription_addons;
115
116			if ( is_null( $subscription_addons ) ) {
117
118			$registered = GFAddon::get_registered_addons();
119
120			foreach ( $registered as $addon ) {
121			if ( method_exists( $addon, 'cancel_subscription' ) && is_callable( array( $addon, 'get_instance' ) ) ) {
122			$addon = $addon::get_instance();
123			$subscription_addons[ $addon->get_slug() ] = $addon;
124			}
125			}
126			}
127
128			if ( empty( $subscription_addons ) ) {
129			return $entry_default_fields;
130			}
131
132			foreach ( $feeds as $feed ) {
133			if ( isset( $subscription_addons[ $feed['addon_slug'] ] ) && 'subscription' === \GV\Utils::get( $feed, 'meta/transactionType' ) ) {
134			if ( ! isset( $entry_default_fields["{$this->name}"] ) && 'edit' !== $context ) {
135			$entry_default_fields["{$this->name}"] = array(
136			'label' => $this->label,
137			'desc' => $this->description,
138			'type' => $this->name,
139			);
140
141			break; // Feed found, field added
142			}
143			}
144			}
145
146			return $entry_default_fields;
147			}
148
149			/**
150			* Modify the render content.
151			*
152			* Called from `gravityview_field_entry_value_unsubscribe`
153			*
154			* @param string $output The output.
155			* @param array $entry The entry.
156			* @param array $field_settings The field settings.
157			* @param \GV\Field $field The field.
158			*
159			* @return string The content.
160			*/
161			public function modify_entry_value_unsubscribe( $output, $entry, $field_settings, $field ) {
			0 ignored issues – show Unused Code introduced 2019-10-02 04:31 UTC by Report Bug Copy Issue Report The parameter `$field` 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...
162			if ( ! is_user_logged_in() ) {
163			return $output;
164			}
165
166			$can_current_user_edit = is_numeric( $entry['created_by'] ) && ( wp_get_current_user()->ID === intval( $entry['created_by'] ) );
167
168			if ( ! $can_current_user_edit ) {
169			if ( empty( $field_settings['unsub_all'] ) \|\| ! \GVCommon::has_cap( 'gravityforms_edit_entries', $entry['id'] ) ) {
170			return $output;
171			}
172			}
173
174			if ( ! $status = \GV\Utils::get( $entry, 'payment_status' ) ) {
175			return $output;
176			}
177
178			// @todo Move to init, or AJAXify, but make sure that the entry is in the View before allowing
179			// @todo Also make sure we check caps if moved from here
180			// @todo Also make sure test_GravityView_Field_Unsubscribe_unsubscribe_permissions is rewritten
181			if ( $entry = $this->maybe_unsubscribe( $entry ) ) {
182			if ( $entry['payment_status'] !== $status ) {
183			// @todo Probably __( 'Unsubscribed', 'gravityview' );
184			return $entry['payment_status'];
185			}
186			}
187
188			if ( 'active' !== mb_strtolower( $entry['payment_status'] ) ) {
189			return $output;
190			}
191
192			global $wp;
193			$current_url = add_query_arg( $wp->query_string, '', home_url( $wp->request ) );
194
195			$link = add_query_arg( 'unsubscribe', wp_create_nonce( 'unsubscribe_' . $entry['id'] ), $current_url );
196			$link = add_query_arg( 'uid', $entry['id'], $link );
197
198			return sprintf( '<a href="%s">%s</a>', esc_url( $link ), esc_html__( 'Unsubscribe', 'gravityview' ) );
199			}
200
201			/**
202			* Try to unsubscribe from the entry.
203			*
204			* Called during a POST request. Checks nonce, feeds, entry ID.
205			* Does not check user permissions. This is left as an exercise for the caller.
206			*
207			* Entry View inclusion is checked ad-hoc during the rendering of the field.
208			* User permissions are also checked ad-hoc during the rendering process.
209			*
210			* @param array $entry The entry
211			*
212			* @return array $entry The entry
213			*/
214			private function maybe_unsubscribe( $entry ) {
215
216			if ( ! wp_verify_nonce( \GV\Utils::_REQUEST( 'unsubscribe' ), 'unsubscribe_' . $entry['id'] ) ) {
217			return $entry;
218			}
219
220			if ( ( ! $uid = \GV\Utils::_REQUEST( 'uid' ) ) \|\| ! is_numeric( $uid ) \|\| ( intval( $uid ) !== intval( $entry['id'] ) ) ) {
221			return $entry;
222			}
223
224			if ( ! $feeds = gform_get_meta( $uid, 'processed_feeds' ) ) {
225			return $entry;
226			}
227
228			static $subscription_addons;
229
230			if ( is_null( $subscription_addons ) ) {
231
232			$registered = GFAddon::get_registered_addons();
233
234			foreach ( $registered as $addon ) {
235			if ( method_exists( $addon, 'cancel_subscription' ) ) {
236			$addon = $addon::get_instance();
237			$subscription_addons[ $addon->get_slug() ] = $addon;
238			}
239			}
240			}
241
242			if ( empty( $subscription_addons ) ) {
243			return $entry;
244			}
245
246			foreach ( $feeds as $slug => $feed_ids ) {
247
248			if ( ! isset( $subscription_addons[ $slug ] ) ) {
249			continue;
250			}
251
252			foreach ( $feed_ids as $feed_id ) {
253
254			$feed = $subscription_addons[ $slug ]->get_feed( $feed_id );
255
256			if ( $feed && 'subscription' === \GV\Utils::get( $feed, 'meta/transactionType' ) ) {
257
258			if ( $subscription_addons[ $slug ]->cancel( $entry, $feed ) ) {
259
260			$subscription_addons[ $slug ]->cancel_subscription( $entry, $feed );
261
262			return \GFAPI::get_entry( $entry['id'] );
263			}
264			}
265			}
266			}
267
268			return $entry;
269			}
270			}
271
272			new GravityView_Field_Unsubscribe;
273

gravityview / GravityView

Push — develop ( 6ed4bc...bc44a9 )

GravityView_Field_Unsubscribe::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like