GravityView_Field_Entry_Approval::field_options() - Code Metrics - Inspection of "Merge pull request #798 from gravityview/develop" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2ddace...f4e16f )

by Zack

created 2016-11-14 23:04 UTC

GravityView_Field_Entry_Approval::field_options() A

↳ Parent: GravityView_Field_Entry_Approval

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	5
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?php


/**
 * Add custom options for address fields
 * @since 1.19
 */
class GravityView_Field_Entry_Approval extends GravityView_Field {

	var $name = 'entry_approval';
class A {
    var $property;
}

	var $is_searchable = true;
class A {
    var $property;
}

	var $is_sortable = true;
class A {
    var $property;
}

	var $is_numeric = true;
class A {
    var $property;
}

	var $group = 'gravityview';
class A {
    var $property;
}

	var $contexts = array( 'single', 'multiple' );
class A {
    var $property;
}

	public function __construct() {

		$this->label = esc_attr__( 'Approve Entries', 'gravityview' );

		$this->description =  esc_attr__( 'Approve and reject entries from the View.', 'gravityview' );


		$this->add_hooks();

		parent::__construct();
	}

	/**
	 * Remove unused settings for the approval field
	 *
	 * @since 1.19
	 *
	 * @param array $field_options
	 * @param string $template_id
	 * @param string $field_id
	 * @param string $context
	 * @param string $input_type
	 *
	 * @return array
	 */
	function field_options( $field_options, $template_id = '', $field_id = '', $context = '', $input_type = '' ) {


		unset( $field_options['only_loggedin'] );

		unset( $field_options['new_window'] );

		unset( $field_options['show_as_link'] );

		return $field_options;
	}

	/**
	 * Add filters and actions for the field
	 *
	 * @since 1.19
	 *
	 * @return void
	 */
	private function add_hooks() {

		add_filter( 'gravityview_entry_default_fields', array( $this, 'filter_gravityview_entry_default_field' ), 10, 3 );

		add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts_and_styles' ) );

		add_action( 'gravityview/field/approval/load_scripts', array( $this, 'enqueue_and_localize_script' ) );

		add_action( 'gravityview_datatables_scripts_styles',  array( $this, 'enqueue_and_localize_script' ) );

		add_filter( 'gravityview_get_entries', array( $this, 'modify_search_parameters' ), 1000 );

		add_filter( 'gravityview/field_output/html', array( $this, 'maybe_prevent_field_render' ), 10, 2 );
	}

	/**
	 * @filter `gravityview/template/field_label` Modify field label output
	 *
	 * @since 1.19
	 *
	 * @param string $html Existing HTML output
	 * @param array $args Arguments passed to the function
	 *
	 * @return string Empty string if user doesn't have the `gravityview_moderate_entries` cap; field HTML otherwise
	 */
	public function maybe_prevent_field_render( $html, $args ) {

		// If the field is `entry_approval` type but the user doesn't have the moderate entries cap, don't render.
		if( $this->name === rgar( $args['field'], 'id' ) && ! GVCommon::has_cap('gravityview_moderate_entries') ) {

			return '';
		}

		return $html;
	}

	/**
	 * Modify search to use `is_approved` meta key to sort, instead of `entry_approval`
	 *
	 * @param array $parameters Search parameters used to generate GF search
	 *
	 * @return array Same parameters, but if sorting by `entry_approval`, changed to `is_approved`
	 */
	public function modify_search_parameters( $parameters ) {

		if( $this->name === rgars( $parameters, 'sorting/key' ) ) {
			$parameters['sorting']['key'] = 'is_approved';
		}

		return $parameters;
	}

	/**
	 * Register the field approval script and style
	 *
	 * @since 1.19
	 *
	 * @return void
	 */
	function register_scripts_and_styles() {

		$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';

		wp_register_script( 'gravityview-field-approval', GRAVITYVIEW_URL . 'assets/js/field-approval'.$script_debug.'.js', array( 'jquery' ), GravityView_Plugin::version, true );

		/**
		 * Override CSS file by placing in your theme's /gravityview/css/ sub-directory.
		 */
		$style_path = GravityView_View::getInstance()->locate_template( 'css/field-approval.css', false );

		$style_url = plugins_url( 'css/field-approval.css', trailingslashit( dirname( $style_path ) )  );


		/**
		 * @filter `gravityview/field/approval/css_url` URL to the Approval field CSS file.
		 * @since 1.19
		 * @param string $style_url Override to use your own CSS file, or return empty string to disable loading.
		 */
		$style_url = apply_filters( 'gravityview/field/approval/css_url', $style_url );

		if( ! empty( $style_url ) ) {
			wp_register_style( 'gravityview-field-approval', $style_url, array( 'dashicons' ), GravityView_Plugin::version, 'screen' );
		}

		unset( $style_path, $style_url );
	}

	/**
	 * Register the field approval script and output the localized text JS variables
	 * @since 1.19
	 * @return void
	 */
	public function enqueue_and_localize_script() {

		// The script is already registered and enqueued
		if( wp_script_is( 'gravityview-field-approval', 'enqueued' ) ) {
			return;
		}

		wp_enqueue_style( 'gravityview-field-approval' );

		wp_enqueue_script( 'gravityview-field-approval' );

		wp_localize_script( 'gravityview-field-approval', 'gvApproval', array(
			'ajaxurl' => admin_url( 'admin-ajax.php' ),
			'nonce' => wp_create_nonce('gravityview_entry_approval'),

			'status' => GravityView_Entry_Approval_Status::get_all(),
		));

	}

	/**
	 * Add Fields to the field list
	 *
	 * @since 1.19
	 *
	 * @param array $entry_default_fields Array of fields shown by default
	 * @param string|array $form form_ID or form object
	 * @param string $context  Either 'single', 'directory', 'header', 'footer'
	 *
	 * @return array
	 */
	public function filter_gravityview_entry_default_field( $entry_default_fields, $form, $context ) {


		if ( ! isset( $entry_default_fields["{$this->name}"] ) ) {

			$entry_default_fields["{$this->name}"] = array(

				'label' => $this->label,
				'desc'  => $this->description,
				'type'  => $this->name,
			);
		}

		return $entry_default_fields;
	}

	/**
	 * Get the anchor text for a link, based on the current status
	 *
	 * @since 1.19
	 * @uses GravityView_Entry_Approval_Status::get_string()
	 *
	 * @param string $approved_status Status string or key
	 *
	 * @return false|string False if string doesn't exist, otherwise the "label" for the status
	 */
	public static function get_anchor_text( $approved_status = '' ) {
		return GravityView_Entry_Approval_Status::get_string( $approved_status, 'label' );
	}

	/**
	 * Get the title attribute for a link, based on the current status
	 *
	 * @since 1.19
	 * @uses GravityView_Entry_Approval_Status::get_string()
	 *
	 * @param int|string $approved_status Status string or key
	 *
	 * @return false|string
	 */
	public static function get_title_attr( $approved_status ) {
		return GravityView_Entry_Approval_Status::get_string( $approved_status, 'title' );
	}

	/**
	 * Get the CSS class for a link, based on the current status
	 *
	 * @param int|string $approved_status Status string or key
	 *
	 * @return string CSS class, sanitized using esc_attr()
	 */
	public static function get_css_class( $approved_status ) {

		$approved_key = GravityView_Entry_Approval_Status::get_key( $approved_status );

		return esc_attr( "gv-approval-{$approved_key}" );
	}
}

new GravityView_Field_Entry_Approval;


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 7 and the first side effect is on line 238. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/**
4			* Add custom options for address fields
5			* @since 1.19
6			*/
7			class GravityView_Field_Entry_Approval extends GravityView_Field {
8
9			var $name = 'entry_approval';
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$name`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
10
11			var $is_searchable = true;
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_searchable`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
12
13			var $is_sortable = true;
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_sortable`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
14
15			var $is_numeric = true;
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_numeric`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
16
17			var $group = 'gravityview';
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$group`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
18
19			var $contexts = array( 'single', 'multiple' );
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$contexts`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
20
21			public function __construct() {
22
23			$this->label = esc_attr__( 'Approve Entries', 'gravityview' );
24
25			$this->description = esc_attr__( 'Approve and reject entries from the View.', 'gravityview' );
			0 ignored issues – show introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Expected 1 space after "="; 2 found Loading history...
26
27			$this->add_hooks();
28
29			parent::__construct();
30			}
31
32			/**
33			* Remove unused settings for the approval field
34			*
35			* @since 1.19
36			*
37			* @param array $field_options
38			* @param string $template_id
39			* @param string $field_id
40			* @param string $context
41			* @param string $input_type
42			*
43			* @return array
44			*/
45			function field_options( $field_options, $template_id = '', $field_id = '', $context = '', $input_type = '' ) {
			0 ignored issues – show Best Practice introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
46
47			unset( $field_options['only_loggedin'] );
48
49			unset( $field_options['new_window'] );
50
51			unset( $field_options['show_as_link'] );
52
53			return $field_options;
54			}
55
56			/**
57			* Add filters and actions for the field
58			*
59			* @since 1.19
60			*
61			* @return void
62			*/
63			private function add_hooks() {
64
65			add_filter( 'gravityview_entry_default_fields', array( $this, 'filter_gravityview_entry_default_field' ), 10, 3 );
66
67			add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts_and_styles' ) );
68
69			add_action( 'gravityview/field/approval/load_scripts', array( $this, 'enqueue_and_localize_script' ) );
70
71			add_action( 'gravityview_datatables_scripts_styles', array( $this, 'enqueue_and_localize_script' ) );
72
73			add_filter( 'gravityview_get_entries', array( $this, 'modify_search_parameters' ), 1000 );
74
75			add_filter( 'gravityview/field_output/html', array( $this, 'maybe_prevent_field_render' ), 10, 2 );
76			}
77
78			/**
79			* @filter `gravityview/template/field_label` Modify field label output
80			*
81			* @since 1.19
82			*
83			* @param string $html Existing HTML output
84			* @param array $args Arguments passed to the function
85			*
86			* @return string Empty string if user doesn't have the `gravityview_moderate_entries` cap; field HTML otherwise
87			*/
88			public function maybe_prevent_field_render( $html, $args ) {
89
90			// If the field is `entry_approval` type but the user doesn't have the moderate entries cap, don't render.
91			if( $this->name === rgar( $args['field'], 'id' ) && ! GVCommon::has_cap('gravityview_moderate_entries') ) {
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history... Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Expected 1 spaces before closing bracket; 0 found Loading history...
92			return '';
93			}
94
95			return $html;
96			}
97
98			/**
99			* Modify search to use `is_approved` meta key to sort, instead of `entry_approval`
100			*
101			* @param array $parameters Search parameters used to generate GF search
102			*
103			* @return array Same parameters, but if sorting by `entry_approval`, changed to `is_approved`
104			*/
105			public function modify_search_parameters( $parameters ) {
106
107			if( $this->name === rgars( $parameters, 'sorting/key' ) ) {
108			$parameters['sorting']['key'] = 'is_approved';
109			}
110
111			return $parameters;
112			}
113
114			/**
115			* Register the field approval script and style
116			*
117			* @since 1.19
118			*
119			* @return void
120			*/
121			function register_scripts_and_styles() {
			0 ignored issues – show Best Practice introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
122			$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
123
124			wp_register_script( 'gravityview-field-approval', GRAVITYVIEW_URL . 'assets/js/field-approval'.$script_debug.'.js', array( 'jquery' ), GravityView_Plugin::version, true );
125
126			/**
127			* Override CSS file by placing in your theme's /gravityview/css/ sub-directory.
128			*/
129			$style_path = GravityView_View::getInstance()->locate_template( 'css/field-approval.css', false );
130
131			$style_url = plugins_url( 'css/field-approval.css', trailingslashit( dirname( $style_path ) ) );
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Expected 1 spaces before closing bracket; 2 found Loading history...
132
133			/**
134			* @filter `gravityview/field/approval/css_url` URL to the Approval field CSS file.
135			* @since 1.19
136			* @param string $style_url Override to use your own CSS file, or return empty string to disable loading.
137			*/
138			$style_url = apply_filters( 'gravityview/field/approval/css_url', $style_url );
139
140			if( ! empty( $style_url ) ) {
141			wp_register_style( 'gravityview-field-approval', $style_url, array( 'dashicons' ), GravityView_Plugin::version, 'screen' );
142			}
143
144			unset( $style_path, $style_url );
145			}
146
147			/**
148			* Register the field approval script and output the localized text JS variables
149			* @since 1.19
150			* @return void
151			*/
152			public function enqueue_and_localize_script() {
153
154			// The script is already registered and enqueued
155			if( wp_script_is( 'gravityview-field-approval', 'enqueued' ) ) {
156			return;
157			}
158
159			wp_enqueue_style( 'gravityview-field-approval' );
160
161			wp_enqueue_script( 'gravityview-field-approval' );
162
163			wp_localize_script( 'gravityview-field-approval', 'gvApproval', array(
164			'ajaxurl' => admin_url( 'admin-ajax.php' ),
165			'nonce' => wp_create_nonce('gravityview_entry_approval'),
			0 ignored issues – show Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history... Coding Style introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Expected 1 spaces before closing bracket; 0 found Loading history...
166			'status' => GravityView_Entry_Approval_Status::get_all(),
167			));
168
169			}
170
171			/**
172			* Add Fields to the field list
173			*
174			* @since 1.19
175			*
176			* @param array $entry_default_fields Array of fields shown by default
177			* @param string\|array $form form_ID or form object
178			* @param string $context Either 'single', 'directory', 'header', 'footer'
179			*
180			* @return array
181			*/
182			public function filter_gravityview_entry_default_field( $entry_default_fields, $form, $context ) {
			0 ignored issues – show Unused Code introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The parameter `$form` 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... Unused Code introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report The parameter `$context` 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...
183
184			if ( ! isset( $entry_default_fields["{$this->name}"] ) ) {
			0 ignored issues – show introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Array keys should be surrounded by spaces unless they contain a string or an integer. Loading history...
185			$entry_default_fields["{$this->name}"] = array(
			0 ignored issues – show introduced 2016-11-08 04:39 UTC by Report Bug Copy Issue Report Array keys should be surrounded by spaces unless they contain a string or an integer. Loading history...
186			'label' => $this->label,
187			'desc' => $this->description,
188			'type' => $this->name,
189			);
190			}
191
192			return $entry_default_fields;
193			}
194
195			/**
196			* Get the anchor text for a link, based on the current status
197			*
198			* @since 1.19
199			* @uses GravityView_Entry_Approval_Status::get_string()
200			*
201			* @param string $approved_status Status string or key
202			*
203			* @return false\|string False if string doesn't exist, otherwise the "label" for the status
204			*/
205			public static function get_anchor_text( $approved_status = '' ) {
206			return GravityView_Entry_Approval_Status::get_string( $approved_status, 'label' );
207			}
208
209			/**
210			* Get the title attribute for a link, based on the current status
211			*
212			* @since 1.19
213			* @uses GravityView_Entry_Approval_Status::get_string()
214			*
215			* @param int\|string $approved_status Status string or key
216			*
217			* @return false\|string
218			*/
219			public static function get_title_attr( $approved_status ) {
220			return GravityView_Entry_Approval_Status::get_string( $approved_status, 'title' );
221			}
222
223			/**
224			* Get the CSS class for a link, based on the current status
225			*
226			* @param int\|string $approved_status Status string or key
227			*
228			* @return string CSS class, sanitized using esc_attr()
229			*/
230			public static function get_css_class( $approved_status ) {
231
232			$approved_key = GravityView_Entry_Approval_Status::get_key( $approved_status );
233
234			return esc_attr( "gv-approval-{$approved_key}" );
235			}
236			}
237
238			new GravityView_Field_Entry_Approval;
239

gravityview / GravityView

Push — master ( 2ddace...f4e16f )

GravityView_Field_Entry_Approval::field_options() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like