custom_elements-8.x-2.x-dev/src/Processor/CustomElementProcessorInterface.php

<?php

namespace Drupal\custom_elements\Processor;

use Drupal\custom_elements\CustomElement;

/**
 * Processes data into custom elements.
 *
 * @see \Drupal\custom_elements\Processor\CustomElementProcessorWithKeyInterface
 */
interface CustomElementProcessorInterface {

  /**
   * Determines whether processing the given data is supported.
   *
   * @param mixed $data
   *   The data to be processed into a custom element.
   * @param string $viewMode
   *   The view mode used for current rendering.
   *
   * @return bool
   *   Returns TRUE if supports, otherwise FALSE.
   */
  public function supports($data, $viewMode);

  /**
   * Processes the given data and adds it to the element.
   *
   * @param mixed $data
   *   The data to be added.
   * @param \Drupal\custom_elements\CustomElement $element
   *   The custom element that is generated.
   * @param string $viewMode
   *   The view mode under which the element is rendered.
   */
  public function addtoElement($data, CustomElement $element, $viewMode);

}