<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Providers\Provider;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Class Core stores the basic information about the provider.

[5] Fix | Delete

* It's also a Container to load single instances of requires classes.

[6] Fix | Delete

*

[7] Fix | Delete

* @since 1.4.7

[8] Fix | Delete

*/

[9] Fix | Delete

abstract class Core {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Unique provider slug.

[13] Fix | Delete

*

[14] Fix | Delete

* @since 1.4.7

[15] Fix | Delete

*

[16] Fix | Delete

* @var string

[17] Fix | Delete

*/

[18] Fix | Delete

public $slug;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Translatable provider name.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 1.4.7

[24] Fix | Delete

*

[25] Fix | Delete

* @var string

[26] Fix | Delete

*/

[27] Fix | Delete

public $name;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Custom provider icon (logo).

[31] Fix | Delete

*

[32] Fix | Delete

* @since 1.4.7

[33] Fix | Delete

*

[34] Fix | Delete

* @var string

[35] Fix | Delete

*/

[36] Fix | Delete

public $icon;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Custom priority for a provider, that will affect loading/placement order.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.4.8

[42] Fix | Delete

*

[43] Fix | Delete

* @var int

[44] Fix | Delete

*/

[45] Fix | Delete

const PRIORITY = 10;

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Get the instance of the class.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.4.7

[51] Fix | Delete

* @since 1.7.3 Compatibility with PHP 8.1

[52] Fix | Delete

*

[53] Fix | Delete

* @return Core

[54] Fix | Delete

*/

[55] Fix | Delete

public static function get_instance() {

[56] Fix | Delete

[57] Fix | Delete

static $instance;

[58] Fix | Delete

[59] Fix | Delete

$class = static::class;

[60] Fix | Delete

[61] Fix | Delete

if ( empty( $instance[ $class ] ) ) {

[62] Fix | Delete

// Same as new static(), but allows avoiding "abstract class init" error.

[63] Fix | Delete

$instance[ $class ] = new $class();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

return $instance[ $class ];

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Core constructor.

[71] Fix | Delete

*

[72] Fix | Delete

* @since 1.4.7

[73] Fix | Delete

*

[74] Fix | Delete

* @param array $params Possible keys: slug*, name*, icon. * are required.

[75] Fix | Delete

*

[76] Fix | Delete

* @throws \UnexpectedValueException Provider class should define provider's "slug"/"name" params.

[77] Fix | Delete

*/

[78] Fix | Delete

public function __construct( array $params ) {

[79] Fix | Delete

[80] Fix | Delete

// Define required provider properties.

[81] Fix | Delete

if ( ! empty( $params['slug'] ) ) {

[82] Fix | Delete

$this->slug = \sanitize_key( $params['slug'] );

[83] Fix | Delete

} else {

[84] Fix | Delete

throw new \UnexpectedValueException( 'Provider class should define a provider "slug" param in its constructor.' );

[85] Fix | Delete

}

[86] Fix | Delete

if ( ! empty( $params['name'] ) ) {

[87] Fix | Delete

$this->name = \sanitize_text_field( $params['name'] );

[88] Fix | Delete

} else {

[89] Fix | Delete

throw new \UnexpectedValueException( 'Provider class should define a provider "name" param in its constructor.' );

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

$this->icon = WPFORMS_PLUGIN_URL . 'assets/images/sullie.png';

[93] Fix | Delete

if ( ! empty( $params['icon'] ) ) {

[94] Fix | Delete

$this->icon = \esc_url_raw( $params['icon'] );

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Add to list of registered providers.

[101] Fix | Delete

*

[102] Fix | Delete

* @since 1.4.7

[103] Fix | Delete

*

[104] Fix | Delete

* @param array $providers Array of all active providers.

[105] Fix | Delete

*

[106] Fix | Delete

* @return array

[107] Fix | Delete

*/

[108] Fix | Delete

public function register_provider( array $providers ) {

[109] Fix | Delete

[110] Fix | Delete

$providers[ $this->slug ] = $this->name;

[111] Fix | Delete

[112] Fix | Delete

return $providers;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Provide an instance of the object, that should process the submitted entry.

[117] Fix | Delete

* It will use data from an already saved entry to pass it further to a Provider.

[118] Fix | Delete

*

[119] Fix | Delete

* @since 1.4.7

[120] Fix | Delete

*

[121] Fix | Delete

* @return null|\WPForms\Providers\Provider\Process

[122] Fix | Delete

*/

[123] Fix | Delete

abstract public function get_process();

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Provide an instance of the object, that should display provider settings

[127] Fix | Delete

* on Settings > Integrations page in admin area.

[128] Fix | Delete

* If you don't want to display it (i.e. you don't need it), you can pass null here in your Core provider class.

[129] Fix | Delete

*

[130] Fix | Delete

* @since 1.4.7

[131] Fix | Delete

*

[132] Fix | Delete

* @return null|\WPForms\Providers\Provider\Settings\PageIntegrations

[133] Fix | Delete

*/

[134] Fix | Delete

abstract public function get_page_integrations();

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Provide an instance of the object, that should display provider settings in the Form Builder.

[138] Fix | Delete

* If you don't want to display it (i.e. you don't need it), you can pass null here in your Core provider class.

[139] Fix | Delete

*

[140] Fix | Delete

* @since 1.4.7

[141] Fix | Delete

*

[142] Fix | Delete

* @return null|\WPForms\Providers\Provider\Settings\FormBuilder

[143] Fix | Delete

*/

[144] Fix | Delete

abstract public function get_form_builder();

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete