DrupalのEntityを定義する簡単な例－４：複数のバンドルの作成/拡張フィールド追加

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

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

 

entity_room.zip (2.84 KB)

DrupalのEntityを定義する簡単な例－３：バンドルの作成/拡張フィールド追加

カスタムモジュールでEntityの定義と作成

カスタムモジュール（entity_room.zip）でEntityとそのBundleを定義し、拡張フィールドの使用ができるようにします

  • 拡張フィールドがEntityオブジェクトが作成後に必要に応じ追加することができます（柔軟性を高める）
    • カスタムモジュール（entity_room.zip）をダウンロードして、参考にしてください
  • 定義されたRoom EntityにRoomバンドル（Bundle）を指定します 
    /**
 * Implements hook_entity_info().
 */
function entity_room_entity_info()
{
    $room_info['room'] = array(
        'label' => t('Room'),
        'controller class' => 'RoomController',
        'base table' => 'room',
        'uri callback' => 'room_uri',
        'fieldable' => TRUE,
        'entity keys' => array(
            'id' => 'rid',
            'label' => 'room_number',
        ),
        'static cache' => TRUE,
        'bundles' => array(　　　　　　　//　バンドルの指定
            'room'=> array(　　　　　　　  //  バンドル名： room
                'label' => 'Room',
                'admin' => array(
                    'path' => 'admin/structure/room/manage',  // バンドルの管理URI
                    'access arguments' => array('administer rooms'),
                ),
            ),
        ),
        'view modes' => array(
            'full' => array(
                'label' => t('Full Room'),
                'custom settings' =>  FALSE,
            ),
        )
    );

    return $room_info;
}
  • 管理画面（/admin/stracture/room/manage）でRoomEntityの拡張フィールドの追加ができるようになります
    • 例：　Room Typeの追加
      バンドルに拡張フィールドの追加

Entity作成時に追加された拡張フィールドが現れます

  • Roomエンティティを作成（/room/add）画面に、Roomエンティティのプロパティ（room_number）と拡張フィールド（room type）が現れます
    Entity作成フォームに追加したフィールド（Room Type）が現れ
  • エンティティ表示画面（/room/[rid]）にも拡張フィールドの内容が表示されます
    Entity表示画面に追加されたフィールドの内容が表示される
  • エンティティ追加、表示のコードは以下のよう 
    /**
 * Implements hook_menu().
 */
function entity_room_menu()
{
    // 管理が面にメッセージ表示のみ
    $items['admin/structure/room/manage'] = array(
        'title' => 'Room Admin',
        'description' => 'Manage Room structure',
        'page callback' => 'room_info',
        'access arguments' => array('administer rooms'),
    );
    // 個別Room表示
    $items['room/%entity_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,
    );
    // 新規Room作成
    $items['room/add'] = array(
        'title' => t('Add Room'),
        'page callback' => 'room_add',
        'access arguments' => array('create room'),
    );
    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'),
        )
    );
}

/**
 * create "add room" form
 */
function room_add() {
    $room = (object) array (
        'rid' => '',
        'type' => 'room',
        'room_number' => '',
    );

    return drupal_get_form('room_add_form', $room);
}
function room_add_form($form, &$form_state, $room) {
    $form['room_number'] = array(
        '#type' => 'textfield',
        '#title' => t('Room Number'),
        '#required' => TRUE,
    );

    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Save'),
    );

    field_attach_form('room', $room, $form, $form_state);

    return $form;
}

function room_add_form_validate($form, &$form_state) {
    $room_submisttion = (object) $form_state['values'];
    field_attach_form_validate('room', $room_submisttion, $form, $form_state);
}

function room_add_form_submit($form, &$form_state) {
    $room_submission = (object) $form_state['values'];
    field_attach_submit('room', $room_submission, $form, $form_state);
    $room = room_save($room_submission);
    $form_state['redirect'] = "room/$room->rid";
}

function room_save(&$room) {
    return entity_get_controller('room')->save($room);
}


function room_info() {
    return t('Welcome to the administration page for your rooms!');
}

function room_page_title($room){
    return $room->room_number;
}

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;
}


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

    return $return;
}


function room_uri( $room ){
    return array(
        'path' => 'room/' . $room->rid,
    );
}

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;
    }

}

/**
 * Implements hook_load().
 */
function entity_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);
}

     

 

DrupalのEntityを定義する簡単な例－５：エンティティ（Entity）を利用して別のエンティティタイプ（Entity Type）のバンドルに作成

一つのエンティティタイプ（Entity Type）に最低一つのバンドルが必要

  • Entityオブジェクトを生成する場合、最初エンティティタイプ（Entity Type）が必要
    • 例： 記事（Article）、基本ページ（Basic Page）を作成する前に、コンテントタイプが必要です（コンテントタイプ⇒エンティティタイプです、記事／基本ページはバンドルです）
  • 前回紹介した「DrupalのEntityを定義する簡単な例－４：複数のバンドルの作成/拡張フィールド追加 」例では一つのエンティティタイプに複数のバンドルを定義します
    • プログラミングでバンドル（例：シングルタイプ、ツインタイプのルーム）を定義します

問題点：プログラミングで定義したバンドルは任意に追加することはできません

  • 上記の例では、エンティティタイプを定義する同時にバンドルも定義します
  • 実際には、エンティティタイプが定義してから、必要に応じていろいろなバンドルを追加する必要があります
    • 例：ルームでは施設によって、ツインタイプのものがあれば、ないところもあります
    • 例：コンテントタイプに記事、基本ページ以外に、必要に応じていろいろなバンドル（例：予約など）追加ができます

解決：エンティティ（Entity）を利用して別のエンティティタイプのバンドルに定義します

  • モジュール：EntityAPIがこの方法を提供してくれました
  • 一つのエンティティ（例：room type）を別のエンティティタイプ（例：room）のバンドルにする定義ができます
    DrupalのEntityオブジェクトを他のエンティティタイプ（EntityType）のバンドルにする
  • 大きな利点は、エンティティタイプがプログラミングで定義、バンドルはDrupalのUIで登録することができます

一つのエンティティを他のエンティティのバンドルにする定義：　"bundle of" にあります

  • プログラミングでエンティティを定義するときに、hook_entity_info を実装して定義します（前回も紹介したので、ここは詳細を省略）
  • 他のエンティティタイプのバンドルにする定義： "bundle of" => "room"  (room typeがroomのバンドルに指定) 
    function entity_room_entity_info()
{
    $return = array(
        'room' => array(
            'label' => t('Room'),
            'entity class' => 'RoomEntity',
            'label callback' => 'entity_class_label', // see RoomEntity class
            'uri callback' => 'entity_class_uri',     // see RoomEntity class
            'controller class' => 'RoomController',
            'base table' => 'room',
            'fieldable' => TRUE,
            'entity keys' => array(
                'id' => 'rid',
                'bundle' => 'room_type_sys',
            ),
            'bundle keys' => array(
                'bundle' => 'room_type_sys',
            ),
            'bundles' => array(),
            'load hook' => 'room_load',
            'view modes' => array(
                'full' => array(
                    'label' => t('Default'),
                    'custom settings' => FALSE,
                ),
            ),
            'module' => 'entity_room',
            'access callback' => 'entity_room_access',
        ),
    );
    $return['room_type'] = array(
        'label' => t('Room Type'),
        'entity class' => 'RoomTypeEntity',
        'controller class' => 'RoomTypeController',
        'base table' => 'room_type',
        'fieldable' => FALSE,
        'bundle of' => 'room',
        'exportable' => TRUE,
        'entity keys' => array(
            'id' => 'rtid',
            'name' => 'room_type_sys',
            'label' => 'room_type_label',
        ),
        'module' => 'entity_room',
        'admin ui' => array(                // Enable the entity API's admin UI.
            'path' => 'admin/structure/room-types',
            'file' => 'room_type.admin.inc',
            'controller class' => 'RoomTypeUIController',
        ),
        'access callback' => 'entity_room_access',
    );

    return $return;
}
  • カスタムモジュール（entity_room.zip）をダウンロードしてください
  • エンティティの具体な操作は次回で説明します