<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Providers\Provider;

[2] Fix | Delete

[3] Fix | Delete

use stdClass;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Class Status gives ability to check/work with provider statuses.

[7] Fix | Delete

* Might be used later to track Provider errors on data-delivery.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.4.8

[10] Fix | Delete

*/

[11] Fix | Delete

class Status {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Provider identifier, its slug.

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.4.8

[17] Fix | Delete

*

[18] Fix | Delete

* @var string

[19] Fix | Delete

*/

[20] Fix | Delete

private $provider;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Form data and settings.

[24] Fix | Delete

*

[25] Fix | Delete

* @since 1.4.8

[26] Fix | Delete

*

[27] Fix | Delete

* @var array

[28] Fix | Delete

*/

[29] Fix | Delete

protected $form_data = [];

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Status constructor.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.4.8

[35] Fix | Delete

*

[36] Fix | Delete

* @param string $provider Provider slug.

[37] Fix | Delete

*/

[38] Fix | Delete

public function __construct( $provider ) {

[39] Fix | Delete

[40] Fix | Delete

$this->provider = sanitize_key( (string) $provider );

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Provide an ability to statically init the object.

[45] Fix | Delete

* Useful for inline-invocations.

[46] Fix | Delete

*

[47] Fix | Delete

* @example: Status::init( 'drip' )->is_ready();

[48] Fix | Delete

*

[49] Fix | Delete

* @since 1.4.8

[50] Fix | Delete

* @since 1.5.9 Added a check on provider.

[51] Fix | Delete

*

[52] Fix | Delete

* @param string $provider Provider slug.

[53] Fix | Delete

*

[54] Fix | Delete

* @return Status

[55] Fix | Delete

*/

[56] Fix | Delete

public static function init( $provider ) {

[57] Fix | Delete

[58] Fix | Delete

static $instance;

[59] Fix | Delete

[60] Fix | Delete

if ( ! $instance || $provider !== $instance->provider ) {

[61] Fix | Delete

$instance = new self( $provider );

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

return $instance;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Check whether the defined provider is configured or not.

[69] Fix | Delete

* "Configured" means has an account that might be checked/updated on Settings > Integrations.

[70] Fix | Delete

*

[71] Fix | Delete

* @since 1.4.8

[72] Fix | Delete

*

[73] Fix | Delete

* @return bool

[74] Fix | Delete

*/

[75] Fix | Delete

public function is_configured() {

[76] Fix | Delete

[77] Fix | Delete

$options = wpforms_get_providers_options();

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Use this filter to change the configuration status of the provider.

[81] Fix | Delete

* We need the filter for BC reasons.

[82] Fix | Delete

*

[83] Fix | Delete

* @since 1.4.8

[84] Fix | Delete

*

[85] Fix | Delete

* @param bool $is_configured Is the provider configured?

[86] Fix | Delete

*/

[87] Fix | Delete

$is_configured = apply_filters( // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[88] Fix | Delete

"wpforms_providers_{$this->provider}_configured",

[89] Fix | Delete

! empty( $options[ $this->provider ] )

[90] Fix | Delete

);

[91] Fix | Delete

[92] Fix | Delete

/**

[93] Fix | Delete

* Use this filter to change the configuration status of the provider.

[94] Fix | Delete

*

[95] Fix | Delete

* @since 1.4.8

[96] Fix | Delete

*

[97] Fix | Delete

* @param bool $is_configured Is the provider configured?

[98] Fix | Delete

* @param string $provider Provider slug.

[99] Fix | Delete

*/

[100] Fix | Delete

return apply_filters( 'wpforms_providers_status_is_configured', $is_configured, $this->provider ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Check whether the defined provider is connected to some form.

[105] Fix | Delete

* "Connected" means it has a Connection in Form Builder > Providers > Provider tab.

[106] Fix | Delete

*

[107] Fix | Delete

* @since 1.4.8

[108] Fix | Delete

*

[109] Fix | Delete

* @param int $form_id Form ID to check the status against.

[110] Fix | Delete

*

[111] Fix | Delete

* @return bool

[112] Fix | Delete

*/

[113] Fix | Delete

public function is_connected( $form_id ) {

[114] Fix | Delete

[115] Fix | Delete

$is_connected = false;

[116] Fix | Delete

[117] Fix | Delete

$revisions = wpforms()->obj( 'revisions' );

[118] Fix | Delete

$revision = $revisions ? $revisions->get_revision() : null;

[119] Fix | Delete

[120] Fix | Delete

if ( $revision ) {

[121] Fix | Delete

$this->form_data = wpforms_decode( $revision->post_content );

[122] Fix | Delete

} else {

[123] Fix | Delete

$this->form_data = wpforms()->obj( 'form' )->get( (int) $form_id, [ 'content_only' => true ] );

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

if ( ! empty( $this->form_data['providers'][ $this->provider ] ) ) {

[127] Fix | Delete

$is_connected = $this->check_valid_connections();

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Use this filter to change the connection status of the provider.

[132] Fix | Delete

*

[133] Fix | Delete

* @since 1.4.8

[134] Fix | Delete

*

[135] Fix | Delete

* @param bool $is_connected Is the provider connected to the form?

[136] Fix | Delete

* @param string $provider Provider slug.

[137] Fix | Delete

*/

[138] Fix | Delete

return (bool) apply_filters( 'wpforms_providers_status_is_connected', $is_connected, $this->provider ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Is the current provider ready to be used?

[143] Fix | Delete

* It means both configured and connected.

[144] Fix | Delete

*

[145] Fix | Delete

* @since 1.4.8

[146] Fix | Delete

*

[147] Fix | Delete

* @param int $form_id Form ID to check the status against.

[148] Fix | Delete

*

[149] Fix | Delete

* @return bool

[150] Fix | Delete

*/

[151] Fix | Delete

public function is_ready( $form_id ) {

[152] Fix | Delete

[153] Fix | Delete

return $this->is_configured() && $this->is_connected( $form_id );

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Check if connections belong to an existing account.

[158] Fix | Delete

*

[159] Fix | Delete

* @since 1.8.8

[160] Fix | Delete

*

[161] Fix | Delete

* @return bool

[162] Fix | Delete

*/

[163] Fix | Delete

private function check_valid_connections(): bool {

[164] Fix | Delete

[165] Fix | Delete

$account_ids = array_keys( wpforms_get_providers_options( $this->provider ) );

[166] Fix | Delete

[167] Fix | Delete

// BC for the Salesforce addon that uses `resource_owner_id` key instead of `account_id` value.

[168] Fix | Delete

if ( $this->provider === 'salesforce' ) {

[169] Fix | Delete

$account_ids = array_column( wpforms_get_providers_options( 'salesforce' ), 'resource_owner_id' );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

// Account id is generated by the `uniqid` function that sometimes returns an integer value.

[173] Fix | Delete

$account_ids = array_map( 'strval', $account_ids );

[174] Fix | Delete

[175] Fix | Delete

$connection_accounts_ids = array_column( $this->form_data['providers'][ $this->provider ], 'account_id' );

[176] Fix | Delete

[177] Fix | Delete

// BC for the Drip addon that uses `option_id` key for storing a connection provider.

[178] Fix | Delete

if ( $this->provider === 'drip' ) {

[179] Fix | Delete

$connection_accounts_ids = array_column( $this->form_data['providers'][ $this->provider ], 'option_id' );

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

foreach ( $connection_accounts_ids as $account ) {

[183] Fix | Delete

if ( in_array( (string) $account, $account_ids, true ) ) {

[184] Fix | Delete

return true;

[185] Fix | Delete

}

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

return false;

[189] Fix | Delete

}

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete