DrupalのEntityを定義する簡単な例－６：EntityAPI（EntityAPIControllerExportable）でバンドルの管理画面の定義

エンティティ（Entity）に一つ以上のバンドル（Bundle）の定義ができます（カスタムモジュールentity_room.zip）

• エンティティ（Enityt）の定義（hook_entity_info）にバンドル（bundle）定義があります（'bundle'=>array()）
  • バンドル定義に空の配列（bundle =>array()）として定義する場合エンティティ（Entity）名と同じバンドルが自動的に定義されます
• 一つエンティティに複数のバンドル定義ができます（カスタムモジュールentity_room.zip をダウンロード）
  • 例： roomエンティティに、シングルタイプルーム（single room）とツインタイプルーム(twin room)のバンドル(bundle)があります
    
  • 複数のバンドル定義するエンティティは以下のようです

    /**
     * Implements hook_entity_info().
     */
    function entity_room_entity_info()
    {
        $room_info['room'] = array(
            'label' => t('Room'),
            'entity class' => 'Entity',
            'controller class' => 'DrupalDefaultEntityController',
            'base table' => 'room',
            'fieldable' => TRUE,
            'entity keys' => array(
                'id' => 'rid',
                'label' => 'room_number',
                'bundle' => 'room_type',     // DB上にroom_typeフィールドでバンドルを区別
            ),
            'bundles' => array(
                'single_room'=> array(
                    'label' => 'Single Room',
                    'admin' => array(
                        'path' => 'admin/structure/single-room/manage',
                    ),
                ),
                'twin_room'=> array(
                    'label' => 'Twin Room',
                    'admin' => array(
                        'path' => 'admin/structure/twin-room/manage',
                    ),
                ),
            ),
            'access callback' => 'access_room',
            'module' => 'entity_room',
        );
    
        return $room_info;
    }
    

バンドルのフィールド管理パス、権限の設定が必要です

• 各バンドル（Bundle）にそれぞれの拡張フィールド管理ができます
• そのため、各バンドルの拡張フィールドの管理画面を分ける必要があります
  • single room: 'path' => 'admin/structure/single-room/manage',
  • twin room: 'path' => 'admin/structure/twin-room/manage',
• 各バンドルに対してエンティティでアクセス権限一括設定ができます
  • 'access callback' => 'access_room',

バンドルオブジェクトを区別するためentity_keysにbundleパラメーターの設定が必要

• 一エンティティ（Entity）ごとに、DB上では一テーブルとなります
  • 上記例はroomテーブル（entity_room.installを参考）
• 複数のバンドルを定義するので、当然どのようにバンドルを区別するか、そのキーが必要となります
  • 上記例は、バンドルを区別するroom_typeフィールドを追加しました
• DB上のバンドル識別フィールドをentity_keysに設定する必要があります
  • 上記では、'bundle' => 'room_type',
• このキーを設定しないと、実際にバンドルオブジェクトの取得はできないです

hook_field_extra_fields(). を実装して、バンドルの拡張フィールド にエンティティのプロパティ項目を追加

• バンドルの拡張フィールド管理画面に、エンティティのプロパティがありません（継承関係でバンドルが下位になっています）
• プロパティをフィールドように見せるために hook_field_extra_fields(). を実装します（実際にフィールド管理画面でプロパティの編集はできない）

  /**
   * Implements hook_field_extra_fields().
   * Field管理にRoomのプロパティ項目を追加（編集不可）
   */
  function entity_room_field_extra_fields()
  {
      $return = array();
      //　For Single Room Bundle
      $return['room']['single_room'] = array(
          'form' => array(
              'room_type' => array(
                  'label' => t('Room Type'),
                  'description' => t('The type of the room'),
                  'weight' => 1,
              ),
              'room_number' => array(
                  'label' => t('Room Number'),
                  'description' => t('The number of the room'),
                  'weight' => 2,
              ),
          ),
      );
      //　For Twin Room Bundle
      $return['room']['twin_room'] = array(
          'form' => array(
              'room_type' => array(
                  'label' => t('Room Type'),
                  'description' => t('The type of the room'),
                  'weight' => 1,
              ),
              'room_number' => array(
                  'label' => t('Room Number'),
                  'description' => t('The number of the room'),
                  'weight' => 2,
              ),
          ),
      );
  
      return $return;
  }
  

エンティティの取得、作成などの操作にhook_menu()を実装して行います

• エンティティの取得、作成などはhook_menu()を実装します
• エンティティ作成、表示にはFormAPIなどを実装しています

  /**
   * Implements hook_menu().
   */
  function entity_room_menu()
  {
      // シングル ルーム 管理画面
      $items['admin/structure/single-room/manage'] = array(
          'title' => t('Single Room Admin'),
          'description' => 'Manage Single Room structure',
          'page callback' => 'room_info',
          'page arguments' => array('Single Room') ,
          'access arguments' => array('administer rooms'),
      );
      $items['single-room/add'] = array(
          'title' => t('Add Single Room'),
          'page callback' => 'room_add',
          'page arguments' => array('single_room'),
          'access arguments' => array('create room'),
      );
  
      // ツインルーム管理が画面
      $items['admin/structure/twin-room/manage'] = array(
          'title' => 'Twin Room Admin',
          'description' => 'Manage Twin Room structure',
          'page callback' => 'room_info' ,
          'page arguments' => array('Twin Room'),
          'access arguments' => array('administer rooms'),
      );
      $items['twin-room/add'] = array(
          'title' => t('Add Twin Room'),
          'page callback' => 'room_add',
          'page arguments' => array('twin_room'),
          'access arguments' => array('create room'),
      );
  
      // Roomの表示
      $items['room/%room'] = array(
          'title callback' => 'room_page_title',
          'title arguments' => array(1),
          'page callback' => 'room_page_view',
          'page arguments' => array(1),
          'access arguments' => array('view rooms'),
          'type' => MENU_CALLBACK,
      );
  
      return $items;
  }
  
  /**
   * Implements hook_permission().
   */
  function entity_room_permission()
  {
      return array(
          'administer rooms' =>  array(
              'title' => t('Administer rooms'),
              'restrict access' => TRUE,
          ),
          'create room' =>  array(
              'title' => t('Create room'),
          ),
          'view rooms' => array(
              'title' => t('View Rooms'),
          )
      );
  }
  
  /**
   * 全員にRoomエンティティの無条件アクセス権限
   */
  function access_room(){
      return true ;
  }
  
  /**
   * create "add room" form
   */
  function room_add($type) {
      $room = (object) array (
          'rid' => '',
          'room_type' => $type,
          'room_number' => '',
      );
  
      return drupal_get_form('room_add_form', $room);
  }
  function room_add_form($form, &$form_state, $room) {
      $form['room_type'] = array(
          '#type' => 'textfield',
          '#title' => t('Room Type'),
          '#default_value' => $room->room_type,
          '#disabled' => true,
          '#required' => TRUE,
      );
  
      $form['room_number'] = array(
          '#type' => 'textfield',
          '#title' => t('Room Number'),
          '#required' => TRUE,
      );
  
      field_attach_form('room', $room, $form, $form_state);
  
      $form['submit'] = array(
          '#type' => 'submit',
          '#value' => t('Save'),
          '#weight' => 10,
      );
  
  
      return $form;
  }
  
  function room_add_form_validate($form, &$form_state) {
      $room_submisttion = (object) $form_state['values'];
      field_attach_form_validate($form_state['values']['room_type'], $room_submisttion, $form, $form_state);
  }
  
  function room_add_form_submit($form, &$form_state) {
      $room_submission = (object) $form_state['values'];
      field_attach_submit($form_state['values']['room_type'], $room_submission, $form, $form_state);
      $room = room_save($room_submission);
      $form_state['redirect'] = "room/$room->rid";
  }
  
  function room_save(&$room) {
      drupal_write_record('room', $room);
      field_attach_insert('room', $room);
      return $room;
  }
  
  
  function room_info($type) {
      return t('Welcome to the administration page for your '.$type.'!');
  }
  
  function room_page_title($room){
      return $room->room_number."(".$room->room_type.")";
  }
  
  function room_page_view($room, $view_mode = 'full'){
  
      $room->content = array();
  
      // Build fields content.
      field_attach_prepare_view('room', array($room->rid => $room), $view_mode);
      entity_prepare_view('room', array($room->rid => $room));
      $room->content += field_attach_view('room', $room, $view_mode);
  
      return $room->content;
  }
  
  function room_uri( $room ){
      return array(
          'path' => 'room/'.$room->rid ,
      );
  }
  
  class RoomController extends EntityAPIController{
  //class RoomController extends DrupalDefaultEntityController{
      public function __construct($entityType) {
          parent::__construct($entityType);
      }
  
      // Entityオブジェクト保存
      public function save($room) {
          drupal_write_record('room', $room);
          field_attach_insert('room', $room);
          return $room;
      }
  
  }
  
  /**
   * hook_menuのURL引数のオブジェクト取得
   */
  function room_load($rid = NULL, $reset = FALSE){
  
      $rids = (isset ($rid) ? array($rid) : array());
      $room = room_load_multiple($rids, $reset);
      return $room ? reset ($room) : FALSE;
  }
  
  function room_load_multiple($rids = array(), $conditions = array(), $reset = FALSE){
      return entity_load('room', $rids, $conditions, $reset);
  }
  

モジュール（EntityAPI）がDrupalコアにある「entity」を拡張したものです

• モジュール（EntityAPI）はAPIモジュールであり、エンドモジュールではありません（インストール後に画面には何の変化もありません）。Drupalへのカスタマイズ、開発するためにAPIです。
  • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター： "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
• プログラミングでEntityを定義する例（DrupalのEntityを定義する簡単な例－３：バンドルの作成/拡張フィールド追加）では、コアのEntity（DrupalDefaultEntityController）を使用した例です

EntityAPI（EntityAPIControllerExportable）を実装してバンドルの管理画面を定義します

• EntityAPI実装よりEntity自身をほかのntityのバンドル（Bundle）にすることことができます
  • 例： DrupalのEntityを定義する簡単な例－５：エンティティ（Entity）を利用して別のエンティティタイプ（Entity Type）のバンドルに作成
• hook_entity_info() のバンドルを管理するUIの定義パラメーター： ”admin ui” => array()
  • "exportable" => TRUE :　エンティティ定義のエクスポートができるかの定義
  • "fieldable" => TRUE :  フィールドの拡張可能かの定義（バンドル（room type）内で定義ではなく、エンティティタイプ内で定義：上記例ではroomエンティティで定義）
    

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

• バンドル管理画面（RoomType管理）でバンドルを作成します
• 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
• これらの操作をできるように、hook_entity_info_alter()の実装が必要です

  /**
   * 追加されたバンドル（RoomType）に拡張フィールド操作URIの追加
   * Implements hook_entity_info_alter().
   */
  function entity_room_entity_info_alter(&$entity_info)
  {
      foreach (room_types() as $type => $info) {
          $entity_info['room']['bundles'][$type] = array(
              'label' => $info->room_type_label,
              'admin' => array(
                  'path' => 'admin/structure/room-types/manage/%room_type',
                  'real path' => 'admin/structure/room-types/manage/' . $type,
                  'bundle argument' => 4,
              ),
          );
      }
  }
  
  // room_type_sys でデータの取得
  // room_type入力がなければ、全部のRoomTypeを返す
  function room_type_load($room_type=null){
      return room_types( $room_type ) ;
  }
  
  function room_types( $room_type = null ){
      $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
      return isset( $room_type ) ? reset($types) : $types ;
  }
  

  • なぜhook_entity_info_alter()の実装が必要か？バンドル（room_type）が作成する前にエンティティの実体がないからです（上記例では必要に応じでバンドル作成）
  • 後ろにある「function room_type_load()」はパスにあるワイドカード（ 'path' => 'admin/structure/room-types/manage/%room_type'）に使用されます
• hook_entity_info_alter()を実装しない、または間違って実装（例：pathのワイドカード使用不正）すると拡張フィールド管理ページが見つからないエラーになります
  

エンティティをバンドルにするデータ構成：エンティティタイプの識別キーが必要

• 上記例のエンティティタイプ、バンドルの関係は以下のようです
  • エンティティタイプ(entity type) ： room
  • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など（必要に応じて作成）
• 作成したエンティティ本体（room）がバンドル（single_type, twin_type）どの関連があるので、二つのテーブル間の参照キーが必要となります
  • 例： 1001室 ⇒ シングル（single_type）、2001室（twin_type）
  • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
    

モジュール（EntityAPI）がDrupalコアにある「entity」を拡張したものです

• モジュール（EntityAPI）はAPIモジュールであり、エンドモジュールではありません（インストール後に画面には何の変化もありません）。Drupalへのカスタマイズ、開発するためにAPIです。
  • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター： "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
• プログラミングでEntityを定義する例（DrupalのEntityを定義する簡単な例－３：バンドルの作成/拡張フィールド追加）では、コアのEntity（DrupalDefaultEntityController）を使用した例です

EntityAPI（EntityAPIControllerExportable）を実装してバンドルの管理画面を定義します

• EntityAPI実装よりEntity自身をほかのntityのバンドル（Bundle）にすることことができます
  • 例： DrupalのEntityを定義する簡単な例－５：エンティティ（Entity）を利用して別のエンティティタイプ（Entity Type）のバンドルに作成
• hook_entity_info() のバンドルを管理するUIの定義パラメーター： ”admin ui” => array()
  • "exportable" => TRUE :　エンティティ定義のエクスポートができるかの定義
  • "fieldable" => TRUE :  フィールドの拡張可能かの定義（バンドル（room type）内で定義ではなく、エンティティタイプ内で定義：上記例ではroomエンティティで定義）
    

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

• バンドル管理画面（RoomType管理）でバンドルを作成します
• 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
• これらの操作をできるように、hook_entity_info_alter()の実装が必要です

  /**
   * 追加されたバンドル（RoomType）に拡張フィールド操作URIの追加
   * Implements hook_entity_info_alter().
   */
  function entity_room_entity_info_alter(&$entity_info)
  {
      foreach (room_types() as $type => $info) {
          $entity_info['room']['bundles'][$type] = array(
              'label' => $info->room_type_label,
              'admin' => array(
                  'path' => 'admin/structure/room-types/manage/%room_type',
                  'real path' => 'admin/structure/room-types/manage/' . $type,
                  'bundle argument' => 4,
              ),
          );
      }
  }
  
  // room_type_sys でデータの取得
  // room_type入力がなければ、全部のRoomTypeを返す
  function room_type_load($room_type=null){
      return room_types( $room_type ) ;
  }
  
  function room_types( $room_type = null ){
      $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
      return isset( $room_type ) ? reset($types) : $types ;
  }
  

  • なぜhook_entity_info_alter()の実装が必要か？バンドル（room_type）が作成する前にエンティティの実体がないからです（上記例では必要に応じでバンドル作成）
  • 後ろにある「function room_type_load()」はパスにあるワイドカード（ 'path' => 'admin/structure/room-types/manage/%room_type'）に使用されます
• hook_entity_info_alter()を実装しない、または間違って実装（例：pathのワイドカード使用不正）すると拡張フィールド管理ページが見つからないエラーになります
  

エンティティをバンドルにするデータ構成：エンティティタイプの識別キーが必要

• 上記例のエンティティタイプ、バンドルの関係は以下のようです
  • エンティティタイプ(entity type) ： room
  • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など（必要に応じて作成）
• 作成したエンティティ本体（room）がバンドル（single_type, twin_type）どの関連があるので、二つのテーブル間の参照キーが必要となります
  • 例： 1001室 ⇒ シングル（single_type）、2001室（twin_type）
  • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります
    

モジュール（EntityAPI）がDrupalコアにある「entity」を拡張したものです

• モジュール（EntityAPI）はAPIモジュールであり、エンドモジュールではありません（インストール後に画面には何の変化もありません）。Drupalへのカスタマイズ、開発するためにAPIです。
  • EntityAPIを利用する場合、実装したhook_entity_info() のパラメーター： "controller class" => "EntityAPIControllerExportable"、"controller class" => "EntityAPIController" を定義します
• プログラミングでEntityを定義する例（DrupalのEntityを定義する簡単な例－３：バンドルの作成/拡張フィールド追加）では、コアのEntity（DrupalDefaultEntityController）を使用した例です

EntityAPI（EntityAPIControllerExportable）を実装してバンドルの管理画面を定義します

• EntityAPI実装よりEntity自身をほかのntityのバンドル（Bundle）にすることことができます
  • 例： DrupalのEntityを定義する簡単な例－５：エンティティ（Entity）を利用して別のエンティティタイプ（Entity Type）のバンドルに作成
• hook_entity_info() のバンドルを管理するUIの定義パラメーター： ”admin ui” => array()
  • "exportable" => TRUE :　エンティティ定義のエクスポートができるかの定義
  • "fieldable" => TRUE :  フィールドの拡張可能かの定義（バンドル（room type）内で定義ではなく、エンティティタイプ内で定義：上記例ではroomエンティティで定義）
    

hook_entity_info_alter()を実装してエンティティの拡張フィールド管理をできるように

• バンドル管理画面（RoomType管理）でバンドルを作成します
• 各バンドル関連のエンティティに拡張フィールドの追加、表示変更ができます
• これらの操作をできるように、hook_entity_info_alter()の実装が必要です

  /**
   * 追加されたバンドル（RoomType）に拡張フィールド操作URIの追加
   * Implements hook_entity_info_alter().
   */
  function entity_room_entity_info_alter(&$entity_info)
  {
      foreach (room_types() as $type => $info) {
          $entity_info['room']['bundles'][$type] = array(
              'label' => $info->room_type_label,
              'admin' => array(
                  'path' => 'admin/structure/room-types/manage/%room_type',
                  'real path' => 'admin/structure/room-types/manage/' . $type,
                  'bundle argument' => 4,
              ),
          );
      }
  }
  
  // room_type_sys でデータの取得
  // room_type入力がなければ、全部のRoomTypeを返す
  function room_type_load($room_type=null){
      return room_types( $room_type ) ;
  }
  
  function room_types( $room_type = null ){
      $types = entity_load_multiple_by_name( 'room_type', isset($room_type) ? array($room_type) : false ) ;
      return isset( $room_type ) ? reset($types) : $types ;
  }
  

  • なぜhook_entity_info_alter()の実装が必要か？バンドル（room_type）が作成する前にエンティティの実体がないからです（上記例では必要に応じでバンドル作成）
  • 後ろにある「function room_type_load()」はパスにあるワイドカード（ 'path' => 'admin/structure/room-types/manage/%room_type'）に使用されます
• hook_entity_info_alter()を実装しない、または間違って実装（例：pathのワイドカード使用不正）すると拡張フィールド管理ページが見つからないエラーになります
  

エンティティをバンドルにするデータ構成：エンティティタイプの識別キーが必要

• 上記例のエンティティタイプ、バンドルの関係は以下のようです
  • エンティティタイプ(entity type) ： room
  • バンドル(bundle) : シングル(single_type)、 ツイン(twin_type) など（必要に応じて作成）
• 作成したエンティティ本体（room）がバンドル（single_type, twin_type）どの関連があるので、二つのテーブル間の参照キーが必要となります
  • 例： 1001室 ⇒ シングル（single_type）、2001室（twin_type）
  • roomテーブルにある「room_type_sys」フィールドにバンドルであるroom_typeにある「room_type_sys」フィールドが参照キーとなります