サクラエディタでphpを扱うときの設定もろもろまとめ

たくさんコードが読めるようになっきてエディタ強化したのでまとめました。


既にサクラエディタphpのまとめはありますが、
http://miau.s9.xrea.com/blog/?itemid=809
まだまだ最適な環境とはいえません。カラーとか特に。

もっと使いやすくしましょう。というわけでもろもろのまとめ。これから始めようって人には親切だけれども、それ以外の人にはくどいので流し読みしにくいかも。

もっとこうした方がいいよって方いましたら、教えていただければと思います。

サクラエディタをダウンロード

公式サイトよりも、
http://sakura.qp.land.to/
新バージョンを確認してダウンロード。よくわからない人はANSI版で。


それからサクラ周りのモジュールをもっさり更新確認できるツールもダウンロード。
サクラエディタのフォルダにつっこみましょう。必ずやってください。
http://0xc000013a.blog96.fc2.com/blog-entry-104.html


使い方はなんとなくわかると思う。

vistaだと問題があるらしく、引用させていただきます。

Vista では SakuraDown が外部の解凍ソフトを利用しないようになっているため、.zip 以外(.lha と .tar.bz2)の解凍が行われません。 ダウンロードは行えていますので、C:\sakura\archive 以下のファイルを自分で解凍→sakura.exe と同階層にコピーする必要があります。


・bron142.lzh 内の bregonig.dll
・cmigemo-1.2-dll.tar.bz2 内の migemo.dll および dict フォルダ
・ppa_124.lzh 内の Ppa.dll

http://miau.s9.xrea.com/blog/?itemid=809

phpのマニュアルをダウンロード

ウェブでみれば良いという人はスルー。インストール結構めんどくさい。

詳しいことは、
http://blog.plastik.jp/archives/15
で説明してくれています。ただこれやっても文字化けするとこはする。
そこはいろいろ直さなきゃいけないみたいで面倒。


めどくさいことをしたくないという人は、
http://another.rocomotion.jp/12427357713320.html
で文字化け部分を直してご親切に配布してくれています。2009/04/17当時のものなので、少し古いですがあまり関係ないですよ。こっちの方がだいぶ時間省けます。感謝感謝。


マニュアルはサクラエディタがあるC:\Program Files\sakuraの階層に入れておきましょう。別の場所にインストールしている場合はそちらに。名前はphp_manual_ja.chmであると、導入時の説明がわかりやすいです。

今回行う主な設定

phpヘルプファイルを設定
・強調キーワードを設定
・入力補完機能のための設定


phpヘルプファイルは、テキスト上に書かれている関数をドラッグすると、ポップアップで引数や使用方法が表示される機能。マニュアルを開く手間が省けます。

強調キーワードは定数や関数、制御構造のキーワードに色をつけて、ソースコードを見やすくできるようになります。

入力補完機能もこの強調キーワードを元に設定します。入力補完とは「a」と打てば「ctrl+space」で先頭がaに関するキーワードの候補を一覧として表示してくれる機能です。便利ですのでぜひ導入しましょう。

ファイルをダウンロード

強調キーワードがまとめられたファイルをダウンロード。そのファイルに記述されているキーワードをもとに強調させたり補完したりするわけですから、これがないと始まりません。


いろいろさがしてみた結果、
http://www.sharkpp.net/junk/sakura-editor/php-keyword.html
のページが一番良いです。このページでDOWNLOADのリンクをクリック。解凍すると、

  • php-mkkwd.php...以下のファイルを自動で作成できるphpスクリプト
  • php-readme.txt...説明書で自動生成されたものではない
  • php.khp...キーワードヘルプ。自動生成されたもの
  • php.kwd...強調キーワードファイル。自動生成
  • php2.kwd...強調キーワードファイル2。「予約語」というキーワードを集めたもの。自動生成

がそろっているはずです。ちょっと使いやすくするために、あれこれいじります。最新の情報が欲しい人はご自分でスクリプトを実行して取得してください。

私で見比べたところ(2009/08/23現在)、特に実行するまでもないとは思います。

php.khp導入

php.khpはキーワードヘルプのファイル。開いてみたらどういうものかわかると思いますが、これを

C:\Program Files\sakura\keyword

の階層に入れてください。このファイルはこれでおっけ。関数をドラッグするとポップアップで簡易ヘルプが確認できるようになります。「これの引数って何だっけ?」というときに重宝します。

こんな感じ。

php.kwdの編集

次は強調キーワードのファイルを編集。これを設定すると、キーワードに色をつけることができてソースコードが見やすくなります。3つありますのでご注意を。では1つ目。

php.kwdファイルは主に関数のキーワードが保存されているファイルです。


1.php.kwdのファイル名をphp1.kwdに変更

2.サクラエディタでそのphp1.kwdを開いて、abstractからunsetまで削除。そして、

//php1 キーワード定義ファイル 関数など
include
include_once
require
require_once

を一番上につけてたして保存。以下のよう感じになります。

//php1 キーワード定義ファイル 関数など
include
include_once
require
require_once
apc_add
apc_cache_info
apc_clear_cache
.
.
.

次。

php2.kwdの編集

2つ目。php2.kwdは主に予約語と呼ばれるキーワードが保存されているファイルです。


1.一番上の行にわかりやすくするために、

//php2 キーワード定義 予約語

と記入。

2.php2.kwdの最後の行を適当に改行して、以下をコピーし貼り付けて保存

//マジカル定数
__CLASS__
__DIR__
__FILE__
__FUNCTION__
__METHOD__
__NAMESPACE__
__CLASS__
__DIR__
__FILE__
__FUNCTION__
__METHOD__
__NAMESPACE__

余談ですが、マジカル定数はどう扱おうか迷いました。よくわからんので、予約語だからこっちにするかという結論に。予約語によってはissetやunsetは関数に入れていたりします。言語構造なのかどうなのかは重要でしょうが、見た目の問題なので定義通りはよくないかなと。

マジかル定数について良い案があれば教えてください。

php3.kwdを作成し編集

3つ目。php3.kwdというファイルを新規作成して利用します。ここには制御構造、クラス関連のキーワードが保存されることになります。


1.php3.kwdというファイルを新規作成し開く

2.以下をコピーして貼り付けて保存

//php3 キーワード定義 制御構造、クラス関連など
abstract
and
as
break
case
catch
class
clone
const
continue
declare
default
do
else
elseif
enddeclare
endfor
endforeach
endif
endswitch
endwhile
extends
final
for
foreach
function
global
goto
if
implements
interface
instanceof
namespace
new
or
private
protected
public
return
static
switch
throw
try
use
var
while
xor


//定義済のクラス
Directory
stdClass
__PHP_Incomplete_Class
exception
php_user_filter
self
parent

この辺のさじ加減はちょっと私には分かりませせん。とりあえずクラス関連と制御構造は一緒にしていますが。定義済みのクラスについては使ったことがないのでわからないです。selfとparentはここにあっても違和感はないとは思うんだけど。

もう少し良い案があれば教えてください。

入力補完機能用ファイル作成

今度は入力補完用のファイルを作ります。


1.php_hokan.kwdというファイルを新規作成し開く

2.php1.kwdを開き、「ctrl+A」で全部選択しコピーしてphp_hokan.kwdに貼り付け

3.php2.kwdも同じく全選択しphp_hokan.kwdに貼り付け

4.php3.kwdも同じく全選択しphp_hokan.kwdに貼り付け

5.上書き保存して終り


全てのキーワードを1つにまとめたことになります。

サクラエディタの設定

これまで作成したファイルやマニュアルをサクラエディタで使えるように設定してきます。
混乱するかもしれませんが、がんばってください。


まず作成した4つのファイル、php1.kwd、php2.kwd、php3.kwd、php_hokan.kwdを以下のフォルダ移動。

C:\Program Files\sakura\keyword

任意の場所にサクラエディタをインストールしている人も\sakura\keyword以下に移動させましょう。


次に、

1.サクラエディタのメニューバーから、設定>タイプ別一覧設定をクリック

2.設定17か設定18か、とにかく「設定○○」という新規の設定部分を選んで「設定変更」をクリック

3.スクリーンタブにて、

  • 設定の名前:PHP
  • ファイル拡張子:php,inc

と記入。

4.次に支援タブにて、

  • 入力補完機能の「単語ファイル」からさっき移動させたphp_hokan.kwdを選択
  • 「英大文字小文字を同一視する」、にチェック

ついでに支援タブ下にある、

  • 外部HTMLヘルプの設定で、phpマニュアルのphp_manual_ja.chmを選択
  • 「ビューアを複数起動しない」、にチェック

とします。

5.正規表現キーワードタブにて、

  • 正規表現キーワードを使用する、にチェック

このタブはこれだけです。後でまた設定しますので次にいきます。

6.キーワードヘルプタブにて、

  • キーワードヘルプ機能を使う、にチェック
  • 辞書ファイルの欄で、php.khpを選択し、「挿入」をクリック

これでOKを押してください。


入力補完機能と、キーワードヘルプ機能、それからマニュアルを閲覧できる機能がつきました。

使い方は、

・入力補完機能は「ctrl+space」で候補が出てきます。隣の説明はキーワードヘルプ機能です。


・最初の方でも説明しましたが、キーワードヘルプ機能はキーワードをドラッグしても利用できます。


・マニュアルはF1を押すだけ。


ショートカットキーは補完とマニュアルだけでも覚えておきましょう。重宝します。

カラー設定

今度はカラー設定を行います。色づけした私のソースコードは、


こんな感じ。フォントは、M+2VM+IPAG circleを使っています。フォントサイズが10で太字にはしません。

MSゴシックでもそれなりにきれいにはみえますが、緑が若干鬱陶しいかなというところ。太字にしても同じですね。なるべく1画面に多くの行を映したいので、フォントサイズは小さめかもしれないです。

カラーは個人のお好みとなりますので、ある程度カスタマイズしやすいようにと思いphp1.kwd、php2.kwd、php3.kwdにわけてあります。今回は私のカラーを設定してもらいますが、気に入らなかったらあれこれ変えましょう。

利用するファイルはまとめると以下の通り。

  • php1.kwd...強調キーワード1。関数系のものが入っています
  • php2.kwd...強調キーワード2。予約語が入っています
  • php3.kwd...強調キーワード3。制御構造、クラス関連が入っています

これでありきたりなカラー設定は簡単にできるようになっています。それでは作業に入っていきましょう。

キーワードをインポート

まずサクラエディタにそれぞれのキーワードをインポートします。


1.設定>共通設定>、をクリック

2.強調キーワードタブにて、

  • セット追加→「PHP1」を作成し、インポートを押してphp1.kwdを選択
  • セット追加→「PHP2」を作成し、インポートを押してphp2.kwdを選択
  • セット追加→「PHP3」を作成し、インポートを押してphp3.kwdを選択

してください。これで強調キーワードがサクラエディタに入りました。
次に共通設定の画面を消してカラー設定をします。


1.C:\Program Files\sakura\keyword以下に、php.colファイルを新規作成し、以下をコピーして貼り付けて保存

// テキストエディタ色設定 Ver3

[SakuraColor]
C[BRC]=1,1,000000,c8c8ff,0
C[CAR]=1,0,000000,f0fbff,0
C[CMT]=1,0,797979,e3f2f2,0
C[CTL]=1,0,00ffff,e3f2f2,0
C[CVL]=0,0,ff8080,f0fbff,0
C[DFA]=1,0,ffff80,ff8000,0
C[DFC]=1,0,ceffff,4080ff,0
C[DFD]=1,0,ffffff,c0c0c0,0
C[EOF]=1,0,1d17fd,e3f2f2,0
C[EOL]=1,0,4bb6a6,e3f2f2,0
C[FND]=1,0,000000,b9b9ff,0
C[IME]=1,0,2f2fd0,f0fbff,0
C[KW1]=1,0,e44151,e3f2f2,0
C[KW2]=1,0,e658ed,e3f2f2,0
C[KW3]=1,0,302bee,e3f2f2,0
C[KW4]=1,0,e4251b,e3f2f2,0
C[KW5]=0,0,0080ff,e3f2f2,0
C[KW6]=0,0,0080ff,e3f2f2,0
C[KW7]=0,0,0080ff,e3f2f2,0
C[KW8]=0,0,0080ff,e3f2f2,0
C[KW9]=0,0,0080ff,e3f2f2,0
C[KWA]=0,0,0080ff,e3f2f2,0
C[LNO]=1,0,000000,536a71,0
C[MOD]=1,1,ffffff,a8a8a8,0
C[MRK]=0,1,808040,e3f2f2,0
C[NUM]=0,0,0000eb,e3f2f2,0
C[RAP]=1,0,c1c0e0,e3f2f2,0
C[RK1]=1,0,0000ff,e3f2f2,0
C[RK2]=1,0,29b445,e3f2f2,0
C[RK3]=1,0,000000,e3f2f2,0
C[RK4]=1,0,ff0000,434189,0
C[RK5]=0,0,ff0000,e3f2f2,0
C[RK6]=0,0,ff0000,e3f2f2,0
C[RK7]=0,0,ff0000,e3f2f2,0
C[RK8]=0,0,ff0000,e3f2f2,0
C[RK9]=0,0,ff0000,e3f2f2,0
C[RKA]=0,0,ff0000,e3f2f2,0
C[RUL]=1,0,000000,e3f2f2,0
C[SPC]=0,0,c0c0c0,e3f2f2,0
C[SQT]=1,0,6f6fbf,e3f2f2,0
C[TAB]=1,0,d1d1d1,e3f2f2,0
C[TXT]=1,0,000000,e3f2f2,0
C[UND]=1,0,d6d6a3,e3f2f2,0
C[URL]=1,0,ff0000,e3f2f2,1
C[VER]=0,0,c0c0c0,f0fbff,0
C[WQT]=1,0,6f6fbf,e3f2f2,0
C[ZEN]=1,0,d7d7d7,e3f2f2,0

2.設定>タイプ別設定一覧、からPHPを選択肢し設定変更をクリック

3.カラータブにてインポートをクリックし、php.colを選択

4.カラータブ右側上で、

  • 強調キーワード1をPHP1に設定
  • 下にある強調キーワード2〜10ボタンをクリック
  • 2と3にそれぞれPHP2、PHP3を選択してOKボタンをクリック

とします。

5.ついでに、その下のコメントスタイルで、

  • ブロック型(F)の部分を /* 〜 */
  • 行型(M)は、//
  • 行型(E)は、#

とします。

6.C:\Program Files\sakura\keyword以下に、php.rkwというファイルを新規作成し、以下をコピーして貼り付け

// 正規表現キーワード Ver1
RxKey[000]=RK1,/<\?(php)?/k
RxKey[001]=RK1,/\?>/k
RxKey[002]=RK2,/\$\w+/k

7.正規表現キーワードタブにて、php.rkwファイルをインポートしてOKボタンをクリック


以上でカラー設定は終りです。正規表現キーワードとは、という文字列と、変数の色を設定するために登録してあります。


カラーを変えたいときは、カラータブにて変更してください。

最初はよくわからないと思いますが、主な部分は強調キーワード1、2、3と、正規表現キーワード2になります。強調キーワード1が関数。強調キーワード2が予約語。強調キーワード3が制御構造、クラス関連。そして正規表現キーワード2が変数の色、となります。


これでだいぶ使いやすくなったはず。試しにいろいろソースコードのぞいてみてください。


以下よりはPHPの中・上級者向けの設定。大量のコードみたり書いたりする人や、フレームワークを利用する人は設定しておきましょう。

中・上級者向け

関数や、フレームワークを扱うときに便利な設定。

ルールファイルを設定

たくさん関数を扱うときに便利。
http://it.kndb.jp/entry/show/id/161

アウトライン解析で関数を一覧で見ることができます。ショートカットはF11。

タグファイル作成

タグファイル作れます。他人のソースコードみたり、フレームワークみるときなんか便利。


1.ctags.cnfというファイルをサクラエディタのフォルダに作成。

2.作成したら下記の文字を記述して保存。

--langmap=PHP:.php.inc
--php-types=c+f+d+v

3.使い方
そのタグファイルを作成したいphpファイルで、「検索>タグファイルの作成」をクリックしたら作成できる。利用法はキーワードにカーソルを合わせてF12。

Sakura PEを導入

perljavaを扱っている人にも使えるツール。
http://satolab.tiu.ac.jp/TiuDevToolsHome/SakuraPE/

面倒なので私は入れていませんが、見た感じでは便利そうという印象。

余談

キーワードの単語登録数でいえば、おそらく
http://memorva.jp/memo/windows/sakura_php_kwd_khp.php
の方のファイルが一番多いと思います。コレクターな人はこちらのファイルを使うといいでしょう。ただヘルプは結構抜けが多い気がしました。