interface WebformSubmissionViewBuilderInterface in Webform 6.x

Defines an interface for webform view builder classes.

Hierarchy

• interface \Drupal\Core\Entity\EntityHandlerInterface; interface \Drupal\Core\Entity\EntityViewBuilderInterface
  • interface \Drupal\webform\WebformSubmissionViewBuilderInterface

File

src/WebformSubmissionViewBuilderInterface.php, line 11

Namespace

Drupal\webform

interface WebformSubmissionViewBuilderInterface extends EntityHandlerInterface, EntityViewBuilderInterface {

  /**
   * Build element display items from elements and submitted data.
   *
   * @param array $elements
   *   Webform elements.
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   * @param array $options
   *   - excluded_elements: An array of elements to be excluded.
   *   - ignore_access: Flag to ignore private and/or access controls and always
   *     display the element.
   *   - email: Format element to be send via email.
   * @param string $format
   *   Output format set to html or text.
   *
   * @return array
   *   A render array displaying the submitted values.
   */
  public function buildElements(array $elements, WebformSubmissionInterface $webform_submission, array $options = [], $format = 'html');

  /**
   * Build table display from elements and submitted data.
   *
   * @param array $elements
   *   A flattened array webform elements that have values.
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   * @param array $options
   *   - excluded_elements: An array of elements to be excluded.
   *   - email: Format element to be send via email.
   *
   * @return array
   *   A render array displaying the submitted values in a table.
   */
  public function buildTable(array $elements, WebformSubmissionInterface $webform_submission, array $options = []);

}

Members

Name	Modifiers	Type	Description	Overrides
EntityHandlerInterface::createInstance	public static	function	Instantiates a new instance of this entity handler.	16
EntityViewBuilderInterface::buildComponents	public	function	Builds the component fields and properties of a set of entities.	1
EntityViewBuilderInterface::getCacheTags	public	function	The cache tag associated with this entity view builder.	1
EntityViewBuilderInterface::resetCache	public	function	Resets the entity render cache.	1
EntityViewBuilderInterface::view	public	function	Builds the render array for the provided entity.	1
EntityViewBuilderInterface::viewField	public	function	Builds a renderable array for the value of a single field in an entity.	1
EntityViewBuilderInterface::viewFieldItem	public	function	Builds a renderable array for a single field item.	1
EntityViewBuilderInterface::viewMultiple	public	function	Builds the render array for the provided entities.	1
WebformSubmissionViewBuilderInterface::buildElements	public	function	Build element display items from elements and submitted data.	1
WebformSubmissionViewBuilderInterface::buildTable	public	function	Build table display from elements and submitted data.	1