class Zone in CloudFlare 8

Zone methods for CloudFlare.

Hierarchy

class \Drupal\cloudflare\Zone implements CloudFlareZoneInterface uses StringTranslationTrait

Expanded class hierarchy of Zone

2 string references to 'Zone'

cloudflare.services.yml in ./cloudflare.services.yml: cloudflare.services.yml
ZoneSelectionForm::buildZoneListing in src/Form/ZoneSelectionForm.php: Builds a form render array for zone selection.

1 service uses Zone

cloudflare.zone in ./cloudflare.services.yml: Drupal\cloudflare\Zone

File

src/Zone.php, line 18

Namespace

Drupal\cloudflare

View source

class Zone 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;

  /**
   * The cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * {@inheritdoc}
   */
  public static function create(ConfigFactoryInterface $config_factory, LoggerInterface $logger, CacheBackendInterface $cache, CloudFlareStateInterface $state, CloudFlareComposerDependenciesCheckInterface $check_interface) {
    $config = $config_factory
      ->get('cloudflare.settings');
    $api_key = $config
      ->get('apikey');
    $email = $config
      ->get('email');

    // If someone has not correctly installed composer here is where we need to
    // handle it to prevent PHP error.
    try {
      $check_interface
        ->assert();
      $zoneapi = new ZoneApi($api_key, $email);
    } catch (ComposerDependencyException $e) {
      $zoneapi = NULL;
    }
    return new static($config_factory, $logger, $cache, $state, $zoneapi, $check_interface);
  }

  /**
   * Zone constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache backend.
   * @param \Drupal\cloudflare\CloudFlareStateInterface $state
   *   Tracks rate limits associated with CloudFlare Api.
   * @param \CloudFlarePhpSdk\ApiEndpoints\ZoneApi|null $zone_api
   *   ZoneApi instance for accessing api.
   * @param \Drupal\cloudflare\CloudFlareComposerDependenciesCheckInterface $check_interface
   *   Checks that composer dependencies are met.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LoggerInterface $logger, CacheBackendInterface $cache, CloudFlareStateInterface $state, $zone_api, CloudFlareComposerDependenciesCheckInterface $check_interface) {
    $this->config = $config_factory
      ->get('cloudflare.settings');
    $this->logger = $logger;
    $this->cache = $cache;
    $this->state = $state;
    $this->zoneApi = $zone_api;
    $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() {
    $this->cloudFlareComposerDependenciesCheck
      ->assert();
    $zones = [];
    $cid = 'cloudflare_zone_listing';
    try {
      if ($cached = $this->cache
        ->get($cid)) {
        return $cached->data;
      }
      else {
        $zones = $this->zoneApi
          ->listZones();

        // @todo come up with a better approach.
        $num_pages = ceil(count($zones) / ZoneApi::MAX_ITEMS_PER_PAGE);
        for ($i = 0; $i < $num_pages; $i++) {
          $this->state
            ->incrementApiRateCount();
        }
        $this->cache
          ->set($cid, $zones, time() + 60 * 5, [
          'cloudflare_zone',
        ]);
      }
    } catch (CloudFlareException $e) {
      $this->logger
        ->error($e
        ->getMessage());
      throw $e;
    }
    return $zones;
  }

  /**
   * {@inheritdoc}
   */
  public static function assertValidCredentials($apikey, $email, CloudFlareComposerDependenciesCheckInterface $composer_dependency_check, CloudFlareStateInterface $state) {
    $composer_dependency_check
      ->assert();
    $zone_api_direct = new ZoneApi($apikey, $email);
    try {
      $zones = $zone_api_direct
        ->listZones();
    } catch (Exception $e) {
      throw $e;
    } finally {
      $state
        ->incrementApiRateCount();
    }
  }

}

Members

Name	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.
Zone::$cache	protected	property	The cache backend.
Zone::$cloudFlareComposerDependenciesCheck	protected	property	Checks that the composer dependencies for CloudFlare are met.
Zone::$config	protected	property	The settings configuration.
Zone::$logger	protected	property	A logger instance.
Zone::$state	protected	property	Tracks rate limits associated with CloudFlare Api.
Zone::$validCredentials	protected	property	Flag for valid credentials.
Zone::$zone	protected	property	The current cloudflare ZoneId.
Zone::$zoneApi	protected	property	ZoneApi object for interfacing with CloudFlare Php Sdk.
Zone::assertValidCredentials	public static	function	Asserts that credentials are valid. Does NOT pull settings from CMI. Overrides CloudFlareZoneInterface::assertValidCredentials
Zone::create	public static	function
Zone::getZoneSettings	public	function	Gets the zone's settings from CloudFlare's API. Overrides CloudFlareZoneInterface::getZoneSettings
Zone::listZones	public	function	Retrieves a listing of zones in the current CloudFlare account. Overrides CloudFlareZoneInterface::listZones
Zone::updateZoneSettings	public	function	Updates a zone's settings from CloudFlare's API. Overrides CloudFlareZoneInterface::updateZoneSettings
Zone::__construct	public	function	Zone constructor.

You are here

class Zone in CloudFlare 8

Hierarchy

File

Namespace

Members

API Navigation