Provides an interface defining a ParagraphsType entity.
Expanded class hierarchy of ParagraphsTypeInterface
All classes that implement ParagraphsTypeInterface
interface ParagraphsTypeInterface extends ConfigEntityInterface {
/**
* Icon upload location.
*
* @var string
*/
const ICON_UPLOAD_LOCATION = 'public://paragraphs_type_icon/';
/**
* Returns the ordered collection of feature plugin instances.
*
* @return \Drupal\paragraphs\ParagraphsBehaviorCollection
* The behavior plugins collection.
*/
public function getBehaviorPlugins();
/**
* Returns an individual plugin instance.
*
* @param string $instance_id
* The ID of a behavior plugin instance to return.
*
* @return \Drupal\paragraphs\ParagraphsBehaviorInterface
* A specific feature plugin instance.
*/
public function getBehaviorPlugin($instance_id);
/**
* Retrieves all the enabled plugins.
*
* @return \Drupal\paragraphs\ParagraphsBehaviorInterface[]
* Array of the enabled plugins as instances.
*/
public function getEnabledBehaviorPlugins();
/**
* Returns the icon file entity.
*
* @return \Drupal\file\FileInterface|false
* The icon's file entity or FALSE if icon does not exist.
*/
public function getIconFile();
/**
* Returns the icon's URL.
*
* @return string|false
* 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.
*
* @param string $plugin_id
* The plugin id, as specified in the plugin annotation details.
*
* @return bool
* TRUE if the plugin is enabled, FALSE otherwise.
*/
public function hasEnabledBehaviorPlugin($plugin_id);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ParagraphsTypeInterface:: |
public | function | Returns an individual plugin instance. | 1 |
ParagraphsTypeInterface:: |
public | function | Returns the ordered collection of feature plugin instances. | 1 |
ParagraphsTypeInterface:: |
public | function | Gets the description. | 1 |
ParagraphsTypeInterface:: |
public | function | Retrieves all the enabled plugins. | 1 |
ParagraphsTypeInterface:: |
public | function | Returns the icon file entity. | 1 |
ParagraphsTypeInterface:: |
public | function | Returns the icon's URL. | 1 |
ParagraphsTypeInterface:: |
public | function | Returns TRUE if $plugin_id is enabled on this ParagraphType Entity. | 1 |
ParagraphsTypeInterface:: |
constant | Icon upload location. |