Issues in class.render.settings.php - New Issues - Inspection of "Merge pull request #753 from gravityview/develop" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 92cdcd...79386d )

by Zack

created 2016-08-31 21:01 UTC

includes/admin/class.render.settings.php (2 issues)

Severity

Unknown 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Renders field/widget options and view settings
 *
 * @package   GravityView
 * @license   GPL2+
 * @author    Katz Web Services, Inc.
 * @link      http://gravityview.co
 * @copyright Copyright 2014, Katz Web Services, Inc.
 *
 * @since 1.2
 */

class GravityView_Render_Settings {

	/**
	 * Get the default options for a standard field.
	 *
	 * @param  string      $field_type  Type of field options to render (`field` or `widget`)
	 * @param  string      $template_id Table slug
	 * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
	 * @param  string      $context     What context are we in? Example: `single` or `directory`
	 * @param  string      $input_type  (textarea, list, select, etc.)
	 * @return array       Array of field options with `label`, `value`, `type`, `default` keys
	 */
	public static function get_default_field_options( $field_type, $template_id, $field_id, $context, $input_type ) {

		$field_options = array();

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

			// Default options - fields
			$field_options = array(
				'show_label' => array(
					'type' => 'checkbox',
					'label' => __( 'Show Label', 'gravityview' ),
					'value' => true,
				),
				'custom_label' => array(
					'type' => 'text',
					'label' => __( 'Custom Label:', 'gravityview' ),
					'value' => '',
					'merge_tags' => true,
				),
				'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',
				),
				'only_loggedin' => array(
					'type' => 'checkbox',
					'label' => __( 'Make visible only to logged-in users?', 'gravityview' ),
					'value' => ''
				),
				'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',
				),
			);

			// Match Table as well as DataTables
			if( preg_match( '/table/ism', $template_id ) && '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' => '',
				);
			}

		}

		/**
		 * @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.)
		 */
		$field_options = apply_filters( "gravityview_template_{$field_type}_options", $field_options, $template_id, $field_id, $context, $input_type );

		/**
		 * @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.)
		 */
		$field_options = apply_filters( "gravityview_template_{$input_type}_options", $field_options, $template_id, $field_id, $context, $input_type );

		return $field_options;
	}

	/**
	 * Get capabilities options for GravityView
	 *
	 * Parameters are only to pass to the filter.
	 *
	 * @param  string $template_id Optional. View slug
	 * @param  string $field_id    Optional. GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
	 * @param  string $context     Optional. What context are we in? Example: `single` or `directory`
	 * @param  string $input_type  Optional. (textarea, list, select, etc.)
	 * @return array Associative array, with the key being the capability and the value being the label shown.
	 */
	static public function get_cap_choices( $template_id = '', $field_id = '', $context = '', $input_type = '' ) {

		$select_cap_choices = array(
			'read' => __( 'Any Logged-In User', 'gravityview' ),
			'publish_posts' => __( 'Author Or Higher', 'gravityview' ),
			'gravityforms_view_entries' => __( 'Can View Gravity Forms Entries', 'gravityview' ),
			'delete_others_posts' => __( 'Editor Or Higher', 'gravityview' ),
			'gravityforms_edit_entries' => __( 'Can Edit Gravity Forms Entries', 'gravityview' ),
			'manage_options' => __( 'Administrator', 'gravityview' ),
		);

		if( is_multisite() ) {
			$select_cap_choices['manage_network'] = __('Multisite Super Admin', 'gravityview' );
		}

		/**
		 * @filter `gravityview_field_visibility_caps` Modify the capabilities shown in the field dropdown
		 * @see http://docs.gravityview.co/article/96-how-to-modify-capabilities-shown-in-the-field-only-visible-to-dropdown
		 * @since  1.0.1
		 * @param  array $select_cap_choices Associative rray of role slugs with labels ( `manage_options` => `Administrator` )
		 * @param  string $template_id Optional. View slug
		 * @param  string $field_id    Optional. GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
		 * @param  string $context     Optional. What context are we in? Example: `single` or `directory`
		 * @param  string $input_type  Optional. (textarea, list, select, etc.)
		 */
		$select_cap_choices = apply_filters('gravityview_field_visibility_caps', $select_cap_choices, $template_id, $field_id, $context, $input_type );

		return $select_cap_choices;
	}


	/**
	 * Render Field Options html (shown through a dialog box)
	 *
	 * @see GravityView_Ajax::get_field_options
	 * @see GravityView_Admin_Views::render_active_areas
	 *
	 * @access public
	 * @param string $field_type field / widget
	 * @param string $template_id
	 * @param string $field_id
	 * @param string $field_label
	 * @param string $area
	 * @param string $uniqid (default: '')
	 * @param string $current (default: '')
	 * @param string $context (default: 'single')
	 * @param array $item Field or widget array that's being rendered
	 *
	 * @return string HTML of dialog box
	 */
	public static function render_field_options( $field_type, $template_id, $field_id, $field_label, $area, $input_type = NULL, $uniqid = '', $current = '', $context = 'single', $item = array() ) {

		if( empty( $uniqid ) ) {
			//generate a unique field id
			$uniqid = uniqid('', false);
		}

		// get field/widget options
		$options = self::get_default_field_options( $field_type, $template_id, $field_id, $context, $input_type );

		// two different post arrays, depending of the field type
		$name_prefix = $field_type .'s' .'['. $area .']['. $uniqid .']';

		// build output
		$output = '';
		$output .= '<input type="hidden" class="field-key" name="'. $name_prefix .'[id]" value="'. esc_attr( $field_id ) .'">';
		$output .= '<input type="hidden" class="field-label" name="'. $name_prefix .'[label]" value="'. esc_attr( $field_label ) .'">';

		// If there are no options, return what we got.
		if(empty($options)) {

			// This is here for checking if the output is empty in render_label()
			$output .= '<!-- No Options -->';

			return $output;
		}

		$output .= '<div class="gv-dialog-options" title="'. esc_attr( sprintf( __( 'Options: %s', 'gravityview' ) , strip_tags( html_entity_decode( $field_label ) ) ) ) .'">';

		/**
		 * @since 1.8
		 */
		if( !empty( $item['subtitle'] ) ) {
			$output .= '<div class="subtitle">' . $item['subtitle'] . '</div>';
		}

		foreach( $options as $key => $option ) {

			$value = isset( $current[ $key ] ) ? $current[ $key ] : NULL;

			$field_output = self::render_field_option( $name_prefix . '['. $key .']' , $option, $value);

			// The setting is empty
			if( empty( $field_output ) ) {
				continue;
			}

			switch( $option['type'] ) {
				// Hide hidden fields
				case 'hidden':
					$output .= '<div class="gv-setting-container gv-setting-container-'. esc_attr( $key ) . ' screen-reader-text">'. $field_output . '</div>';
					break;
				default:
					$output .= '<div class="gv-setting-container gv-setting-container-'. esc_attr( $key ) . '">'. $field_output .'</div>';
			}
		}

		// close options window
		$output .= '</div>';

		return $output;

	}



	/**
	 * Handle rendering a field option form element
	 *
	 * @param  string     $name    Input `name` attribute
	 * @param  array      $option  Associative array of options. See the $defaults variable for available keys.
	 * @param  mixed      $curr_value Current value of option
	 * @return string     HTML output of option
	 */
	public static function render_field_option( $name = '', $option, $curr_value = NULL ) {

		$output = '';

		/**
		 * @deprecated setting index 'default' was replaced by 'value'
		 * @see GravityView_FieldType::get_field_defaults
		 */
		if( !empty( $option['default'] ) && empty( $option['value'] ) ) {
			$option['value'] = $option['default'];
			_deprecated_function( 'GravityView_FieldType::get_field_defaults', '1.1.7', '[value] instead of [default] when defining the setting '. $name .' details' );
		}

		// prepare to render option field type
		if( isset( $option['type'] ) ) {

			$type_class = self::load_type_class( $option );

			if( class_exists( $type_class ) ) {

				/** @var GravityView_FieldType $render_type */
				$render_type = new $type_class( $name, $option, $curr_value );

				ob_start();

				$render_type->render_option();

				$output = ob_get_clean();

				/**
				 * @filter `gravityview/option/output/{option_type}` Modify the output for a GravityView setting.\n
				 * `$option_type` is the type of setting (`radio`, `text`, etc.)
				 * @param[in,out] string $output field class name
				 * @param[in] array $option  option field data
				 */
				$output = apply_filters( "gravityview/option/output/{$option['type']}" , $output, $option );
			}


		} // isset option[type]

		return $output;
	}






	/**
	 * Output a table row for view settings
	 * @param  string $key              The key of the input
	 * @param  array  $current_settings Associative array of current settings to use as input values, if set. If not set, the defaults are used.
	 * @param  string $override_input   [description]
	 * @param  string $name             [description]
	 * @param  string $id               [description]
	 * @return void                   [description]
	 */
	public static function render_setting_row( $key = '', $current_settings = array(), $override_input = null, $name = 'template_settings[%s]', $id = 'gravityview_se_%s' ) {

		$setting = GravityView_View_Data::get_default_arg( $key, true );

		// If the key doesn't exist, there's something wrong.
		if( empty( $setting ) ) { return; }

		/**
		 * @deprecated setting index 'name' was replaced by 'label'
		 * @see GravityView_FieldType::get_field_defaults
		 */
		if( isset( $setting['name'] ) && empty( $setting['label'] ) ) {
			$setting['label'] = $setting['name'];
			_deprecated_function( 'GravityView_FieldType::get_field_defaults', '1.1.7', '[label] instead of [name] when defining the setting '. $key .' details' );
		}

		$name = esc_attr( sprintf( $name, $key ) );
		$setting['id'] = esc_attr( sprintf( $id, $key ) );
		$setting['tooltip'] = 'gv_' . $key;

		// Use default if current setting isn't set.
		$curr_value = isset( $current_settings[ $key ] ) ? $current_settings[ $key ] : $setting['value'];

		// default setting type = text
		$setting['type'] = empty( $setting['type'] ) ? 'text' : $setting['type'];

		// merge tags
		if( !isset( $setting['merge_tags'] ) ) {
			if( $setting['type'] === 'text' ) {
				$setting['merge_tags'] = true;
			} else {
				$setting['merge_tags'] = false;
			}
		}

		$output = '';

		// render the setting
		$type_class = self::load_type_class( $setting );
		if( class_exists( $type_class ) ) {
			/** @var GravityView_FieldType $render_type */
			$render_type = new $type_class( $name, $setting, $curr_value );
			ob_start();
			$render_type->render_setting( $override_input );
			$output = ob_get_clean();
		}

		// Check if setting is specific for a template
		if( !empty( $setting['show_in_template'] ) ) {
			if( !is_array( $setting['show_in_template'] ) ) {
				$setting['show_in_template'] = array( $setting['show_in_template'] );
			}
			$show_if = ' data-show-if="'. implode( ' ', $setting['show_in_template'] ).'"';
		} else {
			$show_if = '';
		}

		// output
		echo '<tr valign="top" '. $show_if .'>' . $output . '</tr>';

	}


	/**
	 * Given a field type calculates the php class. If not found try to load it.
	 * @param  array $field
	 * @return string type class name
	 */
	public static function load_type_class( $field = NULL ) {

		if( empty( $field['type'] ) ) {
			return NULL;
		}

		/**
		 * @filter `gravityview/setting/class/{field_type}`
		 * @param string $class_suffix  field class suffix; `GravityView_FieldType_{$class_suffix}`
		 * @param array $field   field data
		 */
		$type_class = apply_filters( "gravityview/setting/class/{$field['type']}", 'GravityView_FieldType_' . $field['type'], $field );

		if( !class_exists( $type_class ) ) {

			/**
			 * @filter `gravityview/setting/class_file/{field_type}`
			 * @param string  $field_type_include_path field class file path
			 * @param array $field  field data
			 */
			$class_file = apply_filters( "gravityview/setting/class_file/{$field['type']}", GRAVITYVIEW_DIR . "includes/admin/field-types/type_{$field['type']}.php", $field );

			if( $class_file ) {
				if( file_exists( $class_file ) ) {
					require_once( $class_file );
				}
			}


		}

		return $type_class;
	}





	/**
	 * @deprecated 1.2
	 * Render the HTML for a checkbox input to be used on the field & widgets options
	 * @param  string $name , name attribute
	 * @param  string $current current value
	 * @return string         html tags
	 */
	public static function render_checkbox_option( $name = '', $id = '', $current = '' ) {

		_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_checkbox::render_input' );

		$output  = '<input name="'. esc_attr( $name ) .'" type="hidden" value="0">';
		$output .= '<input name="'. esc_attr( $name ) .'" id="'. esc_attr( $id ) .'" type="checkbox" value="1" '. checked( $current, '1', false ) .' >';

		return $output;
	}


	/**
	 * @deprecated 1.2
	 * Render the HTML for an input text to be used on the field & widgets options
	 * @param  string $name    Unique name of the field. Exampe: `fields[directory_list-title][5374ff6ab128b][custom_label]`
	 * @param  string $current [current value]
	 * @param string $add_merge_tags Add merge tags to the input?
	 * @param array $args Field settings, including `class` key for CSS class
	 * @return string         [html tags]
	 */
	public static function render_text_option( $name = '', $id = '', $current = '', $add_merge_tags = NULL, $args = array() ) {

		_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_text::render_input' );

		// Show the merge tags if the field is a list view
		$is_list = ( preg_match( '/_list-/ism', $name ));

		// Or is a single entry view
		$is_single = ( preg_match( '/single_/ism', $name ));
		$show = ( $is_single || $is_list );

		$class = '';
		// and $add_merge_tags is not false
		if( $show && $add_merge_tags !== false || $add_merge_tags === 'force' ) {
			$class = 'merge-tag-support mt-position-right mt-hide_all_fields ';
		}

		$class .= !empty( $args['class'] ) ? $args['class'] : 'widefat';
		$type = !empty( $args['type'] ) ? $args['type'] : 'text';

		return '<input name="'. esc_attr( $name ) .'" id="'. esc_attr( $id ) .'" type="'.esc_attr($type).'" value="'. esc_attr( $current ) .'" class="'.esc_attr( $class ).'">';
	}

	/**
	 * @deprecated 1.2
	 * Render the HTML for an textarea input to be used on the field & widgets options
	 * @param  string $name    Unique name of the field. Exampe: `fields[directory_list-title][5374ff6ab128b][custom_label]`
	 * @param  string $current [current value]
	 * @param string|boolean $add_merge_tags Add merge tags to the input?
	 * @param array $args Field settings, including `class` key for CSS class
	 * @return string         [html tags]
	 */
	public static function render_textarea_option( $name = '', $id = '', $current = '', $add_merge_tags = NULL, $args = array() ) {

		_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_textarea::render_input' );

		// Show the merge tags if the field is a list view
		$is_list = ( preg_match( '/_list-/ism', $name ));

		// Or is a single entry view
		$is_single = ( preg_match( '/single_/ism', $name ));
		$show = ( $is_single || $is_list );

		$class = '';
		// and $add_merge_tags is not false
		if( $show && $add_merge_tags !== false || $add_merge_tags === 'force' ) {
			$class = 'merge-tag-support mt-position-right mt-hide_all_fields ';
		}

		$class .= !empty( $args['class'] ) ? 'widefat '.$args['class'] : 'widefat';

		return '<textarea name="'. esc_attr( $name ) .'" id="'. esc_attr( $id ) .'" class="'.esc_attr( $class ).'">'. esc_textarea( $current ) .'</textarea>';
	}

	/**
	 *
	 * Render the HTML for a select box to be used on the field & widgets options
	 * @deprecated 1.2
	 * @param  string $name    [name attribute]
	 * @param  array $choices [select options]
	 * @param  string $current [current value]
	 * @return string          [html tags]
	 */
	public static function render_select_option( $name = '', $id = '', $choices, $current = '' ) {

		_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_select::render_input' );

		$output = '<select name="'. $name .'" id="'. $id .'">';
		foreach( $choices as $value => $label ) {
			$output .= '<option value="'. esc_attr( $value ) .'" '. selected( $value, $current, false ) .'>'. esc_html( $label ) .'</option>';
		}
		$output .= '</select>';

		return $output;
	}


}


1			<?php
2			/**
3			* Renders field/widget options and view settings
4			*
5			* @package GravityView
6			* @license GPL2+
7			* @author Katz Web Services, Inc.
8			* @link http://gravityview.co
9			* @copyright Copyright 2014, Katz Web Services, Inc.
10			*
11			* @since 1.2
12			*/
13
14			class GravityView_Render_Settings {
15
16			/**
17			* Get the default options for a standard field.
18			*
19			* @param string $field_type Type of field options to render (`field` or `widget`)
20			* @param string $template_id Table slug
21			* @param float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
22			* @param string $context What context are we in? Example: `single` or `directory`
23			* @param string $input_type (textarea, list, select, etc.)
24			* @return array Array of field options with `label`, `value`, `type`, `default` keys
25			*/
26			public static function get_default_field_options( $field_type, $template_id, $field_id, $context, $input_type ) {
27
28			$field_options = array();
29
30			if( 'field' === $field_type ) {
31
32			// Default options - fields
33			$field_options = array(
34			'show_label' => array(
35			'type' => 'checkbox',
36			'label' => __( 'Show Label', 'gravityview' ),
37			'value' => true,
38			),
39			'custom_label' => array(
40			'type' => 'text',
41			'label' => __( 'Custom Label:', 'gravityview' ),
42			'value' => '',
43			'merge_tags' => true,
44			),
45			'custom_class' => array(
46			'type' => 'text',
47			'label' => __( 'Custom CSS Class:', 'gravityview' ),
48			'desc' => __( 'This class will be added to the field container', 'gravityview'),
49			'value' => '',
50			'merge_tags' => true,
51			'tooltip' => 'gv_css_merge_tags',
52			),
53			'only_loggedin' => array(
54			'type' => 'checkbox',
55			'label' => __( 'Make visible only to logged-in users?', 'gravityview' ),
56			'value' => ''
57			),
58			'only_loggedin_cap' => array(
59			'type' => 'select',
60			'label' => __( 'Make visible for:', 'gravityview' ),
61			'options' => self::get_cap_choices( $template_id, $field_id, $context, $input_type ),
62			'class' => 'widefat',
63			'value' => 'read',
64			),
65			);
66
67			// Match Table as well as DataTables
68			if( preg_match( '/table/ism', $template_id ) && 'directory' === $context ) {
69			$field_options['width'] = array(
70			'type' => 'number',
71			'label' => __('Percent Width', 'gravityview'),
72			'desc' => __( 'Leave blank for column width to be based on the field content.', 'gravityview'),
73			'class' => 'code widefat',
74			'value' => '',
75			);
76			}
77
78			}
79
80			/**
81			* @filter `gravityview_template_{$field_type}_options` Filter the field options by field type. Filter names: `gravityview_template_field_options` and `gravityview_template_widget_options`
82			* @param[in,out] array Array of field options with `label`, `value`, `type`, `default` keys
83			* @param[in] string $template_id Table slug
84			* @param[in] float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
85			* @param[in] string $context What context are we in? Example: `single` or `directory`
86			* @param[in] string $input_type (textarea, list, select, etc.)
87			*/
88			$field_options = apply_filters( "gravityview_template_{$field_type}_options", $field_options, $template_id, $field_id, $context, $input_type );
89
90			/**
91			* @filter `gravityview_template_{$input_type}_options` Filter the field options by input type (`$input_type` examples: `textarea`, `list`, `select`, etc.)
92			* @param[in,out] array Array of field options with `label`, `value`, `type`, `default` keys
93			* @param[in] string $template_id Table slug
94			* @param[in] float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
95			* @param[in] string $context What context are we in? Example: `single` or `directory`
96			* @param[in] string $input_type (textarea, list, select, etc.)
97			*/
98			$field_options = apply_filters( "gravityview_template_{$input_type}_options", $field_options, $template_id, $field_id, $context, $input_type );
99
100			return $field_options;
101			}
102
103			/**
104			* Get capabilities options for GravityView
105			*
106			* Parameters are only to pass to the filter.
107			*
108			* @param string $template_id Optional. View slug
109			* @param string $field_id Optional. GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
110			* @param string $context Optional. What context are we in? Example: `single` or `directory`
111			* @param string $input_type Optional. (textarea, list, select, etc.)
112			* @return array Associative array, with the key being the capability and the value being the label shown.
113			*/
114			static public function get_cap_choices( $template_id = '', $field_id = '', $context = '', $input_type = '' ) {
115
116			$select_cap_choices = array(
117			'read' => __( 'Any Logged-In User', 'gravityview' ),
118			'publish_posts' => __( 'Author Or Higher', 'gravityview' ),
119			'gravityforms_view_entries' => __( 'Can View Gravity Forms Entries', 'gravityview' ),
120			'delete_others_posts' => __( 'Editor Or Higher', 'gravityview' ),
121			'gravityforms_edit_entries' => __( 'Can Edit Gravity Forms Entries', 'gravityview' ),
122			'manage_options' => __( 'Administrator', 'gravityview' ),
123			);
124
125			if( is_multisite() ) {
126			$select_cap_choices['manage_network'] = __('Multisite Super Admin', 'gravityview' );
127			}
128
129			/**
130			* @filter `gravityview_field_visibility_caps` Modify the capabilities shown in the field dropdown
131			* @see http://docs.gravityview.co/article/96-how-to-modify-capabilities-shown-in-the-field-only-visible-to-dropdown
132			* @since 1.0.1
133			* @param array $select_cap_choices Associative rray of role slugs with labels ( `manage_options` => `Administrator` )
134			* @param string $template_id Optional. View slug
135			* @param string $field_id Optional. GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
136			* @param string $context Optional. What context are we in? Example: `single` or `directory`
137			* @param string $input_type Optional. (textarea, list, select, etc.)
138			*/
139			$select_cap_choices = apply_filters('gravityview_field_visibility_caps', $select_cap_choices, $template_id, $field_id, $context, $input_type );
140
141			return $select_cap_choices;
142			}
143
144
145			/**
146			* Render Field Options html (shown through a dialog box)
147			*
148			* @see GravityView_Ajax::get_field_options
149			* @see GravityView_Admin_Views::render_active_areas
150			*
151			* @access public
152			* @param string $field_type field / widget
153			* @param string $template_id
154			* @param string $field_id
155			* @param string $field_label
156			* @param string $area
157			* @param string $uniqid (default: '')
158			* @param string $current (default: '')
159			* @param string $context (default: 'single')
160			* @param array $item Field or widget array that's being rendered
161			*
162			* @return string HTML of dialog box
163			*/
164			public static function render_field_options( $field_type, $template_id, $field_id, $field_label, $area, $input_type = NULL, $uniqid = '', $current = '', $context = 'single', $item = array() ) {
165
166			if( empty( $uniqid ) ) {
167			//generate a unique field id
168			$uniqid = uniqid('', false);
169			}
170
171			// get field/widget options
172			$options = self::get_default_field_options( $field_type, $template_id, $field_id, $context, $input_type );
173
174			// two different post arrays, depending of the field type
175			$name_prefix = $field_type .'s' .'['. $area .']['. $uniqid .']';
176
177			// build output
178			$output = '';
179			$output .= '<input type="hidden" class="field-key" name="'. $name_prefix .'[id]" value="'. esc_attr( $field_id ) .'">';
180			$output .= '<input type="hidden" class="field-label" name="'. $name_prefix .'[label]" value="'. esc_attr( $field_label ) .'">';
181
182			// If there are no options, return what we got.
183			if(empty($options)) {
184
185			// This is here for checking if the output is empty in render_label()
186			$output .= '<!-- No Options -->';
187
188			return $output;
189			}
190
191			$output .= '<div class="gv-dialog-options" title="'. esc_attr( sprintf( __( 'Options: %s', 'gravityview' ) , strip_tags( html_entity_decode( $field_label ) ) ) ) .'">';
192
193			/**
194			* @since 1.8
195			*/
196			if( !empty( $item['subtitle'] ) ) {
197			$output .= '<div class="subtitle">' . $item['subtitle'] . '</div>';
198			}
199
200			foreach( $options as $key => $option ) {
201
202			$value = isset( $current[ $key ] ) ? $current[ $key ] : NULL;
203
204			$field_output = self::render_field_option( $name_prefix . '['. $key .']' , $option, $value);
205
206			// The setting is empty
207			if( empty( $field_output ) ) {
208			continue;
209			}
210
211			switch( $option['type'] ) {
212			// Hide hidden fields
213			case 'hidden':
214			$output .= '<div class="gv-setting-container gv-setting-container-'. esc_attr( $key ) . ' screen-reader-text">'. $field_output . '</div>';
215			break;
216			default:
217			$output .= '<div class="gv-setting-container gv-setting-container-'. esc_attr( $key ) . '">'. $field_output .'</div>';
218			}
219			}
220
221			// close options window
222			$output .= '</div>';
223
224			return $output;
225
226			}
227
228
229
230			/**
231			* Handle rendering a field option form element
232			*
233			* @param string $name Input `name` attribute
234			* @param array $option Associative array of options. See the $defaults variable for available keys.
235			* @param mixed $curr_value Current value of option
236			* @return string HTML output of option
237			*/
238			public static function render_field_option( $name = '', $option, $curr_value = NULL ) {
239
240			$output = '';
241
242			/**
243			* @deprecated setting index 'default' was replaced by 'value'
244			* @see GravityView_FieldType::get_field_defaults
245			*/
246			if( !empty( $option['default'] ) && empty( $option['value'] ) ) {
247			$option['value'] = $option['default'];
248			_deprecated_function( 'GravityView_FieldType::get_field_defaults', '1.1.7', '[value] instead of [default] when defining the setting '. $name .' details' );
249			}
250
251			// prepare to render option field type
252			if( isset( $option['type'] ) ) {
253
254			$type_class = self::load_type_class( $option );
255
256			if( class_exists( $type_class ) ) {
257
258			/** @var GravityView_FieldType $render_type */
259			$render_type = new $type_class( $name, $option, $curr_value );
260
261			ob_start();
262
263			$render_type->render_option();
264
265			$output = ob_get_clean();
266
267			/**
268			* @filter `gravityview/option/output/{option_type}` Modify the output for a GravityView setting.\n
269			* `$option_type` is the type of setting (`radio`, `text`, etc.)
270			* @param[in,out] string $output field class name
271			* @param[in] array $option option field data
272			*/
273			$output = apply_filters( "gravityview/option/output/{$option['type']}" , $output, $option );
274			}
			1 ignored issue – show introduced 2016-08-25 19:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this Blank line found after control structure Loading history...
275
276			} // isset option[type]
277
278			return $output;
279			}
280
281
282
283
284
285
286			/**
287			* Output a table row for view settings
288			* @param string $key The key of the input
289			* @param array $current_settings Associative array of current settings to use as input values, if set. If not set, the defaults are used.
290			* @param string $override_input [description]
291			* @param string $name [description]
292			* @param string $id [description]
293			* @return void [description]
294			*/
295			public static function render_setting_row( $key = '', $current_settings = array(), $override_input = null, $name = 'template_settings[%s]', $id = 'gravityview_se_%s' ) {
296
297			$setting = GravityView_View_Data::get_default_arg( $key, true );
298
299			// If the key doesn't exist, there's something wrong.
300			if( empty( $setting ) ) { return; }
301
302			/**
303			* @deprecated setting index 'name' was replaced by 'label'
304			* @see GravityView_FieldType::get_field_defaults
305			*/
306			if( isset( $setting['name'] ) && empty( $setting['label'] ) ) {
307			$setting['label'] = $setting['name'];
308			_deprecated_function( 'GravityView_FieldType::get_field_defaults', '1.1.7', '[label] instead of [name] when defining the setting '. $key .' details' );
309			}
310
311			$name = esc_attr( sprintf( $name, $key ) );
312			$setting['id'] = esc_attr( sprintf( $id, $key ) );
313			$setting['tooltip'] = 'gv_' . $key;
314
315			// Use default if current setting isn't set.
316			$curr_value = isset( $current_settings[ $key ] ) ? $current_settings[ $key ] : $setting['value'];
317
318			// default setting type = text
319			$setting['type'] = empty( $setting['type'] ) ? 'text' : $setting['type'];
320
321			// merge tags
322			if( !isset( $setting['merge_tags'] ) ) {
323			if( $setting['type'] === 'text' ) {
324			$setting['merge_tags'] = true;
325			} else {
326			$setting['merge_tags'] = false;
327			}
328			}
329
330			$output = '';
331
332			// render the setting
333			$type_class = self::load_type_class( $setting );
334			if( class_exists( $type_class ) ) {
335			/** @var GravityView_FieldType $render_type */
336			$render_type = new $type_class( $name, $setting, $curr_value );
337			ob_start();
338			$render_type->render_setting( $override_input );
339			$output = ob_get_clean();
340			}
341
342			// Check if setting is specific for a template
343			if( !empty( $setting['show_in_template'] ) ) {
344			if( !is_array( $setting['show_in_template'] ) ) {
345			$setting['show_in_template'] = array( $setting['show_in_template'] );
346			}
347			$show_if = ' data-show-if="'. implode( ' ', $setting['show_in_template'] ).'"';
348			} else {
349			$show_if = '';
350			}
351
352			// output
353			echo '<tr valign="top" '. $show_if .'>' . $output . '</tr>';
354
355			}
356
357
358			/**
359			* Given a field type calculates the php class. If not found try to load it.
360			* @param array $field
361			* @return string type class name
362			*/
363			public static function load_type_class( $field = NULL ) {
364
365			if( empty( $field['type'] ) ) {
366			return NULL;
367			}
368
369			/**
370			* @filter `gravityview/setting/class/{field_type}`
371			* @param string $class_suffix field class suffix; `GravityView_FieldType_{$class_suffix}`
372			* @param array $field field data
373			*/
374			$type_class = apply_filters( "gravityview/setting/class/{$field['type']}", 'GravityView_FieldType_' . $field['type'], $field );
375
376			if( !class_exists( $type_class ) ) {
377
378			/**
379			* @filter `gravityview/setting/class_file/{field_type}`
380			* @param string $field_type_include_path field class file path
381			* @param array $field field data
382			*/
383			$class_file = apply_filters( "gravityview/setting/class_file/{$field['type']}", GRAVITYVIEW_DIR . "includes/admin/field-types/type_{$field['type']}.php", $field );
384
385			if( $class_file ) {
386			if( file_exists( $class_file ) ) {
387			require_once( $class_file );
388			}
389			}
			1 ignored issue – show introduced 2016-08-25 19:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this Blank line found after control structure Loading history...
390
391			}
392
393			return $type_class;
394			}
395
396
397
398
399
400			/**
401			* @deprecated 1.2
402			* Render the HTML for a checkbox input to be used on the field & widgets options
403			* @param string $name , name attribute
404			* @param string $current current value
405			* @return string html tags
406			*/
407			public static function render_checkbox_option( $name = '', $id = '', $current = '' ) {
408
409			_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_checkbox::render_input' );
410
411			$output = '<input name="'. esc_attr( $name ) .'" type="hidden" value="0">';
412			$output .= '<input name="'. esc_attr( $name ) .'" id="'. esc_attr( $id ) .'" type="checkbox" value="1" '. checked( $current, '1', false ) .' >';
413
414			return $output;
415			}
416
417
418			/**
419			* @deprecated 1.2
420			* Render the HTML for an input text to be used on the field & widgets options
421			* @param string $name Unique name of the field. Exampe: `fields[directory_list-title][5374ff6ab128b][custom_label]`
422			* @param string $current [current value]
423			* @param string $add_merge_tags Add merge tags to the input?
424			* @param array $args Field settings, including `class` key for CSS class
425			* @return string [html tags]
426			*/
427			public static function render_text_option( $name = '', $id = '', $current = '', $add_merge_tags = NULL, $args = array() ) {
428
429			_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_text::render_input' );
430
431			// Show the merge tags if the field is a list view
432			$is_list = ( preg_match( '/_list-/ism', $name ));
433
434			// Or is a single entry view
435			$is_single = ( preg_match( '/single_/ism', $name ));
436			$show = ( $is_single \|\| $is_list );
437
438			$class = '';
439			// and $add_merge_tags is not false
440			if( $show && $add_merge_tags !== false \|\| $add_merge_tags === 'force' ) {
441			$class = 'merge-tag-support mt-position-right mt-hide_all_fields ';
442			}
443
444			$class .= !empty( $args['class'] ) ? $args['class'] : 'widefat';
445			$type = !empty( $args['type'] ) ? $args['type'] : 'text';
446
447			return '<input name="'. esc_attr( $name ) .'" id="'. esc_attr( $id ) .'" type="'.esc_attr($type).'" value="'. esc_attr( $current ) .'" class="'.esc_attr( $class ).'">';
448			}
449
450			/**
451			* @deprecated 1.2
452			* Render the HTML for an textarea input to be used on the field & widgets options
453			* @param string $name Unique name of the field. Exampe: `fields[directory_list-title][5374ff6ab128b][custom_label]`
454			* @param string $current [current value]
455			* @param string\|boolean $add_merge_tags Add merge tags to the input?
456			* @param array $args Field settings, including `class` key for CSS class
457			* @return string [html tags]
458			*/
459			public static function render_textarea_option( $name = '', $id = '', $current = '', $add_merge_tags = NULL, $args = array() ) {
460
461			_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_textarea::render_input' );
462
463			// Show the merge tags if the field is a list view
464			$is_list = ( preg_match( '/_list-/ism', $name ));
465
466			// Or is a single entry view
467			$is_single = ( preg_match( '/single_/ism', $name ));
468			$show = ( $is_single \|\| $is_list );
469
470			$class = '';
471			// and $add_merge_tags is not false
472			if( $show && $add_merge_tags !== false \|\| $add_merge_tags === 'force' ) {
473			$class = 'merge-tag-support mt-position-right mt-hide_all_fields ';
474			}
475
476			$class .= !empty( $args['class'] ) ? 'widefat '.$args['class'] : 'widefat';
477
478			return '<textarea name="'. esc_attr( $name ) .'" id="'. esc_attr( $id ) .'" class="'.esc_attr( $class ).'">'. esc_textarea( $current ) .'</textarea>';
479			}
480
481			/**
482			*
483			* Render the HTML for a select box to be used on the field & widgets options
484			* @deprecated 1.2
485			* @param string $name [name attribute]
486			* @param array $choices [select options]
487			* @param string $current [current value]
488			* @return string [html tags]
489			*/
490			public static function render_select_option( $name = '', $id = '', $choices, $current = '' ) {
491
492			_deprecated_function( __METHOD__, '1.2', 'GravityView_FieldType_select::render_input' );
493
494			$output = '<select name="'. $name .'" id="'. $id .'">';
495			foreach( $choices as $value => $label ) {
496			$output .= '<option value="'. esc_attr( $value ) .'" '. selected( $value, $current, false ) .'>'. esc_html( $label ) .'</option>';
497			}
498			$output .= '</select>';
499
500			return $output;
501			}
502
503
504			}
505

gravityview / GravityView

Push — master ( 92cdcd...79386d )

includes/admin/class.render.settings.php (2 issues)

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like