Pictnotes メインイメージ

お仕事メモ

basderCMSのpluginを作ってみる その1

basderCMSのプラグインの作り方メモ(作りながら書いてるので、最後の記事ができるまで改訂が入ります)



とりあえず、現在あるプラグインを覗いて中身を確認するのがはやいけど、とりあえずのHotwo

1)サーバ上の、app/plugins(baser/pluginsと間違わないこと) フォルダに作成したいプラグイン名のフォルダを作成する。

ここでは、PostgreSQLのINDEX管理ページを作りたいので postgresql_index というフォルダ名にする
ちなみにこの段階で、管理画面から、 > プラグイン管理 > プラグイン一覧
を覗いてみると、作成したフォルダ名がリストにでてくる。

とりあえず、こんな感じに表示されるはず。
プラグイン説明その1
 

2) 必要なディレクトリを作成

とりあえず、いろいろ置いておいて必要なディレクトリとファイル(空ファイル)を作成します。
(D)がdirectory (F)がfileです。 -> まだ未完成です。

postgresql_index(D)
├ config (D)
│ ├ bootstrap.php
│ ├ config.php
│ ├ csv (D)
│ │ └ postgresql_index
│ ├init.php
│ └ sql (D)
│    └ postgresql_index.csv
│    └ postgresql_index.php

├ controllers (D)
│ └ postgresql_index_controller.php

├ models (D)
│ └ postgresql_index.php

├ vendors (D)
│ ├ css (D)
│ │ └ postgresql_index.css
│ └ js (D)
│    └ postgresql_index.js

├ VERSION.txt

└ views (D)
  ├ bootstrap.php
  ├ config.php
  ├ helpers (D)
  │ └ postgresql_index_baser.php
  └ postgresql_index (D)
     └ admin
       └ postgresql_index.php


3)プラグインの説明や開発者を登録しよう。

リストにはプラグイン名(フォルダ名)しかでてないと思うので、その他の情報
「バージョン    説明    開発者    登録日 更新日」なんかを表示出来る様にしよう。
config/config.phpファイルに
<?php
/**
 * PostgreSQL INDEX設定プラグイン
 */
$title = 'PostgreSQL Index';
$description = 'DatabaseにPostgreSQLをしている場合推奨するindexを張ることができます。';
$author = 'itm_kiyo';
$url = 'http://www.pictnotes.jp';
$adminLink = array('admin' => true, 'plugin' => 'postgresql_index', 'controller' => 'postgresql_index', 'action' => 'index');
//$adminLink = '/admin/postgresql_index/postgresql_index/index'; と指定するのと一緒です。
$installMessage = 'ここに文章を記載しておくと、INSTALL時にここの文章を出力できます。';
?>
と記載してアップロードで、管理画面上で「説明    開発者」が表示されるようになります。

次に、
VERSION.txt ファイルに
1行目に 0.9.0 と書いてアップロードするとバージョン情報が入ってきます。ファイルには、あわせてリリースノートも
書いておくと良いでしょう。

0.9.0

///////////////////////////////////////////////////////////////////////////////////////////////////////////
// +---------------------------------------------------------------------------------------------------+ //
// + Release Notes
// +---------------------------------------------------------------------------------------------------+ //
///////////////////////////////////////////////////////////////////////////////////////////////////////////

[2012-08-24] PostgreSQL Index 0.9.0
-リリース

[2012-08-24] PostgreSQL Index 0.9.1
-いきなりバグフィックス


その2に続く

 

baserCMS   2012/08/24   admin