Same name in this branch
- 10 core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
- 10 core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
- 10 core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
Same name and namespace in other branches
- 8.9.x core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
- 9 core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
Defines the Node type configuration entity.
Plugin annotation
@ConfigEntityType(
id = "node_type",
label = @Translation("Content type"),
label_collection = @Translation("Content types"),
label_singular = @Translation("content type"),
label_plural = @Translation("content types"),
label_count = @PluralTranslation(
singular = "@count content type",
plural = "@count content types",
),
handlers = {
"access" = "Drupal\node\NodeTypeAccessControlHandler",
"form" = {
"add" = "Drupal\node\NodeTypeForm",
"edit" = "Drupal\node\NodeTypeForm",
"delete" = "Drupal\node\Form\NodeTypeDeleteConfirm"
},
"route_provider" = {
"permissions" = "Drupal\user\Entity\EntityPermissionsRouteProvider",
},
"list_builder" = "Drupal\node\NodeTypeListBuilder",
},
admin_permission = "administer content types",
config_prefix = "type",
bundle_of = "node",
entity_keys = {
"id" = "type",
"label" = "name"
},
links = {
"edit-form" = "/admin/structure/types/manage/{node_type}",
"delete-form" = "/admin/structure/types/manage/{node_type}/delete",
"entity-permissions-form" = "/admin/structure/types/manage/{node_type}/permissions",
"collection" = "/admin/structure/types",
},
config_export = {
"name",
"type",
"description",
"help",
"new_revision",
"preview_mode",
"display_submitted",
}
)
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\node\Entity\NodeType implements NodeTypeInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of NodeType
158 files declare their use of NodeType
- ArgumentDefaultTest.php in core/
modules/ views/ tests/ src/ Functional/ Plugin/ ArgumentDefaultTest.php - ArgumentNodeRevisionIdTest.php in core/
modules/ node/ tests/ src/ Kernel/ Views/ ArgumentNodeRevisionIdTest.php - ArgumentStringTest.php in core/
modules/ views/ tests/ src/ Kernel/ Handler/ ArgumentStringTest.php - BaseFieldOverrideResourceTestBase.php in core/
tests/ Drupal/ FunctionalTests/ Rest/ BaseFieldOverrideResourceTestBase.php - BaseFieldOverrideTest.php in core/
modules/ jsonapi/ tests/ src/ Functional/ BaseFieldOverrideTest.php
File
- core/
modules/ node/ src/ Entity/ NodeType.php, line 58
Namespace
Drupal\node\EntityView source
class NodeType extends ConfigEntityBundleBase implements NodeTypeInterface {
/**
* The machine name of this node type.
*
* @var string
*
* @todo Rename to $id.
*/
protected $type;
/**
* The human-readable name of the node type.
*
* @var string
*
* @todo Rename to $label.
*/
protected $name;
/**
* A brief description of this node type.
*
* @var string|null
*/
protected $description = NULL;
/**
* Help information shown to the user when creating a Node of this type.
*
* @var string|null
*/
protected $help = NULL;
/**
* Default value of the 'Create new revision' checkbox of this node type.
*
* @var bool
*/
protected $new_revision = TRUE;
/**
* The preview mode.
*
* @var int
*/
protected $preview_mode = DRUPAL_OPTIONAL;
/**
* Display setting for author and date Submitted by post information.
*
* @var bool
*/
protected $display_submitted = TRUE;
/**
* {@inheritdoc}
*/
public function id() {
return $this->type;
}
/**
* {@inheritdoc}
*/
public function isLocked() {
$locked = \Drupal::state()
->get('node.type.locked');
return isset($locked[$this
->id()]) ? $locked[$this
->id()] : FALSE;
}
/**
* {@inheritdoc}
*/
public function setNewRevision($new_revision) {
$this->new_revision = $new_revision;
}
/**
* {@inheritdoc}
*/
public function displaySubmitted() {
return $this->display_submitted;
}
/**
* {@inheritdoc}
*/
public function setDisplaySubmitted($display_submitted) {
$this->display_submitted = $display_submitted;
}
/**
* {@inheritdoc}
*/
public function getPreviewMode() {
return $this->preview_mode;
}
/**
* {@inheritdoc}
*/
public function setPreviewMode($preview_mode) {
$this->preview_mode = $preview_mode;
}
/**
* {@inheritdoc}
*/
public function getHelp() {
return $this->help ?? '';
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this->description ?? '';
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if ($update && $this
->getOriginalId() != $this
->id()) {
$update_count = $storage
->updateType($this
->getOriginalId(), $this
->id());
if ($update_count) {
\Drupal::messenger()
->addStatus(\Drupal::translation()
->formatPlural($update_count, 'Changed the content type of 1 post from %old-type to %type.', 'Changed the content type of @count posts from %old-type to %type.', [
'%old-type' => $this
->getOriginalId(),
'%type' => $this
->id(),
]));
}
}
if ($update) {
// Clear the cached field definitions as some settings affect the field
// definitions.
\Drupal::service('entity_field.manager')
->clearCachedFieldDefinitions();
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
// Clear the node type cache to reflect the removal.
$storage
->resetCache(array_keys($entities));
}
/**
* {@inheritdoc}
*/
public function shouldCreateNewRevision() {
return $this->new_revision;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Is entity being created updated or deleted through synchronization process. | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | |
NodeType:: |
public | function |
Gets whether a new revision should be created by default. Overrides RevisionableEntityBundleInterface:: |
|
NodeType:: |
public | function |
Sets the preview mode. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Sets whether a new revision should be created by default. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Sets whether 'Submitted by' information should be shown. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase:: |
|
NodeType:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides ConfigEntityBundleBase:: |
|
NodeType:: |
public | function |
Determines whether the node type is locked. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
NodeType:: |
public | function |
Gets the preview mode. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Gets the help information. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Gets the description. Overrides NodeTypeInterface:: |
|
NodeType:: |
public | function |
Gets whether 'Submitted by' information should be shown. Overrides NodeTypeInterface:: |
|
NodeType:: |
protected | property | The machine name of this node type. | |
NodeType:: |
protected | property | The preview mode. | |
NodeType:: |
protected | property | Default value of the 'Create new revision' checkbox of this node type. | |
NodeType:: |
protected | property | The human-readable name of the node type. | |
NodeType:: |
protected | property | Help information shown to the user when creating a Node of this type. | |
NodeType:: |
protected | property | Display setting for author and date Submitted by post information. | |
NodeType:: |
protected | property | A brief description of this node type. | |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | |
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
3 |
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array link templates. | |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
private | function | Returns the typed data class name for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
The cache tags 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 contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
|
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 2 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
ConfigEntityBundleBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
ConfigEntityBundleBase:: |
protected | function | Returns view or form displays for this bundle. | |
ConfigEntityBundleBase:: |
protected | function | Deletes display if a bundle is deleted. | |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
3 |
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
6 |
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
3 |
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 4 |
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
5 |
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
10 |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
protected | property | ||
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 3 |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache contexts. |