blizz_vanisher-8.x-1.x-dev/src/Service/ThirdPartyServicesVanisherInterface.php

<?php

namespace Drupal\blizz_vanisher\Service;

/**
 * Interface ThirdPartyServicesVanisherInterface.
 *
 * @package Drupal\blizz_vanisher\Service
 */
interface ThirdPartyServicesVanisherInterface {

  /**
   * Vanishes the content.
   *
   * @param string $content
   *   The content to vanish.
   *
   * @return string
   *   The vanished content.
   */
  public function vanish(&$content);

  /**
   * Returns the vanisher name.
   *
   * @return string
   *   The vanisher name.
   */
  public function getVanisherName();

  /**
   * Returns the name of this vanisher.
   *
   * @return string
   *   The name of this vanisher.
   */
  public function __toString();

  /**
   * Returns a array with cookie names.
   *
   * @return string[]
   *   A list of the cookie names
   */
  public function getCookies();

  /**
   * Returns a javascript so activate the service.
   * @see tarteaucitron.services.js
   *
   * @return string
   *   The javascript function to activate the service.
   */
  public function getJavascript();

  /**
   * Returns the name of this vanisher.
   * @see tarteaucitron.services.js
   *
   * @return string
   *   A fallback javascript
   */
  public function getFallbackJavascript();

}