DrupalのEntityAPIを実装したエンティティはViewsでの検索可能になったためhook_views_dataの実装必要はない

Entityを定義する簡単な例：Roomエンティティ（Entityのサンプロモジュール：entity_example）

• Entityをプログラミングで定義するには、最初簡単なこと、必要最小限のことを定義します
• ここで、ルーム（Room）エンティティ（Entity）を例として紹介します(サンプルモジュールをダウンロードしてください)
  

Roomエンティティ：Entityの定義 ＋ データインポート ＋ Entityの参照

• Roomのテストデータ（dsvフォーマット）： 

  • ルームナンバー：　room_number

  • ルームタイプ:： type

    rid,room_number,type
    1,1001,シングル
    2,1002,シングル
    3,1003,シングル
    4,2001,ダブル
    5,3001,ダブル

• データベース上に「room」テーブルを作成、または、モジュールのinstallファイルでスキーマを定義して、モジュールがインストール時に自動的に作成されます

  /**
   * Implement hook_schema()
   */
  function entity_example_schema(){
      $schema['room']=array(
          'description' => 'Rooms',
          'fields' => array(
              'rid' => array(
                  'type' => 'serial',
                  'description' => 'Room Id'
              ),
              'type' => array(
                  'type' => 'varchar',
                  'length' => '255',
                  'description' => 'Room Type'
              ),
              'room_number' => array(
                  'type' => 'varchar',
                  'length' => '25',
                  'description' => 'Room Number'
              ),
  
          ),
          'primary key' => array('rid'),
  
      );
  
      return $schema;
  }

• モジュールファイル（.module）にRoomエンティティを定義します

  /**
   * Implements hook_entity_info().
   */
  /**
   * Implements hook_entity_info().
   */
  function entity_example_entity_info()
  {
  
     $services['room'] = array(
          'label' => t('Room'),                       // エンティティ名
          'entity class' => 'Entity',                 // デフォルトクラスの使用
          'controller class' => 'EntityAPIController',//　デフォルトクラスの使用
          'base table' => 'room',                     // DB上のテーブル名
          'fieldable' => TRUE,                        // 余分のフィールド追加可能
          'entity keys' => array(                     // ルームIDをエンティティのキー.
              'id' => 'rid',
              'label' => 'room_number',               //　コールバック関数が優先
          ),
          'view modes' => array(
              'full' => array(
                  'label' => t('Default'),
                  'custom settings' => FALSE,
              ),
          ),
          'bundles' => array(),                       // bundleはこのエンティティ自身
  //        'label callback' => 'room_label',   　　　　// 指定しないとラベルの取得ができない
          'access callback' => 'room_access' ,        // default:'value user_access'動作しない
          'module' => 'entity_example',
          'metadata controller class' => 'EntityExampleMetadataController',
  
      );
  
      return $services;
  }
  
  /**
   * Extend the defaults.
   */
  class EntityExampleMetadataController extends EntityDefaultMetadataController {
      public function entityPropertyInfo() {
          $info = parent::entityPropertyInfo();
          $properties = &$info[$this->type]['properties'];
          $properties['type'] = array(
              'label' => t('Room type'),
              'schema field' => 'type',
              'getter callback' => 'entity_property_getter_method',
              'setter callback' => 'entity_property_verbatim_set',
              'required' => TRUE,
              'description' => t('Room type of the room'),
          );
          $properties['room_number'] = array(
              'label' => t('Room Number'),
              'schema field' => 'room_number',
              'getter callback' => 'entity_property_getter_method',
              'setter callback' => 'entity_property_verbatim_set',
              'required' => TRUE,
              'description' => t('The number of the room'),
          )
          return $info;
      }
  }
  
  function room_access($op, $room = NULL, $account = NULL) {
      // 全員アクセス可能にする
      return TRUE;
  }
  
  

• これだけで、Entityの定義が完了しました
• モジュール（Feeds）でRoomサンプルデータをDBにインポートします
  • モジュール（Feeds Entity Processor）のインストール/有効化が必要
• 実際にRoomエンティティが動作しているかをテストします
  • 任意のコンテンツタイプ（例：記事）Roomフィールドを追加します（Entity参照タイプ）
  • Entity参照タイプのターゲットを「Room」にします
  • 一つの記事を作成して、Roomエンティティの動作を確認します

Enity定義の注意点：アクセス権限、エンティティのラベル定義を正しく定義します

• 上記例として、Entityの必要な最低限な定義となります
• ネットでEntity定義例がありますが、アクセス権限、エンティティのラベルなどの権限が間違いやすいです
• アクセス権限（access callback）で定義しないと、エンティティのラベルがうまく表示されないです
  
• エンティティのラベルを2か所で定義できます
  • entity_keys: DB上にどのフィールドがラベルとして利用するかを指定します
  • label callback :　ユーザー必要応じて、ラベルを生成するコールバック関数
  • コールバック関数がentity_keys設定より優先です