paragraphs_sets-8.x-2.x-dev/src/ParagraphsSetInterface.php

<?php

namespace Drupal\paragraphs_sets;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a ParagraphsSet entity.
 */
interface ParagraphsSetInterface extends ConfigEntityInterface {

  /**
   * Returns the icon file entity.
   *
   * @return \Drupal\file\FileInterface|bool
   *   The icon's file entity or FALSE if icon does not exist.
   */
  public function getIconFile();

  /**
   * Returns the icon's URL.
   *
   * @return string|bool
   *   The icon's URL or FALSE if icon does not exits.
   */
  public function getIconUrl();

  /**
   * Returns the static icon URI (if set).
   *
   * @return string|null
   *   The static icon URI or NULL if no static icon is set.
   */
  public function getStaticIconUri();

  /**
   * Return the label of the Paragraph Set.
   *
   * @return string
   *   The label of the Paragraph Set.
   */
  public function getLabel();

  /**
   * Gets the description.
   *
   * @return string
   *   The description of the Paragraph Set.
   */
  public function getDescription();

  /**
   * Get the list of paragraphs in the set.
   *
   * @return array<int, array{
   *     'bundle': string,
   *     'data': array<mixed>,
   *     ...
   *   }>
   *   The paragraphs data of the Paragraph Set.
   */
  public function getParagraphs();

}