Updated to Drupal 8.5. Core Media not yet in use.
[yaffs-website] / web / modules / contrib / paragraphs / src / ParagraphsTypeInterface.php
index 9465772c969670b4c7d50119efa2aafabfbbdfa4..9eb889ea3087ae4acf5ddaf0797144e593264281 100644 (file)
@@ -31,11 +31,35 @@ interface ParagraphsTypeInterface extends ConfigEntityInterface {
   /**
    * Retrieves all the enabled plugins.
    *
-   * @return array
+   * @return \Drupal\paragraphs\ParagraphsBehaviorInterface[]
    *   Array of the enabled plugins as instances.
    */
   public function getEnabledBehaviorPlugins();
 
+  /**
+   * 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();
+
+  /**
+   * Gets the description.
+   *
+   * @return string
+   *   The description of this paragraph type.
+   */
+  public function getDescription();
+
   /**
    * Returns TRUE if $plugin_id is enabled on this ParagraphType Entity.
    *
@@ -43,7 +67,7 @@ interface ParagraphsTypeInterface extends ConfigEntityInterface {
    *   The plugin id, as specified in the plugin annotation details.
    *
    * @return bool
-   *   True or False dependant on plugin state
+   *   TRUE if the plugin is enabled, FALSE otherwise.
    */
   public function hasEnabledBehaviorPlugin($plugin_id);