class NodeType
Defines the Node type configuration entity.
Attributes
#[ConfigEntityType(id: 'node_type', label: new TranslatableMarkup('Content type'), label_collection: new TranslatableMarkup('Content types'), label_singular: new TranslatableMarkup('content type'), label_plural: new TranslatableMarkup('content types'), config_prefix: 'type', entity_keys: [
'id' => 'type',
'label' => 'name',
], handlers: [
'access' => NodeTypeAccessControlHandler::class,
'form' => [
'add' => NodeTypeForm::class,
'edit' => NodeTypeForm::class,
'delete' => NodeTypeDeleteConfirm::class,
],
'route_provider' => [
'permissions' => EntityPermissionsRouteProvider::class,
],
'list_builder' => NodeTypeListBuilder::class,
], 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',
], admin_permission: 'administer content types', bundle_of: 'node', label_count: [
'singular' => '@count content type',
'plural' => '@count content types',
], config_export: [
'name',
'type',
'description',
'help',
'new_revision',
'preview_mode',
'display_submitted',
])]
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 implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\node\Entity\NodeType implements \Drupal\node\NodeTypeInterface extends \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of NodeType
166 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 - ArgumentSummaryTest.php in core/
modules/ views/ tests/ src/ Kernel/ Handler/ ArgumentSummaryTest.php - BaseFieldOverrideResourceTestBase.php in core/
tests/ Drupal/ FunctionalTests/ Rest/ BaseFieldOverrideResourceTestBase.php
File
-
core/
modules/ node/ src/ Entity/ NodeType.php, line 21
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 = NodePreviewMode::Optional->value;
/**
* 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 $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(bool $returnAsInt = TRUE) {
$previewMode = NodePreviewMode::from($this->preview_mode);
if ($returnAsInt) {
@trigger_error('Calling ' . __METHOD__ . ' with the $returnAsInt parameter is deprecated in drupal:11.3.0 and is removed in drupal:13.0.0. See https://www.drupal.org/node/3538666', E_USER_DEPRECATED);
return $previewMode->value;
}
return $previewMode;
}
/**
* {@inheritdoc}
*/
public function setPreviewMode($preview_mode) {
if (!$preview_mode instanceof NodePreviewMode) {
@trigger_error('Calling ' . __METHOD__ . ' with an integer $preview_mode parameter is deprecated in drupal:11.3.0 and is removed in drupal:13.0.0. Use the \\Drupal\\node\\NodePreviewMode enum instead. See https://www.drupal.org/node/3538666', E_USER_DEPRECATED);
$this->preview_mode = $preview_mode;
return;
}
$this->preview_mode = $preview_mode->value;
}
/**
* {@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) {
// 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
| 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 | Information maintained by Drupal core about configuration. | |||
| ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |||
| ConfigEntityBase::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | Overrides ConfigEntityInterface::calculateDependencies | 12 | |
| ConfigEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | |
| ConfigEntityBase::disable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Disable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::disable | 1 | |
| ConfigEntityBase::enable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Enable'), pluralize: FALSE)] | 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::isInstallable | public | function | Checks whether this entity is installable. | Overrides ConfigEntityInterface::isInstallable | 2 | |
| ConfigEntityBase::isNew | public | function | Overrides EntityBase::isNew(). | Overrides EntityBase::isNew | ||
| ConfigEntityBase::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | Overrides ConfigEntityInterface::isUninstalling | ||
| ConfigEntityBase::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | Overrides ConfigEntityInterface::onDependencyRemoval | 8 | |
| ConfigEntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | 8 | |
| ConfigEntityBase::save | public | function | Saves an entity permanently. | Overrides EntityBase::save | 2 | |
| ConfigEntityBase::set | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set a value'), pluralize: 'setMultiple')] | Overrides ConfigEntityInterface::set | 1 | |
| ConfigEntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityBase::setOriginalId | ||
| ConfigEntityBase::setStatus | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set status'), pluralize: FALSE)] | Overrides ConfigEntityInterface::setStatus | ||
| ConfigEntityBase::setThirdPartySetting | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set third-party setting'))] | Overrides ThirdPartySettingsInterface::setThirdPartySetting | ||
| ConfigEntityBase::setUninstalling | public | function | ||||
| ConfigEntityBase::sort | public static | function | Callback for uasort() to sort configuration entities by weight and label. | 6 | ||
| 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 | 3 | |
| 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 | 9 | |
| ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | ||
| ConfigEntityBundleBase::deleteDisplays | protected | function | Deletes display if a bundle is deleted. | |||
| ConfigEntityBundleBase::loadDisplays | protected | function | Returns view or form displays for this bundle. | |||
| ConfigEntityBundleBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides ConfigEntityBase::preSave | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 2 | ||
| 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::$originalEntity | protected | property | The original unchanged entity. | |||
| 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 | 2 | |
| 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 | 1 | |
| 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::getOriginal | public | function | Returns the original unchanged entity. | Overrides EntityInterface::getOriginal | ||
| 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::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 | 5 | |
| 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 | 6 | |
| EntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityInterface::referencedEntities | 1 | |
| EntityBase::setOriginal | public | function | Sets the original unchanged entity. | Overrides EntityInterface::setOriginal | ||
| 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. | |||
| EntityBase::__get | public | function | 1 | |||
| EntityBase::__isset | public | function | 1 | |||
| EntityBase::__set | public | function | 1 | |||
| EntityBase::__unset | public | function | 1 | |||
| NodeType::$description | protected | property | A brief description of this node type. | |||
| NodeType::$display_submitted | protected | property | Display setting for author and date Submitted by post information. | |||
| NodeType::$help | protected | property | Help information shown to the user when creating a Node of this type. | |||
| NodeType::$name | protected | property | The human-readable name of the node type. | |||
| NodeType::$new_revision | protected | property | Default value of the 'Create new revision' checkbox of this node type. | |||
| NodeType::$preview_mode | protected | property | The preview mode. | |||
| NodeType::$type | protected | property | The machine name of this node type. | |||
| NodeType::displaySubmitted | public | function | Gets whether 'Submitted by' information should be shown. | Overrides NodeTypeInterface::displaySubmitted | ||
| NodeType::getDescription | public | function | Gets the description. | Overrides NodeTypeInterface::getDescription | ||
| NodeType::getHelp | public | function | Gets the help information. | Overrides NodeTypeInterface::getHelp | ||
| NodeType::getPreviewMode | public | function | Gets the preview mode. | Overrides NodeTypeInterface::getPreviewMode | ||
| NodeType::id | public | function | Gets the identifier. | Overrides EntityBase::id | ||
| NodeType::isLocked | public | function | Determines whether the node type is locked. | Overrides NodeTypeInterface::isLocked | ||
| NodeType::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides ConfigEntityBundleBase::postDelete | ||
| NodeType::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides ConfigEntityBundleBase::postSave | ||
| NodeType::setDisplaySubmitted | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set whether to display submission information'), pluralize: FALSE)] | Overrides NodeTypeInterface::setDisplaySubmitted | ||
| NodeType::setNewRevision | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Automatically create new revisions'), pluralize: FALSE)] | Overrides NodeTypeInterface::setNewRevision | ||
| NodeType::setPreviewMode | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set preview mode'), pluralize: FALSE)] | Overrides NodeTypeInterface::setPreviewMode | ||
| NodeType::shouldCreateNewRevision | public | function | Gets whether a new revision should be created by default. | Overrides RevisionableEntityBundleInterface::shouldCreateNewRevision | ||
| 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.