File Editor

Directories:

Files:

Create New File

Edit File: Status.php

<?php

namespace WPForms\Providers\Provider;

use stdClass;

/**
 * Class Status gives ability to check/work with provider statuses.
 * Might be used later to track Provider errors on data-delivery.
 *
 * @since 1.4.8
 */
class Status {

/**
	 * Provider identifier, its slug.
	 *
	 * @since 1.4.8
	 *
	 * @var string
	 */
	private $provider;

/**
	 * Form data and settings.
	 *
	 * @since 1.4.8
	 *
	 * @var array
	 */
	protected $form_data = [];

/**
	 * Status constructor.
	 *
	 * @since 1.4.8
	 *
	 * @param string $provider Provider slug.
	 */
	public function __construct( $provider ) {

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

/**
	 * Provide ability to statically init the object.
	 * Useful for inline-invocations.
	 *
	 * @example: Status::init( 'drip' )->is_ready();
	 *
	 * @since 1.4.8
	 * @since 1.5.9 Added a check on provider.
	 *
	 * @param string $provider Provider slug.
	 *
	 * @return Status
	 */
	public static function init( $provider ) {

static $instance;

if ( ! $instance || $provider !== $instance->provider ) {
			$instance = new self( $provider );
		}

return $instance;
	}

/**
	 * Check whether the defined provider is configured or not.
	 * "Configured" means has an account, that might be checked/updated on Settings > Integrations.
	 *
	 * @since 1.4.8
	 *
	 * @return bool
	 */
	public function is_configured() {

$options = wpforms_get_providers_options();

// We meed to leave this filter for BC.
		$is_configured = \apply_filters(
			'wpforms_providers_' . $this->provider . '_configured',
			! empty( $options[ $this->provider ] )
		);

// Use this filter to change the configuration status of the provider.
		return apply_filters( 'wpforms_providers_status_is_configured', $is_configured, $this->provider );
	}

/**
	 * Check whether the defined provider is connected to some form.
	 * "Connected" means it has a Connection in Form Builder > Providers > Provider tab.
	 *
	 * @since 1.4.8
	 *
	 * @param int $form_id Form ID to check the status against.
	 *
	 * @return bool
	 */
	public function is_connected( $form_id ) {

$is_connected = false;

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

if ( $revision ) {
			$form_id = $revision->ID;
		}

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

if ( ! empty( $this->form_data['providers'][ $this->provider ] ) ) {
			$is_connected = $this->check_valid_connections();
		}

return apply_filters( 'wpforms_providers_status_is_connected', $is_connected, $this->provider );
	}

/**
	 * Is the current provider ready to be used?
	 * It means both configured and connected.
	 *
	 * @since 1.4.8
	 *
	 * @param int $form_id Form ID to check the status against.
	 *
	 * @return bool
	 */
	public function is_ready( $form_id ) {

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

/**
	 * Check if connections belong to existing account.
	 *
	 * @since 1.8.8
	 *
	 * @return bool
	 */
	private function check_valid_connections(): bool {

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

// BC for the Salesforce addon that uses `resource_owner_id` key instead of `account_id` value.
		if ( $this->provider === 'salesforce' ) {
			$account_ids = array_column( wpforms_get_providers_options( 'salesforce' ), 'resource_owner_id' );
		}

// Account id is generated by the `uniqid` function that sometimes returns an integer value.
		$account_ids = array_map( 'strval', $account_ids );

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

// BC for the Drip addon that uses `option_id` key for storing a connection provider.
		if ( $this->provider === 'drip' ) {
			$connection_accounts_ids = array_column( $this->form_data['providers'][ $this->provider ], 'option_id' );
		}

foreach ( $connection_accounts_ids as $account ) {
			if ( in_array( (string) $account, $account_ids, true ) ) {
				return true;
			}
		}

return false;
	}
}

File Editor

Directories:

Files:

Create New File

Edit File: Status.php

Rename File