Drupal -setupで独自のカスタムエンティティを構築します

キーポイント

Drupalのエンティティは、データを整理するための強力な方法であり、特定の種類の情報を表すようにカスタマイズできます。このチュートリアルでは、タイトル、説明、締め切りなどの属性を含むプロジェクトと呼ばれるカスタムエンティティタイプを作成する方法を示しています。
新しいエンティティタイプを作成するには、スキーマ定義を宣言し、エンティティデータのデータベーステーブルを生成する必要があります。このチュートリアルには、4つの列（ID、名前、説明、および締め切り）を持つ「demo_projects」テーブルを作成するためのコード例を提供します。
エンティティAPIモジュールをサイトで有効にし、カスタムモジュールの依存関係として設定する必要があります。これは、Drupal Coreに欠けている多くのエンティティ処理機能を提供します。これには、新しいエンティティの作成、データベースへの保存、表示が含まれます。
• このチュートリアルでは、デフォルトのEntityApicOntrollerクラスのbuildContent（）メソッドをオーバーライドしてエンティティを表示する方法と、Entity_view（）ヘルパー関数を介してエンティティリストを作成する方法についても説明しています。チュートリアルの2番目の部分では、個々のプロジェクトエンティティを表示し、UIを介してフィールド可能にするページの作成を導入し、クエリおよびリスト表示のビューに公開します。
Drupalエンティティは、データを整理するための優れた方法です。ノード、分類用語、コメント、またはユーザーに精通している場合は、Drupal 7以降、これらがエンティティであったことも知っておく必要があります。それらについてのもう1つの重要な側面は、フィールドAPIを通じてフィールド化できることです。

このチュートリアルでは、独自のカスタムエンティティタイプを定義して開始する方法を紹介します。ノードを使用する代わりに、なぜ誰かがこれをしたいのですか？なぜなら、それらは素晴らしいですが、ノードは時々過度に複雑になることがあります。リビジョンやコメントなど、多くの機能を必要としない場合があります。

このチュートリアルでは、プロジェクトに関する簡単な情報（タイトル、説明、および締め切り）を表すために、「プロジェクト」と呼ばれる独自のカスタムエンティティタイプを定義します。その後、このタイプのエンティティの使用について少し学びます。 学習を続けるために、基本的なカスタムモジュールの作成方法を知っていると思います（モジュールにはデモという名前です）。このトピックについては、優れたチュートリアルをご覧ください。 .infoファイルの書き込みを続け、空の.moduleと.installファイルを作成します。また、このチュートリアルのすべてのソースコードを取得できるGitリポジトリを設定します（各セクションに1つのブランチ、2つのセクションが公開されます）。

さらに、サイト上のエンティティAPIコントリブモジュールを有効にし、カスタムモジュールの依存関係として設定する必要があります。エンティティAPIモジュールは、Drupal Coreに欠けている機能の多くを提供するため、エンティティを扱うときに非常に強力です。

独自のDrupalエンティティタイプ

を定義します

新しいエンティティタイプを作成するには、最初にスキーマ定義を宣言する必要があります。つまり、エンティティデータデータベーステーブルを生成するコードを書き込みます。私のdemo.installファイルには、次のコードがあります。

/**
 * Implements hook_schema().
 */
function demo_schema() {

  $schema = array();

  $schema['demo_projects'] = array(
    'description' => 'The base table for the Project entity',
    'fields' => array(
      'id' => array(
        'description' => 'Primary key of the Project entity',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'name' => array(
        'description' => 'Project name.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ),
      'description' => array(
        'description' => 'Project description.',
        'type' => 'text',
        'size' => 'big',
        'not null' => FALSE,
        'default' => NULL
      ),
      'deadline' => array(
        'description' => 'Project deadline.',
        'type' => 'int',
        'length' => 11,
        'not null' => FALSE,
      ),
    ),
    'primary key' => array('id'),
  );

  return $schema;
}

これは、fook_schema（）の単純な実装です。大したことではありません。

次に、hook_entity_info（）を実装する必要があります。このフックには多くのオプションを指定できますが、ここに最も基本的で必要なオプションがあります（これはdemo.moduleファイルにあります）：

/**
 * Implements hook_entity_info().
 */
function demo_entity_info() {

  $info = array();

  $info['project'] = array(
    'label' => t('Project'),
    'base table' => 'demo_projects',
    'entity keys' => array(
      'id' => 'id',
      'label' => 'name',
    ),
    'module' => 'demo',
    'entity class' => 'Entity',
    'controller class' => 'ProjectEntityController',
  );

  return $info;
}

このフックを使用すると、エンティティマシン名を表す$ info Arrayの新しいキーを返します。この配列では、オプションを指定します（このチュートリアル中にオプションを追加します）。次に、タグ（エンティティタイプの読み取り可能な名前）、エンティティデータを格納するベーステーブル、エンティティ識別子の属性として機能するエンティティキー、およびエンティティタイプを定義するモジュールを指定するモジュールを使用します。最後のものは必須ではありませんが、推奨されます。

この方法では、Drupalに独自の基本エンティティタイプを登録します。動作するかどうかをテストするには、モジュールを初めて有効にし、データベースにテーブルが作成されているかどうかを確認します。次に、使用するものがあるように、数行で記入してください。

最後に、hook_menu（）を使用して、Drupalを使用してパス（テスト用の任意のパスに対して）を登録し、次のコールバック関数に貼り付けます。

INSERT INTO `demo_projects` (`id`, `name`, `description`, `deadline`)
VALUES
    (1, 'Summer House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501105),
    (2, 'Winter House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501132);

最初に、Entity_load（）関数を使用してIDS 1と2のプロジェクトエンティティをロードし、Devel DPM（）関数（テストのためにサイトでDevelが有効になっていることを確認してください）を使用して、スクリーン上のスクリーン。ページのコールバック関数が何かを返す必要があることを忘れないでください。そうしないと、構築されません。

このページに移動すると、Krumoのデータベースに2つのエンティティのデータが表示されます。

$projects = entity_load('project', array(1, 2));
dpm($projects);
return 'Some string';

または、EntityFieldQueryクラスを使用して、必要なプロパティ（IDだけでなく）に基づいて新しいエンティティを照会できます。これがどのように機能するかの詳細については、このSitePointチュートリアルをご覧ください。これにより、開始に役立ちます。

エンティティクラスとコントローラー

残念ながら、Drupal Coreはエンティティを処理するためのあまり多くのヘルパー関数を提供しません（Entity_load（）はほとんど一意です）。ただし、エンティティAPIモジュールはこのギャップを埋めます。

その機能を使用するには、以前に宣言したエンティティ情報を変更し、エンティティの処理に使用できるPHPクラスを指定する必要があります。次に、hook_entity_info（）実装で入力されたプロジェクトアレイにさらに2つのキーを追加します：

前述のコードにはすでに

が含まれています

EntityApicOntrollerクラス（ModuleのEntity.Controller.incファイルにあります）は、エンティティを処理するための合理的なデフォルト値を提供します。デフォルトのDrupal Core DrupaldeFaultentityControllerクラスを拡張し、（他の多くのことの中でも）CRUD操作を実行する責任があります。

'entity class' => 'Entity', 'controller class' => 'ProjectEntityController',両方のクラスをカスタムモジュールに拡張して、機能を調整できます（エンティティのクエリ、読み込み、表示など）。後でこれを行う方法を確認します。

しかし、最初に、新しいエンティティを保存する方法をお見せしたいと思います。現在、私のデータベースにはID 1と2の2つのレコードがあります。上記のテストページコールバック関数に書いたコードを調整して、ID 3の新しいエンティティを作成してください。このように見えるかもしれません：

/**
 * Implements hook_schema().
 */
function demo_schema() {

  $schema = array();

  $schema['demo_projects'] = array(
    'description' => 'The base table for the Project entity',
    'fields' => array(
      'id' => array(
        'description' => 'Primary key of the Project entity',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'name' => array(
        'description' => 'Project name.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ),
      'description' => array(
        'description' => 'Project description.',
        'type' => 'text',
        'size' => 'big',
        'not null' => FALSE,
        'default' => NULL
      ),
      'deadline' => array(
        'description' => 'Project deadline.',
        'type' => 'int',
        'length' => 11,
        'not null' => FALSE,
      ),
    ),
    'primary key' => array('id'),
  );

  return $schema;
}

ご覧のとおり、3つのプロジェクトエンティティをロードし、3番目のエンティティが存在するかどうかを確認しようとします。存在しない場合は、エンティティAPIによって提供されるentity_create（）ヘルパー関数を使用し、プロパティをランダム値に設定し、エンティティのsave（）メソッドを使用してデータベースに持続します。このメソッドはエンティティクラスによって提供され、そのジョブは、上記で定義したコントローラークラスのsave（）メソッドを呼び出すことです。この方法は、エンティティを持続するために必要なロジックを実行します。しかし、これらはすべて舞台裏で起こりますが、心配する必要はありません。

ページをリロードすると、2つのプロジェクトエンティティのみが返される必要がありますが、2回目は3つのプロジェクトが必要です。

エンティティクラスをカバーします

このチュートリアルのこの部分であなたに紹介したい最後のことは、エンティティを表示する方法です。これを行うには、使用しているページコールバック関数に固執し、実際のリストになります。

最初に、デフォルトのentitityApicontrollerクラスのbuildcontent（）メソッドをオーバーライドする必要があります。その理由は、コントローラーがデータについて仮定できないため、表示する方法に関する情報を提供する必要があるためです。まず、前のクラスを拡張するコントローラークラスを宣言しましょう。

/**
 * Implements hook_entity_info().
 */
function demo_entity_info() {

  $info = array();

  $info['project'] = array(
    'label' => t('Project'),
    'base table' => 'demo_projects',
    'entity keys' => array(
      'id' => 'id',
      'label' => 'name',
    ),
    'module' => 'demo',
    'entity class' => 'Entity',
    'controller class' => 'ProjectEntityController',
  );

  return $info;
}

クラス名ProjectentityControllerを選択しましたが、hook_entity_info（）実装のコントローラークラスキーに設定した値を必ず置き換える必要があります。忘れないで。

このクラスでは、メソッド名を元のクラスからコピーして、親クラスが返すものを返すことができます。 このクラスでは、メソッド名を元のクラスからコピーして、親クラスが返すものを返すことができます。基本的に2つの新しいアイテムを配列に追加しました。最初のものは説明を

で包み、2番目はパラグラフラベル間にフォーマットされた日付を出力します。これは基本的なDrupalのテーマです。ここで何が起こっているのかわからない場合は、レビューしてください。ただし、プロジェクト名が不足していることに気付くでしょう。 Drupalは、hook_entity_info（）によって実装されたエンティティキーのタグとして指定するため、自動的にレンダリングします。最後のステップは、ページコールバック関数に移動し、エンティティを表示させることです。簡単な方法（デモンストレーションのみのため）：

前と同様に、最初に対応するIDをエンティティにロードします。次に、それらをentity_view（）ヘルパー関数を介して実行します。これにより、最終的に上書きされたbuildcontent（）メソッドを呼び出します。この関数は、各エンティティのレンダリングされた配列のリストを返します。それぞれをレンダリングし、結果を$ outputアレイに保存し、それを連結して返品します。 <div> ページを更新でき、ロードしたすべてのエンティティのリストが表示されます。変更が表示されるように、キャッシュがクリアされていることを確認してください。 <pre class='brush:php;toolbar:false;'>INSERT INTO `demo_projects` (`id`, `name`, `description`, `deadline`) VALUES (1, 'Summer House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501105), (2, 'Winter House', 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 1397501132);</pre><h2 id="結論">結論</h2> このチュートリアルでは、コード内の独自のエンティティタイプを定義することにより、Drupalのエンティティについて学び始めます。私たちは、それらが表すデータのスキーマ定義を書く方法と、それらをDrupalに登録する方法を学びました。次に、エンティティAPI Contribモジュールを使用して、オブジェクト指向の方法でエンティティを処理する力がわかります。 <p> このチュートリアルの第2部では、3つの主要な側面について説明します。まず、個々のプロジェクトエンティティを表示するためのページを作成し、プロジェクトを管理するための管理インターフェイスを起動します。第二に、UIを介してフィールド化可能にします。第三に、適切なクエリを実行してディスプレイをリストできるように、ビューに公開します。乞うご期待！ </p> Drupalのカスタムエンティティの構築に関する<p> FAQ </p> <h2 id="Drupalカスタムエンティティを作成するための前提条件は何ですか"> Drupalカスタムエンティティを作成するための前提条件は何ですか？ </h2> <h3 id="Drupalカスタムエンティティの作成を開始する前に-DrupalのエンティティAPIを基本的に理解する必要があります-また-PHPの概念とオブジェクト指向プログラミングに精通している必要があります-さらに-Drupal-Development環境を設定する必要があります-これには-ローカルマシンまたはサーバーにDrupalのインストールと構成が含まれます"> Drupalカスタムエンティティの作成を開始する前に、DrupalのエンティティAPIを基本的に理解する必要があります。また、PHPの概念とオブジェクト指向プログラミングに精通している必要があります。さらに、Drupal Development環境を設定する必要があります。これには、ローカルマシンまたはサーバーにDrupalのインストールと構成が含まれます。 </h3> <p> Drupalにバンドルを使用してカスタムコンテンツエンティティを作成する方法は？ </p> <h3 id="Drupalにバンドルを使用してカスタムコンテンツエンティティを作成するには-複数のステップが含まれます-まず-カスタムモジュールでエンティティとそのプロパティを定義する必要があります-次に-エンティティを追加および編集するフォームを作成する必要があります-その後-エンティティの運用のルートを定義する必要があります-最後に-エンティティを表示するためにビュービルダーを作成する必要があります">Drupalにバンドルを使用してカスタムコンテンツエンティティを作成するには、複数のステップが含まれます。まず、カスタムモジュールでエンティティとそのプロパティを定義する必要があります。次に、エンティティを追加および編集するフォームを作成する必要があります。その後、エンティティの運用のルートを定義する必要があります。最後に、エンティティを表示するためにビュービルダーを作成する必要があります。 </h3> <p> Drupalのコンテンツエンティティと構成エンティティの違いは何ですか？ </p> <h3 id="Drupalでは-コンテンツエンティティは-ユーザーが作成-編集-削除できるコンテンツフラグメントです-例には-ノード-ユーザー-コメントが含まれます-一方-構成エンティティは-データベースに保存されている構成フラグメントであり-コードにエクスポートできます-例には-ビュー-画像スタイル-ユーザーロールが含まれます"> Drupalでは、コンテンツエンティティは、ユーザーが作成、編集、削除できるコンテンツフラグメントです。例には、ノード、ユーザー、コメントが含まれます。一方、構成エンティティは、データベースに保存されている構成フラグメントであり、コードにエクスポートできます。例には、ビュー、画像スタイル、ユーザーロールが含まれます。 </h3> <p> Drupal 8でコンテンツエンティティタイプを作成する方法は？ </p> <h3 id="Drupal-でコンテンツエンティティタイプの作成には-カスタムモジュールでエンティティとそのプロパティを定義することが含まれます-また-エンティティを追加および編集し-エンティティオペレーションのルートを定義し-エンティティを表示するビュービルダーを作成するフォームを作成する必要があります">Drupal 8でコンテンツエンティティタイプの作成には、カスタムモジュールでエンティティとそのプロパティを定義することが含まれます。また、エンティティを追加および編集し、エンティティオペレーションのルートを定義し、エンティティを表示するビュービルダーを作成するフォームを作成する必要があります。 </h3> <p>エンティティAPIモジュールを使用してDrupalでカスタムエンティティを作成できますか？ </p> <h3 id="はい-エンティティAPIモジュールを使用してDrupalでカスタムエンティティを作成できます-このモジュールは-エンティティとそのプロパティを処理する統一された方法を提供します-また-作成-読み取り-更新-削除などのエンティティで操作を実行するためのAPIを提供します">はい、エンティティAPIモジュールを使用してDrupalでカスタムエンティティを作成できます。このモジュールは、エンティティとそのプロパティを処理する統一された方法を提供します。また、作成、読み取り、更新、削除などのエンティティで操作を実行するためのAPIを提供します。 </h3> <p>Drupalカスタムエンティティを作成することの利点は何ですか？ </p> <h3 id="Drupalカスタムエンティティの作成により-独自のデータ構造とビジネスロジックを定義できます-これにより-サイトがより効率的で管理しやすくなります-また-カスタムエンティティを使用すると-エンティティを処理するための強力なツールを提供するDrupalのエンティティAPIを利用できます">Drupalカスタムエンティティの作成により、独自のデータ構造とビジネスロジックを定義できます。これにより、サイトがより効率的で管理しやすくなります。また、カスタムエンティティを使用すると、エンティティを処理するための強力なツールを提供するDrupalのエンティティAPIを利用できます。 </h3> <h3 id="Drupalのカスタムエンティティにフィールドを追加する方法は">Drupalのカスタムエンティティにフィールドを追加する方法は？ </h3> <p>Drupalのカスタムエンティティにフィールドを追加するには、フィールドAPIを使用する必要があります。これには、エンティティのベースフィールド定義方法でフィールドを定義することが含まれます。また、フィールドUIモジュールを使用して、Drupal Managementインターフェイスを介してエンティティにフィールドを追加することもできます。 </p> <h3 id="Drupalにカスタムエンティティを表示する方法は"> Drupalにカスタムエンティティを表示する方法は？ </h3> <p> Drupalにカスタムエンティティを表示するには、エンティティ用のビュービルダーを作成する必要があります。これには、EntityViewBuilderクラスを拡張するクラスを定義し、ビューメソッドを実装することが含まれます。ビューモジュールを使用して、エンティティのカスタムビューを作成することもできます。 </p> <h3 id="Drupalでカスタムエンティティを追加および編集するためのフォームを作成する方法は"> Drupalでカスタムエンティティを追加および編集するためのフォームを作成する方法は？ </h3> <p>カスタムエンティティを追加および編集するためのDrupalにフォームを作成するには、エンティティのフォームクラスを定義する必要があります。これには、エンティティフォームクラスを拡張し、フォームを実装、検証、および送信することが含まれます。 </p> <h3 id="Drupalでカスタムエンティティを削除する方法は"> Drupalでカスタムエンティティを削除する方法は？ </h3> <p> Drupalでカスタムエンティティを削除するには、エンティティAPIの削除メソッドを使用する必要があります。これには、エンティティのロード、削除メソッドの呼び出し、エンティティの保存が含まれます。エンティティAPIのdeletemultipleメソッドを使用して、複数のエンティティを一度に削除することもできます。 </p> </div>

以上がDrupal -setupで独自のカスタムエンティティを構築しますの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。