NamingConvention

Top > PluginDev > NamingConvention

名前規約

プラグイン製作者がオリジナルライブラリを作成、配置する際の名前規約を提案してみます。

まず、命名ルールとして、クラス名は DirectoryDirectoryFilename、関数名は directory_directory_filename_関数名、 定数は DIRECTORY_DIRECTORY_FILENAME_定数名、グローバル変数は、$directory_directory_filename_変数名 とする。

例えば、plugin/lsx.inc.php の場合、

class PluginLsx
function plugin_lsx_関数名
define('PLUGIN_LSX_定数名');
global $plguin_lsx_変数名;

個人ライブラリファイルの保存場所には、「plugin/ハンドル/」 ディレクトリを作成、使用するものとする。

例えば、私の場合は plugin/sonots となる。 そして、例えば、plugin/sonots/pagelist.class.php を作成した場合、そのファイル中で使用されるクラス名等は、

class PluginSonotsPagelist
function plugin_sonots_pagelist_関数名
define('PLUGIN_SONOTS_PAGELIST_定数名');
global $plguin_sonots_pagelist_変数名;

となる。

.class.php であるか、.inc.php であるかは、あくまで個人ライブラリなので気にする必要はないと思われるが、 php 的に内部で class を定義する場合は .class.php であることが多いようである。