Completed
Push — master ( 3a59f6...f89873 )
by Zack
43:57 queued 28:41
created

GravityView_Field_Entry_Approval::get_title_attr()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 1
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
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 268.

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 by
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 by
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
	public $search_operators = array( 'is', 'isnot' );
14
15
	var $is_sortable = true;
0 ignored issues
show
Coding Style introduced by
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...
16
17
	var $is_numeric = true;
0 ignored issues
show
Coding Style introduced by
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...
18
19
	var $group = 'gravityview';
0 ignored issues
show
Coding Style introduced by
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...
20
21
	var $contexts = array( 'single', 'multiple' );
0 ignored issues
show
Coding Style introduced by
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...
22
23
	public function __construct() {
24
25
		$this->label = esc_attr__( 'Approve Entries', 'gravityview' );
26
27
		$this->description =  esc_attr__( 'Approve and reject entries from the View.', 'gravityview' );
0 ignored issues
show
introduced by
Expected 1 space after "="; 2 found
Loading history...
28
29
		$this->add_hooks();
30
31
		parent::__construct();
32
	}
33
34
	/**
35
	 * Remove unused settings for the approval field
36
	 *
37
	 * @since 1.19
38
	 *
39
	 * @param array $field_options
40
	 * @param string $template_id
41
	 * @param string $field_id
42
	 * @param string $context
43
	 * @param string $input_type
44
	 *
45
	 * @return array
46
	 */
47
	function field_options( $field_options, $template_id = '', $field_id = '', $context = '', $input_type = '' ) {
0 ignored issues
show
Best Practice introduced by
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...
48
49
		unset( $field_options['only_loggedin'] );
50
51
		unset( $field_options['new_window'] );
52
53
		unset( $field_options['show_as_link'] );
54
55
		return $field_options;
56
	}
57
58
	/**
59
	 * Add filters and actions for the field
60
	 *
61
	 * @since 1.19
62
	 *
63
	 * @return void
64
	 */
65
	private function add_hooks() {
66
67
		add_filter( 'gravityview_entry_default_fields', array( $this, 'filter_gravityview_entry_default_field' ), 10, 3 );
68
69
		add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts_and_styles' ) );
70
71
		add_action( 'gravityview/field/approval/load_scripts', array( $this, 'enqueue_and_localize_script' ) );
72
73
		add_action( 'gravityview_datatables_scripts_styles',  array( $this, 'enqueue_and_localize_script' ) );
74
75
		add_filter( 'gravityview_get_entries', array( $this, 'modify_search_parameters' ), 1000 );
76
77
		add_filter( 'gravityview/field_output/html', array( $this, 'maybe_prevent_field_render' ), 10, 2 );
78
79
		add_filter( 'gravityview/field/is_visible', array( $this, 'maybe_not_visible' ), 10, 2 );
80
	}
81
82
	/**
83
	 * @filter `gravityview/template/field_label` Modify field label output
84
	 *
85
	 * @since 1.19
86
	 *
87
	 * @param string $html Existing HTML output
88
	 * @param array $args Arguments passed to the function
89
	 *
90
	 * @return string Empty string if user doesn't have the `gravityview_moderate_entries` cap; field HTML otherwise
91
	 */
92 30
	public function maybe_prevent_field_render( $html, $args ) {
93
94
		// If the field is `entry_approval` type but the user doesn't have the moderate entries cap, don't render.
95 30
		if( $this->name === \GV\Utils::get( $args['field'], 'id' ) && ! GVCommon::has_cap('gravityview_moderate_entries') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
96
			return '';
97
		}
98
99 30
		return $html;
100
	}
101
102
	/**
103
	 * Do not show this field if `gravityview_moderate_entries` capability is absent.
104
	 *
105
	 * @return boolean Whether this field is visible or not.
106
	 */
107 36
	public function maybe_not_visible( $visible, $field ) {
108 36
		if ( $this->name !== $field->ID ) {
109 36
			return $visible;
110
		}
111
112
		return GVCommon::has_cap( 'gravityview_moderate_entries' );
113
	}
114
115
	/**
116
	 * Modify search to use `is_approved` meta key to sort, instead of `entry_approval`
117
	 *
118
	 * @param array $parameters Search parameters used to generate GF search
119
	 *
120
	 * @return array Same parameters, but if sorting by `entry_approval`, changed to `is_approved`
121
	 */
122 55
	public function modify_search_parameters( $parameters ) {
123
124 55
		if ( $this->name === \GV\Utils::get( $parameters, 'sorting/key' ) ) {
125
			$parameters['sorting']['key'] = 'is_approved';
126
		}
127
128 55
		return $parameters;
129
	}
130
131
	/**
132
	 * Register the field approval script and style
133
	 *
134
	 * @since 1.19
135
	 *
136
	 * @return void
137
	 */
138
	function register_scripts_and_styles() {
0 ignored issues
show
Best Practice introduced by
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...
139
		$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
140
141
		wp_register_script( 'gravityview-field-approval', GRAVITYVIEW_URL . 'assets/js/field-approval'.$script_debug.'.js', array( 'jquery' ), GravityView_Plugin::version, true );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
142
143
		wp_register_script( 'gravityview-field-approval-popper', GRAVITYVIEW_URL . 'assets/lib/tippy/popper.min.js', array(), GravityView_Plugin::version, true );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
144
		wp_register_script( 'gravityview-field-approval-tippy', GRAVITYVIEW_URL . 'assets/lib/tippy/tippy.min.js', array(), GravityView_Plugin::version, true );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
145
		wp_register_style( 'gravityview-field-approval-tippy', GRAVITYVIEW_URL . 'assets/lib/tippy/tippy.css', array(), GravityView_Plugin::version, 'screen' );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
146
147
		$style_path = GRAVITYVIEW_DIR . 'templates/css/field-approval.css';
148
149
		if( class_exists( 'GravityView_View' ) ) {
150
			/**
151
			 * Override CSS file by placing in your theme's /gravityview/css/ sub-directory.
152
			 */
153
			$style_path = GravityView_View::getInstance()->locate_template( 'css/field-approval.css', false );
154
		}
155
156
		$style_url = plugins_url( 'css/field-approval.css', trailingslashit( dirname( $style_path ) )  );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 2 found
Loading history...
157
158
		/**
159
		 * @filter `gravityview/field/approval/css_url` URL to the Approval field CSS file.
160
		 * @since 1.19
161
		 * @param string $style_url Override to use your own CSS file, or return empty string to disable loading.
162
		 */
163
		$style_url = apply_filters( 'gravityview/field/approval/css_url', $style_url );
164
165
		if( ! empty( $style_url ) ) {
166
			wp_register_style( 'gravityview-field-approval', $style_url, array( 'dashicons' ), GravityView_Plugin::version, 'screen' );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
167
		}
168
169
		unset( $style_path, $style_url );
170
	}
171
172
	/**
173
	 * Register the field approval script and output the localized text JS variables
174
	 * @since 1.19
175
	 * @return void
176
	 */
177 1
	public function enqueue_and_localize_script() {
178
179
		// The script is already registered and enqueued
180 1
		if( wp_script_is( 'gravityview-field-approval', 'enqueued' ) ) {
181
			return;
182
		}
183
184 1
		wp_enqueue_style( 'gravityview-field-approval' );
185
186 1
		wp_enqueue_script( 'gravityview-field-approval' );
187 1
		wp_enqueue_script( 'gravityview-field-approval-tippy' );
188 1
		wp_enqueue_script( 'gravityview-field-approval-popper' );
189 1
		wp_enqueue_style( 'gravityview-field-approval-tippy' );
190
191 1
		wp_localize_script( 'gravityview-field-approval', 'gvApproval', array(
192 1
			'ajaxurl' => admin_url( 'admin-ajax.php' ),
193 1
			'nonce' => wp_create_nonce('gravityview_entry_approval'),
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
194 1
			'status' => GravityView_Entry_Approval_Status::get_all(),
195 1
			'status_popover_template' => GravityView_Entry_Approval::get_popover_template(),
196 1
			'status_popover_placement' => GravityView_Entry_Approval::get_popover_placement(),
197
		));
198
199 1
	}
200
201
	/**
202
	 * Add Fields to the field list
203
	 *
204
	 * @since 1.19
205
	 *
206
	 * @param array $entry_default_fields Array of fields shown by default
207
	 * @param string|array $form form_ID or form object
208
	 * @param string $context  Either 'single', 'directory', 'header', 'footer'
209
	 *
210
	 * @return array
211
	 */
212
	public function filter_gravityview_entry_default_field( $entry_default_fields, $form, $context ) {
213
214
		if ( ! isset( $entry_default_fields["{$this->name}"] ) && 'edit' !== $context ) {
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
215
			$entry_default_fields["{$this->name}"] = array(
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
216
				'label' => $this->label,
217
				'desc'  => $this->description,
218
				'type'  => $this->name,
219
			);
220
		}
221
222
		return $entry_default_fields;
223
	}
224
225
	/**
226
	 * Get the anchor text for a link, based on the current status
227
	 *
228
	 * @since 1.19
229
	 * @uses GravityView_Entry_Approval_Status::get_string()
230
	 *
231
	 * @param string $approved_status Status string or key
232
	 *
233
	 * @return false|string False if string doesn't exist, otherwise the "label" for the status
234
	 */
235 1
	public static function get_anchor_text( $approved_status = '' ) {
236 1
		return GravityView_Entry_Approval_Status::get_string( $approved_status, 'label' );
237
	}
238
239
	/**
240
	 * Get the title attribute for a link, based on the current status
241
	 *
242
	 * @since 1.19
243
	 * @uses GravityView_Entry_Approval_Status::get_string()
244
	 *
245
	 * @param int|string $approved_status Status string or key
246
	 *
247
	 * @return false|string
248
	 */
249 1
	public static function get_title_attr( $approved_status ) {
250 1
		return GravityView_Entry_Approval_Status::get_string( $approved_status, 'title' );
251
	}
252
253
	/**
254
	 * Get the CSS class for a link, based on the current status
255
	 *
256
	 * @param int|string $approved_status Status string or key
257
	 *
258
	 * @return string CSS class, sanitized using esc_attr()
259
	 */
260 1
	public static function get_css_class( $approved_status ) {
261
262 1
		$approved_key = GravityView_Entry_Approval_Status::get_key( $approved_status );
263
264 1
		return esc_attr( "gv-approval-{$approved_key}" );
265
	}
266
}
267
268
new GravityView_Field_Entry_Approval;
269