プラグインの作り方を調べる-001

「実践マスターPHP+MySQL - PHP4/PHP5対応」という本を読んで少しPHPを勉強した上で、Nucleusプラグインを書いてみます。
プラグインは、PHPで言うところの Class を用いて機能を提供するみたいです。

--------------------

引用元 : プラグイン API 「はじめてプラグインを書いてみる」

解読の為の参照 : Nucleusプラグインメソッド リファレンス

--------------------

<?php

// プラグイン変数として使われる名前は、
// class の後に続く NP_HelloWorld から NP_ を除いた文字。
// この例では HellowWorld が <%HellowWorld%> として使われる。

class NP_HelloWorld extends NucleusPlugin
{

// 以下、管理画面「プラグインの管理」で表記される内容

    // プラグインの名前
    function getName()
    {
        return 'Hello World';
    }

    // プラグインの作者
    function getAuthor()
    {
        return 'Wouter Demuynck';
    }

    // プラグインのサイトURL
    // mailto:foo@bar.com の形式も可
    function getURL()
    {
        return 'http://nucleuscms.org/';
    }

    // プラグインのバージョン
    function getVersion()
    {
        return '1.0';
    }

    // 説明文
    function getDescription()
    {
        return 'Just a sample plugin.';
    }

// 以下、おまじない。

    function supportsFeature ($what)
    {
        switch ($what)
        {
            case 'SqlTablePrefix':
                return 1;
            default:
                return 0;
        }
    }

// 以下、スキン上に書いた変数から呼び出される処理

    function doSkinVar($skinType)
    {
    // 「Hellow World!」と出力
        echo 'Hello World!';
    }
}
?>

このプラグインは、スキンに<%HelloWorld%>と入力した場所に「Hello World!」という文字を表示します。

        echo 'Hello World!';

        echo 'Nucleusのプラグインを書いてみる';

と変えると、スキンに<%HelloWorld%>と入力した場所に「Nucleusのプラグインを書いてみる」という文字を表示します。

以上から判ったのは、「 function doSkinVar () に書いたコードが、プラグインとしての機能を提供する」事でした。

--------------------

ちなみに、

    function doSkinVar($skinType , $param1)

とパラメータ「$param1」をひとつ増やして、

        echo "Nucleusの$param1プラグインを書いてみる";

と、ダブルクォーテーションに包んだ文の中に「$param1」を加えます。

すると、スキン上で<%HelloWorld(おもしろい)%>と入力する事で、「Nucleusのおもしろいプラグインを書いてみる」という文字を表示できます。

2008年09月25日:J_プラグインの作り方::ephemera