You are here

public static function CloudFlareZoneInterface::assertValidCredentials in CloudFlare 8

Asserts that credentials are valid. Does NOT pull settings from CMI.

Parameters

string $apikey: The secret Api key used to authenticate against CloudFlare.

string $email: Email of the account used to authenticate against CloudFlare.

\Drupal\cloudflare\CloudFlareComposerDependenciesCheckInterface $composer_dependency_check: Checks that composer dependencies are met.

\Drupal\cloudflare\CloudFlareStateInterface $state: Tracks rate limits associated with CloudFlare Api.

Throws

CloudFlarePhpSdk\Exceptions\CloudFlareInvalidCredentialException Thrown if $apikey and $email fail to authenticate against the Api.

CloudFlarePhpSdk\Exceptions\CloudFlareTimeoutException Thrown if the connection to the Api times out.

CloudFlarePhpSdk\Exceptions\CloudFlareException Thrown if an unknown exception occurs when connecting to the Api.

2 methods override CloudFlareZoneInterface::assertValidCredentials()
Zone::assertValidCredentials in src/Zone.php
Asserts that credentials are valid. Does NOT pull settings from CMI.
ZoneMock::assertValidCredentials in tests/modules/cloudflare_form_tester/src/Mocks/ZoneMock.php
Asserts that credentials are valid. Does NOT pull settings from CMI.

File

src/CloudFlareZoneInterface.php, line 59

Class

CloudFlareZoneInterface
Zone methods for CloudFlare.

Namespace

Drupal\cloudflare

Code

public static function assertValidCredentials($apikey, $email, CloudFlareComposerDependenciesCheckInterface $composer_dependency_check, CloudFlareStateInterface $state);