entity-content.php.twig

{% 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 %}
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\{{ module }}\{{ entity_class }}Interface;
use Drupal\user\UserInterface;
{% endblock %}

{% block class_declaration %}
/**
 * Defines the {{ entity_class }} entity.
 *
 * @ingroup {{ module }}
 *
 * @ContentEntityType(
 *   id = "{{ entity_name }}",
 *   label = @Translation("{{ entity_class }} entity"),
 *   handlers = {
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\{{ module }}\Entity\Controller\{{ entity_class }}ListController",
 *     "views_data" = "Drupal\{{ module }}\Entity\{{ entity_class }}ViewsData",
 *
 *     "form" = {
 *       "default" = "Drupal\{{ module }}\Entity\Form\{{ entity_class }}Form",
 *       "add" = "Drupal\{{ module }}\Entity\Form\{{ entity_class }}Form",
 *       "edit" = "Drupal\{{ module }}\Entity\Form\{{ entity_class }}Form",
 *       "delete" = "Drupal\{{ module }}\Entity\Form\{{ entity_class }}DeleteForm",
 *     },
 *     "access" = "Drupal\{{ module }}\{{ entity_class }}AccessControlHandler",
 *   },
 *   base_table = "{{ entity_name }}",
 *   admin_permission = "administer {{ entity_class }} entity",
 *   fieldable = TRUE,
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "name",
 *     "uuid" = "uuid"
 *   },
 *   links = {
 *     "canonical" = "/entity.{{ entity_name }}.canonical",
 *     "edit-form" = "/entity.{{ entity_name }}.edit_form",
 *     "delete-form" = "/entity.{{ entity_name }}.delete_form",
 *     "collection" = "/entity.{{ entity_name }}.collection"
 *   },
 *   field_ui_base_route = "{{ entity_name }}.settings"
 * )
 */
class {{ entity_class }} extends ContentEntityBase implements {{ entity_class }}Interface {% endblock %}
{% block class_methods %}
  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
    $values += array(
      'user_id' => \Drupal::currentUser()->id(),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getChangedTime() {
    return $this->get('changed')->value;
  }

  /**
   * {@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;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('ID'))
      ->setDescription(t('The ID of the {{ entity_class }} entity.'))
      ->setReadOnly(TRUE);

    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The UUID of the {{ entity_class }} entity.'))
      ->setReadOnly(TRUE);

    $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Authored by'))
      ->setDescription(t('The user ID of the {{ entity_class }} entity author.'))
      ->setRevisionable(TRUE)
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setDefaultValueCallback('Drupal\node\Entity\Node::getCurrentUserId')
      ->setTranslatable(TRUE)
      ->setDisplayOptions('view', array(
        'label' => 'hidden',
        'type' => 'author',
        'weight' => 0,
      ))
      ->setDisplayOptions('form', array(
        'type' => 'entity_reference_autocomplete',
        'weight' => 5,
        'settings' => array(
          'match_operator' => 'CONTAINS',
          'size' => '60',
          'autocomplete_type' => 'tags',
          'placeholder' => '',
        ),
      ))
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);

    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The name of the {{ entity_class }} entity.'))
      ->setSettings(array(
        'default_value' => '',
        'max_length' => 50,
        'text_processing' => 0,
      ))
      ->setDisplayOptions('view', array(
        'label' => 'above',
        'type' => 'string',
        'weight' => -4,
      ))
      ->setDisplayOptions('form', array(
        'type' => 'string_textfield',
        'weight' => -4,
      ))
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);

    $fields['langcode'] = BaseFieldDefinition::create('language')
      ->setLabel(t('Language code'))
      ->setDescription(t('The language code of {{ entity_class }} entity.'));

    $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.'));

    return $fields;
  }
{% endblock %}