技術資料

Movable Type でプラグインを開発する際に、独自のオブジェクトを新規に作成する方法について解説します。

今回は MT::Shop というオブジェクトを MT:Entry の子オブジェクトとして追加するプラグインを例に説明していきます。

MTプラグイン開発の基本的な手順については、Movable Typeプラグイン開発入門：第一回 基本的なプラグインの作成方法 などを参照。

config.yaml の記述

新規にオブジェクトを追加するには、プラグインの config.yaml ファイルに以下のように記述します。

schema_version: 1.00
object_types:
    shop: MT::Shop

上記の例では、shop というオブジェクトタイプを MT::Shop クラスとして定義しています。

schema_version の値は、プラグインのアップデートなどによりテーブルのカラムを追加・変更した場合などに変更します。

MT/shop.pm の作成

続いて、プラグインディレクトリ内に lib/MT/shop.pm というファイルを作成し、以下のように記述します。

package MT::Shop;
use strict;
use base qw( MT::Object );

__PACKAGE__->install_properties ({
    column_defs => {
        'id' => 'integer not null auto_increment',
        'entry_id' => 'integer not null',
        'name' => 'text',
        'tel' => 'text',
        'address' => 'text',
        'enabled' => 'integer',
    },
    indexes => {
        id => 1,
        entry_id => 1,
    },
    defaults => {
        'enable' => 0,
    },
    child_of => 'MT::Entry',
    audit => 1,
    datasource  => 'shop',
    primary_key => 'id',
    class_type  => 'shop',
});

1;

上記の例では、MT::Shop クラスを MT::Object クラスから継承し、install_properties メソッドでオブジェクトのプロパティを定義しています。

各プロパティの意味は以下の通りです。

column_defs

オブジェクトのカラム定義をハッシュリファレンスで指定します。上記の例では、id、entry_id、name、tel、address、enabled の6つのカラムを定義しています。

indexes

インデックスを設定するカラムをハッシュリファレンスで指定します。上記の例では、id と entry_id にインデックスを設定しています。

defaults

カラムのデフォルト値をハッシュリファレンスで指定します。上記の例では、enabled カラムのデフォルト値を0に設定しています。

child_of

このオブジェクトが属する親オブジェクトを指定します。上記の例では、MT::Entry の子オブジェクトとして定義しています。

audit

オブジェクトの作成日時や更新日時を自動的に管理するかどうかを指定します。1 を指定すると有効になります。
自動的に管理されるカラムは以下の通りです。

• created_on
• created_by
• modified_on
• modified_by

datasource

データベースのテーブル名を指定します。上記の例では、shop が指定されているため mt_shop というテーブル名になります。

primary_key

プライマリキーとなるカラムを指定します。上記の例では、id カラムがプライマリキーになります。

class_type

オブジェクトのタイプを指定します。上記の例では、shop が指定されています。

動作確認

以上で、MT::Shop オブジェクトの定義は完了です。MTの管理画面でプラグインを有効化すると、データベースに mt_shop テーブルが作成されます。

独自オブジェクトの操作方法

独自オブジェクトの操作は、他の MT オブジェクトと同様に行います。以下に基本的な操作例を示します。

my $entry_id = 123;
my $shop = MT->model('shop')->load( { entry_id => $entry_id } );
if (!$shop) {
    $shop = MT->model('shop')->new;
    $shop->entry_id($entry_id);
}

$shop->name('My Shop');
$shop->tel('123-456-7890');
$shop->address('奈良県奈良市西大寺本町12345');
$shop->enabled(1);
$shop->save() or die $shop->errstr();

上記の例では、entry_id が 123 の MT::Shop オブジェクトをロードし、存在しない場合は新規作成しています。その後、各カラムに値を設定し、save メソッドで保存しています。

このようにして、独自オブジェクトを定義し、操作することができます。