Completed
Push — develop ( f984d3...38967a )
by Aristeides
02:55
created

Kirki_Control_Typography::content_template()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 149
Code Lines 30

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 30
nc 1
nop 0
dl 0
loc 149
rs 8.2857
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * Customizer Control: typography.
4
 *
5
 * @package     Kirki
6
 * @subpackage  Controls
7
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
8
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
9
 * @since       2.0
10
 */
11
12
// Exit if accessed directly.
13
if ( ! defined( 'ABSPATH' ) ) {
14
	exit;
15
}
16
17
/**
18
 * Typography control.
19
 */
20
class Kirki_Control_Typography extends WP_Customize_Control {
21
22
	/**
23
	 * The control type.
24
	 *
25
	 * @access public
26
	 * @var string
27
	 */
28
	public $type = 'kirki-typography';
29
30
	/**
31
	 * Used to automatically generate all CSS output.
32
	 *
33
	 * @access public
34
	 * @var array
35
	 */
36
	public $output = array();
37
38
	/**
39
	 * Data type
40
	 *
41
	 * @access public
42
	 * @var string
43
	 */
44
	public $option_type = 'theme_mod';
45
46
	/**
47
	 * The kirki_config we're using for this control
48
	 *
49
	 * @access public
50
	 * @var string
51
	 */
52
	public $kirki_config = 'global';
53
54
	/**
55
	 * Constructor.
56
	 *
57
	 * Supplied `$args` override class property defaults.
58
	 *
59
	 * If `$args['settings']` is not defined, use the $id as the setting ID.
60
	 *
61
	 * @since 3.0.0
62
	 *
63
	 * @param WP_Customize_Manager $manager Customizer bootstrap instance.
64
	 * @param string               $id      Control ID.
65
	 * @param array                $args    {
66
	 *     Optional. Arguments to override class property defaults.
67
	 *
68
	 *     @type int                  $instance_number Order in which this instance was created in relation
69
	 *                                                 to other instances.
70
	 *     @type WP_Customize_Manager $manager         Customizer bootstrap instance.
71
	 *     @type string               $id              Control ID.
72
	 *     @type array                $settings        All settings tied to the control. If undefined, `$id` will
73
	 *                                                 be used.
74
	 *     @type string               $setting         The primary setting for the control (if there is one).
75
	 *                                                 Default 'default'.
76
	 *     @type int                  $priority        Order priority to load the control. Default 10.
77
	 *     @type string               $section         Section the control belongs to. Default empty.
78
	 *     @type string               $label           Label for the control. Default empty.
79
	 *     @type string               $description     Description for the control. Default empty.
80
	 *     @type array                $choices         List of choices for 'radio' or 'select' type controls, where
81
	 *                                                 values are the keys, and labels are the values.
82
	 *                                                 Default empty array.
83
	 *     @type array                $input_attrs     List of custom input attributes for control output, where
84
	 *                                                 attribute names are the keys and values are the values. Not
85
	 *                                                 used for 'checkbox', 'radio', 'select', 'textarea', or
86
	 *                                                 'dropdown-pages' control types. Default empty array.
87
	 *     @type array                $json            Deprecated. Use WP_Customize_Control::json() instead.
88
	 *     @type string               $type            Control type. Core controls include 'text', 'checkbox',
89
	 *                                                 'textarea', 'radio', 'select', and 'dropdown-pages'. Additional
90
	 *                                                 input types such as 'email', 'url', 'number', 'hidden', and
91
	 *                                                 'date' are supported implicitly. Default 'text'.
92
	 * }
93
	 */
94
	public function __construct( $manager, $id, $args = array() ) {
95
96
		parent::__construct( $manager, $id, $args );
97
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_scripts' ), 999 );
98
99
	}
100
101
	/**
102
	 * Enqueue control related scripts/styles.
103
	 *
104
	 * @access public
105
	 */
106
	public function enqueue_scripts() {
107
108
		wp_enqueue_script( 'wp-color-picker-alpha', trailingslashit( Kirki::$url ) . 'assets/vendor/wp-color-picker-alpha/wp-color-picker-alpha.js', array( 'wp-color-picker' ), '1.2', true );
109
		wp_enqueue_style( 'wp-color-picker' );
110
111
		wp_enqueue_script( 'kirki-typography', trailingslashit( Kirki::$url ) . 'controls/typography/typography.js', array( 'jquery', 'customize-base', 'select2', 'wp-color-picker-alpha' ), false, true );
112
		wp_enqueue_style( 'kirki-typography-css', trailingslashit( Kirki::$url ) . 'controls/typography/typography.css', null );
113
114
		wp_enqueue_script( 'select2', trailingslashit( Kirki::$url ) . 'assets/vendor/select2/js/select2.full.js', array( 'jquery' ), '4.0.3', true );
115
		wp_enqueue_style( 'select2', trailingslashit( Kirki::$url ) . 'assets/vendor/select2/css/select2.css', array(), '4.0.3' );
116
		wp_enqueue_style( 'kirki-select2', trailingslashit( Kirki::$url ) . 'assets/vendor/select2/kirki.css', null );
117
118
		$custom_fonts_array  = ( isset( $this->choices['fonts'] ) && ( isset( $this->choices['fonts']['google'] ) || isset( $this->choices['fonts']['standard'] ) ) && ( ! empty( $this->choices['fonts']['google'] ) || ! empty( $this->choices['fonts']['standard'] ) ) );
119
		$localize_script_var = ( $custom_fonts_array ) ? 'kirkiFonts' . $this->id : 'kirkiAllFonts';
120
		wp_localize_script( 'kirki-typography', $localize_script_var, array(
121
			'standard' => $this->get_standard_fonts(),
122
			'google'   => $this->get_google_fonts(),
123
		) );
124
	}
125
126
	/**
127
	 * Refresh the parameters passed to the JavaScript via JSON.
128
	 *
129
	 * @see WP_Customize_Control::to_json()
130
	 */
131
	public function to_json() {
132
		parent::to_json();
133
134
		$this->json['default'] = $this->setting->default;
135
		if ( isset( $this->default ) ) {
136
			$this->json['default'] = $this->default;
137
		}
138
		$this->json['output']  = $this->output;
139
		$this->json['value']   = Kirki_Field_Typography::sanitize( $this->value() );
140
		$this->json['choices'] = $this->choices;
141
		$this->json['link']    = $this->get_link();
142
		$this->json['id']      = $this->id;
143
144
		$this->json['inputAttrs'] = '';
145
		foreach ( $this->input_attrs as $attr => $value ) {
146
			$this->json['inputAttrs'] .= $attr . '="' . esc_attr( $value ) . '" ';
147
		}
148
149
		$defaults = array(
150
			'font-family'    => false,
151
			'font-size'      => false,
152
			'variant'        => false,
153
			'line-height'    => false,
154
			'letter-spacing' => false,
155
			'word-spacing'   => false,
156
			'color'          => false,
157
			'text-align'     => false,
158
		);
159
		$this->json['default'] = wp_parse_args( $this->json['default'], $defaults );
160
161
		// Fix for https://github.com/aristath/kirki/issues/1405.
162
		foreach ( $this->json['value'] as $key => $val ) {
163
			if ( isset( $this->json['default'][ $key ] ) && false === $this->json['default'][ $key ] ) {
164
				unset( $this->json['value'][ $key ] );
165
			}
166
		}
167
		$this->json['show_variants'] = ( true === Kirki_Fonts_Google::$force_load_all_variants ) ? false : true;
168
		$this->json['show_subsets']  = ( true === Kirki_Fonts_Google::$force_load_all_subsets ) ? false : true;
169
		$this->json['languages']     = Kirki_Fonts::get_google_font_subsets();
170
	}
171
172
	/**
173
	 * An Underscore (JS) template for this control's content (but not its container).
174
	 *
175
	 * Class variables for this control class are available in the `data` JS object;
176
	 * export custom variables by overriding {@see WP_Customize_Control::to_json()}.
177
	 *
178
	 * @see WP_Customize_Control::print_template()
179
	 *
180
	 * @access protected
181
	 */
182
	protected function content_template() {
183
		?>
184
		<div class="kirki-controls-loading-spinner"><div class="bounce1"></div><div class="bounce2"></div><div class="bounce3"></div></div>
185
		<label class="customizer-text">
186
			<# if ( data.label ) { #><span class="customize-control-title">{{{ data.label }}}</span><# } #>
187
			<# if ( data.description ) { #><span class="description customize-control-description">{{{ data.description }}}</span><# } #>
188
		</label>
189
190
		<div class="wrapper">
191
192
			<# if ( data.default['font-family'] ) { #>
193
				<# if ( '' == data.value['font-family'] ) { data.value['font-family'] = data.default['font-family']; } #>
194
				<# if ( data.choices['fonts'] ) { data.fonts = data.choices['fonts']; } #>
195
				<div class="font-family">
196
					<h5><?php esc_attr_e( 'Font Family', 'kirki' ); ?></h5>
197
					<select {{{ data.inputAttrs }}} id="kirki-typography-font-family-{{{ data.id }}}" placeholder="<?php esc_attr_e( 'Select Font Family', 'kirki' ); ?>"></select>
198
				</div>
199
				<# if ( ! _.isUndefined( data.choices['font-backup'] ) && true === data.choices['font-backup'] ) { #>
200
					<div class="font-backup hide-on-standard-fonts kirki-font-backup-wrapper">
201
						<h5><?php esc_attr_e( 'Backup Font', 'kirki' ); ?></h5>
202
						<select {{{ data.inputAttrs }}} id="kirki-typography-font-backup-{{{ data.id }}}" placeholder="<?php esc_attr_e( 'Select Font Family', 'kirki' ); ?>"></select>
203
					</div>
204
				<# } #>
205
				<# if ( true === data.show_variants || false !== data.default.variant ) { #>
206
					<div class="variant kirki-variant-wrapper">
207
						<h5><?php esc_attr_e( 'Variant', 'kirki' ); ?></h5>
208
						<select {{{ data.inputAttrs }}} class="variant" id="kirki-typography-variant-{{{ data.id }}}"></select>
209
					</div>
210
				<# } #>
211
				<# if ( true === data.show_subsets ) { #>
212
					<div class="subsets hide-on-standard-fonts kirki-subsets-wrapper">
213
						<h5><?php esc_attr_e( 'Subset(s)', 'kirki' ); ?></h5>
214
						<select {{{ data.inputAttrs }}} class="subset" id="kirki-typography-subsets-{{{ data.id }}}"<# if ( _.isUndefined( data.choices['disable-multiple-variants'] ) || false === data.choices['disable-multiple-variants'] ) { #> multiple<# } #>>
215
							<# _.each( data.value.subsets, function( subset ) { #>
216
								<option value="{{ subset }}" selected="selected">{{ data.languages[ subset ] }}</option>
217
							<# } ); #>
218
						</select>
219
					</div>
220
				<# } #>
221
			<# } #>
222
223
			<# if ( data.default['font-size'] ) { #>
224
				<div class="font-size">
225
					<h5><?php esc_attr_e( 'Font Size', 'kirki' ); ?></h5>
226
					<input {{{ data.inputAttrs }}} type="text" value="{{ data.value['font-size'] }}"/>
227
				</div>
228
			<# } #>
229
230
			<# if ( data.default['line-height'] ) { #>
231
				<div class="line-height">
232
					<h5><?php esc_attr_e( 'Line Height', 'kirki' ); ?></h5>
233
					<input {{{ data.inputAttrs }}} type="text" value="{{ data.value['line-height'] }}"/>
234
				</div>
235
			<# } #>
236
237
			<# if ( data.default['letter-spacing'] ) { #>
238
				<div class="letter-spacing">
239
					<h5><?php esc_attr_e( 'Letter Spacing', 'kirki' ); ?></h5>
240
					<input {{{ data.inputAttrs }}} type="text" value="{{ data.value['letter-spacing'] }}"/>
241
				</div>
242
			<# } #>
243
244
			<# if ( data.default['word-spacing'] ) { #>
245
				<div class="word-spacing">
246
					<h5><?php esc_attr_e( 'Word Spacing', 'kirki' ); ?></h5>
247
					<input {{{ data.inputAttrs }}} type="text" value="{{ data.value['word-spacing'] }}"/>
248
				</div>
249
			<# } #>
250
251
			<# if ( data.default['text-align'] ) { #>
252
				<div class="text-align">
253
					<h5><?php esc_attr_e( 'Text Align', 'kirki' ); ?></h5>
254
					<input {{{ data.inputAttrs }}} type="radio" value="inherit" name="_customize-typography-text-align-radio-{{ data.id }}" id="{{ data.id }}-text-align-inherit" <# if ( data.value['text-align'] === 'inherit' ) { #> checked="checked"<# } #>>
255
						<label for="{{ data.id }}-text-align-inherit">
256
							<span class="dashicons dashicons-editor-removeformatting"></span>
257
							<span class="screen-reader-text"><?php esc_attr_e( 'Inherit', 'kirki' ); ?></span>
258
						</label>
259
					</input>
260
					<input {{{ data.inputAttrs }}} type="radio" value="left" name="_customize-typography-text-align-radio-{{ data.id }}" id="{{ data.id }}-text-align-left" <# if ( data.value['text-align'] === 'left' ) { #> checked="checked"<# } #>>
261
						<label for="{{ data.id }}-text-align-left">
262
							<span class="dashicons dashicons-editor-alignleft"></span>
263
							<span class="screen-reader-text"><?php esc_attr_e( 'Left', 'kirki' ); ?></span>
264
						</label>
265
					</input>
266
					<input {{{ data.inputAttrs }}} type="radio" value="center" name="_customize-typography-text-align-radio-{{ data.id }}" id="{{ data.id }}-text-align-center" <# if ( data.value['text-align'] === 'center' ) { #> checked="checked"<# } #>>
267
						<label for="{{ data.id }}-text-align-center">
268
							<span class="dashicons dashicons-editor-aligncenter"></span>
269
							<span class="screen-reader-text"><?php esc_attr_e( 'Center', 'kirki' ); ?></span>
270
						</label>
271
					</input>
272
					<input {{{ data.inputAttrs }}} type="radio" value="right" name="_customize-typography-text-align-radio-{{ data.id }}" id="{{ data.id }}-text-align-right" <# if ( data.value['text-align'] === 'right' ) { #> checked="checked"<# } #>>
273
						<label for="{{ data.id }}-text-align-right">
274
							<span class="dashicons dashicons-editor-alignright"></span>
275
							<span class="screen-reader-text"><?php esc_attr_e( 'Right', 'kirki' ); ?></span>
276
						</label>
277
					</input>
278
					<input {{{ data.inputAttrs }}} type="radio" value="justify" name="_customize-typography-text-align-radio-{{ data.id }}" id="{{ data.id }}-text-align-justify" <# if ( data.value['text-align'] === 'justify' ) { #> checked="checked"<# } #>>
279
						<label for="{{ data.id }}-text-align-justify">
280
							<span class="dashicons dashicons-editor-justify"></span>
281
							<span class="screen-reader-text"><?php esc_attr_e( 'Justify', 'kirki' ); ?></span>
282
						</label>
283
					</input>
284
				</div>
285
			<# } #>
286
287
			<# if ( data.default['text-transform'] ) { #>
288
				<div class="text-transform">
289
					<h5><?php esc_attr_e( 'Text Transform', 'kirki' ); ?></h5>
290
					<select {{{ data.inputAttrs }}} id="kirki-typography-text-transform-{{{ data.id }}}">
291
						<option value="none"<# if ( 'none' === data.value['text-transform'] ) { #>selected<# } #>><?php esc_attr_e( 'None', 'kirki' ); ?></option>
292
						<option value="capitalize"<# if ( 'capitalize' === data.value['text-transform'] ) { #>selected<# } #>><?php esc_attr_e( 'Capitalize', 'kirki' ); ?></option>
293
						<option value="uppercase"<# if ( 'uppercase' === data.value['text-transform'] ) { #>selected<# } #>><?php esc_attr_e( 'Uppercase', 'kirki' ); ?></option>
294
						<option value="lowercase"<# if ( 'lowercase' === data.value['text-transform'] ) { #>selected<# } #>><?php esc_attr_e( 'Lowercase', 'kirki' ); ?></option>
295
						<option value="initial"<# if ( 'initial' === data.value['text-transform'] ) { #>selected<# } #>><?php esc_attr_e( 'Initial', 'kirki' ); ?></option>
296
						<option value="inherit"<# if ( 'inherit' === data.value['text-transform'] ) { #>selected<# } #>><?php esc_attr_e( 'Inherit', 'kirki' ); ?></option>
297
					</select>
298
				</div>
299
			<# } #>
300
301
			<# if ( false !== data.default['color'] && data.default['color'] ) { #>
302
				<div class="color">
303
					<h5><?php esc_attr_e( 'Color', 'kirki' ); ?></h5>
304
					<input {{{ data.inputAttrs }}} type="text" data-palette="{{ data.palette }}" data-default-color="{{ data.default['color'] }}" value="{{ data.value['color'] }}" class="kirki-color-control" {{{ data.link }}} />
305
				</div>
306
			<# } #>
307
308
			<# if ( data.default['margin-top'] ) { #>
309
				<div class="margin-top">
310
					<h5><?php esc_attr_e( 'Margin Top', 'kirki' ); ?></h5>
311
					<input {{{ data.inputAttrs }}} type="text" value="{{ data.value['margin-top'] }}"/>
312
				</div>
313
			<# } #>
314
315
			<# if ( data.default['margin-bottom'] ) { #>
316
				<div class="margin-bottom">
317
					<h5><?php esc_attr_e( 'Margin Bottom', 'kirki' ); ?></h5>
318
					<input {{{ data.inputAttrs }}} type="text" value="{{ data.value['margin-bottom'] }}"/>
319
				</div>
320
			<# } #>
321
		</div>
322
		<#
323
		if ( ! _.isUndefined( data.value['font-family'] ) ) {
324
			data.value['font-family'] = data.value['font-family'].replace( /&quot;/g, '&#39' );
325
		}
326
		valueJSON = JSON.stringify( data.value ).replace( /'/g, '&#39' );
327
		#>
328
		<input class="typography-hidden-value" type="hidden" value='{{{ valueJSON }}}' {{{ data.link }}}>
329
		<?php
330
	}
331
332
	/**
333
	 * Formats variants.
334
	 *
335
	 * @access protected
336
	 * @since 3.0.0
337
	 * @param array $variants The variants.
338
	 * @return array
339
	 */
340
	protected function format_variants_array( $variants ) {
341
342
		$all_variants = Kirki_Fonts::get_all_variants();
343
		$final_variants = array();
344
		foreach ( $variants as $variant ) {
345
			if ( is_string( $variant ) ) {
346
				$final_variants[] = array(
347
					'id'    => $variant,
348
					'label' => isset( $all_variants[ $variant ] ) ? $all_variants[ $variant ] : $variant,
349
				);
350
			} elseif ( is_array( $variant ) && isset( $variant['id'] ) && isset( $variant['label'] ) ) {
351
				$final_variants[] = $variant;
352
			}
353
		}
354
		return $final_variants;
355
	}
356
357
	/**
358
	 * Gets standard fonts properly formatted for our control.
359
	 *
360
	 * @access protected
361
	 * @since 3.0.0
362
	 * @return array
363
	 */
364
	protected function get_standard_fonts() {
365
		// Add fonts to our JS objects.
366
		$standard_fonts = Kirki_Fonts::get_standard_fonts();
367
368
		$std_user_keys = $this->choices['fonts']['standard'];
369
370
		$standard_fonts_final = array();
371
		$default_variants = $this->format_variants_array( array(
372
			'regular',
373
			'italic',
374
			'700',
375
			'700italic',
376
		) );
377
		foreach ( $standard_fonts as $key => $font ) {
378
			if ( ( ! empty( $std_user_keys ) && ! in_array( $key, $std_user_keys, true ) ) || ! isset( $font['stack'] ) || ! isset( $font['label'] ) ) {
379
				continue;
380
			}
381
			$standard_fonts_final[] = array(
382
				'family'      => $font['stack'],
383
				'label'       => $font['label'],
384
				'subsets'     => array(),
385
				'is_standard' => true,
386
				'variants'    => ( isset( $font['variants'] ) ) ? $this->format_variants_array( $font['variants'] ) : $default_variants,
387
			);
388
		}
389
		return $standard_fonts_final;
390
	}
391
392
	/**
393
	 * Gets google fonts properly formatted for our control.
394
	 *
395
	 * @access protected
396
	 * @since 3.0.0
397
	 * @return array
398
	 */
399
	protected function get_google_fonts() {
400
		// Add fonts to our JS objects.
401
		$google_fonts = Kirki_Fonts::get_google_fonts();
402
		$all_variants = Kirki_Fonts::get_all_variants();
403
		$all_subsets  = Kirki_Fonts::get_google_font_subsets();
404
405
		$gf_user_keys = $this->choices['fonts']['google'];
406
407
		$google_fonts_final = array();
408
		foreach ( $google_fonts as $family => $args ) {
409
			if ( ! empty( $gf_user_keys ) && ! in_array( $family, $gf_user_keys, true ) ) {
410
				continue;
411
			}
412
413
			$label    = ( isset( $args['label'] ) ) ? $args['label'] : $family;
414
			$variants = ( isset( $args['variants'] ) ) ? $args['variants'] : array( 'regular', '700' );
415
			$subsets  = ( isset( $args['subsets'] ) ) ? $args['subsets'] : array();
416
417
			$available_variants = array();
418
			if ( is_array( $variants ) ) {
419
				foreach ( $variants as $variant ) {
420
					if ( array_key_exists( $variant, $all_variants ) ) {
421
						$available_variants[] = array(
422
							'id' => $variant,
423
							'label' => $all_variants[ $variant ],
424
						);
425
					}
426
				}
427
			}
428
429
			$available_subsets = array();
430
			if ( is_array( $subsets ) ) {
431
				foreach ( $subsets as $subset ) {
432
					if ( array_key_exists( $subset, $all_subsets ) ) {
433
						$available_subsets[] = array(
434
							'id' => $subset,
435
							'label' => $all_subsets[ $subset ],
436
						);
437
					}
438
				}
439
			}
440
441
			$google_fonts_final[] = array(
442
				'family'       => $family,
443
				'label'        => $label,
444
				'variants'     => $available_variants,
445
				'subsets'      => $available_subsets,
446
			);
447
		} // End foreach().
448
		return $google_fonts_final;
449
	}
450
451
	/**
452
	 * Render the control's content.
453
	 *
454
	 * @see WP_Customize_Control::render_content()
455
	 */
456
	protected function render_content() {}
457
}
458