Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, AnalyticsToken $analyticsToken, FlagManager $flagManager)

	getStatus ()

	getStatusForEnabledSubscription ()

	getStatusForDisabledSubscription ()

Data Fields
const	ENABLED = "Enabled"

const	FAILED = "Failed"

const	PENDING = "Pending"

const	DISABLED = "Disabled"

Detailed Description

Provider of subscription status.

Definition at line 16 of file SubscriptionStatusProvider.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		AnalyticsToken	$analyticsToken,
		FlagManager	$flagManager
	)

Parameters

ScopeConfigInterface	$scopeConfig
AnalyticsToken	$analyticsToken
FlagManager	$flagManager

Definition at line 58 of file SubscriptionStatusProvider.php.

       {
         $this->scopeConfig = $scopeConfig;
         $this->analyticsToken = $analyticsToken;
         $this->flagManager = $flagManager;
     }

Member Function Documentation

◆ getStatus()

getStatus ( )

Retrieve subscription status to Magento BI Advanced Reporting.

Statuses: Enabled - if subscription is enabled and MA token was received; Pending - if subscription is enabled and MA token was not received; Disabled - if subscription is not enabled. Failed - if subscription is enabled and token was not received after attempts ended.

Returns: string

Definition at line 79 of file SubscriptionStatusProvider.php.

     {
         $isSubscriptionEnabledInConfig = $this->scopeConfig->getValue('analytics/subscription/enabled');
         if ($isSubscriptionEnabledInConfig) {
             return $this->getStatusForEnabledSubscription();
         }
 
         return $this->getStatusForDisabledSubscription();
     }

◆ getStatusForDisabledSubscription()

getStatusForDisabledSubscription ( )

Retrieve status for subscription that disabled in config.

Returns: string

Definition at line 116 of file SubscriptionStatusProvider.php.

     {
         return static::DISABLED;
     }

◆ getStatusForEnabledSubscription()

getStatusForEnabledSubscription ( )

Retrieve status for subscription that enabled in config.

Returns: string

Definition at line 94 of file SubscriptionStatusProvider.php.

     {
         $status = static::ENABLED;
         if ($this->flagManager->getFlagData(SubscriptionUpdateHandler::PREVIOUS_BASE_URL_FLAG_CODE)) {
             $status = self::PENDING;
         }
 
         if (!$this->analyticsToken->isTokenExist()) {
             $status = static::PENDING;
             if ($this->flagManager->getFlagData(SubscriptionHandler::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE) === null) {
                 $status = static::FAILED;
             }
         }
 
         return $status;
     }

Field Documentation

◆ DISABLED

const DISABLED = "Disabled"

Represents a disabled subscription state.

Definition at line 36 of file SubscriptionStatusProvider.php.

◆ ENABLED

const ENABLED = "Enabled"

Represents an enabled subscription state.

Definition at line 21 of file SubscriptionStatusProvider.php.

◆ FAILED

const FAILED = "Failed"

Represents a failed subscription state.

Definition at line 26 of file SubscriptionStatusProvider.php.

◆ PENDING

const PENDING = "Pending"

Represents a pending subscription state.

Definition at line 31 of file SubscriptionStatusProvider.php.

The documentation for this class was generated from the following file:

vendor/magento/module-analytics/Model/SubscriptionStatusProvider.php

Public Member Functions

Data Fields