GravityView_Field_Custom

Complexity

Total Complexity

23

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	7

Test Coverage

Coverage

32.93%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	field_options()	0	44	2
B	show_field_in_edit_entry()	0	44	6
C	add_filtersorts()	0	59	14

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

/**
 * Add custom options for Code field
 * @since 1.2
 */
class GravityView_Field_Custom extends GravityView_Field {

	var $name = 'custom';

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

	/**
	 * @var bool
	 * @since 1.15.3
	 */
	var $is_sortable = true;

	/**
	 * @var bool
	 * @since 1.15.3
	 */
	var $is_searchable = false;

	var $group = 'gravityview';

	public function __construct() {

		$this->label = esc_html__( 'Custom Content', 'gravityview' );

		add_filter( 'gravityview/edit_entry/form_fields', array( $this, 'show_field_in_edit_entry' ), 10, 4 );

		add_filter( 'gravityview/view/add_filtersorts', array( $this, 'add_filtersorts' ), 10, 2 );

		/**
		 * @filter `gravityview/fields/custom/sortable` Whether the custom content field should be sortable or not.
		 * @param bool $sortable
		 */
		$this->is_sortable = apply_filters( 'gravityview/fields/custom/sortable', $this->is_sortable );

		parent::__construct();
	}

	/**
	 * @inheritDoc
	 * @since 2.9.1 Added "This content is numeric" setting
	 */
	public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {

		unset ( $field_options['search_filter'], $field_options['show_as_link'] );

		$new_fields = array(
			'content' => array(
				'type' => 'textarea',
				'label' => __( 'Custom Content', 'gravityview' ),
				'desc' => sprintf( __( 'Enter text or HTML. Also supports shortcodes. You can show or hide data using the %s shortcode (%slearn more%s).', 'gravityview' ), '<code>[gvlogic]</code>', '<a href="https://docs.gravityview.co/article/252-gvlogic-shortcode" data-beacon-article-sidebar="552355bfe4b0221aadf2572b">', '</a>' ) . ' ' . sprintf( __( 'Click the arrow icon next to the content area to add %sMerge Tags%s.', 'gravityview' ), '<a href="https://docs.gravityview.co/article/76-merge-tags" data-beacon-article-inline="54c67bbbe4b051242988551d">', '</a>' ),
				'value' => '',
				'class'	=> 'code',
				'merge_tags' => 'force',
				'rows' => 15,
				'show_all_fields' => true, // Show the `{all_fields}` and `{pricing_fields}` merge tags
			),
			'wpautop' => array(
				'type' => 'checkbox',
				'label' => __( 'Automatically add paragraphs to content', 'gravityview' ),
				'tooltip' => __( 'Wrap each block of text in an HTML paragraph tag (recommended for text).', 'gravityview' ),
				'value' => '',
			),
			'oembed' => array(
				'type' => 'checkbox',
				'label' => __( 'Render oEmbeds', 'gravityview' ),
				'desc' => sprintf( _x( 'Automatically convert oEmbed URLs into embedded content (%slearn more%s).', 'HTML link pointing to WordPress article on oEmbed', 'gravityview' ), '<a href="https://codex.wordpress.org/Embeds" rel="external noopener noreferrer">', '</a>' ),
				'value' => '',
			),
			'admin_label' => array(
				'type' => 'text',
				'class' => 'widefat',
				'label' => __( 'Admin Label', 'gravityview' ),
				'desc' => __( 'A label that is only shown in the GravityView View configuration screen.', 'gravityview' ),
				'value' => '',
			),
		);

		$this->add_field_support( 'is_numeric', $new_fields );

		if ( 'edit' === $context ) {
			unset( $field_options['custom_label'], $field_options['show_label'], $field_options['allow_edit_cap'], $new_fields['wpautop'], $new_fields['oembed'] );
		}

		return $new_fields + $field_options;
	}

	/**
	 * Adds the GravityView Custom Content field to the Edit Entry form
	 *
	 * It does this by pretending to be a HTML field so that Gravity Forms displays it
	 *
	 * @since 1.19.2
	 *
	 * @param GF_Field[] $fields Gravity Forms form fields
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
	 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
	 * @param int $view_id View ID
	 *
	 * @return GF_Field[] If Custom Content field exists, returns fields array with the fields inserted. Otherwise, returns unmodified fields array.
	 */
	public function show_field_in_edit_entry( $fields, $edit_fields = null, $form = array(), $view_id = 0 ) {

The parameter $view_id is not used and could be removed.

		// Not configured; show all fields.
		if ( is_null( $edit_fields ) ) {
			return $fields;
		}

		$new_fields = array();
		$i = 0;

		$entry = gravityview()->request->is_edit_entry();

		// Loop through the configured Edit Entry fields and add Custom Content fields if there are any
		// TODO: Make this available to other custom GV field types
		foreach ( (array) $edit_fields as $edit_field ) {

			if( 'custom' === \GV\Utils::get( $edit_field, 'id') ) {

				$field_data = array(
					'label' => \GV\Utils::get( $edit_field, 'custom_label' ),
					'customLabel' => \GV\Utils::get( $edit_field, 'custom_label' ),
				    'content' => \GV\Utils::get( $edit_field, 'content' ),
				);

				// Replace merge tags in the content
				foreach ( $field_data as $key => $field_datum ) {
					$field_data[ $key ] = GravityView_Merge_Tags::replace_variables( $field_datum, $form, $entry->as_entry(), false, false );
				}

				$field_data['cssClass'] = \GV\Utils::get( $edit_field, 'custom_class' );

				$new_fields[] = new GF_Field_HTML( $field_data );

			} else {
				if( isset( $fields[ $i ] ) ) {
					$new_fields[] =  $fields[ $i ];
				}
				$i++;
			}

		}

		return $new_fields;
	}

	/**
	 * Sort by custom content field if required!
	 *
	 * @param \GV\View $view The view.
	 * @param \GV\Request $request The request.
	 *
	 * @return void
	 */
	public function add_filtersorts( $view, $request ) {

The parameter $request is not used and could be removed.

		if ( ! $view->fields->by_type( 'custom' )->count() ) {
			return; // No sorts.
		}

		if ( ! $sorts = \GV\Utils::_GET( 'sort' ) ) {
			$sorts = array_combine( (array)$view->settings->get( 'sort_field' ), (array)$view->settings->get( 'sort_direction' ) );
		}

		if ( strpos( implode( ':', array_keys( $sorts ) ), 'custom_' ) === false ) {
			return; // No custom sorts here.
		}

		add_filter( 'gravityview/entries/sort', $callback = function( $compare, $entry1, $entry2, $view, $request ) use ( $sorts ) {
			/**
			 * We'll actually need to sort everything on the PHP side now.
			 * This is weird...
			 */
			$renderer = new \GV\Field_Renderer();

			foreach ( $sorts as $key => $direction ) {
				if ( strpos( $key, 'custom_' ) === 0 ) {
					$field = $view->fields->get( str_replace( 'custom_', '', $key ) );
				} else {
					$field  = is_numeric( $key ) ? \GV\GF_Field::by_id( $view->form, $key ) : \GV\Internal_Field::by_id( $key );
				}

				$source = is_numeric( $key ) ? $view->form : new \GV\Internal_Source();

				$value1 = $renderer->render( $field, $view, $source, $entry1, $request );
				$value2 = $renderer->render( $field, $view, $source, $entry2, $request );

				if ( $value1 === $value2 ) {
					continue;
				}

				if ( $field->is_numeric ) { // @todo do we not have a filter that controls sorting?
					if ( is_numeric( $value1 ) ) {
						$value1 = floatval( $value1 );
					}

					if ( is_numeric( $value2 ) ) {
						$value2 = floatval( $value2 );
					}

					return strnatcmp( $value1, $value2 ) * ( ( strtolower( $direction ) == 'desc' ) ? -1 : 1 );
				} else {
					return strcmp( $value1, $value2 ) * ( ( strtolower( $direction ) == 'desc' ) ? -1 : 1 );
				}

			}

			return 0; // They're the same.
		}, 10, 5 );

		add_action( 'gravityview/view/remove_filtersorts', function() use ( $callback ) {
			remove_action( 'gravityview/entries/sort', $callback );
		} );
	}

}

new GravityView_Field_Custom;