前章でMTオブジェクトの利用方法について解説しましたが、既存の物だけではなく自分でもMTオブジェクトを作成する事ができます。

今回は、こういった独自オブジェクトの作成について解説します。

MT::Objectから派生させた、独自のMTオブジェクトの事をさします。MT::Entryなどの派生オブジェクトを作成し拡張する事も可能です。

プラグインでMTオブジェクトを追加する場合は、config.yamlでのオブジェクト情報の記載と、MTオブジェクトのPerlモジュールが必要となります。

独自オブジェクト（MT::Foo）を例として作成法を解説します。

• MT::Objectを継承したクラス
• モジュール名はMT::Foo
• タイプ名はfoo
• 指定カラム
  • id : オブジェクトID
  • blog_id : ブログID
  • title : タイトル（最大２５５文字）
  • bar : テキスト情報
• インデックス
  • blog_id
  • created_on
  • modified_on
• データソース : mt_foo
• プライマリキー : id
• 作成日時、修正日時を自動記録

config.yamlに記載する情報は少ないです。

id: MyPlugin11
key: MyPlugin11
name: <__trans phrase="Sample Plugin Uniquely Object">
version: 1.0
description: <__trans phrase="_PLUGIN_DESCRIPTION">
author_name: <__trans phrase="_PLUGIN_AUTHOR">
author_link: http://www.example.com/about/
doc_link: http://www.example.com/docs/
l10n_class: MyPlugin11::L10N

schema_version: 0.01
object_types:
    foo: MT::Foo

• schema_version: 0.01
  • プラグインのスキーマのバージョンを記載します。
  • プラグインのインストール時と、スキーマバージョンのアップデート時にスキーマのアップデートが行われます。
• object_types
  • オブジェクトのタイプとクラス名を指定します。
• foo: MT::Foo
  • タイプ名 : foo
  • クラス名 : MT::Foo

簡単な例としてMT::Fooを作成します。ここにデータベーステーブルの情報や組み込み関数などを記載します。

package MT::Foo;
use strict;

use base qw( MT::Object );

__PACKAGE__->install_properties ({
    column_defs => {
        'id'      => 'integer not null auto_increment',
        'blog_id' => 'integer not null',
        'title'   => 'string(255) not null',
        'bar'     => 'text',
    },
    indexes => {
        blog_id => 1,
        created_on => 1,
        modified_on => 1,
    },
    child_of => 'MT::Blog',
    audit => 1,
    datasource  => 'foo',
    primary_key => 'id',
    class_type  => 'foo',
});

1;

• package MT::Foo;
  • パッケージ名をMT::Fooに指定しています。
• use base qw( MT::Object );
  • MT::Objectクラスを継承している事を明記します。
• __PACKAGE__->install_properties ({});
  • オブジェクトの色々な情報を指定し、MTアプリケーションに設定を知らせます。
• column_defs => {},
  • 以下の４つのカラムを指定します。
    • ‘id’ => ‘integer not null auto_increment’,
    • ‘blog_id’ => ‘integer not null’,
    • ‘title’ => ‘string(255) not null’,
    • ‘bar’ => ‘text’,
• indexes => {},
  • 以下の３つのカラムをデータベーステーブルのインデックスとして指定します。
    • blog_id => 1,
    • created_on => 1,
    • modified_on => 1,
• audit => 1,
  • オブジェクトの作成日時と変更日時を自動的に登録するようにします。
  • created_on, created_by, modified_on, modified_byの４つのカラムが自動的に追加されます。
• datasource => 'foo',
  • データベーステーブル名をmt_fooにします。
• primary_key => 'id',
  • データベーステーブルのプライマリーキーをidにします。
• class_type => 'foo',
  • MT::Fooクラスのタイプ名をfooにします。

string	文字列。サイズを指定します（例：string(255)）
text	テキスト
boolean	真偽値
smallint	16bitの整数
integer	32bitの整数
float	浮動小数点
blob	バイナリデータ
datetime	日時
timestamp	日時。保存時に自動的にアップデートされます。

not null	必須項目です。空は許されません。
auto_increment	新規オブジェクト作成時に自動的に整数値がカウントアップされます。

プラグインのインストール時に作成されたテーブルを確認してみます。

mysql> show create table mt_foo \G
*************************** 1. row ***************************
       Table: mt_foo
Create Table: CREATE TABLE `mt_foo` (
  `foo_id` int(11) NOT NULL auto_increment,
  `foo_bar` mediumtext,
  `foo_blog_id` int(11) NOT NULL,
  `foo_class` varchar(255) default 'foo',
  `foo_created_by` int(11) default NULL,
  `foo_created_on` datetime default NULL,
  `foo_modified_by` int(11) default NULL,
  `foo_modified_on` datetime default NULL,
  `foo_title` varchar(255) NOT NULL,
  PRIMARY KEY  (`foo_id`),
  KEY `mt_foo_modified_on` (`foo_modified_on`),
  KEY `mt_foo_created_on` (`foo_created_on`),
  KEY `mt_foo_class` (`foo_class`),
  KEY `mt_foo_blog_id` (`foo_blog_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8
1 row in set (0.00 sec)

$MT_DIR/
|__ plugins/
   |__ MyPlugin11/
      |__ config.yaml
      |__ lib/
         |＿ MyPlugin11/
         |  |__ L10N.pm
         |  |＿ L10N/
         |     |＿ en_us.pm
         |     |＿ ja.pm
         |＿ MT
            |__ Foo.pm

作成されたMT::Fooクラスは前章で上げた利用方法と同じです。ここでは復習として簡単にMT::Fooの利用方法を解説します。

my $class_name = 'foo';
my $class = MT->model($class_name);
my $foo = $class->new();
$foo->blog_id(2);
$foo->title('MT::Foo test');
$foo->bar('Hello, world!!');
$foo->save()
    or die $foo->errstr();

my $title = $foo->title();

MyPlugin11.zip(2.38KB)

今回は最低限の実装しかしていませんが、ここから多くの機能を搭載したクラスを作成することが可能です。

自分でプラグインを作成する際、新規にオブジェクトを作成すると楽に機能が実装できる場面が多くあります。

しかし、MTのアップデート時などにプラグインを一緒にアップデートする必要が出てくるかもしれません。アップデート時はきちんとバックアップを取った上で、テスト用の環境でテストを行い、問題がないことを確認してから本番環境のアップデートをするようにしましょう。（もちろん、これはプラグインのアップデートに限った話ではありませんが）

1. プラグイン開発のためのファーストステップ
2. レジストリ、YAMLについて
3. 環境変数について
4. プラグインのローカライゼーションについて
5. テストドリブンでのプラグインの開発について
6. グローバル・モディファイアプラグインの開発について
7. ファンクションタグ プラグインの開発について
8. ブロックタグ プラグインの開発について
9. コンディショナルタグ プラグインの開発について
10. プラグインのデバッグ
11. プラグインの設定方法
12. コールバックとフックポイント
13. スケジュールタスクの開発
14. MTオブジェクトの利用方法
15. 独自オブジェクトの作成
16. 新規アプリケーションの作成
17. Transformerプラグインの開発
18. 管理画面のメニュー修正
19. リストアクションの追加
20. 動作モードの追加とモーダルウィンドウの表示
21. 外部Web APIとの連携
22. 権限とロール