GV\Field_Template::render()

Complexity

Conditions	13
Paths	145

Size

Total Lines

227

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	59
CRAP Score	13.0432

Importance

Changes

0

<?php
	public function render() {
		if ( ! $entry = $this->entry->from_field( $this->field ) ) {
			gravityview()->log->error( 'Entry is invalid for field. Returning empty.' );
			return;
		}

		/** Retrieve the value. */
		$display_value = $value = $this->field->get_value( $this->view, $this->source, $entry );

		$source = $this->source;
		$source_backend = $source ? $source::$backend : null;

		\GV\Mocks\Legacy_Context::load( array(
			'field' => $this->field,
		) );

		/** Alter the display value according to Gravity Forms. */
		if ( $source_backend == \GV\Source::BACKEND_GRAVITYFORMS ) {
			/** Prevent any PHP warnings that may be generated. */
			ob_start();

			$display_value = \GFCommon::get_lead_field_display( $this->field->field, $value, $entry['currency'], false, 'html' );

The property field does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

			if ( $errors = ob_get_clean() ) {
				gravityview()->log->error( 'Errors when calling GFCommon::get_lead_field_display()', array( 'data' => $errors ) );
			}

			// `gform_entry_field_value` expects a GF_Field, but $this->field->field can be NULL
			if ( ! $this->field->field instanceof GF_Field ) {

The property field does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

				$gf_field = \GF_Fields::create( $this->field->field );

The property field does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

			}

			/** Call the Gravity Forms field value filter. */
			$display_value = apply_filters( 'gform_entry_field_value', $display_value, $gf_field, $entry->as_entry(), $this->source->form );

The property form does not seem to exist in GV\Source.

The variable $gf_field does not seem to be defined for all execution paths leading up to this point.

			unset( $gf_field );

			/** Replace merge tags for admin-only fields. */
			if ( ! empty( $this->field->field->adminOnly ) ) {

The property field does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

				$display_value = \GravityView_API::replace_variables( $display_value, $this->form->form, $entry->as_entry(), false, false );

The property form does not exist. Did you maybe forget to declare it?

			}
		}

		$context = Template_Context::from_template( $this, compact( 'display_value', 'value' ) );

		/**
		 * Make various pieces of data available to the template
		 *  under the $gravityview scoped variable.
		 *
		 * @filter `gravityview/template/field/context`
		 * @param \GV\Template_Context $context The context for this template.
		 * @since 2.0
		 */
		$this->push_template_data( apply_filters( 'gravityview/template/field/context', $context ), 'gravityview' );

		/** Bake the template. */
		ob_start();
		$this->located_template = $this->get_template_part( static::$slug );
		$output = ob_get_clean();

		if ( empty( $output ) ) {
			/**
			 * @filter `gravityview_empty_value` What to display when a field is empty
			 * @deprecated Use the `gravityview/field/value/empty` filter instead
			 * @param string $value (empty string)
			 */
			$output = apply_filters( 'gravityview_empty_value', $output );

			/**
			 * @filter `gravityview/field/value/empty` What to display when this field is empty.
			 * @param string $value The value to display (Default: empty string)
			 * @param \GV\Template_Context The template context this is being called from.
			 */
			$output = apply_filters( 'gravityview/field/value/empty', $output, Template_Context::from_template( $this ) );

			$context = Template_Context::from_template( $this, compact( 'display_value', 'value' ) );
		}

		gravityview()->log->info( 'Field template for field #{field_id} loaded: {located_template}', array( 'field_id' => $this->field->ID, 'located_template' => $this->located_template ) );

		$this->pop_template_data( 'gravityview' );

		/** A compatibility array that's required by some of the deprecated filters. */
		$field_compat = array(
			'form' => $source_backend == \GV\Source::BACKEND_GRAVITYFORMS ? $this->source->form : ( $this->view->form ? $this->view->form->form : null ),

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.

			'field_id' => $this->field->ID,
			'field' => $this->field->field,

The property field does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

			'field_settings' => $this->field->as_configuration(),
			'value' => $value,
			'display_value' => $display_value,
			'format' => 'html',
			'entry' => $entry->as_entry(),
			'field_type' => $this->field->type,

The property type does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

			'field_path' => $this->located_template,
		);

		/**
		 * Wrap output in a link, if enabled in the field settings
		 *
		 * @todo Cleanup
		 *
		 * @param string $output HTML value output
		 * @param \GV\Template_Context $context
		 *
		 * @return mixed|string|void
		 */
		$pre_link_compat_callback = function( $output, $context ) use ( $field_compat ) {
			$field = $context->field;

			/**
			 * @filter `gravityview_field_entry_value_{$field_type}_pre_link` Modify the field value output for a field type before Show As Link setting is applied. Example: `gravityview_field_entry_value_number_pre_link`
			 * @since 1.16
			 * @param string $output HTML value output
			 * @param array  $entry The GF entry array
			 * @param array  $field_settings Settings for the particular GV field
			 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
			 *
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
			 */
			$output = apply_filters( "gravityview_field_entry_value_{$field->type}_pre_link", $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			$output = apply_filters( 'gravityview_field_entry_value_pre_link', $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			/**
			 * Link to the single entry by wrapping the output in an anchor tag
			 *
			 * Fields can override this by modifying the field data variable inside the field. See /templates/fields/post_image.php for an example.
			 */
			if ( ! empty( $field->show_as_link ) && ! \gv_empty( $output, false, false ) ) {
				$link_atts = empty( $field->new_window ) ? array() : array( 'target' => '_blank' );

				$permalink = $context->entry->get_permalink( $context->view, $context->request );
				$output = \gravityview_get_link( $permalink, $output, $link_atts );

				/**
				 * @filter `gravityview_field_entry_link` Modify the link HTML
				 * @param string $link HTML output of the link
				 * @param string $href URL of the link
				 * @param array  $entry The GF entry array
				 * @param array $field_settings Settings for the particular GV field
				 * @deprecated Use `gravityview/template/field/entry_link`
				 */
				$output = apply_filters( 'gravityview_field_entry_link', $output, $permalink, $context->entry->as_entry(), $field->as_configuration() );

				/**
				 * @filter `gravityview/template/field/entry_link` Modify the link HTML
				 * @since 2.0
				 * @param string $link HTML output of the link
				 * @param string $href URL of the link
				 * @param \GV\Template_Context $context The context
				 */
				$output = apply_filters( 'gravityview/template/field/entry_link', $output, $permalink, $context );
			}

			return $output;
		};

		// TODO Cleanup
		$post_link_compat_callback = function( $output, $context ) use ( $field_compat ) {
			$field = $context->field;

			/**
			 * @filter `gravityview_field_entry_value_{$field_type}` Modify the field value output for a field type. Example: `gravityview_field_entry_value_number`
			 * @since 1.6
			 * @param string $output HTML value output
			 * @param array  $entry The GF entry array
			 * @param  array $field_settings Settings for the particular GV field
			 * @param array $field Current field being displayed
			 *
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
			 */
			$output = apply_filters( "gravityview_field_entry_value_{$field->type}", $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			/**
			 * @filter `gravityview_field_entry_value` Modify the field value output for all field types
			 * @param string $output HTML value output
			 * @param array  $entry The GF entry array
			 * @param  array $field_settings Settings for the particular GV field
			 * @param array $field_data  {@since 1.6}
			 *
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
			 */
			$output = apply_filters( 'gravityview_field_entry_value', $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );

			/**
			 * @filter `gravityview/template/field/{$field_type}/output` Modify the field output for a field type.
			 *
			 * @since 2.0
			 *
			 * @param string $output The current output.
			 * @param \GV\Template_Context The template context this is being called from.
			 */
			return apply_filters( "gravityview/template/field/{$field->type}/output", $output, $context );
		};

		/**
		 * Okay, what's this whole pre/post_link compat deal, huh?
		 *
		 * Well, the `gravityview_field_entry_value_{$field_type}_pre_link` filter
		 *  is expected to be applied before the value is turned into an entry link.
		 *
		 * And then `gravityview_field_entry_value_{$field_type}` and `gravityview_field_entry_value`
		 *  are called afterwards.
		 *
		 * So we're going to use filter priorities to make sure this happens inline with
		 *  our new filters, in the correct sequence. Pre-link called with priority 5 and
		 *  post-link called with priority 9. Then everything else.
		 *
		 * If a new code wants to alter the value before it is hyperlinked (hyperlinkified?),
		 *  it should hook into a priority between -inf. and 8. Afterwards: 10 to +inf.
		 */
		add_filter( 'gravityview/template/field/output', $pre_link_compat_callback, 5, 2 );
		add_filter( 'gravityview/template/field/output', $post_link_compat_callback, 9, 2 );

		/**
		 * @filter `gravityview/template/field/output` Modify the field output for a field.
		 *
		 * @since 2.0
		 *
		 * @param string $output The current output.
		 * @param \GV\Template_Context The template this is being called from.
		 */
		echo apply_filters( "gravityview/template/field/output", $output, $context );

		remove_filter( 'gravityview/template/field/output', $pre_link_compat_callback, 5 );
		remove_filter( 'gravityview/template/field/output', $post_link_compat_callback, 9 );
	}
}