oont-contents/plugins/elementor/modules/atomic-widgets/base/atomic-widget-base.php
2025-02-08 15:10:23 +01:00

176 lines
4.6 KiB
PHP

<?php
namespace Elementor\Modules\AtomicWidgets\Base;
use Elementor\Modules\AtomicWidgets\Controls\Section;
use Elementor\Modules\AtomicWidgets\PropTypes\Contracts\Prop_Type;
use Elementor\Modules\AtomicWidgets\Styles\Style_Schema;
use Elementor\Modules\AtomicWidgets\Validators\Props_Validator;
use Elementor\Modules\AtomicWidgets\PropsResolver\Props_Resolver;
use Elementor\Modules\AtomicWidgets\Validators\Styles_Validator;
use Elementor\Utils;
use Elementor\Widget_Base;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
abstract class Atomic_Widget_Base extends Widget_Base {
protected $version = '0.0';
protected $styles = [];
public function __construct( $data = [], $args = null ) {
parent::__construct( $data, $args );
$this->version = $data['version'] ?? '0.0';
$this->styles = $data['styles'] ?? [];
}
public function has_widget_inner_wrapper(): bool {
return false;
}
public function get_atomic_controls() {
$controls = $this->define_atomic_controls();
$schema = static::get_props_schema();
// Validate the schema only in the Editor.
static::validate_schema( $schema );
return $this->get_valid_controls( $schema, $controls );
}
private function get_valid_controls( array $schema, array $controls ): array {
$valid_controls = [];
foreach ( $controls as $control ) {
if ( $control instanceof Section ) {
$cloned_section = clone $control;
$cloned_section->set_items(
$this->get_valid_controls( $schema, $control->get_items() )
);
$valid_controls[] = $cloned_section;
continue;
}
if ( ! ( $control instanceof Atomic_Control_Base ) ) {
Utils::safe_throw( 'Control must be an instance of `Atomic_Control_Base`.' );
continue;
}
$prop_name = $control->get_bind();
if ( ! $prop_name ) {
Utils::safe_throw( 'Control is missing a bound prop from the schema.' );
continue;
}
if ( ! array_key_exists( $prop_name, $schema ) ) {
Utils::safe_throw( "Prop `{$prop_name}` is not defined in the schema of `{$this->get_name()}`." );
continue;
}
$valid_controls[] = $control;
}
return $valid_controls;
}
abstract protected function define_atomic_controls(): array;
final public function get_controls( $control_id = null ) {
if ( ! empty( $control_id ) ) {
return null;
}
return [];
}
final public function get_initial_config() {
$config = parent::get_initial_config();
$config['atomic_controls'] = $this->get_atomic_controls();
$config['atomic_props_schema'] = static::get_props_schema();
$config['version'] = $this->version;
return $config;
}
final public function get_data_for_save() {
$data = parent::get_data_for_save();
$data['version'] = $this->version;
$data['settings'] = $this->sanitize_atomic_settings( $data['settings'] );
$data['styles'] = $this->sanitize_atomic_styles( $data['styles'] );
return $data;
}
final public function get_raw_data( $with_html_content = false ) {
$raw_data = parent::get_raw_data( $with_html_content );
$raw_data['styles'] = $this->styles;
return $raw_data;
}
final public function get_stack( $with_common_controls = true ) {
return [
'controls' => [],
'tabs' => [],
];
}
final public function get_atomic_settings(): array {
$schema = static::get_props_schema();
$props = $this->get_settings();
return Props_Resolver::for_settings()->resolve( $schema, $props );
}
public static function get_props_schema(): array {
return apply_filters(
'elementor/atomic-widgets/props-schema',
static::define_props_schema()
);
}
// TODO: Move to a `Schema_Validator` class?
private static function validate_schema( array $schema ) {
$widget_name = static::class;
foreach ( $schema as $key => $prop ) {
if ( ! ( $prop instanceof Prop_Type ) ) {
Utils::safe_throw( "Prop `$key` must be an instance of `Prop_Type` in `{$widget_name}`." );
}
}
}
private function sanitize_atomic_styles( array $styles ) {
[ , $validated, $errors ] = Styles_Validator::make( Style_Schema::get() )->validate( $styles );
if ( ! empty( $errors ) ) {
throw new \Exception( 'Styles validation failed. Invalid keys: ' . join( ', ', $errors ) );
}
return $validated;
}
private function sanitize_atomic_settings( array $settings ): array {
$schema = static::get_props_schema();
[ , $validated, $errors ] = Props_Validator::make( $schema )->validate( $settings );
if ( ! empty( $errors ) ) {
throw new \Exception( 'Settings validation failed. Invalid keys: ' . join( ', ', $errors ) );
}
return $validated;
}
/**
* @return array<string, Prop_Type>
*/
abstract protected static function define_props_schema(): array;
}