interface AkamaiClientInterface in Akamai 8.3

Contains the \Drupal\akamai\AkamaiClientInterface interface.

Hierarchy

• interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\akamai\AkamaiClientInterface

1 file declares its use of AkamaiClientInterface

QueueLengthCheck.php in src/Plugin/Purge/DiagnosticCheck/QueueLengthCheck.php

File

src/AkamaiClientInterface.php, line 12

Namespace

Drupal\akamai

interface AkamaiClientInterface extends ContainerFactoryPluginInterface, PluginInspectionInterface, PluginFormInterface {

  /**
   * String constant for the production network.
   */
  const NETWORK_PRODUCTION = 'production';

  /**
   * String constant for the staging network.
   */
  const NETWORK_STAGING = 'staging';

  /**
   * The maximum size, in bytes, of a request body allowed by the API.
   */
  const MAX_BODY_SIZE = 50000;

  /**
   * Sets the domain to clear.
   *
   * @param string $domain
   *   The domain to clear, either 'production' or 'staging'.
   *
   * @return $this
   */
  public function setDomain($domain);

  /**
   * Helper function to set the action for purge request.
   *
   * @param string $action
   *   Action to be taken while purging.
   *
   * @return $this
   */
  public function setAction($action);

  /**
   * Sets the type of purge.
   *
   * @param string $type
   *   The type of purge, either 'arl' or 'cpcode'.
   *
   * @return $this
   */
  public function setType($type);

  /**
   * Verifies that the body of a purge request will be under 50,000 bytes.
   *
   * @param array $paths
   *   An array of paths to be purged.
   *
   * @return bool
   *   TRUE if the body size is below the limit, otherwise FALSE.
   */
  public function bodyIsBelowLimit(array $paths = []);

}

Members

Name	Modifiers	Type	Description	Overrides
AkamaiClientInterface::bodyIsBelowLimit	public	function	Verifies that the body of a purge request will be under 50,000 bytes.	1
AkamaiClientInterface::MAX_BODY_SIZE		constant	The maximum size, in bytes, of a request body allowed by the API.
AkamaiClientInterface::NETWORK_PRODUCTION		constant	String constant for the production network.
AkamaiClientInterface::NETWORK_STAGING		constant	String constant for the staging network.
AkamaiClientInterface::setAction	public	function	Helper function to set the action for purge request.	1
AkamaiClientInterface::setDomain	public	function	Sets the domain to clear.	1
AkamaiClientInterface::setType	public	function	Sets the type of purge.	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2