Checkbox.php
6.42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?php if ( ! defined( 'ABSPATH' ) ) exit;
/**
* Class NF_Fields_Checkbox
*/
class NF_Fields_Checkbox extends NF_Abstracts_Input
{
protected $_name = 'checkbox';
protected $_nicename = 'Checkbox';
protected $_section = 'common';
protected $_icon = 'check-square-o';
protected $_type = 'checkbox';
protected $_templates = 'checkbox';
protected $_test_value = 0;
protected $_settings = array( 'checkbox_default_value', 'checkbox_values', 'checked_calc_value', 'unchecked_calc_value' );
protected $_settings_exclude = array( 'default', 'placeholder', 'input_limit_set' );
/**
* NF_Fields_Checkbox constructor.
* @since 3.0
*/
public function __construct()
{
parent::__construct();
$this->_nicename = esc_html__( 'Single Checkbox', 'ninja-forms' );
$this->_settings[ 'label_pos' ][ 'value' ] = 'right';
add_filter( 'ninja_forms_custom_columns', array( $this, 'custom_columns' ), 10, 2 );
add_filter( 'ninja_forms_merge_tag_value_' . $this->_name, array( $this, 'filter_merge_tag_value' ), 10, 2 );
add_filter( 'ninja_forms_merge_tag_calc_value_' . $this->_name, array( $this, 'filter_merge_tag_value_calc' ), 10, 2 );
add_filter( 'ninja_forms_subs_export_field_value_' . $this->_type, array( $this, 'export_value' ), 10, 2 );
}
/**
* Admin Form Element
* Display the checkbox on the edit submissions area.
* @since 3.0
*
* @param $id Field ID.
* @param $value Field value.
* @return string HTML used for display of checkbox.
*/
public function admin_form_element( $id, $value )
{
// If the checkboxes value is 1 or on...
if( 'on' == $value || 1 == $value ) {
// ...this variable to checked.
$checked = 'checked';
} else {
// ...else leave the variable empty.
$checked = '';
}
// Return HTML to be output to the submission edit page.
return "<input type='hidden' name='fields[$id]' value='0' >
<input type='checkbox' name='fields[$id]' id='' $checked>";
}
/**
* Custom Columns
* Creates what is displayed in the columns on the submissions page.
* @since 3.0
*nf_subs_export_pre_value
* @param $value checkbox value
* @param $field field model.
* @return $value string|void
*/
public function custom_columns( $value, $field )
{
// If the field type is equal to checkbox...
if( 'checkbox' == $field->get_setting( 'type' ) ) {
// Backwards compatibility check for the new checked value setting.
if( null == $field->get_setting( 'checked_value' ) && 1 == $value || 'on' == $value ) {
return esc_html__( 'Checked', 'ninja-forms' );
} elseif( null == $field->get_setting( 'unchecked_value' ) && 0 == $value ) {
return esc_html__( 'Unchecked', 'ninja-forms');
}
// If the field value is set to 1....
if( 1 == $value || 'on' == $value ) {
// Set the value to the checked value setting.
$value = $field->get_setting( 'checked_value' );
}
// Unless we've somehow gotten the display value in here...
elseif ( $field->get_setting( 'checked_value' ) != $value ) {
// Set the value to the unchecked value setting.
$value = $field->get_setting( 'unchecked_value' );
}
}
return $value;
}
/**
* Filter Merge Tag Value
* This is what provides the merge tag with the fields value.
* @since 3.0
*
* @param $value Field value
* @param $field field model
* @return string|void
*/
public function filter_merge_tag_value( $value, $field )
{
// If value is true, return checked value setting.
if( $value ) return $field[ 'settings' ][ 'checked_value' ];
// Else return unchecked value setting.
return $field[ 'settings' ][ 'unchecked_value' ];;
}
/**
* Filter Merge Tag Value Calc
* Provides the calculation value when the merge tag is used.
* @since 3.0
*
* @param $value checkbox value
* @param $field field model
* @return $field
*/
public function filter_merge_tag_value_calc( $value, $field )
{
// If value is equal to 1...
if ( 1 == $value ) {
// ...return the checked calc value of the field model.
return $field[ 'checked_calc_value' ];
} else {
// ...else return the unchecked calc value of the field model.
return $field[ 'unchecked_calc_value' ];
}
}
/**
* Export Value
* Determines the value to send to submission export.
* @since 3.0
*
* @param $value checkbox field value
* @param $field checkbox field model
* @return string|void
*/
public function export_value( $value, $field )
{
// @TODO: Why were these values translated in the first place?
// If value is equal to checked or unchecked return the value
if ( __( 'checked', 'ninja-forms' ) == $value ||
__( 'unchecked', 'ninja-forms' ) == $value ) return $value;
// Creating settings variables for our check.
if( is_array( $field ) ) {
// The email action sends teh field variable as an array
$checked_setting = $field[ 'setting' ][ 'checked_value' ];
$unchecked_setting = $field[ 'setting' ][ 'unchecked_value' ];
} else {
$checked_setting = $field->get_setting( 'checked_value' );
$unchecked_setting = $field->get_setting( 'unchecked_value' );
}
// If the the value and check to see if we have checked and unchecked settings...
if ( ( 1 == $value || 'on' == $value ) && ! empty( $checked_setting ) ) {
// ...if we do return checked setting
return $checked_setting;
} elseif ( 0 == $value && ! empty( $unchecked_setting ) ) {
// ...else return unchecked setting.
return $unchecked_setting;
/*
* These checks are for checkbox fields that were created before version 3.2.7.
*/
} elseif ( 1 == $value || 'on' == $value ) {
return esc_html__( 'checked', 'ninja-forms' );
} elseif ( 0 == $value ) {
return esc_html__( 'unchecked', 'ninja-forms' );
}
}
}