<?php

[0] Fix | Delete

namespace Elementor;

[1] Fix | Delete

[2] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[3] Fix | Delete

exit; // Exit if accessed directly.

[4] Fix | Delete

}

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Elementor group control base.

[8] Fix | Delete

*

[9] Fix | Delete

* An abstract class for creating new group controls in the panel.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.0.0

[12] Fix | Delete

* @abstract

[13] Fix | Delete

*/

[14] Fix | Delete

abstract class Group_Control_Base implements Group_Control_Interface {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Arguments.

[18] Fix | Delete

*

[19] Fix | Delete

* Holds all the group control arguments.

[20] Fix | Delete

*

[21] Fix | Delete

* @access private

[22] Fix | Delete

*

[23] Fix | Delete

* @var array Group control arguments.

[24] Fix | Delete

*/

[25] Fix | Delete

private $args = [];

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Options.

[29] Fix | Delete

*

[30] Fix | Delete

* Holds all the group control options.

[31] Fix | Delete

*

[32] Fix | Delete

* Currently supports only the popover options.

[33] Fix | Delete

*

[34] Fix | Delete

* @access private

[35] Fix | Delete

*

[36] Fix | Delete

* @var array Group control options.

[37] Fix | Delete

*/

[38] Fix | Delete

private $options;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Get options.

[42] Fix | Delete

*

[43] Fix | Delete

* Retrieve group control options. If options are not set, it will initialize default options.

[44] Fix | Delete

*

[45] Fix | Delete

* @since 1.9.0

[46] Fix | Delete

* @access public

[47] Fix | Delete

*

[48] Fix | Delete

* @param array $option Optional. Single option.

[49] Fix | Delete

*

[50] Fix | Delete

* @return mixed Group control options. If option parameter was not specified, it will

[51] Fix | Delete

* return an array of all the options. If single option specified, it will

[52] Fix | Delete

* return the option value or `null` if option does not exists.

[53] Fix | Delete

*/

[54] Fix | Delete

final public function get_options( $option = null ) {

[55] Fix | Delete

if ( null === $this->options ) {

[56] Fix | Delete

$this->init_options();

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

if ( $option ) {

[60] Fix | Delete

if ( isset( $this->options[ $option ] ) ) {

[61] Fix | Delete

return $this->options[ $option ];

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

return null;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

return $this->options;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Add new controls to stack.

[72] Fix | Delete

*

[73] Fix | Delete

* Register multiple controls to allow the user to set/update data.

[74] Fix | Delete

*

[75] Fix | Delete

* @since 1.0.0

[76] Fix | Delete

* @access public

[77] Fix | Delete

*

[78] Fix | Delete

* @param Controls_Stack $element The element stack.

[79] Fix | Delete

* @param array $user_args The control arguments defined by the user.

[80] Fix | Delete

* @param array $options Optional. The element options. Default is

[81] Fix | Delete

* an empty array.

[82] Fix | Delete

*/

[83] Fix | Delete

final public function add_controls( Controls_Stack $element, array $user_args, array $options = [] ) {

[84] Fix | Delete

$this->init_args( $user_args );

[85] Fix | Delete

[86] Fix | Delete

// Filter which controls to display

[87] Fix | Delete

$filtered_fields = $this->filter_fields();

[88] Fix | Delete

$filtered_fields = $this->prepare_fields( $filtered_fields );

[89] Fix | Delete

[90] Fix | Delete

// For php < 7

[91] Fix | Delete

reset( $filtered_fields );

[92] Fix | Delete

[93] Fix | Delete

if ( isset( $this->args['separator'] ) ) {

[94] Fix | Delete

$filtered_fields[ key( $filtered_fields ) ]['separator'] = $this->args['separator'];

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

$has_injection = false;

[98] Fix | Delete

[99] Fix | Delete

if ( ! empty( $options['position'] ) ) {

[100] Fix | Delete

$has_injection = true;

[101] Fix | Delete

[102] Fix | Delete

$element->start_injection( $options['position'] );

[103] Fix | Delete

[104] Fix | Delete

unset( $options['position'] );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

if ( $this->get_options( 'popover' ) ) {

[108] Fix | Delete

$this->start_popover( $element );

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

foreach ( $filtered_fields as $field_id => $field_args ) {

[112] Fix | Delete

// Add the global group args to the control

[113] Fix | Delete

$field_args = $this->add_group_args_to_field( $field_id, $field_args );

[114] Fix | Delete

[115] Fix | Delete

// Register the control

[116] Fix | Delete

$id = $this->get_controls_prefix() . $field_id;

[117] Fix | Delete

[118] Fix | Delete

if ( ! empty( $field_args['responsive'] ) ) {

[119] Fix | Delete

unset( $field_args['responsive'] );

[120] Fix | Delete

[121] Fix | Delete

$element->add_responsive_control( $id, $field_args, $options );

[122] Fix | Delete

} else {

[123] Fix | Delete

$element->add_control( $id, $field_args, $options );

[124] Fix | Delete

}

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

if ( $this->get_options( 'popover' ) ) {

[128] Fix | Delete

$element->end_popover();

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

if ( $has_injection ) {

[132] Fix | Delete

$element->end_injection();

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Get arguments.

[138] Fix | Delete

*

[139] Fix | Delete

* Retrieve group control arguments.

[140] Fix | Delete

*

[141] Fix | Delete

* @since 1.0.0

[142] Fix | Delete

* @access public

[143] Fix | Delete

*

[144] Fix | Delete

* @return array Group control arguments.

[145] Fix | Delete

*/

[146] Fix | Delete

final public function get_args() {

[147] Fix | Delete

return $this->args;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Get fields.

[152] Fix | Delete

*

[153] Fix | Delete

* Retrieve group control fields.

[154] Fix | Delete

*

[155] Fix | Delete

* @since 1.2.2

[156] Fix | Delete

* @access public

[157] Fix | Delete

*

[158] Fix | Delete

* @return array Control fields.

[159] Fix | Delete

*/

[160] Fix | Delete

final public function get_fields() {

[161] Fix | Delete

if ( null === static::$fields ) {

[162] Fix | Delete

static::$fields = $this->init_fields();

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

return static::$fields;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Get controls prefix.

[170] Fix | Delete

*

[171] Fix | Delete

* Retrieve the prefix of the group control, which is `{{ControlName}}_`.

[172] Fix | Delete

*

[173] Fix | Delete

* @since 1.0.0

[174] Fix | Delete

* @access public

[175] Fix | Delete

*

[176] Fix | Delete

* @return string Control prefix.

[177] Fix | Delete

*/

[178] Fix | Delete

public function get_controls_prefix() {

[179] Fix | Delete

return $this->args['name'] . '_';

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Get group control classes.

[184] Fix | Delete

*

[185] Fix | Delete

* Retrieve the classes of the group control.

[186] Fix | Delete

*

[187] Fix | Delete

* @since 1.0.0

[188] Fix | Delete

* @access public

[189] Fix | Delete

*

[190] Fix | Delete

* @return string Group control classes.

[191] Fix | Delete

*/

[192] Fix | Delete

public function get_base_group_classes() {

[193] Fix | Delete

return 'elementor-group-control-' . static::get_type() . ' elementor-group-control';

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Init fields.

[198] Fix | Delete

*

[199] Fix | Delete

* Initialize group control fields.

[200] Fix | Delete

*

[201] Fix | Delete

* @abstract

[202] Fix | Delete

* @since 1.2.2

[203] Fix | Delete

* @access protected

[204] Fix | Delete

*/

[205] Fix | Delete

abstract protected function init_fields();

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* Get default options.

[209] Fix | Delete

*

[210] Fix | Delete

* Retrieve the default options of the group control. Used to return the

[211] Fix | Delete

* default options while initializing the group control.

[212] Fix | Delete

*

[213] Fix | Delete

* @since 1.9.0

[214] Fix | Delete

* @access protected

[215] Fix | Delete

*

[216] Fix | Delete

* @return array Default group control options.

[217] Fix | Delete

*/

[218] Fix | Delete

protected function get_default_options() {

[219] Fix | Delete

return [];

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

/**

[223] Fix | Delete

* Get child default arguments.

[224] Fix | Delete

*

[225] Fix | Delete

* Retrieve the default arguments for all the child controls for a specific group

[226] Fix | Delete

* control.

[227] Fix | Delete

*

[228] Fix | Delete

* @since 1.2.2

[229] Fix | Delete

* @access protected

[230] Fix | Delete

*

[231] Fix | Delete

* @return array Default arguments for all the child controls.

[232] Fix | Delete

*/

[233] Fix | Delete

protected function get_child_default_args() {

[234] Fix | Delete

return [];

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

/**

[238] Fix | Delete

* Filter fields.

[239] Fix | Delete

*

[240] Fix | Delete

* Filter which controls to display, using `include`, `exclude` and the

[241] Fix | Delete

* `condition` arguments.

[242] Fix | Delete

*

[243] Fix | Delete

* @since 1.2.2

[244] Fix | Delete

* @access protected

[245] Fix | Delete

*

[246] Fix | Delete

* @return array Control fields.

[247] Fix | Delete

*/

[248] Fix | Delete

protected function filter_fields() {

[249] Fix | Delete

$args = $this->get_args();

[250] Fix | Delete

[251] Fix | Delete

$fields = $this->get_fields();

[252] Fix | Delete

[253] Fix | Delete

if ( ! empty( $args['include'] ) ) {

[254] Fix | Delete

$fields = array_intersect_key( $fields, array_flip( $args['include'] ) );

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

if ( ! empty( $args['exclude'] ) ) {

[258] Fix | Delete

$fields = array_diff_key( $fields, array_flip( $args['exclude'] ) );

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

return $fields;

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Add group arguments to field.

[266] Fix | Delete

*

[267] Fix | Delete

* Register field arguments to group control.

[268] Fix | Delete

*

[269] Fix | Delete

* @since 1.2.2

[270] Fix | Delete

* @access protected

[271] Fix | Delete

*

[272] Fix | Delete

* @param string $control_id Group control id.

[273] Fix | Delete

* @param array $field_args Group control field arguments.

[274] Fix | Delete

*

[275] Fix | Delete

* @return array

[276] Fix | Delete

*/

[277] Fix | Delete

protected function add_group_args_to_field( $control_id, $field_args ) {

[278] Fix | Delete

$args = $this->get_args();

[279] Fix | Delete

[280] Fix | Delete

if ( ! empty( $args['tab'] ) ) {

[281] Fix | Delete

$field_args['tab'] = $args['tab'];

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

if ( ! empty( $args['section'] ) ) {

[285] Fix | Delete

$field_args['section'] = $args['section'];

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

$field_args['classes'] = $this->get_base_group_classes() . ' elementor-group-control-' . $control_id;

[289] Fix | Delete

[290] Fix | Delete

foreach ( [ 'condition', 'conditions' ] as $condition_type ) {

[291] Fix | Delete

if ( ! empty( $args[ $condition_type ] ) ) {

[292] Fix | Delete

if ( empty( $field_args[ $condition_type ] ) ) {

[293] Fix | Delete

$field_args[ $condition_type ] = [];

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

$field_args[ $condition_type ] += $args[ $condition_type ];

[297] Fix | Delete

}

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

return $field_args;

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

/**

[304] Fix | Delete

* Prepare fields.

[305] Fix | Delete

*

[306] Fix | Delete

* Process group control fields before adding them to `add_control()`.

[307] Fix | Delete

*

[308] Fix | Delete

* @since 1.2.2

[309] Fix | Delete

* @access protected

[310] Fix | Delete

*

[311] Fix | Delete

* @param array $fields Group control fields.

[312] Fix | Delete

*

[313] Fix | Delete

* @return array Processed fields.

[314] Fix | Delete

*/

[315] Fix | Delete

protected function prepare_fields( $fields ) {

[316] Fix | Delete

$popover_options = $this->get_options( 'popover' );

[317] Fix | Delete

[318] Fix | Delete

$popover_name = ! $popover_options ? null : $popover_options['starter_name'];

[319] Fix | Delete

[320] Fix | Delete

foreach ( $fields as $field_key => &$field ) {

[321] Fix | Delete

if ( $popover_name ) {

[322] Fix | Delete

$field['condition'][ $popover_name . '!' ] = '';

[323] Fix | Delete

}

[324] Fix | Delete

[325] Fix | Delete

if ( isset( $this->args['fields_options']['__all'] ) ) {

[326] Fix | Delete

$field = array_merge( $field, $this->args['fields_options']['__all'] );

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

if ( isset( $this->args['fields_options'][ $field_key ] ) ) {

[330] Fix | Delete

$field = array_merge( $field, $this->args['fields_options'][ $field_key ] );

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

if ( ! empty( $field['condition'] ) ) {

[334] Fix | Delete

$field = $this->add_condition_prefix( $field );

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

if ( ! empty( $field['conditions'] ) ) {

[338] Fix | Delete

$field['conditions'] = $this->add_conditions_prefix( $field['conditions'] );

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

if ( ! empty( $field['selectors'] ) ) {

[342] Fix | Delete

$field['selectors'] = $this->handle_selectors( $field['selectors'] );

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete

if ( ! empty( $field['device_args'] ) ) {

[346] Fix | Delete

foreach ( $field['device_args'] as $device => $device_arg ) {

[347] Fix | Delete

if ( ! empty( $field['device_args'][ $device ]['condition'] ) ) {

[348] Fix | Delete

$field['device_args'][ $device ] = $this->add_condition_prefix( $field['device_args'][ $device ] );

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

if ( ! empty( $field['device_args'][ $device ]['conditions'] ) ) {

[352] Fix | Delete

$field['device_args'][ $device ]['conditions'] = $this->add_conditions_prefix( $field['device_args'][ $device ]['conditions'] );

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete

if ( ! empty( $device_arg['selectors'] ) ) {

[356] Fix | Delete

$field['device_args'][ $device ]['selectors'] = $this->handle_selectors( $device_arg['selectors'] );

[357] Fix | Delete

}

[358] Fix | Delete

}

[359] Fix | Delete

}

[360] Fix | Delete

}

[361] Fix | Delete

[362] Fix | Delete

return $fields;

[363] Fix | Delete

}

[364] Fix | Delete

[365] Fix | Delete

/**

[366] Fix | Delete

* Init options.

[367] Fix | Delete

*

[368] Fix | Delete

* Initializing group control options.

[369] Fix | Delete

*

[370] Fix | Delete

* @since 1.9.0

[371] Fix | Delete

* @access private

[372] Fix | Delete

*/

[373] Fix | Delete

private function init_options() {

[374] Fix | Delete

$default_options = [

[375] Fix | Delete

'popover' => [

[376] Fix | Delete

'starter_name' => 'popover_toggle',

[377] Fix | Delete

'starter_value' => 'custom',

[378] Fix | Delete

'starter_title' => '',

[379] Fix | Delete

],

[380] Fix | Delete

];

[381] Fix | Delete

[382] Fix | Delete

$this->options = array_replace_recursive( $default_options, $this->get_default_options() );

[383] Fix | Delete

}

[384] Fix | Delete

[385] Fix | Delete

/**

[386] Fix | Delete

* Init arguments.

[387] Fix | Delete

*

[388] Fix | Delete

* Initializing group control base class.

[389] Fix | Delete

*

[390] Fix | Delete

* @since 1.2.2

[391] Fix | Delete

* @access protected

[392] Fix | Delete

*

[393] Fix | Delete

* @param array $args Group control settings value.

[394] Fix | Delete

*/

[395] Fix | Delete

protected function init_args( $args ) {

[396] Fix | Delete

$this->args = array_merge( $this->get_default_args(), $this->get_child_default_args(), $args );

[397] Fix | Delete

[398] Fix | Delete

if ( isset( $this->args['scheme'] ) ) {

[399] Fix | Delete

$this->args['global']['default'] = Plugin::$instance->kits_manager->convert_scheme_to_global( $this->args['scheme'] );

[400] Fix | Delete

}

[401] Fix | Delete

}

[402] Fix | Delete

[403] Fix | Delete

/**

[404] Fix | Delete

* Get default arguments.

[405] Fix | Delete

*

[406] Fix | Delete

* Retrieve the default arguments of the group control. Used to return the

[407] Fix | Delete

* default arguments while initializing the group control.

[408] Fix | Delete

*

[409] Fix | Delete

* @since 1.2.2

[410] Fix | Delete

* @access private

[411] Fix | Delete

*

[412] Fix | Delete

* @return array Control default arguments.

[413] Fix | Delete

*/

[414] Fix | Delete

private function get_default_args() {

[415] Fix | Delete

return [

[416] Fix | Delete

'default' => '',

[417] Fix | Delete

'selector' => '{{WRAPPER}}',

[418] Fix | Delete

'fields_options' => [],

[419] Fix | Delete

];

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

/**

[423] Fix | Delete

* Add condition prefix.

[424] Fix | Delete

*

[425] Fix | Delete

* Used to add the group prefix to controls with conditions, to

[426] Fix | Delete

* distinguish them from other controls with the same name.

[427] Fix | Delete

*

[428] Fix | Delete

* This way Elementor can apply condition logic to a specific control in a

[429] Fix | Delete

* group control.

[430] Fix | Delete

*

[431] Fix | Delete

* @since 1.2.0

[432] Fix | Delete

* @access private

[433] Fix | Delete

*

[434] Fix | Delete

* @param array $field Group control field.

[435] Fix | Delete

*

[436] Fix | Delete

* @return array Group control field.

[437] Fix | Delete

*/

[438] Fix | Delete

private function add_condition_prefix( $field ) {

[439] Fix | Delete

$controls_prefix = $this->get_controls_prefix();

[440] Fix | Delete

[441] Fix | Delete

$prefixed_condition_keys = array_map(

[442] Fix | Delete

function( $key ) use ( $controls_prefix ) {

[443] Fix | Delete

return $controls_prefix . $key;

[444] Fix | Delete

},

[445] Fix | Delete

array_keys( $field['condition'] )

[446] Fix | Delete

);

[447] Fix | Delete

[448] Fix | Delete

$field['condition'] = array_combine(

[449] Fix | Delete

$prefixed_condition_keys,

[450] Fix | Delete

$field['condition']

[451] Fix | Delete

);

[452] Fix | Delete

[453] Fix | Delete

return $field;

[454] Fix | Delete

}

[455] Fix | Delete

[456] Fix | Delete

private function add_conditions_prefix( $conditions ) {

[457] Fix | Delete

$controls_prefix = $this->get_controls_prefix();

[458] Fix | Delete

[459] Fix | Delete

foreach ( $conditions['terms'] as & $condition ) {

[460] Fix | Delete

if ( isset( $condition['terms'] ) ) {

[461] Fix | Delete

$condition = $this->add_conditions_prefix( $condition );

[462] Fix | Delete

[463] Fix | Delete

continue;

[464] Fix | Delete

}

[465] Fix | Delete

[466] Fix | Delete

$condition['name'] = $controls_prefix . $condition['name'];

[467] Fix | Delete

}

[468] Fix | Delete

[469] Fix | Delete

return $conditions;

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

/**

[473] Fix | Delete

* Handle selectors.

[474] Fix | Delete

*

[475] Fix | Delete

* Used to process the CSS selector of group control fields. When using

[476] Fix | Delete

* group control, Elementor needs to apply the selector to different fields.

[477] Fix | Delete

* This method handles the process.

[478] Fix | Delete

*

[479] Fix | Delete

* In addition, it handles selector values from other fields and process the

[480] Fix | Delete

* css.

[481] Fix | Delete

*

[482] Fix | Delete

* @since 1.2.2

[483] Fix | Delete

* @access private

[484] Fix | Delete

*

[485] Fix | Delete

* @param array $selectors An array of selectors to process.

[486] Fix | Delete

*

[487] Fix | Delete

* @return array Processed selectors.

[488] Fix | Delete

*/

[489] Fix | Delete

private function handle_selectors( $selectors ) {

[490] Fix | Delete

$args = $this->get_args();

[491] Fix | Delete

[492] Fix | Delete

$selectors = array_combine(

[493] Fix | Delete

array_map(

[494] Fix | Delete

function( $key ) use ( $args ) {

[495] Fix | Delete

return str_replace( '{{SELECTOR}}', $args['selector'], $key );

[496] Fix | Delete

}, array_keys( $selectors )

[497] Fix | Delete

),

[498] Fix | Delete

$selectors

[499] Fix | Delete