class ConfigTest
Same name in this branch
- 9 core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/d8/ConfigTest.php \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\d8\ConfigTest
- 9 core/modules/migrate/tests/src/Unit/destination/ConfigTest.php \Drupal\Tests\migrate\Unit\destination\ConfigTest
- 9 core/modules/system/tests/src/Functional/File/ConfigTest.php \Drupal\Tests\system\Functional\File\ConfigTest
- 9 core/tests/Drupal/Tests/Composer/Plugin/ProjectMessage/ConfigTest.php \Drupal\Tests\Composer\Plugin\ProjectMessage\ConfigTest
- 9 core/tests/Drupal/Tests/Composer/Plugin/VendorHardening/ConfigTest.php \Drupal\Tests\Composer\Plugin\VendorHardening\ConfigTest
- 9 core/tests/Drupal/Tests/Core/Config/ConfigTest.php \Drupal\Tests\Core\Config\ConfigTest
Same name in other branches
- 8.9.x core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/d8/ConfigTest.php \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\d8\ConfigTest
- 8.9.x core/modules/config/tests/config_test/src/Entity/ConfigTest.php \Drupal\config_test\Entity\ConfigTest
- 8.9.x core/modules/migrate/tests/src/Unit/destination/ConfigTest.php \Drupal\Tests\migrate\Unit\destination\ConfigTest
- 8.9.x core/modules/system/tests/src/Functional/File/ConfigTest.php \Drupal\Tests\system\Functional\File\ConfigTest
- 8.9.x core/tests/Drupal/Tests/Composer/Plugin/ProjectMessage/ConfigTest.php \Drupal\Tests\Composer\Plugin\ProjectMessage\ConfigTest
- 8.9.x core/tests/Drupal/Tests/Composer/Plugin/VendorHardening/ConfigTest.php \Drupal\Tests\Composer\Plugin\VendorHardening\ConfigTest
- 8.9.x core/tests/Drupal/Tests/Core/Config/ConfigTest.php \Drupal\Tests\Core\Config\ConfigTest
- 10 core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/d8/ConfigTest.php \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\d8\ConfigTest
- 10 core/modules/config/tests/config_test/src/Entity/ConfigTest.php \Drupal\config_test\Entity\ConfigTest
- 10 core/modules/migrate/tests/src/Unit/destination/ConfigTest.php \Drupal\Tests\migrate\Unit\destination\ConfigTest
- 10 core/modules/system/tests/src/Functional/File/ConfigTest.php \Drupal\Tests\system\Functional\File\ConfigTest
- 10 core/tests/Drupal/Tests/Composer/Plugin/ProjectMessage/ConfigTest.php \Drupal\Tests\Composer\Plugin\ProjectMessage\ConfigTest
- 10 core/tests/Drupal/Tests/Composer/Plugin/VendorHardening/ConfigTest.php \Drupal\Tests\Composer\Plugin\VendorHardening\ConfigTest
- 10 core/tests/Drupal/Tests/Core/Config/ConfigTest.php \Drupal\Tests\Core\Config\ConfigTest
- 11.x core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/d8/ConfigTest.php \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\d8\ConfigTest
- 11.x core/modules/config/tests/config_test/src/Entity/ConfigTest.php \Drupal\config_test\Entity\ConfigTest
- 11.x core/modules/migrate/tests/src/Unit/destination/ConfigTest.php \Drupal\Tests\migrate\Unit\destination\ConfigTest
- 11.x core/modules/system/tests/src/Functional/File/ConfigTest.php \Drupal\Tests\system\Functional\File\ConfigTest
- 11.x core/tests/Drupal/Tests/Composer/Plugin/ProjectMessage/ConfigTest.php \Drupal\Tests\Composer\Plugin\ProjectMessage\ConfigTest
- 11.x core/tests/Drupal/Tests/Composer/Plugin/VendorHardening/ConfigTest.php \Drupal\Tests\Composer\Plugin\VendorHardening\ConfigTest
- 11.x core/tests/Drupal/Tests/Core/Config/ConfigTest.php \Drupal\Tests\Core\Config\ConfigTest
Defines the ConfigTest configuration entity.
Plugin annotation
@ConfigEntityType(
id = "config_test",
label = @Translation("Test configuration"),
handlers = {
"storage" = "Drupal\config_test\ConfigTestStorage",
"list_builder" = "Drupal\config_test\ConfigTestListBuilder",
"form" = {
"default" = "Drupal\config_test\ConfigTestForm",
"delete" = "Drupal\Core\Entity\EntityDeleteForm"
},
"access" = "Drupal\config_test\ConfigTestAccessControlHandler"
},
config_prefix = "dynamic",
entity_keys = {
"id" = "id",
"label" = "label",
"status" = "status"
},
config_export = {
"id",
"label",
"weight",
"style",
"size",
"size_value",
"protected_property",
},
links = {
"edit-form" = "/admin/structure/config_test/manage/{config_test}",
"delete-form" = "/admin/structure/config_test/manage/{config_test}/delete",
"enable" = "/admin/structure/config_test/manage/{config_test}/enable",
"disable" = "/admin/structure/config_test/manage/{config_test}/disable",
"collection" = "/admin/structure/config_test",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\config_test\Entity\ConfigTest extends \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\config_test\ConfigTestInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of ConfigTest
6 files declare their use of ConfigTest
- ConfigEntityListTest.php in core/
modules/ config/ tests/ src/ Functional/ ConfigEntityListTest.php - ConfigInstallWebTest.php in core/
modules/ config/ tests/ src/ Functional/ ConfigInstallWebTest.php - ConfigTestController.php in core/
modules/ config/ tests/ config_test/ src/ ConfigTestController.php - ConfigTestResourceTestBase.php in core/
modules/ config/ tests/ config_test/ tests/ src/ Functional/ Rest/ ConfigTestResourceTestBase.php - ConfigTestTest.php in core/
modules/ jsonapi/ tests/ src/ Functional/ ConfigTestTest.php
File
-
core/
modules/ config/ tests/ config_test/ src/ Entity/ ConfigTest.php, line 49
Namespace
Drupal\config_test\EntityView source
class ConfigTest extends ConfigEntityBase implements ConfigTestInterface {
/**
* The machine name for the configuration entity.
*
* @var string
*/
protected $id;
/**
* The human-readable name of the configuration entity.
*
* @var string
*/
public $label;
/**
* The weight of the configuration entity.
*
* @var int
*/
public $weight = 0;
/**
* The image style to use.
*
* @var string
*/
public $style;
/**
* A protected property of the configuration entity.
*
* @var string
*/
protected $protected_property;
/**
* {@inheritdoc}
*/
public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
\Drupal::state()->set('config_entity_sort', TRUE);
return parent::sort($a, $b);
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
// Used to test secondary writes during config sync.
if ($this->id() == 'primary') {
$secondary = $storage->create([
'id' => 'secondary',
'label' => 'Secondary Default',
]);
$secondary->save();
}
if ($this->id() == 'deleter') {
$deletee = $storage->load('deletee');
$deletee->delete();
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
foreach ($entities as $entity) {
if ($entity->id() == 'deleter') {
$deletee = $storage->load('deletee');
$deletee->delete();
}
}
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
if ($module = \Drupal::state()->get('config_test_new_dependency', FALSE)) {
$this->addDependency('module', $module);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function onDependencyRemoval(array $dependencies) {
// Record which entities have this method called on and what dependencies
// are passed.
$called = \Drupal::state()->get('config_test.on_dependency_removal_called', []);
$called[$this->id()] = $dependencies;
$called[$this->id()]['config'] = array_keys($called[$this->id()]['config']);
$called[$this->id()]['content'] = array_keys($called[$this->id()]['content']);
\Drupal::state()->set('config_test.on_dependency_removal_called', $called);
$changed = parent::onDependencyRemoval($dependencies);
if (!isset($this->dependencies['enforced']['config'])) {
return $changed;
}
$fix_deps = \Drupal::state()->get('config_test.fix_dependencies', []);
foreach ($dependencies['config'] as $entity) {
if (in_array($entity->getConfigDependencyName(), $fix_deps)) {
$key = array_search($entity->getConfigDependencyName(), $this->dependencies['enforced']['config']);
if ($key !== FALSE) {
$changed = TRUE;
unset($this->dependencies['enforced']['config'][$key]);
}
}
}
// If any of the dependencies removed still exists, return FALSE.
if (array_intersect_key(array_flip($this->dependencies['enforced']['config']), $dependencies['config'])) {
return FALSE;
}
return $changed;
}
/**
* Sets the enforced dependencies.
*
* @param array $dependencies
* A config dependency array.
*
* @return $this
*
* @see \Drupal\Core\Config\Entity\ConfigDependencyManager
*/
public function setEnforcedDependencies(array $dependencies) {
$this->dependencies['enforced'] = $dependencies;
return $this;
}
/**
* {@inheritdoc}
*/
public function isInstallable() {
return $this->id != 'isinstallable' || \Drupal::state()->get('config_test.isinstallable');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | |||
ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | |||
ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | |||
ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 4 | ||
ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | |||
ConfigEntityBase::$trustedData | protected | property | Trust supplied data and not use configuration schema on save. | |||
ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | |||
ConfigEntityBase::$_core | protected | property | ||||
ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |||
ConfigEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | |
ConfigEntityBase::disable | public | function | Disables the configuration entity. | Overrides ConfigEntityInterface::disable | 1 | |
ConfigEntityBase::enable | public | function | Enables the configuration entity. | Overrides ConfigEntityInterface::enable | ||
ConfigEntityBase::get | public | function | Returns the value of a property. | Overrides ConfigEntityInterface::get | ||
ConfigEntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityBase::getCacheTagsToInvalidate | 1 | |
ConfigEntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityBase::getConfigDependencyName | ||
ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | |||
ConfigEntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityBase::getConfigTarget | ||
ConfigEntityBase::getDependencies | public | function | Gets the configuration dependencies. | Overrides ConfigEntityInterface::getDependencies | ||
ConfigEntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityBase::getOriginalId | ||
ConfigEntityBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | ||
ConfigEntityBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | ||
ConfigEntityBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | ||
ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | |||
ConfigEntityBase::hasTrustedData | public | function | Gets whether on not the data is trusted. | Overrides ConfigEntityInterface::hasTrustedData | ||
ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. |
Overrides EntityBase::invalidateTagsOnDelete | ||
ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. |
Overrides EntityBase::invalidateTagsOnSave | ||
ConfigEntityBase::isNew | public | function | Overrides Entity::isNew(). | Overrides EntityBase::isNew | ||
ConfigEntityBase::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | Overrides ConfigEntityInterface::isUninstalling | ||
ConfigEntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | 8 | |
ConfigEntityBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides EntityBase::preSave | 13 | |
ConfigEntityBase::save | public | function | Saves an entity permanently. | Overrides EntityBase::save | 1 | |
ConfigEntityBase::set | public | function | Sets the value of a property. | Overrides ConfigEntityInterface::set | ||
ConfigEntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityBase::setOriginalId | ||
ConfigEntityBase::setStatus | public | function | Sets the status of the configuration entity. | Overrides ConfigEntityInterface::setStatus | ||
ConfigEntityBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::setThirdPartySetting | ||
ConfigEntityBase::setUninstalling | public | function | ||||
ConfigEntityBase::status | public | function | Returns whether the configuration entity is enabled. | Overrides ConfigEntityInterface::status | 4 | |
ConfigEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | 2 | |
ConfigEntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityBase::toUrl | ||
ConfigEntityBase::trustData | public | function | Sets that the data should be trusted. | Overrides ConfigEntityInterface::trustData | ||
ConfigEntityBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | ||
ConfigEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | 10 | |
ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | ||
ConfigTest::$id | protected | property | The machine name for the configuration entity. | |||
ConfigTest::$label | public | property | The human-readable name of the configuration entity. | |||
ConfigTest::$protected_property | protected | property | A protected property of the configuration entity. | |||
ConfigTest::$style | public | property | The image style to use. | |||
ConfigTest::$weight | public | property | The weight of the configuration entity. | |||
ConfigTest::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | Overrides ConfigEntityBase::calculateDependencies | ||
ConfigTest::isInstallable | public | function | Checks whether this entity is installable. | Overrides ConfigEntityBase::isInstallable | ||
ConfigTest::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | Overrides ConfigEntityBase::onDependencyRemoval | ||
ConfigTest::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityBase::postDelete | ||
ConfigTest::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityBase::postSave | ||
ConfigTest::setEnforcedDependencies | public | function | Sets the enforced dependencies. | |||
ConfigTest::sort | public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | Overrides ConfigEntityBase::sort | ||
DependencySerializationTrait::$_entityStorages | protected | property | ||||
DependencySerializationTrait::$_serviceIds | protected | property | ||||
DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | ||
EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
EntityBase::$entityTypeId | protected | property | The entity type. | |||
EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
EntityBase::access | public | function | Checks data value access. | Overrides AccessibleInterface::access | 1 | |
EntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityInterface::bundle | 1 | |
EntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityInterface::create | 1 | |
EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 1 | |
EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | ||
EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | |||
EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | |||
EntityBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts | ||
EntityBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge | ||
EntityBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags | ||
EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | ||
EntityBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityInterface::getEntityType | ||
EntityBase::getEntityTypeId | public | function | Gets the ID of the type of the entity. | Overrides EntityInterface::getEntityTypeId | ||
EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
EntityBase::getTypedData | public | function | Gets a typed data object for this entity object. | Overrides EntityInterface::getTypedData | ||
EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
EntityBase::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | Overrides EntityInterface::hasLinkTemplate | ||
EntityBase::id | public | function | Gets the identifier. | Overrides EntityInterface::id | 11 | |
EntityBase::label | public | function | Gets the label of the entity. | Overrides EntityInterface::label | 6 | |
EntityBase::language | public | function | Gets the language of the entity. | Overrides EntityInterface::language | 1 | |
EntityBase::languageManager | protected | function | Gets the language manager. | |||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
EntityBase::load | public static | function | Loads an entity. | Overrides EntityInterface::load | ||
EntityBase::loadMultiple | public static | function | Loads one or more entities. | Overrides EntityInterface::loadMultiple | ||
EntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityInterface::postCreate | 4 | |
EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 3 | |
EntityBase::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityInterface::preCreate | 7 | |
EntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityInterface::referencedEntities | 1 | |
EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | ||
EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | ||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | ||
EntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityInterface::uuid | 1 | |
EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | |||
PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | |||
SynchronizableEntityTrait::isSyncing | public | function | ||||
SynchronizableEntityTrait::setSyncing | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.