You are here

Home » API reference » CloudFlare 8 » ZoneMock.php

class ZoneMock in CloudFlare 8

Zone methods for CloudFlare.

Hierarchy

Expanded class hierarchy of ZoneMock

2 files declare their use of ZoneMock
CloudFlareAdminSettingsFormTest.php in tests/src/Functional/CloudFlareAdminSettingsFormTest.php
CloudFlareAdminSettingsInvalidFormTest.php in tests/src/Functional/CloudFlareAdminSettingsInvalidFormTest.php
1 string reference to 'ZoneMock'
cloudflare_form_tester.services.yml in tests/modules/cloudflare_form_tester/cloudflare_form_tester.services.yml
tests/modules/cloudflare_form_tester/cloudflare_form_tester.services.yml
1 service uses ZoneMock
cloudflare.zonemock in tests/modules/cloudflare_form_tester/cloudflare_form_tester.services.yml
Drupal\cloudflare_form_tester\Mocks\ZoneMock

File

tests/modules/cloudflare_form_tester/src/Mocks/ZoneMock.php, line 19

Namespace

Drupal\cloudflare_form_tester\Mocks
View source 
class ZoneMock implements CloudFlareZoneInterface {
  use StringTranslationTrait;

  /**
   * The settings configuration.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * A logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Tracks rate limits associated with CloudFlare Api.
   *
   * @var \Drupal\cloudflare\CloudFlareStateInterface
   */
  protected $state;

  /**
   * ZoneApi object for interfacing with CloudFlare Php Sdk.
   *
   * @var \CloudFlarePhpSdk\ApiEndpoints\ZoneApi
   */
  protected $zoneApi;

  /**
   * The current cloudflare ZoneId.
   *
   * @var string
   */
  protected $zone;

  /**
   * Flag for valid credentials.
   *
   * @var bool
   */
  protected $validCredentials;

  /**
   * Checks that the composer dependencies for CloudFlare are met.
   *
   * @var \Drupal\cloudflare\CloudFlareComposerDependenciesCheckInterface
   */
  protected $cloudFlareComposerDependenciesCheck;

  /**
   * {@inheritdoc}
   */
  public static function create(ConfigFactoryInterface $config_factory, LoggerInterface $logger, CloudFlareStateInterface $state, CloudFlareComposerDependenciesCheckInterface $check_interface) {
    return new static($config_factory, $logger, $state, $check_interface);
  }

  /**
   * Zone constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\cloudflare\CloudFlareStateInterface $state
   *   Tracks rate limits associated with CloudFlare Api.
   * @param \Drupal\cloudflare\CloudFlareComposerDependenciesCheckInterface $check_interface
   *   Checks that composer dependencies are met.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LoggerInterface $logger, CloudFlareStateInterface $state, CloudFlareComposerDependenciesCheckInterface $check_interface) {
    $this->config = $config_factory
      ->get('cloudflare.settings');
    $this->logger = $logger;
    $this->state = $state;
    $this->zone = $this->config
      ->get('zone');
    $this->validCredentials = $this->config
      ->get('valid_credentials');
    $this->cloudFlareComposerDependenciesCheck = $check_interface;
  }

  /**
   * {@inheritdoc}
   */
  public function getZoneSettings() {
    $this->cloudFlareComposerDependenciesCheck
      ->assert();
    if (!$this->validCredentials) {
      return NULL;
    }
    try {
      $settings = $this->zoneApi
        ->getZoneSettings($this->zone);
      $this->state
        ->incrementApiRateCount();
      return $settings;
    } catch (CloudFlareException $e) {
      $this->logger
        ->error($e
        ->getMessage());
      throw $e;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function updateZoneSettings(ZoneSettings $zone_settings) {
    $this->cloudFlareComposerDependenciesCheck
      ->assert();
    if (!$this->validCredentials) {
      return;
    }
    try {
      $this->zoneApi
        ->updateZone($zone_settings);
      $this->state
        ->incrementApiRateCount();
    } catch (CloudFlareException $e) {
      $this->logger
        ->error($e
        ->getMessage());
      throw $e;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function listZones() {
    $cloudflare_zone_settings = [];
    $cloudflare_zone_settings['id'] = '123456789';
    $cloudflare_zone_settings['name'] = 'testdomain.com';
    $cloudflare_zone_settings['status'] = 'Active';
    $cloudflare_zone_settings['paused'] = FALSE;
    $cloudflare_zone_settings['type'] = 'zone';
    $cloudflare_zone_settings['development_mode'] = FALSE;
    $cloudflare_zone_settings['name_servers'] = [
      '1.2.3.4',
      '1.2.3.5',
    ];
    $cloudflare_zone_settings['original_name_servers'] = [
      '1.2.3.4',
      '1.2.3.5',
    ];
    $cloudflare_zone_settings['original_registrar'] = 'rsa.com';
    $cloudflare_zone_settings['original_dnshost'] = [
      '1.2.3.4',
      '1.2.3.5',
    ];
    $cloudflare_zone_settings['modified_on'] = '1453579581 ';
    $cloudflare_zone_settings['created_on'] = '1453579581';
    $cloudflare_zone_settings['owner'] = 'Drupal Developer';
    $cloudflare_zone_settings['permissions'] = 'EMPTY';
    $cloudflare_zone_settings['plan'] = 'EMPTY';
    $cloudflare_zone_settings2['id'] = '123456789999';
    $cloudflare_zone_settings2['name'] = 'testdomain2.com';
    $cloudflare_zone_settings2['status'] = 'Active';
    $cloudflare_zone_settings2['paused'] = FALSE;
    $cloudflare_zone_settings2['type'] = 'zone';
    $cloudflare_zone_settings2['development_mode'] = FALSE;
    $cloudflare_zone_settings2['name_servers'] = [
      '1.2.3.4',
      '1.2.3.5',
    ];
    $cloudflare_zone_settings2['original_name_servers'] = [
      '1.2.3.4',
      '1.2.3.5',
    ];
    $cloudflare_zone_settings2['original_registrar'] = 'rsa.com';
    $cloudflare_zone_settings2['original_dnshost'] = [
      '1.2.3.4',
      '1.2.3.5',
    ];
    $cloudflare_zone_settings2['modified_on'] = '1453579581 ';
    $cloudflare_zone_settings2['created_on'] = '1453579581';
    $cloudflare_zone_settings2['owner'] = 'Drupal Developer';
    $cloudflare_zone_settings2['permissions'] = 'EMPTY';
    $cloudflare_zone_settings2['plan'] = 'EMPTY';
    $zone1 = new Zone($cloudflare_zone_settings);
    $zone2 = new Zone($cloudflare_zone_settings2);
    $has_multi_zone = \Drupal::state()
      ->get('cloudflaretesting.multizone');
    if ($has_multi_zone) {
      return [
        $zone1,
        $zone2,
      ];
    }
    else {
      return [
        $zone1,
      ];
    }
  }

  /**
   * Tells the mock to assert if credentials are valid or not.
   *
   * @param bool $assert_valid_credentials
   *   TRUE to mock credentials are met.  FALSE otherwise.
   */
  public static function mockAssertValidCredentials($assert_valid_credentials) {
    \Drupal::state()
      ->set('cloudflaretesting.assetValidCredentials', $assert_valid_credentials);
  }

  /**
   * Tells the mock to return multiple zones.
   *
   * @param bool $multi_zone
   *   TRUE to mock multipleZones.  FALSE for singlezone.
   */
  public static function mockMultiZoneAccount($multi_zone) {
    \Drupal::state()
      ->set('cloudflaretesting.multizone', $multi_zone);
  }

  /**
   * {@inheritdoc}
   */
  public static function assertValidCredentials($apikey, $email, CloudFlareComposerDependenciesCheckInterface $composer_dependency_check, CloudFlareStateInterface $state) {
    $assert_valid_credentials = \Drupal::state()
      ->get('cloudflaretesting.assetValidCredentials');
    if ($assert_valid_credentials != TRUE) {
      throw new CloudFlareInvalidCredentialException("invalid", 1);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
ZoneMock::$cloudFlareComposerDependenciesCheck protected property Checks that the composer dependencies for CloudFlare are met.
ZoneMock::$config protected property The settings configuration.
ZoneMock::$logger protected property A logger instance.
ZoneMock::$state protected property Tracks rate limits associated with CloudFlare Api.
ZoneMock::$validCredentials protected property Flag for valid credentials.
ZoneMock::$zone protected property The current cloudflare ZoneId.
ZoneMock::$zoneApi protected property ZoneApi object for interfacing with CloudFlare Php Sdk.
ZoneMock::assertValidCredentials public static function Asserts that credentials are valid. Does NOT pull settings from CMI. Overrides CloudFlareZoneInterface::assertValidCredentials
ZoneMock::create public static function
ZoneMock::getZoneSettings public function Gets the zone's settings from CloudFlare's API. Overrides CloudFlareZoneInterface::getZoneSettings
ZoneMock::listZones public function Retrieves a listing of zones in the current CloudFlare account. Overrides CloudFlareZoneInterface::listZones
ZoneMock::mockAssertValidCredentials public static function Tells the mock to assert if credentials are valid or not.
ZoneMock::mockMultiZoneAccount public static function Tells the mock to return multiple zones.
ZoneMock::updateZoneSettings public function Updates a zone's settings from CloudFlare's API. Overrides CloudFlareZoneInterface::updateZoneSettings
ZoneMock::__construct public function Zone constructor.