www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/paragraphs/src/ParagraphsTypeInterface.php

   1 <?php
   2
   3 namespace Drupal\paragraphs;
   4
   5 use Drupal\Core\Config\Entity\ConfigEntityInterface;
   6
   7 /**
   8  * Provides an interface defining a ParagraphsType entity.
   9  */
  10 interface ParagraphsTypeInterface extends ConfigEntityInterface {
  11
  12   /**
  13    * Returns the ordered collection of feature plugin instances.
  14    *
  15    * @return \Drupal\paragraphs\ParagraphsBehaviorCollection
  16    *   The behavior plugins collection.
  17    */
  18   public function getBehaviorPlugins();
  19
  20   /**
  21    * Returns an individual plugin instance.
  22    *
  23    * @param string $instance_id
  24    *   The ID of a behavior plugin instance to return.
  25    *
  26    * @return \Drupal\paragraphs\ParagraphsBehaviorInterface
  27    *   A specific feature plugin instance.
  28    */
  29   public function getBehaviorPlugin($instance_id);
  30
  31   /**
  32    * Retrieves all the enabled plugins.
  33    *
  34    * @return array
  35    *   Array of the enabled plugins as instances.
  36    */
  37   public function getEnabledBehaviorPlugins();
  38
  39   /**
  40    * Returns TRUE if $plugin_id is enabled on this ParagraphType Entity.
  41    *
  42    * @param string $plugin_id
  43    *   The plugin id, as specified in the plugin annotation details.
  44    *
  45    * @return bool
  46    *   True or False dependant on plugin state
  47    */
  48   public function hasEnabledBehaviorPlugin($plugin_id);
  49
  50 }