GravityView_Render_Settings::get_default_field_options()

Complexity

Conditions	10
Paths	12

Size

Total Lines

134

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	38
CRAP Score	10.0125

Importance

Changes

0

<?php
	public static function get_default_field_options( $field_type, $template_id, $field_id, $context, $input_type, $form_id, $grouped = false ) {

		$field_options = array();

		$is_table_layout = preg_match( '/table/ism', $template_id );

		if( 'field' === $field_type ) {

			// Default options - fields
			$field_options = array(
				'show_label' => array(
					'type' => 'checkbox',
					'label' => __( 'Show Label', 'gravityview' ),
					'value' => ! empty ( $is_table_layout ),
					'priority' => 1000,
					'group' => 'label',
				),
				'custom_label' => array(
					'type' => 'text',
					'label' => __( 'Custom Label:', 'gravityview' ),
					'value' => '',
					'merge_tags' => true,
					'class'      => 'widefat',
					'priority' => 1100,
					'requires' => 'show_label',
					'group' => 'label',
				),
				'custom_class' => array(
					'type'       => 'text',
					'label'      => __( 'Custom CSS Class:', 'gravityview' ),
					'desc'       => __( 'This class will be added to the field container', 'gravityview' ),
					'value'      => '',
					'merge_tags' => true,
					'tooltip'    => 'gv_css_merge_tags',
					'class'      => 'widefat code',
					'priority' => 5000,
					'group' => 'advanced',
				),
				'only_loggedin' => array(
					'type' => 'checkbox',
					'label' => __( 'Make visible only to logged-in users?', 'gravityview' ),
					'value' => '',
					'priority' => 4000,
					'group' => 'visibility',
				),
				'only_loggedin_cap' => array(
					'type' => 'select',
					'label' => __( 'Make visible for:', 'gravityview' ),
					'options' => self::get_cap_choices( $template_id, $field_id, $context, $input_type ),
					'class' => 'widefat',
					'value' => 'read',
					'priority' => 4100,
					'requires' => 'only_loggedin',
					'group' => 'visibility',
				),
			);

			// Match Table as well as DataTables
			if( $is_table_layout && 'directory' === $context ) {
				$field_options['width'] = array(
					'type' => 'number',
					'label' => __('Percent Width', 'gravityview'),
					'desc' => __( 'Leave blank for column width to be based on the field content.', 'gravityview'),
					'class' => 'code widefat',
					'value' => '',
					'priority' => 200,
					'group' => 'display',
				);
			}

		}

		// Remove suffix ":" from the labels to standardize style. Using trim() instead of rtrim() for i18n.
		foreach ( $field_options as $key => $field_option ) {
			$field_options[ $key ]['label'] = trim( $field_options[ $key ]['label'], ':' );
		}

		/**
		 * @filter `gravityview_template_{$field_type}_options` Filter the field options by field type. Filter names: `gravityview_template_field_options` and `gravityview_template_widget_options`
		 * @param[in,out] array    Array of field options with `label`, `value`, `type`, `default` keys
		 * @param[in]  string      $template_id Table slug
		 * @param[in]  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
		 * @param[in]  string      $context     What context are we in? Example: `single` or `directory`
		 * @param[in]  string      $input_type  (textarea, list, select, etc.)
		 * @param[in]  int         $form_id     The form ID. {@since 2.5}
		 */
		$field_options = apply_filters( "gravityview_template_{$field_type}_options", $field_options, $template_id, $field_id, $context, $input_type, $form_id );

		/**
		 * @filter `gravityview_template_{$input_type}_options` Filter the field options by input type (`$input_type` examples: `textarea`, `list`, `select`, etc.)
		 * @param[in,out] array    Array of field options with `label`, `value`, `type`, `default` keys
		 * @param[in]  string      $template_id Table slug
		 * @param[in]  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
		 * @param[in]  string      $context     What context are we in? Example: `single` or `directory`
		 * @param[in]  string      $input_type  (textarea, list, select, etc.)
		 * @param[in]  int         $form_id     The form ID. {@since 2.5}
		 */
		$field_options = apply_filters( "gravityview_template_{$input_type}_options", $field_options, $template_id, $field_id, $context, $input_type, $form_id );

		if ( $grouped ) {

			$option_groups = array();

			foreach ( $field_options as $key => $field_option ) {

				// TODO: Add filter to override instead of doing inline.
				switch ( $key ) {
					case 'show_as_link':
						$_group = 'display';
						$field_option['priority'] = 100;
						break;
					default:
						$_group = \GV\Utils::get( $field_option, 'group', 'display' );
						break;
				}

				$option_groups[ $_group ][ $key ] = $field_option;
			}

			foreach ( $option_groups as & $option_group ) {
				uasort( $option_group, array( __CLASS__, '_sort_by_priority' ) );
			}

			$field_options = array();
			foreach ( self::get_field_groups() as $group_key => $group_name  ) {
				$field_options[ $group_key ] = \GV\Utils::get( $option_groups, $group_key, array() );
			}

		} else {
			uasort( $field_options, array( __CLASS__, '_sort_by_priority' ) );
		}

		return $field_options;
	}