import

テーマを適用するPerlのサブルーチンを指定します。引数として、三つのオブジェクトが渡されます。

• 適用するテーマ エレメント
• テーマ エレメントを含むテーマ全体
• テーマを適用する(多くの場合は作成されたばかりの)MT::BlogまたはMT::Websiteのインスタンス

テーマ エレメント および テーマ全体は、それぞれMT::Theme::ElementとMT::Theme クラスにblessされたオブジェクトとして引き渡されます。

以下は、ブログの各種設定を埋め込んだ テーマ エレメントを、MT::Blogクラスに適用するインポータの例です。

sub my_importer {
    my ( $element, $theme, $obj_to_apply ) = @_;
    my $data = $element->data;
    if ( ref $obj_to_apply ne MT->model('blog') ) {
        return $element->errtrans('this element cannot apply for not blog object.');
    }
    my $blog = $obj_to_apply;
    for my $conf ( keys $data ) {
        if ( $blog->has_column($conf) ) {
            my $value = $data->{$conf};
            $blog->$conf($value);
        }
    }
    return 1;
}

info

Movable Typeがテーマの内容を解析するためのサブルーチンです。テーマを適用したときに、何が起こるかをユーザーに伝えるメッセージを表示します。

sub info {
    my ($element, $theme, $blog) = @_;
　　　　my $item_count;
    ## analyse the $element and set some value for $item_count
    return sub {
        MT->translate(
            '[_1] items would be added to your blog.',
            $item_count,
        );
    };
}

validator

現在のブログの状態をテストし、テーマ エレメントの読み込みが可能かを判断するサブルーチンを指定します。

sub validator {
    my ( $element, $theme, $obj_to_apply ) = @_;
    my $conflict;
    ## validate $obj_to_apply is okay to apply $element.
    if ( $conflict) {
        return $element->error(
            MT->translate(
                'Conflict has occured!',
            )
        );
    }
    return 1;
}

params

テーマをエクスポートするときに、オプション設定画面で使用するパラメータ一の名前を指定します。Movable Typeはこの値をもとに、エクスポート設定を保持します。複数のパラメータを利用する場合、Array_refで指定してください。

component

エクスポートしたデータを、インポートするインポータのComponentIDを指定します。

template

エクスポートのオプション設定画面の出力サブルーチンを指定します。

sub export_template {
    my $app = shift;
    my ( $blog, $setting ) = @_;
    $setting = { some_setting => 'default' }
        if !defined $setting;
    my $param = $setting->{some_setting};
    my %param = (
        param_for_tmpl => $param,
    );
    return $app->load_tmpl(
        'include/my_export_screen.tmpl',
        ¥%param,
    );
}

export

実際のエクスポート処理を行うサブルーチンを指定します。

sub export {
    my $app = shift;
    my ( $blog, $setting ) = @_;
    my $export_data = {};
    ## do copy some data from $blog to $export_data
    return $export_data;
}

exportサブルーチンではハッシュリファレンスをリターンするようにしてください。この戻り値が、エクスポートされたテーマ エレメントのdata要素として格納されます。

finalize

エクスポート処理の後に実行するサブルーチンを指定します。ここで指定したサブルーチンは、テーマのデータ構造が問題無く作成され、エクスポート処理用のテンポラリーディレクトリを確保した後に呼び出されます。ファイルコピーのような、テーマへの直接の操作をおこなうことができます。

sub finalize {
    my $app = shift;
    my ( $blog, $theme_hash, $tmpdir, $setting ) = @_;
    my $success = 0;
    ## some work for $tmpdir
    return $success ? 1 : 0;
}

condition

テーマをエクスポートするウェブサイトあるいはブログで、エクスポートハンドラが利用可能かどうかを判定するサブルーチンを指定します。たとえば、カテゴリが存在しないブログでは、カテゴリのエクスポートオプションを表示しないように判定します。

sub condition {
    my ( $blog ) = @_;
    # show export option if blog has at least one template.
    my $tmpl = MT->model('template')->load(
        { blog_id => $blog->id },
        { limit => 1 },
    );
    return defined $tmpl ? 1 : 0;
}