CodeExplorer
You are a developer and looking for Shopware projects?
Apply Now!
getConfigPrefix example
if (!$form_state->isValueEmpty('custom_entity_id')) {
$data[$id_key] = $form_state->getValue('custom_entity_id');
}
$entity_storage = $this->entityTypeManager->getStorage($form_state->getValue('config_type'));
// If an entity ID was not specified, set an error. if (!isset($data[$id_key])) {
$form_state->setErrorByName('import', $this->t('Missing ID key "@id_key" for this @entity_type import.', ['@id_key' => $id_key, '@entity_type' => $definition->getLabel()]));
return;
}
$config_name = $definition->getConfigPrefix() . '.' . $data[$id_key];
// If there is an existing entity, ensure matching ID and UUID. if ($entity = $entity_storage->load($data[$id_key])) {
$this->configExists = $entity;
if (!isset($data['uuid'])) {
$form_state->setErrorByName('import', $this->t('An entity with this machine name already exists but the import did not specify a UUID.'));
return;
}
if ($data['uuid'] !== $entity->uuid()) {
$form_state->setErrorByName('import', $this->t('An entity with this machine name already exists but the UUID does not match.'));
return;
}
}
$data[$id_key] = $form_state->getValue('custom_entity_id');
}
$entity_storage = $this->entityTypeManager->getStorage($form_state->getValue('config_type'));
// If an entity ID was not specified, set an error. if (!isset($data[$id_key])) {
$form_state->setErrorByName('import', $this->t('Missing ID key "@id_key" for this @entity_type import.', ['@id_key' => $id_key, '@entity_type' => $definition->getLabel()]));
return;
}
$config_name = $definition->getConfigPrefix() . '.' . $data[$id_key];
// If there is an existing entity, ensure matching ID and UUID. if ($entity = $entity_storage->load($data[$id_key])) {
$this->configExists = $entity;
if (!isset($data['uuid'])) {
$form_state->setErrorByName('import', $this->t('An entity with this machine name already exists but the import did not specify a UUID.'));
return;
}
if ($data['uuid'] !== $entity->uuid()) {
$form_state->setErrorByName('import', $this->t('An entity with this machine name already exists but the UUID does not match.'));
return;
}
}
$enforced_dependencies = $dependencies['enforced'];
unset($dependencies['enforced']);
$dependencies = NestedArray::mergeDeep($dependencies, $enforced_dependencies);
}
return $dependencies;
}
/** * {@inheritdoc} */
public function getConfigDependencyName() {
return $this->getEntityType()->getConfigPrefix() . '.' . $this->id();
}
/** * {@inheritdoc} */
public function getConfigTarget() {
// For configuration entities, use the config ID for the config target // identifier. This ensures that default configuration (which does not yet // have UUIDs) can be provided and installed with references to the target, // and also makes config dependencies more readable. return $this->id();
}
unset($dependencies['enforced']);
$dependencies = NestedArray::mergeDeep($dependencies, $enforced_dependencies);
}
return $dependencies;
}
/** * {@inheritdoc} */
public function getConfigDependencyName() {
return $this->getEntityType()->getConfigPrefix() . '.' . $this->id();
}
/** * {@inheritdoc} */
public function getConfigTarget() {
// For configuration entities, use the config ID for the config target // identifier. This ensures that default configuration (which does not yet // have UUIDs) can be provided and installed with references to the target, // and also makes config dependencies more readable. return $this->id();
}
$form['export']['#value'] = NULL;
return $form;
}
/** * Handles switching the export textarea. */
public function updateExport($form, FormStateInterface $form_state) {
// Determine the full config name for the selected config entity. if ($form_state->getValue('config_type') !== 'system.simple') {
$definition = $this->entityTypeManager->getDefinition($form_state->getValue('config_type'));
$name = $definition->getConfigPrefix() . '.' . $form_state->getValue('config_name');
}
// The config name is used directly for simple configuration. else {
$name = $form_state->getValue('config_name');
}
// Read the raw data for this config name, encode it, and display it. $form['export']['#value'] = Yaml::encode($this->configStorage->read($name));
$form['export']['#description'] = $this->t('Filename: %name', ['%name' => $name . '.yml']);
return $form['export'];
}
return $form;
}
/** * Handles switching the export textarea. */
public function updateExport($form, FormStateInterface $form_state) {
// Determine the full config name for the selected config entity. if ($form_state->getValue('config_type') !== 'system.simple') {
$definition = $this->entityTypeManager->getDefinition($form_state->getValue('config_type'));
$name = $definition->getConfigPrefix() . '.' . $form_state->getValue('config_name');
}
// The config name is used directly for simple configuration. else {
$name = $form_state->getValue('config_name');
}
// Read the raw data for this config name, encode it, and display it. $form['export']['#value'] = Yaml::encode($this->configStorage->read($name));
$form['export']['#description'] = $this->t('Filename: %name', ['%name' => $name . '.yml']);
return $form['export'];
}
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$this->configuration['rid'] = $form_state->getValue('rid');
}
/** * {@inheritdoc} */
public function calculateDependencies() {
if (!empty($this->configuration['rid'])) {
$prefix = $this->entityType->getConfigPrefix() . '.';
$this->addDependency('config', $prefix . $this->configuration['rid']);
}
return $this->dependencies;
}
/** * {@inheritdoc} */
public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
/** @var \Drupal\user\UserInterface $object */
$access = $object->access('update', $account, TRUE)
$this->storage = $this->container->get('entity_type.manager')->getStorage('config_test');
}
/** * Tests storage methods. */
public function testStorageMethods() {
$entity_type = \Drupal::entityTypeManager()->getDefinition('config_test');
// Test the static extractID() method. $expected_id = 'test_id';
$config_name = $entity_type->getConfigPrefix() . '.' . $expected_id;
$storage = $this->storage;
$this->assertSame($expected_id, $storage::getIDFromConfigName($config_name, $entity_type->getConfigPrefix()));
// Create three entities, two with the same style. $style = $this->randomMachineName(8);
for ($i = 0; $i < 2; $i++) {
$entity = $this->storage->create([
'id' => $this->randomMachineName(),
'label' => $this->randomString(),
'style' => $style,
]);
}
/** * Tests storage methods. */
public function testStorageMethods() {
$entity_type = \Drupal::entityTypeManager()->getDefinition('config_test');
// Test the static extractID() method. $expected_id = 'test_id';
$config_name = $entity_type->getConfigPrefix() . '.' . $expected_id;
$storage = $this->storage;
$this->assertSame($expected_id, $storage::getIDFromConfigName($config_name, $entity_type->getConfigPrefix()));
// Create three entities, two with the same style. $style = $this->randomMachineName(8);
for ($i = 0; $i < 2; $i++) {
$entity = $this->storage->create([
'id' => $this->randomMachineName(),
'label' => $this->randomString(),
'style' => $style,
]);
return $result;
}
/** * Loads the config records to examine for the query. * * @return array * Config records keyed by entity IDs. */
protected function loadRecords() {
$prefix = $this->entityType->getConfigPrefix() . '.';
$prefix_length = strlen($prefix);
// Search the conditions for restrictions on configuration object names. $filter_by_names = [];
$has_added_restrictions = FALSE;
$id_condition = NULL;
$id_key = $this->entityType->getKey('id');
if ($this->condition->getConjunction() == 'AND') {
$lookup_keys = $this->entityType->getLookupKeys();
$conditions = $this->condition->conditions();
foreach ($conditions as $condition_key => $condition) {
public function setEntity(ConfigEntityInterface $entity) {
if (parent::setEntity($entity)) {
// Field storage config can also contain translatable values. Add the name // of the config as well to the list of configs for this entity. /** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
$field_storage = $this->entity->getFieldStorageDefinition();
/** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type_info */
$entity_type_info = $this->entityTypeManager->getDefinition($field_storage->getEntityTypeId());
$this->addConfigName($entity_type_info->getConfigPrefix() . '.' . $field_storage->id());
return TRUE;
}
return FALSE;
}
}
/**
* Determines if the menu has configuration overrides.
*
* @return bool
* TRUE if the menu has configuration overrides, otherwise FALSE.
*/
protected function hasMenuOverrides() {
// @todo Replace the following with $this->menu->hasOverrides() in https://www.drupal.org/project/drupal/issues/2910353 // and remove this function. return $this->configFactory->get($this->menu->getEntityType()
->getConfigPrefix() . '.' . $this->menu->id())->hasOverrides();
}
}
protected function hasMenuOverrides() {
// @todo Replace the following with $this->menu->hasOverrides() in https://www.drupal.org/project/drupal/issues/2910353 // and remove this function. return $this->configFactory->get($this->menu->getEntityType()
->getConfigPrefix() . '.' . $this->menu->id())->hasOverrides();
}
}
return FALSE;
}
break;
case 'create':
if ($target_exists) {
// If the target already exists, use the entity storage to delete it // again, if is a simple config, delete it directly. if ($entity_type_id = $this->configManager->getEntityTypeIdByName($name)) {
$entity_storage = $this->configManager->getEntityTypeManager()->getStorage($entity_type_id);
$entity_type = $this->configManager->getEntityTypeManager()->getDefinition($entity_type_id);
$entity = $entity_storage->load($entity_storage->getIDFromConfigName($name, $entity_type->getConfigPrefix()));
$entity->delete();
$this->logError($this->t('Deleted and replaced configuration entity "@name"', ['@name' => $name]));
}
else {
$this->storageComparer->getTargetStorage($collection)->delete($name);
$this->logError($this->t('Deleted and replaced configuration "@name"', ['@name' => $name]));
}
return TRUE;
}
break;
}
break;
case 'create':
if ($target_exists) {
// If the target already exists, use the entity storage to delete it // again, if is a simple config, delete it directly. if ($entity_type_id = $this->configManager->getEntityTypeIdByName($name)) {
$entity_storage = $this->configManager->getEntityTypeManager()->getStorage($entity_type_id);
$entity_type = $this->configManager->getEntityTypeManager()->getDefinition($entity_type_id);
$entity = $entity_storage->load($entity_storage->getIDFromConfigName($name, $entity_type->getConfigPrefix()));
$entity->delete();
$this->logError($this->t('Deleted and replaced configuration entity "@name"', ['@name' => $name]));
}
else {
$this->storageComparer->getTargetStorage($collection)->delete($name);
$this->logError($this->t('Deleted and replaced configuration "@name"', ['@name' => $name]));
}
return TRUE;
}
break;
public function onConfigImporterValidate(ConfigImporterEvent $event) {
foreach ($event->getChangelist('delete') as $config_name) {
// Get the config entity type ID. This also ensure we are dealing with a // configuration entity. if ($entity_type_id = $this->configManager->getEntityTypeIdByName($config_name)) {
$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
// Does this entity type define a bundle of another entity type. if ($bundle_of = $entity_type->getBundleOf()) {
// Work out if there are entities with this bundle. $bundle_of_entity_type = $this->entityTypeManager->getDefinition($bundle_of);
$bundle_id = ConfigEntityStorage::getIDFromConfigName($config_name, $entity_type->getConfigPrefix());
$entity_query = $this->entityTypeManager->getStorage($bundle_of)->getQuery();
$entity_ids = $entity_query->condition($bundle_of_entity_type->getKey('bundle'), $bundle_id)
->accessCheck(FALSE)
->range(0, 1)
->execute();
if (!empty($entity_ids)) {
$entity = $this->entityTypeManager->getStorage($entity_type_id)->load($bundle_id);
$event->getConfigImporter()->logError($this->t('Entities exist of type %entity_type and %bundle_label %bundle. These entities need to be deleted before importing.', ['%entity_type' => $bundle_of_entity_type->getLabel(), '%bundle_label' => $bundle_of_entity_type->getBundleLabel(), '%bundle' => $entity->label()]));
}
}
}
}
$config_factory = $this->container->get('config.factory');
foreach ($default_config_storage->listAll() as $config_name) {
if ($active_config_storage->exists($config_name)) {
// If it is a config entity re-save it. This ensures that any // recalculation of dependencies does not cause config change. if ($entity_type = $config_manager->getEntityTypeIdByName($config_name)) {
$entity_storage = $config_manager
->getEntityTypeManager()
->getStorage($entity_type);
$id = $entity_storage->getIDFromConfigName($config_name, $entity_storage->getEntityType()
->getConfigPrefix());
$entity_storage->load($id)->calculateDependencies()->save();
}
else {
// Ensure simple configuration is re-saved so any schema sorting is // applied. $config_factory->getEditable($config_name)->save();
}
$result = $config_manager->diff($default_config_storage, $active_config_storage, $config_name);
// ::assertConfigDiff will throw an exception if the configuration is // different. $this->assertNull($this->assertConfigDiff($result, $config_name, static::$skippedConfig));
}
foreach ($default_config_storage->listAll() as $config_name) {
if ($active_config_storage->exists($config_name)) {
// If it is a config entity re-save it. This ensures that any // recalculation of dependencies does not cause config change. if ($entity_type = $config_manager->getEntityTypeIdByName($config_name)) {
$entity_storage = $config_manager
->getEntityTypeManager()
->getStorage($entity_type);
$id = $entity_storage->getIDFromConfigName($config_name, $entity_storage->getEntityType()
->getConfigPrefix());
$entity_storage->load($id)->calculateDependencies()->save();
}
else {
// Ensure simple configuration is re-saved so any schema sorting is // applied. $config_factory->getEditable($config_name)->save();
}
$result = $config_manager->diff($default_config_storage, $active_config_storage, $config_name);
// ::assertConfigDiff will throw an exception if the configuration is // different. $this->assertNull($this->assertConfigDiff($result, $config_name, static::$skippedConfig));
}
public function testConfigPrefixLengthExceeds() {
// A provider length of 24 and config_prefix length of 59 (+1 for the .) // results in a config length of 84, which is too long. $definition = [
'provider' => $this->randomMachineName(24),
'config_prefix' => $this->randomMachineName(59),
];
$config_entity = $this->setUpConfigEntityType($definition);
$this->expectException('\Drupal\Core\Config\ConfigPrefixLengthException');
$this->expectExceptionMessage("The configuration file name prefix {$definition['provider']}.{$definition['config_prefix']} exceeds the maximum character limit of " . ConfigEntityType::PREFIX_LENGTH);
$this->assertEmpty($config_entity->getConfigPrefix());
}
/** * Tests when the prefix length is valid. * * Tests that a valid config prefix returned by getConfigPrefix() * does not throw an exception and is formatted as expected. * * @covers ::getConfigPrefix */
public function testConfigPrefixLengthValid() {
$config_dependencies = $entity->getDependencies()['config'] ?? [];
foreach ($constraint->entityTypes as $entity_type_id) {
$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
if (!$entity_type instanceof ConfigEntityTypeInterface) {
throw new LogicException("'$entity_type_id' is not a config entity type.");
}
// Ensure the current entity type's config prefix is found in the config // dependencies of the entity being validated. $pattern = sprintf('/^%s\\.\\w+/', $entity_type->getConfigPrefix());
if (!preg_grep($pattern, $config_dependencies)) {
$this->context->addViolation($constraint->message, [
'@entity_type' => $entity->getEntityType()->getSingularLabel(),
'@dependency_type' => $entity_type->getSingularLabel(),
]);
}
}
}
}
foreach ($constraint->entityTypes as $entity_type_id) {
$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
if (!$entity_type instanceof ConfigEntityTypeInterface) {
throw new LogicException("'$entity_type_id' is not a config entity type.");
}
// Ensure the current entity type's config prefix is found in the config // dependencies of the entity being validated. $pattern = sprintf('/^%s\\.\\w+/', $entity_type->getConfigPrefix());
if (!preg_grep($pattern, $config_dependencies)) {
$this->context->addViolation($constraint->message, [
'@entity_type' => $entity->getEntityType()->getSingularLabel(),
'@dependency_type' => $entity_type->getSingularLabel(),
]);
}
}
}
}
/**
* Returns entity (form) displays for the current entity display type.
*
* @return \Drupal\Core\Entity\Display\EntityDisplayInterface[]
* An array holding entity displays or entity form displays.
*/
protected function getDisplays() {
$load_ids = [];
$display_entity_type = $this->entity->getEntityTypeId();
$entity_type = $this->entityTypeManager->getDefinition($display_entity_type);
$config_prefix = $entity_type->getConfigPrefix();
$ids = $this->configFactory()->listAll($config_prefix . '.' . $this->entity->getTargetEntityTypeId() . '.' . $this->entity->getTargetBundle() . '.');
foreach ($ids as $id) {
$config_id = str_replace($config_prefix . '.', '', $id);
[,, $display_mode] = explode('.', $config_id);
if ($display_mode != 'default') {
$load_ids[] = $config_id;
}
}
return $this->entityTypeManager->getStorage($display_entity_type)->loadMultiple($load_ids);
}
protected function getDisplays() {
$load_ids = [];
$display_entity_type = $this->entity->getEntityTypeId();
$entity_type = $this->entityTypeManager->getDefinition($display_entity_type);
$config_prefix = $entity_type->getConfigPrefix();
$ids = $this->configFactory()->listAll($config_prefix . '.' . $this->entity->getTargetEntityTypeId() . '.' . $this->entity->getTargetBundle() . '.');
foreach ($ids as $id) {
$config_id = str_replace($config_prefix . '.', '', $id);
[,, $display_mode] = explode('.', $config_id);
if ($display_mode != 'default') {
$load_ids[] = $config_id;
}
}
return $this->entityTypeManager->getStorage($display_entity_type)->loadMultiple($load_ids);
}
// default configuration entities to exist will be unstable after the
// module has been enabled and before the config entity has been
// imported.
if ($this->isSyncing()) {
continue;
}
/** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $entity_storage */
$entity_storage = $this->configManager
->getEntityTypeManager()
->getStorage($entity_type);
$id = $entity_storage->getIDFromConfigName($name, $entity_storage->getEntityType()->getConfigPrefix());
// It is possible that secondary writes can occur during configuration // creation. Updates of such configuration are allowed. if ($this->getActiveStorages($collection)->exists($name)) {
$entity = $entity_storage->load($id);
$entity = $entity_storage->updateFromStorageRecord($entity, $new_config->get());
}
else {
$entity = $entity_storage->createFromStorageRecord($new_config->get());
}
if ($entity->isInstallable()) {
$entity->trustData()->save();
continue;
}
/** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $entity_storage */
$entity_storage = $this->configManager
->getEntityTypeManager()
->getStorage($entity_type);
$id = $entity_storage->getIDFromConfigName($name, $entity_storage->getEntityType()->getConfigPrefix());
// It is possible that secondary writes can occur during configuration // creation. Updates of such configuration are allowed. if ($this->getActiveStorages($collection)->exists($name)) {
$entity = $entity_storage->load($id);
$entity = $entity_storage->updateFromStorageRecord($entity, $new_config->get());
}
else {
$entity = $entity_storage->createFromStorageRecord($new_config->get());
}
if ($entity->isInstallable()) {
$entity->trustData()->save();