class ParagraphsType in Paragraphs 8
Same name in this branch
- 8 src/Entity/ParagraphsType.php \Drupal\paragraphs\Entity\ParagraphsType
- 8 src/Plugin/migrate/source/d7/ParagraphsType.php \Drupal\paragraphs\Plugin\migrate\source\d7\ParagraphsType
Defines the ParagraphsType entity.
Plugin annotation
@ConfigEntityType(
id = "paragraphs_type",
label = @Translation("Paragraphs type"),
label_collection = @Translation("Paragraphs types"),
label_singular = @Translation("Paragraphs type"),
label_plural = @Translation("Paragraphs types"),
label_count = @PluralTranslation(
singular = "@count Paragraphs type",
plural = "@count Paragraphs types",
),
handlers = {
"access" = "Drupal\paragraphs\ParagraphsTypeAccessControlHandler",
"list_builder" = "Drupal\paragraphs\Controller\ParagraphsTypeListBuilder",
"form" = {
"add" = "Drupal\paragraphs\Form\ParagraphsTypeForm",
"edit" = "Drupal\paragraphs\Form\ParagraphsTypeForm",
"delete" = "Drupal\paragraphs\Form\ParagraphsTypeDeleteConfirm"
}
},
config_prefix = "paragraphs_type",
admin_permission = "administer paragraphs types",
entity_keys = {
"id" = "id",
"label" = "label",
},
config_export = {
"id",
"label",
"icon_uuid",
"icon_default",
"description",
"behavior_plugins",
},
bundle_of = "paragraph",
links = {
"edit-form" = "/admin/structure/paragraphs_type/{paragraphs_type}",
"delete-form" = "/admin/structure/paragraphs_type/{paragraphs_type}/delete",
"collection" = "/admin/structure/paragraphs_type",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\paragraphs\Entity\ParagraphsType implements EntityWithPluginCollectionInterface, ParagraphsTypeInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of ParagraphsType
21 files declare their use of ParagraphsType
- paragraphs.module in ./
paragraphs.module - Contains paragraphs.module
- ParagraphsAddModesTest.php in tests/
src/ Functional/ WidgetLegacy/ ParagraphsAddModesTest.php - ParagraphsAddModesTest.php in tests/
src/ Functional/ WidgetStable/ ParagraphsAddModesTest.php - ParagraphsBehaviorBase.php in src/
ParagraphsBehaviorBase.php - ParagraphsBehaviorInterface.php in src/
ParagraphsBehaviorInterface.php
File
- src/
Entity/ ParagraphsType.php, line 57
Namespace
Drupal\paragraphs\EntityView source
class ParagraphsType extends ConfigEntityBundleBase implements ParagraphsTypeInterface, EntityWithPluginCollectionInterface {
/**
* The ParagraphsType ID.
*
* @var string
*/
public $id;
/**
* The ParagraphsType label.
*
* @var string
*/
public $label;
/**
* A brief description of this paragraph type.
*
* @var string
*/
public $description;
/**
* UUID of the Paragraphs type icon file.
*
* @var string
*/
protected $icon_uuid;
/**
* Default icon encoded as data URL scheme (RFC 2397).
*
* @var string
*/
protected $icon_default;
/**
* The Paragraphs type behavior plugins configuration keyed by their id.
*
* @var array
*/
public $behavior_plugins = [];
/**
* Holds the collection of behavior plugins that are attached to this
* Paragraphs type.
*
* @var \Drupal\paragraphs\ParagraphsBehaviorCollection
*/
protected $behaviorCollection;
/**
* Restores the icon file from the default icon value.
*
* @return \Drupal\file\FileInterface|bool
* The icon's file entity or FALSE if no default icon set.
*/
protected function restoreDefaultIcon() {
// Default icon data in RFC 2397 format ("data" URL scheme).
if ($this->icon_default && ($icon_data = fopen($this->icon_default, 'r'))) {
// Compose the default icon file destination.
$icon_meta = stream_get_meta_data($icon_data);
// File extension from MIME, only JPG/JPEG, PNG and SVG expected.
list(, $icon_file_ext) = explode('image/', $icon_meta['mediatype']);
// SVG special case.
if ($icon_file_ext == 'svg+xml') {
$icon_file_ext = 'svg';
}
$filesystem = \Drupal::service('file_system');
$icon_upload_path = ParagraphsTypeInterface::ICON_UPLOAD_LOCATION;
$icon_file_destination = $icon_upload_path . $this
->id() . '-default-icon.' . $icon_file_ext;
// Check the directory exists before writing data to it.
$filesystem
->prepareDirectory($icon_upload_path, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
// Save the default icon file.
$icon_file_uri = $filesystem
->saveData($icon_data, $icon_file_destination);
if ($icon_file_uri) {
// Create the icon file entity.
$icon_entity_values = [
'uri' => $icon_file_uri,
'uid' => \Drupal::currentUser()
->id(),
'uuid' => $this->icon_uuid,
'status' => FILE_STATUS_PERMANENT,
];
// Delete existent icon file if it exists.
if ($old_icon = $this
->getFileByUuid($this->icon_uuid)) {
$old_icon
->delete();
}
$new_icon = File::create($icon_entity_values);
$new_icon
->save();
$this
->updateFileIconUsage($new_icon, $old_icon);
return $new_icon;
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getIconFile() {
$icon = $this
->getFileByUuid($this->icon_uuid) ?: $this
->restoreDefaultIcon();
if ($this->icon_uuid && $icon) {
return $icon;
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getBehaviorPlugins() {
if (!isset($this->behaviorCollection)) {
$this->behaviorCollection = new ParagraphsBehaviorCollection(\Drupal::service('plugin.manager.paragraphs.behavior'), $this->behavior_plugins);
}
return $this->behaviorCollection;
}
/**
* {@inheritdoc}
*/
public function getIconUrl() {
if ($image = $this
->getIconFile()) {
return file_create_url($image
->getFileUri());
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getBehaviorPlugin($instance_id) {
return $this
->getBehaviorPlugins()
->get($instance_id);
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
// Add the file icon entity as dependency if a UUID was specified.
if ($this->icon_uuid && ($file_icon = $this
->getIconFile())) {
$this
->addDependency($file_icon
->getConfigDependencyKey(), $file_icon
->getConfigDependencyName());
}
return $this;
}
/**
* {@inheritdoc}
*/
public function onDependencyRemoval(array $dependencies) {
$changed = parent::onDependencyRemoval($dependencies);
$behavior_plugins = $this
->getBehaviorPlugins();
foreach ($dependencies['module'] as $module) {
/** @var \Drupal\Component\Plugin\PluginInspectionInterface $plugin */
foreach ($behavior_plugins as $instance_id => $plugin) {
$definition = (array) $plugin
->getPluginDefinition();
// If a module providing a behavior plugin is being uninstalled,
// remove the plugin and dependency so this paragraph bundle is not
// deleted too.
if (isset($definition['provider']) && $definition['provider'] === $module) {
unset($this->behavior_plugins[$instance_id]);
$this
->getBehaviorPlugins()
->removeInstanceId($instance_id);
$changed = TRUE;
}
}
}
return $changed;
}
/**
* {@inheritdoc}
*/
public function getEnabledBehaviorPlugins() {
return $this
->getBehaviorPlugins()
->getEnabled();
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'behavior_plugins' => $this
->getBehaviorPlugins(),
];
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this->description;
}
/**
* {@inheritdoc}
*/
public function hasEnabledBehaviorPlugin($plugin_id) {
$plugins = $this
->getBehaviorPlugins();
if ($plugins
->has($plugin_id)) {
/** @var \Drupal\paragraphs\ParagraphsBehaviorInterface $plugin */
$plugin = $plugins
->get($plugin_id);
$config = $plugin
->getConfiguration();
return array_key_exists('enabled', $config) && $config['enabled'] === TRUE;
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
if (!$update || $this->icon_uuid != $this->original->icon_uuid) {
// Update the file usage for the icon file.
$new_icon_file = $this->icon_uuid ? $this
->getFileByUuid($this->icon_uuid) : FALSE;
// Update the file usage of the old icon as well if the icon was changed.
$old_icon_file = $update && $this->original->icon_uuid ? $this
->getFileByUuid($this->original->icon_uuid) : FALSE;
$this
->updateFileIconUsage($new_icon_file, $old_icon_file);
}
parent::postSave($storage, $update);
}
/**
* Gets the file entity defined by the UUID.
*
* @param string $uuid
* The file entity's UUID.
*
* @return \Drupal\file\FileInterface|null
* The file entity. NULL if the UUID is invalid.
*/
protected function getFileByUuid($uuid) {
if ($id = \Drupal::service('paragraphs_type.uuid_lookup')
->get($uuid)) {
return $this
->entityTypeManager()
->getStorage('file')
->load($id);
}
return NULL;
}
/**
* Updates the icon file usage information.
*
* @param \Drupal\file\FileInterface|mixed $new_icon
* The new icon file, FALSE on deletion.
* @param \Drupal\file\FileInterface|mixed $old_icon
* (optional) Old icon, on update or deletion.
*/
protected function updateFileIconUsage($new_icon, $old_icon = FALSE) {
/** @var \Drupal\file\FileUsage\FileUsageInterface $file_usage */
$file_usage = \Drupal::service('file.usage');
if ($new_icon) {
// Add usage of the new icon file.
$file_usage
->add($new_icon, 'paragraphs', 'paragraphs_type', $this
->id());
}
if ($old_icon) {
// Delete usage of the old icon file.
$file_usage
->delete($old_icon, 'paragraphs', 'paragraphs_type', $this
->id());
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
ConfigEntityBundleBase:: |
protected | function | Deletes display if a bundle is deleted. | |
ConfigEntityBundleBase:: |
protected | function | Returns view or form displays for this bundle. | |
ConfigEntityBundleBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
ParagraphsType:: |
protected | property | Holds the collection of behavior plugins that are attached to this Paragraphs type. | |
ParagraphsType:: |
public | property | The Paragraphs type behavior plugins configuration keyed by their id. | |
ParagraphsType:: |
public | property | A brief description of this paragraph type. | |
ParagraphsType:: |
protected | property | Default icon encoded as data URL scheme (RFC 2397). | |
ParagraphsType:: |
protected | property | UUID of the Paragraphs type icon file. | |
ParagraphsType:: |
public | property | The ParagraphsType ID. | |
ParagraphsType:: |
public | property | The ParagraphsType label. | |
ParagraphsType:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase:: |
|
ParagraphsType:: |
public | function |
Returns an individual plugin instance. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
public | function |
Returns the ordered collection of feature plugin instances. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
public | function |
Gets the description. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
public | function |
Retrieves all the enabled plugins. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
protected | function | Gets the file entity defined by the UUID. | |
ParagraphsType:: |
public | function |
Returns the icon file entity. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
public | function |
Returns the icon's URL. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
public | function |
Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface:: |
|
ParagraphsType:: |
public | function |
Returns TRUE if $plugin_id is enabled on this ParagraphType Entity. Overrides ParagraphsTypeInterface:: |
|
ParagraphsType:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase:: |
|
ParagraphsType:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase:: |
|
ParagraphsType:: |
protected | function | Restores the icon file from the default icon value. | |
ParagraphsType:: |
protected | function | Updates the icon file usage information. | |
ParagraphsTypeInterface:: |
constant | Icon upload location. | ||
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |