{% extends "base/class.php.twig" %} {% block file_path %} \Drupal\{{ module }}\Entity\{{ entity_class }}. {% endblock %} {% block namespace_class %} namespace Drupal\{{ module }}\Entity; {% endblock %} {% block use_class %} {% if has_owner or revisionable%} use Drupal\Core\Entity\EntityStorageInterface; {% endif %} use Drupal\Core\Field\BaseFieldDefinition; {% if revisionable %} use Drupal\Core\Entity\EditorialContentEntityBase; use Drupal\Core\Entity\RevisionableInterface; {% else %} use Drupal\Core\Entity\ContentEntityBase; {% endif %} use Drupal\Core\Entity\EntityChangedTrait; use Drupal\Core\Entity\EntityPublishedTrait; use Drupal\Core\Entity\EntityTypeInterface; {% if has_owner %} use Drupal\user\UserInterface; {% endif %} {% endblock %} {% block class_declaration %} /** * Defines the {{ label }} entity. * * @ingroup {{ module }} * * @ContentEntityType( * id = "{{ entity_name }}", * label = @Translation("{{ label }}"), {% if bundle_entity_type %} * bundle_label = @Translation("{{ label }} type"), {% endif %} * handlers = { {% if revisionable %} * "storage" = "Drupal\{{ module }}\{{ entity_class }}Storage", {% endif %} * "view_builder" = "Drupal\Core\Entity\EntityViewBuilder", * "list_builder" = "Drupal\{{ module }}\{{ entity_class }}ListBuilder", * "views_data" = "Drupal\{{ module }}\Entity\{{ entity_class }}ViewsData", {% if is_translatable %} * "translation" = "Drupal\{{ module }}\{{ entity_class }}TranslationHandler", {% endif %} * {% if has_forms %} * "form" = { * "default" = "Drupal\{{ module }}\Form\{{ entity_class }}Form", * "add" = "Drupal\{{ module }}\Form\{{ entity_class }}Form", * "edit" = "Drupal\{{ module }}\Form\{{ entity_class }}Form", * "delete" = "Drupal\{{ module }}\Form\{{ entity_class }}DeleteForm", * }, * "route_provider" = { * "html" = "Drupal\{{ module }}\{{ entity_class }}HtmlRouteProvider", * }, {% endif %} * "access" = "Drupal\{{ module }}\{{ entity_class }}AccessControlHandler", * }, * base_table = "{{ entity_name }}", {% if is_translatable %} * data_table = "{{ entity_name }}_field_data", {% endif %} {% if revisionable %} * revision_table = "{{ entity_name }}_revision", * revision_data_table = "{{ entity_name }}_field_revision", {% endif %} * translatable = {{ is_translatable ? 'TRUE' : 'FALSE' }}, {% if has_bundle_permissions %} * permission_granularity = "bundle", {% endif %} * admin_permission = "administer {{ label|lower }} entities", * entity_keys = { * "id" = "id", {% if revisionable %} * "revision" = "vid", {% endif %} {% if bundle_entity_type %} * "bundle" = "type", {% endif %} * "label" = "name", * "uuid" = "uuid", {% if has_owner %} * "uid" = "user_id", {% endif %} * "langcode" = "langcode", * "published" = "status", * }, {% if has_forms %} * links = { * "canonical" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}", {% if bundle_entity_type %} * "add-page" = "{{ base_path }}/{{ entity_name }}/add", * "add-form" = "{{ base_path }}/{{ entity_name }}/add/{{ '{'~bundle_entity_type~'}' }}", {% else %} * "add-form" = "{{ base_path }}/{{ entity_name }}/add", {% endif %} * "edit-form" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/edit", * "delete-form" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/delete", {% if revisionable %} * "version-history" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/revisions", * "revision" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/revisions/{{ '{'~entity_name~'_revision}' }}/view", * "revision_revert" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/revisions/{{ '{'~entity_name~'_revision}' }}/revert", * "revision_delete" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/revisions/{{ '{'~entity_name~'_revision}' }}/delete", {% if is_translatable %} * "translation_revert" = "{{ base_path }}/{{ entity_name }}/{{ '{'~entity_name~'}' }}/revisions/{{ '{'~entity_name~'_revision}' }}/revert/{langcode}", {% endif %} {% endif %} * "collection" = "{{ base_path }}/{{ entity_name }}", * }, {% endif %} {% if bundle_entity_type %} * bundle_entity_type = "{{ bundle_entity_type }}", * field_ui_base_route = "entity.{{ bundle_entity_type }}.edit_form" {% else %} {% if has_forms %} * field_ui_base_route = "{{ entity_name }}.settings" {% endif %} {% endif %} * ) */ class {{ entity_class }} extends {% if revisionable %}EditorialContentEntityBase{% else %}ContentEntityBase{% endif %} implements {{ entity_class }}Interface {% endblock %} {% block use_trait %} use EntityChangedTrait; use EntityPublishedTrait; {% endblock %} {% block class_methods %} {% if has_owner %} /** * {@inheritdoc} */ public static function preCreate(EntityStorageInterface $storage_controller, array &$values) { parent::preCreate($storage_controller, $values); $values += [ 'user_id' => \Drupal::currentUser()->id(), ]; } {% endif %} {% if revisionable %} /** * {@inheritdoc} */ protected function urlRouteParameters($rel) { $uri_route_parameters = parent::urlRouteParameters($rel); if ($rel === 'revision_revert' && $this instanceof RevisionableInterface) { $uri_route_parameters[$this->getEntityTypeId() . '_revision'] = $this->getRevisionId(); } elseif ($rel === 'revision_delete' && $this instanceof RevisionableInterface) { $uri_route_parameters[$this->getEntityTypeId() . '_revision'] = $this->getRevisionId(); } return $uri_route_parameters; } /** * {@inheritdoc} */ public function preSave(EntityStorageInterface $storage) { parent::preSave($storage); {% if is_translatable %} foreach (array_keys($this->getTranslationLanguages()) as $langcode) { $translation = $this->getTranslation($langcode); // If no owner has been set explicitly, make the anonymous user the owner. if (!$translation->getOwner()) { $translation->setOwnerId(0); } } {% endif %} // If no revision author has been set explicitly, // make the {{ entity_name }} owner the revision author. if (!$this->getRevisionUser()) { $this->setRevisionUserId($this->getOwnerId()); } } {% endif %} /** * {@inheritdoc} */ public function getName() { return $this->get('name')->value; } /** * {@inheritdoc} */ public function setName($name) { $this->set('name', $name); return $this; } /** * {@inheritdoc} */ public function getCreatedTime() { return $this->get('created')->value; } /** * {@inheritdoc} */ public function setCreatedTime($timestamp) { $this->set('created', $timestamp); return $this; } {% if has_owner %} /** * {@inheritdoc} */ public function getOwner() { return $this->get('user_id')->entity; } /** * {@inheritdoc} */ public function getOwnerId() { return $this->get('user_id')->target_id; } /** * {@inheritdoc} */ public function setOwnerId($uid) { $this->set('user_id', $uid); return $this; } /** * {@inheritdoc} */ public function setOwner(UserInterface $account) { $this->set('user_id', $account->id()); return $this; } {% endif %} /** * {@inheritdoc} */ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { $fields = parent::baseFieldDefinitions($entity_type); // Add the published field. $fields += static::publishedBaseFieldDefinitions($entity_type); {% if has_owner %} $fields['user_id'] = BaseFieldDefinition::create('entity_reference') ->setLabel(t('Authored by')) ->setDescription(t('The user ID of author of the {{ label }} entity.')) ->setRevisionable(TRUE) ->setSetting('target_type', 'user') ->setSetting('handler', 'default') {% if is_translatable %} ->setTranslatable(TRUE) {% endif %} ->setDisplayOptions('view', [ 'label' => 'hidden', 'type' => 'author', 'weight' => 0, ]) ->setDisplayOptions('form', [ 'type' => 'entity_reference_autocomplete', 'weight' => 5, 'settings' => [ 'match_operator' => 'CONTAINS', 'size' => '60', 'autocomplete_type' => 'tags', 'placeholder' => '', ], ]) ->setDisplayConfigurable('form', TRUE) ->setDisplayConfigurable('view', TRUE); {% endif %} $fields['name'] = BaseFieldDefinition::create('string') ->setLabel(t('Name')) ->setDescription(t('The name of the {{ label }} entity.')) {% if revisionable %} ->setRevisionable(TRUE) {% endif %} ->setSettings([ 'max_length' => 50, 'text_processing' => 0, ]) ->setDefaultValue('') ->setDisplayOptions('view', [ 'label' => 'above', 'type' => 'string', 'weight' => -4, ]) ->setDisplayOptions('form', [ 'type' => 'string_textfield', 'weight' => -4, ]) ->setDisplayConfigurable('form', TRUE) ->setDisplayConfigurable('view', TRUE) ->setRequired(TRUE); $fields['status']->setDescription(t('A boolean indicating whether the {{ label }} is published.')) ->setDisplayOptions('form', [ 'type' => 'boolean_checkbox', 'weight' => -3, ]); $fields['created'] = BaseFieldDefinition::create('created') ->setLabel(t('Created')) ->setDescription(t('The time that the entity was created.')); $fields['changed'] = BaseFieldDefinition::create('changed') ->setLabel(t('Changed')) ->setDescription(t('The time that the entity was last edited.')); {% if revisionable and is_translatable %} $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean') ->setLabel(t('Revision translation affected')) ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.')) ->setReadOnly(TRUE) ->setRevisionable(TRUE) ->setTranslatable(TRUE); {% endif %} return $fields; } {% endblock %}