class NodeType

Same name in this branch
  1. 10 core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  2. 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
  1. 9 core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  2. 9 core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  3. 9 core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
  4. 9 core/modules/node/src/Plugin/Condition/NodeType.php \Drupal\node\Plugin\Condition\NodeType
  5. 8.9.x core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  6. 8.9.x core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  7. 8.9.x core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
  8. 8.9.x core/modules/node/src/Plugin/Condition/NodeType.php \Drupal\node\Plugin\Condition\NodeType
  9. 11.x core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  10. 11.x core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  11. 11.x core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\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

Expanded class hierarchy of NodeType

180 files declare their use of NodeType
AddToAllBundlesConfigActionTest.php in core/modules/field/tests/src/Kernel/AddToAllBundlesConfigActionTest.php
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

... See full list

File

core/modules/node/src/Entity/NodeType.php, line 58

Namespace

Drupal\node\Entity
View 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 $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

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
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::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
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::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
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::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 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::sort public static function Helper 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 10
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
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 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
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::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::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.
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 Sets whether 'Submitted by' information should be shown. Overrides NodeTypeInterface::setDisplaySubmitted
NodeType::setNewRevision public function Sets whether a new revision should be created by default. Overrides NodeTypeInterface::setNewRevision
NodeType::setPreviewMode public function Sets the preview mode. 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.