Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
Config Class Reference

Public Member Functions

 __construct (ScopeConfigInterface $scopeConfig)
 
 isActive ($storeId=null)
 
 getApiKey ($storeId=null)
 
 getApiUrl ($storeId=null)
 
 isDebugModeEnabled ($storeId=null)
 

Detailed Description

Signifyd integration configuration.

Class is a proxy service for retrieving configuration settings.

Definition at line 16 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( ScopeConfigInterface  $scopeConfig)

Config constructor.

Parameters
ScopeConfigInterface$scopeConfig

Definition at line 28 of file Config.php.

29  {
30  $this->scopeConfig = $scopeConfig;
31  }

Member Function Documentation

◆ getApiKey()

getApiKey (   $storeId = null)

Signifyd API Key used for authentication.

See also
https://www.signifyd.com/docs/api/#/introduction/authentication
https://app.signifyd.com/settings
Parameters
int | null$storeId
Returns
string

Definition at line 59 of file Config.php.

59  : string
60  {
61  $apiKey = $this->scopeConfig->getValue(
62  'fraud_protection/signifyd/api_key',
64  $storeId
65  );
66  return $apiKey;
67  }

◆ getApiUrl()

getApiUrl (   $storeId = null)

Base URL to Signifyd REST API. Usually equals to https://api.signifyd.com/v2 and should not be changed

Parameters
int | null$storeId
Returns
string

Definition at line 76 of file Config.php.

76  : string
77  {
78  $apiUrl = $this->scopeConfig->getValue(
79  'fraud_protection/signifyd/api_url',
81  $storeId
82  );
83  return $apiUrl;
84  }

◆ isActive()

isActive (   $storeId = null)

If this config option set to false no Signifyd integration should be available (only possibility to configure Signifyd setting in admin)

Parameters
int | null$storeId
Returns
bool

Definition at line 40 of file Config.php.

40  : bool
41  {
42  $enabled = $this->scopeConfig->isSetFlag(
43  'fraud_protection/signifyd/active',
45  $storeId
46  );
47  return $enabled;
48  }

◆ isDebugModeEnabled()

isDebugModeEnabled (   $storeId = null)

If is "true" extra information about interaction with Signifyd API are written to debug.log file

Parameters
int | null$storeId
Returns
bool

Definition at line 92 of file Config.php.

92  : bool
93  {
94  $debugModeEnabled = $this->scopeConfig->isSetFlag(
95  'fraud_protection/signifyd/debug',
97  $storeId
98  );
99  return $debugModeEnabled;
100  }

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