校正オプション

目次

校正オプションの拡張について

Acms\Custom\Correctorクラス(extension/acms/Corrector.php)にメソッドを定義することで、校正オプションの拡張が可能です。Acms\Custom\Correctorクラスが記述される、extension/acms/Corrector.phpは、アップデート時の上書き対象ではないので、自由に拡張してご利用いただけます。

テンプレート上の校正オプション指定との対応

<!-- {var}の中は、'a-blog cms' とする -->
<body>
{var}[sample('hoge', 'fuga')]
</body>

テンプレート上に記述する校正オプション名と、Acms\Custom\Corrector 内で拡張するメソッド名を同一にします。テンプレート上から指定するメソッドへの引数は、シングルクオーテーションで囲い、カンマで区切ります。

<?php

namespace Acms\Custom;

/**
 * 校正オプションにユーザー定義のメソッドを追加します。
 * ユーザー定義のメソッドが優先されます。
 */
class Corrector
{
    /**
     * sample
     * 校正オプションのサンプルメソッド
     *
     * @param  string $txt  - 校正オプションが適用されている文字列
     * @param  array  $args - 校正オプションの引数 {var}[sample('ここの値')]
     * @return string       - 校正後の文字列
     */
    public function sample($txt, $args = array())
    {
        // 例 {var}[sample('hoge','fuga')]
        // {var}の中は,'a-blogcms' とする

        $hoge = isset($args[0]) ? $args[0] : null; // 'hoge'
        $fuga = isset($args[1]) ? $args[1] : null; // 'fuga'

        return $hoge.$fuga.'+'.$txt; // 'hogefuga+a-blog cms'
    }
}

校正オプションのメソッドには、校正オプション適用対象の変数(主に文字列)と、テンプレート上で指定された引数が渡されます。

<body>
hogefuga+a-blogcms
</body>

例では、本来の変数 'a-blog cms' と、引数として与えられた文字列 'hoge' , 'fuga' が合成されて、'hogefuga+a-blogcms' という文字列が出力されます。

備考

校正オプションは、各GETモジュール内でテンプレート内の変数を解決する際に、付随する形で実行されます。そのためモジュールが出力してない変数に校正オプションを指定しても実行されません。