エンティティタイプ

• Drupal 7 - Entityは汎用のstdClassオブジェクトでした。
• Drupal 8 - Entityは現在、特定の型付けを持つオブジェクトになりました。各エンティティタイプは、そのエンティティのインスタンスに使用されるクラスを定義します。

要件
Entityクラスは、エンティティタイプを提供するモジュールのEntity名前空間サブスペースに配置する必要があります。例：\Drupal\[module_name]\Entity。つまり、EntityクラスのPHPファイルはモジュールのsrc/Entityディレクトリにあります。

クラスのdocblockには、そのタイプのEntityのメタデータを定義するEntityTypeアノテーションが含まれている必要があります。これには、エンティティタイプのラベル、コントローラー、テーブルなどが含まれます。利用可能なすべてのメタデータプロパティの文書化されたリストについては、\Drupal\Core\Entity\Annotation\EntityTypeクラスを参照してください。

命名

エンティティタイプとモジュール名が一致しない場合、エンティティタイプ名にはモジュール名のプレフィックスを付ける必要があります。エンティティタイプクラス自体のプレフィックスは、定義元モジュールの名前空間内にあるため、それ自体が十分に意味がある限り不要です。例：タクソノミー用語のエンティティタイプはtaxonomy_termと呼ばれ、クラス名はDrupal\taxonomy\Entity\Termです。

インターフェース

Drupal 8では、クラスではなくインターフェースで型ヒントの関数とメソッドを導入することを推奨しています。例：汎用エンティティのストレージはhook_entity_insert (EntityInterface $entity)のようにEntityInterfaceで型ヒントをキャッチし、ノード固有のストレージはhook_node_insert (NodeInterface $node)のようにNodeInterfaceで型ヒントをキャッチします。

Entityのフィールド/プロパティは、多くの場合非常に短く、ストレージ指向で、あまり情報がありません。さらに、コンテンツエンティティは、フィールド（ノードのタイトルなどの基本フィールドを含む）に定義済みプロパティをまったく使用しません。

したがって、推奨されるアプローチは、文書化されたメソッド名を持つインターフェースを提供することです。その際、いくつかのルールに従う必要があります：

• メソッドには通常、get/set/isまたは同様のプレフィックスが付きます：getSomething()、setSomething($value)、isSomething()。
• 他のコードが変更すべきものにのみメソッドを追加してください。ノードの最終更新日（$node->updated）は変更されるべきではないため、$node->getChangedTime()メソッドは存在しますが、$node->setChangedTime()メソッドはありません。
• 自己記述的なメソッド名を使用してください。例：$node->statusにアクセスするメソッドは$node->isPublished()と呼ばれます。

発見可能性

モジュールがどのEntityタイプを提供しているかを確認するには、そのモジュールのEntity名前空間サブスペースにあるクラスを参照してください。これらのクラスには@EntityTypeアノテーションがあり、アノテーションのidキーに名前も含まれています。

特定のEntityタイプがどこで定義されているかを探すとき、最初に探すべきはエンティティタイプのプレフィックスです。モジュールがこの命名規則に従っていない場合、id = "$type"を検索すると見つかります。エンティティタイプではなくクラスやインターフェースがわかっている場合、名前空間がその出所を示します。

例

core/modules/node/src/Entity/Node.php:

namespace Drupal\node\Entity;

use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Session\AccountInterface;
use Drupal\node\NodeInterface;
use Drupal\user\UserInterface;

/**
 * Defines the node entity class.
 *
 * @ContentEntityType(
 *   id = "node",
 *   label = @Translation("Content"),
 *   bundle_label = @Translation("Content type"),
 *   handlers = {
 *     "storage" = "Drupal\node\NodeStorage",
 *     "storage_schema" = "Drupal\node\NodeStorageSchema",
 *     "view_builder" = "Drupal\node\NodeViewBuilder",
 *     "access" = "Drupal\node\NodeAccessControlHandler",
 *     "views_data" = "Drupal\node\NodeViewsData",
 *     "form" = {
 *       "default" = "Drupal\node\NodeForm",
 *       "delete" = "Drupal\node\Form\NodeDeleteForm",
 *       "edit" = "Drupal\node\NodeForm"
 *     },
 *     "route_provider" = {
 *       "html" = "Drupal\node\Entity\NodeRouteProvider",
 *     },
 *     "list_builder" = "Drupal\node\NodeListBuilder",
 *     "translation" = "Drupal\node\NodeTranslationHandler"
 *   },
 *   base_table = "node",
 *   data_table = "node_field_data",
 *   revision_table = "node_revision",
 *   revision_data_table = "node_field_revision",
 *   translatable = TRUE,
 *   list_cache_contexts = { "user.node_grants:view" },
 *   entity_keys = {
 *     "id" = "nid",
 *     "revision" = "vid",
 *     "bundle" = "type",
 *     "label" = "title",
 *     "langcode" = "langcode",
 *     "uuid" = "uuid",
 *     "status" = "status",
 *     "uid" = "uid",
 *   },
 *   bundle_entity_type = "node_type",
 *   field_ui_base_route = "entity.node_type.edit_form",
 *   common_reference_target = TRUE,
 *   permission_granularity = "bundle",
 *   links = {
 *     "canonical" = "/node/{node}",
 *     "delete-form" = "/node/{node}/delete",
 *     "edit-form" = "/node/{node}/edit",
 *     "version-history" = "/node/{node}/revisions",
 *     "revision" = "/node/{node}/revisions/{node_revision}/view",
 *   }
 * )
 */
class Node extends ContentEntityBase implements NodeInterface {
  // ...
}

Drupal 8のエンティティの全体像を把握するために、次の図を見てみましょう。これはエンティティクラスを表しています。新しいタブで開いて表示します：