2018-01-26 15:50:15 +01:00

477 lines
13 KiB
PHP

<?php
namespace Elementor;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Elementor background control.
*
* A base control for creating background control. Displays input fields to define
* the background color, background image, background gradiant or background video.
*
* Creating new control in the editor (inside `Widget_Base::_register_controls()`
* method):
*
* $this->add_group_control(
* Group_Control_Background::get_type(),
* [
* 'name' => 'background',
* 'types' => [ 'classic', 'gradient', 'video' ],
* 'selector' => '{{WRAPPER}} .wrapper',
* 'separator' => 'before',
* ]
* );
*
* @since 1.2.2
*
* @param string $name The field name.
* @param array $types Optional. Define spesific types to use. Available
* types are `classic`, `gradient` and `video`. Default
* is an empty array, including all the types.
* @param array $fields_options Optional. An array of arays contaning data that
* overrides control settings. Default is an empty array.
* @param string $separator Optional. Set the position of the control separator.
* Available values are 'default', 'before', 'after'
* and 'none'. 'default' will position the separator
* depending on the control type. 'before' / 'after'
* will position the separator before/after the
* control. 'none' will hide the separator. Default
* is 'default'.
*/
class Group_Control_Background extends Group_Control_Base {
/**
* Fields.
*
* Holds all the background control fields.
*
* @since 1.2.2
* @access protected
* @static
*
* @var array Background control fields.
*/
protected static $fields;
/**
* Background Types.
*
* Holds all the available background types.
*
* @since 1.2.2
* @access private
* @static
*
* @var array
*/
private static $background_types;
/**
* Retrieve type.
*
* Get background control type.
*
* @since 1.0.0
* @access public
* @static
*
* @return string Control type.
*/
public static function get_type() {
return 'background';
}
/**
* Retrieve background types.
*
* Gat available background types.
*
* @since 1.2.2
* @access public
* @static
*
* @return array Available background types.
*/
public static function get_background_types() {
if ( null === self::$background_types ) {
self::$background_types = self::init_background_types();
}
return self::$background_types;
}
/* TODO: rename to `default_background_types()` */
/**
* Default background types.
*
* Retrieve background control initial types.
*
* @since 1.2.2
* @access private
* @static
*
* @return array Default background types.
*/
private static function init_background_types() {
return [
'classic' => [
'title' => _x( 'Classic', 'Background Control', 'elementor' ),
'icon' => 'fa fa-paint-brush',
],
'gradient' => [
'title' => _x( 'Gradient', 'Background Control', 'elementor' ),
'icon' => 'fa fa-barcode',
],
'video' => [
'title' => _x( 'Background Video', 'Background Control', 'elementor' ),
'icon' => 'fa fa-video-camera',
],
];
}
/**
* Init fields.
*
* Initialize background control fields.
*
* @since 1.2.2
* @access public
*
* @return array Control fields.
*/
public function init_fields() {
$fields = [];
$fields['background'] = [
'label' => _x( 'Background Type', 'Background Control', 'elementor' ),
'type' => Controls_Manager::CHOOSE,
'label_block' => false,
'render_type' => 'ui',
];
$fields['color'] = [
'label' => _x( 'Color', 'Background Control', 'elementor' ),
'type' => Controls_Manager::COLOR,
'default' => '',
'title' => _x( 'Background Color', 'Background Control', 'elementor' ),
'selectors' => [
'{{SELECTOR}}' => 'background-color: {{VALUE}};',
],
'condition' => [
'background' => [ 'classic', 'gradient' ],
],
];
$fields['color_stop'] = [
'label' => _x( 'Location', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ '%' ],
'default' => [
'unit' => '%',
'size' => 0,
],
'render_type' => 'ui',
'condition' => [
'background' => [ 'gradient' ],
],
'of_type' => 'gradient',
];
$fields['color_b'] = [
'label' => _x( 'Second Color', 'Background Control', 'elementor' ),
'type' => Controls_Manager::COLOR,
'default' => '#f2295b',
'render_type' => 'ui',
'condition' => [
'background' => [ 'gradient' ],
],
'of_type' => 'gradient',
];
$fields['color_b_stop'] = [
'label' => _x( 'Location', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ '%' ],
'default' => [
'unit' => '%',
'size' => 100,
],
'render_type' => 'ui',
'condition' => [
'background' => [ 'gradient' ],
],
'of_type' => 'gradient',
];
$fields['gradient_type'] = [
'label' => _x( 'Type', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SELECT,
'options' => [
'linear' => _x( 'Linear', 'Background Control', 'elementor' ),
'radial' => _x( 'Radial', 'Background Control', 'elementor' ),
],
'default' => 'linear',
'render_type' => 'ui',
'condition' => [
'background' => [ 'gradient' ],
],
'of_type' => 'gradient',
];
$fields['gradient_angle'] = [
'label' => _x( 'Angle', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'deg' ],
'default' => [
'unit' => 'deg',
'size' => 180,
],
'range' => [
'deg' => [
'step' => 10,
],
],
'selectors' => [
'{{SELECTOR}}' => 'background-color: transparent; background-image: linear-gradient({{SIZE}}{{UNIT}}, {{color.VALUE}} {{color_stop.SIZE}}{{color_stop.UNIT}}, {{color_b.VALUE}} {{color_b_stop.SIZE}}{{color_b_stop.UNIT}})',
],
'condition' => [
'background' => [ 'gradient' ],
'gradient_type' => 'linear',
],
'of_type' => 'gradient',
];
$fields['gradient_position'] = [
'label' => _x( 'Position', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SELECT,
'options' => [
'center center' => _x( 'Center Center', 'Background Control', 'elementor' ),
'center left' => _x( 'Center Left', 'Background Control', 'elementor' ),
'center right' => _x( 'Center Right', 'Background Control', 'elementor' ),
'top center' => _x( 'Top Center', 'Background Control', 'elementor' ),
'top left' => _x( 'Top Left', 'Background Control', 'elementor' ),
'top right' => _x( 'Top Right', 'Background Control', 'elementor' ),
'bottom center' => _x( 'Bottom Center', 'Background Control', 'elementor' ),
'bottom left' => _x( 'Bottom Left', 'Background Control', 'elementor' ),
'bottom right' => _x( 'Bottom Right', 'Background Control', 'elementor' ),
],
'default' => 'center center',
'selectors' => [
'{{SELECTOR}}' => 'background-color: transparent; background-image: radial-gradient(at {{VALUE}}, {{color.VALUE}} {{color_stop.SIZE}}{{color_stop.UNIT}}, {{color_b.VALUE}} {{color_b_stop.SIZE}}{{color_b_stop.UNIT}})',
],
'condition' => [
'background' => [ 'gradient' ],
'gradient_type' => 'radial',
],
'of_type' => 'gradient',
];
$fields['image'] = [
'label' => _x( 'Image', 'Background Control', 'elementor' ),
'type' => Controls_Manager::MEDIA,
'title' => _x( 'Background Image', 'Background Control', 'elementor' ),
'selectors' => [
'{{SELECTOR}}' => 'background-image: url("{{URL}}");',
],
'condition' => [
'background' => [ 'classic' ],
],
];
$fields['position'] = [
'label' => _x( 'Position', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => '',
'options' => [
'' => _x( 'Default', 'Background Control', 'elementor' ),
'top left' => _x( 'Top Left', 'Background Control', 'elementor' ),
'top center' => _x( 'Top Center', 'Background Control', 'elementor' ),
'top right' => _x( 'Top Right', 'Background Control', 'elementor' ),
'center left' => _x( 'Center Left', 'Background Control', 'elementor' ),
'center center' => _x( 'Center Center', 'Background Control', 'elementor' ),
'center right' => _x( 'Center Right', 'Background Control', 'elementor' ),
'bottom left' => _x( 'Bottom Left', 'Background Control', 'elementor' ),
'bottom center' => _x( 'Bottom Center', 'Background Control', 'elementor' ),
'bottom right' => _x( 'Bottom Right', 'Background Control', 'elementor' ),
],
'selectors' => [
'{{SELECTOR}}' => 'background-position: {{VALUE}};',
],
'condition' => [
'background' => [ 'classic' ],
'image[url]!' => '',
],
];
$fields['attachment'] = [
'label' => _x( 'Attachment', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => '',
'options' => [
'' => _x( 'Default', 'Background Control', 'elementor' ),
'scroll' => _x( 'Scroll', 'Background Control', 'elementor' ),
'fixed' => _x( 'Fixed', 'Background Control', 'elementor' ),
],
'selectors' => [
'(tablet+){{SELECTOR}}' => 'background-attachment: {{VALUE}};',
],
'condition' => [
'background' => [ 'classic' ],
'image[url]!' => '',
],
];
$fields['repeat'] = [
'label' => _x( 'Repeat', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => '',
'options' => [
'' => _x( 'Default', 'Background Control', 'elementor' ),
'no-repeat' => _x( 'No-repeat', 'Background Control', 'elementor' ),
'repeat' => _x( 'Repeat', 'Background Control', 'elementor' ),
'repeat-x' => _x( 'Repeat-x', 'Background Control', 'elementor' ),
'repeat-y' => _x( 'Repeat-y', 'Background Control', 'elementor' ),
],
'selectors' => [
'{{SELECTOR}}' => 'background-repeat: {{VALUE}};',
],
'condition' => [
'background' => [ 'classic' ],
'image[url]!' => '',
],
];
$fields['size'] = [
'label' => _x( 'Size', 'Background Control', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => '',
'options' => [
'' => _x( 'Default', 'Background Control', 'elementor' ),
'auto' => _x( 'Auto', 'Background Control', 'elementor' ),
'cover' => _x( 'Cover', 'Background Control', 'elementor' ),
'contain' => _x( 'Contain', 'Background Control', 'elementor' ),
],
'selectors' => [
'{{SELECTOR}}' => 'background-size: {{VALUE}};',
],
'condition' => [
'background' => [ 'classic' ],
'image[url]!' => '',
],
];
$fields['video_link'] = [
'label' => _x( 'Video Link', 'Background Control', 'elementor' ),
'type' => Controls_Manager::TEXT,
'placeholder' => 'https://www.youtube.com/watch?v=9uOETcuFjbE',
'description' => __( 'YouTube link or video file (mp4 is recommended).', 'elementor' ),
'label_block' => true,
'default' => '',
'condition' => [
'background' => [ 'video' ],
],
'of_type' => 'video',
];
$fields['video_fallback'] = [
'label' => _x( 'Background Fallback', 'Background Control', 'elementor' ),
'description' => __( 'This cover image will replace the background video on mobile and tablet devices.', 'elementor' ),
'type' => Controls_Manager::MEDIA,
'label_block' => true,
'condition' => [
'background' => [ 'video' ],
],
'selectors' => [
'{{SELECTOR}}' => 'background: url("{{URL}}") 50% 50%; background-size: cover;',
],
'of_type' => 'video',
];
return $fields;
}
/**
* Retrieve child default args.
*
* Get the default arguments for all the child controls for a specific group
* control.
*
* @since 1.2.2
* @access protected
*
* @return array Default arguments for all the child controls.
*/
protected function get_child_default_args() {
return [
'types' => [ 'classic', 'gradient' ],
];
}
/**
* Filter fields.
*
* Filter which controls to display, using `include`, `exclude`, `condition`
* and `of_type` arguments.
*
* @since 1.2.2
* @access protected
*
* @return array Control fields.
*/
protected function filter_fields() {
$fields = parent::filter_fields();
$args = $this->get_args();
foreach ( $fields as &$field ) {
if ( isset( $field['of_type'] ) && ! in_array( $field['of_type'], $args['types'] ) ) {
unset( $field );
}
}
return $fields;
}
/**
* Prepare fields.
*
* Process background control fields before adding them to `add_control()`.
*
* @since 1.2.2
* @access protected
*
* @param array $fields Background control fields.
*
* @return array Processed fields.
*/
protected function prepare_fields( $fields ) {
$args = $this->get_args();
$background_types = self::get_background_types();
$choose_types = [];
foreach ( $args['types'] as $type ) {
if ( isset( $background_types[ $type ] ) ) {
$choose_types[ $type ] = $background_types[ $type ];
}
}
$fields['background']['options'] = $choose_types;
return parent::prepare_fields( $fields );
}
/**
* @since 1.9.0
* @access protected
*/
protected function get_default_options() {
return [
'popover' => false,
];
}
}