省略名と Tab キーを使用したコードテンプレートの展開

「オプション」ダイアログの「コードテンプレート」タブをもう一度見てみましょう。最下部にある「テンプレートを展開」ドロップダウンフィールドでキーの組み合わせを選択します。これは、コードテンプレートの省略名を入力したあとに押すことによってコードテンプレートを展開するキーの組み合わせです。デフォルトでは Tab キーが選択されていますが、代わりにほかの組み合わせも選択できます。

この節ではこれ以降、「テンプレートを展開」フィールドでデフォルトの Tab キーが選択されていると仮定して説明を進めます。

テンプレートの省略名がコード補完のキーワードの一部でもあるときに、省略名を展開することが難しい場合があります。このような場合、コード補完を使用してテンプレートを挿入するほうが簡単です。

省略名と Tab キーを使用して新規クラスコードテンプレートを展開する

1. 空の PHP ファイルを作成します。
2. そのファイルの PHP ブロックで、「cls」と入力して Tab キーを押します。cls コードテンプレートが展開されます。

   注意: 省略名のスペルを間違えないようにしてください。省略名のスペルが間違っていると展開は機能しません。

   
3. プレースホルダのクラス名 (class_name) が自動的に選択されます。クラスに付ける名前をその場で入力でき、入力した名前によってプレースホルダが上書きされます。名前の入力を終えて Enter キーを押すと、最初の関数 (この場合はコンストラクタ) の名前が IDE で選択されます。

   注: プレースホルダ名については「プレースホルダ名」の節で詳しく説明します。

   
4. 関数名を編集するか、またはデフォルトの名前をそのまま使用します。もう一度 Enter キーを押すと、カーソルが関数本体の内部に移動します。実際の開発時には、ここで関数およびクラスの残り部分のコーディングを開始します。

   カーソルの最終位置は ${cursor} パラメータによって決定されます。このパラメータについては「予約名」の節で説明します。

コード補完によるコードテンプレートの挿入

コード補完を使用してコードテンプレートを挿入するには、テンプレートの省略名ではなく、展開されるスニペットの先頭部分を入力します。コード補完ダイアログが開き、スニペットが表示されます。

コード補完を使用して新規クラスコードテンプレートを挿入する

1. PHP ファイルの PHP ブロックで、「cla」と入力します。
2. コード補完ダイアログが表示されるまで待ちます。
3. 省略名 (cls) とともに一覧表示される新規クラステンプレートを探します。PHPDoc フレームには展開されたテンプレートが表示されます。
   
4. 新規クラステンプレートをクリックします。IDE で、そのテンプレートがコードに挿入されます。
5. プレースホルダのクラス名 (class_name) が自動的に選択されます。クラスに付ける名前をその場で入力でき、入力した名前によってプレースホルダが上書きされます。名前の入力を終えて Enter キーを押すと、最初の関数 (この場合はコンストラクタ) の名前が IDE で選択されます。
   
6. 関数名を編集するか、またはデフォルトの名前をそのまま使用します。もう一度 Enter キーを押すと、カーソルが関数本体の内部に移動します。実際の開発時には、ここで関数およびクラスの残り部分のコーディングを開始します。

テンプレートでコードを囲む

次の PHP テンプレートでコードを囲むことができます。

• while
• do
  
• switch
• if / elseif
• try と catch
• foreach
• for
• ob_start と ob_end_clean

テンプレートでコードを囲むには、コードを選択して「囲む...」ダイアログを開きます。「囲む...」ダイアログを開くには、Alt-Insert キーを押すか、またはヒント アイコンをクリックします。

if(true) テンプレートでコードを囲む

1. 変数 $a = true および $b = 10 を含む PHP ブロックを作成します。

   <?php
   $a = false;
           
   $b = 10;
   ?>

2. 「$b = 10;」行を選択します。
   /li>
3. ヒント アイコンをダブルクリックするか、または Alt-Enter キーを押します。「囲む...」ダイアログが開きます。
   
4. 「囲む if(true){...」をクリックします。
   
5. IDE で、「$b = 10;」行が「if(true){...」テンプレートで囲まれます。
   

IDE では自動的に、出現済みでもっとも近い位置にある適切な変数が if 文の条件として挿入されます。$a はブール型であり、if(true){} 文はその条件としてブール型の変数をパラメータに取るので、この場合は $a 変数が挿入されます。また、IDE で条件に挿入された変数が正しい変数でない場合、その条件が自動的に編集のために選択されます。つまり、テンプレートの挿入後ただちに、正しい変数の入力を開始できます。この場合、コード補完が正しい変数の選択に役立つことがあります。

注:if(true){} テンプレートについては、「ヒントによって定義されるパラメータ」の節で詳しく説明します。

Enter キーを押して文の条件を終了します。カーソルが適切な位置 (この場合は「$b = 10;」行の末尾) に移動します。条件を編集して Enter キーを押すか、または自動挿入された条件を受け入れて Enter キーを押すことができます。どちらの場合でも、カーソルは条件ブロックから適切な位置に移動します。

次の節では、展開されたテンプレート内のパラメータの編集について詳しく説明します。

展開されたテンプレート内のパラメータの編集

コードへのテンプレートの挿入に関する節では、新規クラステンプレートの展開時に IDE でクラス名が編集のために自動選択されることと、if(true) テンプレートの展開時に IDE で条件名が編集のために自動選択されることを示しました。この節では、展開されたテンプレート内のパラメータの編集を補助する IDE の機能について説明します。

パラメータの複数のインスタンスを同時に編集する

1. 空の PHP ブロックで「for」と入力し、Ctrl-スペースを押してコード補完を開きます。繰り返し処理テンプレート (省略名 iter) を選択してクリックします。新しい繰り返し処理がコードに挿入されます。
   
2. 繰り返し処理には、パラメータとして $index および $array の 2 つの変数があります。$index が編集のために自動的に選択されます。
   

   「i」と入力します。$index の 3 つのインスタンスがすべて $i に変化します。

   
3. Enter キーを押します。パラメータ $array が選択されます。
4. もう一度 Enter キーを押します。カーソルが繰り返し処理のメソッド本体に移動します。

NetBeans の変数名リファクタリング機能では、変数の 1 つのインスタンスを編集することにより、その変数のすべてのインスタンスを変更できます。この機能がテンプレートのパラメータに適用されると役に立つことがわかります。

NetBeans IDE の PHP エディタは、変数に対する正しいメソッドの識別も補助します。

テンプレート内の変数を正しいメソッドと関連付ける

1. 空の PHP ブロックで、次のコードを入力します。

   <?php
   
   $arr = array(new ArrayIterator($array()), new ArrayObject($array()));
   
   ?>

2. $arr 配列を宣言する行のあとに「fore」と入力し、コード補完を使用して foreach テンプレート (省略名 fore) を挿入します。
   
3. (Enter キーを 2 回押して)foreach 関数の本体にカーソルを移動し、「$value」と入力するか、または「$」とだけ入力してコード補完から「$value」を選択します。

   <?php
   
   $arr = array(new ArrayIterator($array()), new ArrayObject($array()));
   
   foreach ($arr as $value) {
       $value
   }
   
   ?>

4. 「$value」に続けて「->」と入力します。コード補完により、配列 $arr から派生した $value 変数に対する適切なメソッドが提示されます。
   

プレースホルダ名

もっとも単純なケースでは、コードテンプレートパラメータは任意のプレースホルダ値です。テンプレートが展開されると、IDE でこのプレースホルダ名が編集のために選択されます。

たとえば、このチュートリアルの「定義済み PHP テンプレート」および「省略名と Tab キーを使用したコードテンプレートの展開」の各節で示した新規クラステンプレート (cls) を考えます。新規クラステンプレートの展開されたテキストは「class ${className}」で始まります。ここで、単語 class は PHP コードであり、${className} はパラメータです。このパラメータは単に、クラスの名前の任意のプレースホルダ値です。IDE でテンプレートが展開されると、${className} は class_name になります。IDE は class_name を単なるプレースホルダ値と認識し、編集のためにこの値を自動的に選択します。

予約名

IDE では、処理指示として使用される 2 つのパラメータ名が予約されています。

• ${cursor} は、展開されたテンプレート内で自動選択されたすべての値の編集を完了したあとのカーソルの位置を定義します。
• ${selection} は、エディタの選択内容をペーストする位置を定義します。これは、ユーザーがエディタでテキストを選択するたびにヒントとして表示される「選択テンプレート」によって使用されます。テンプレートに ${selection} が含まれる場合、それは通常、${cursor} と同じ位置を参照します。

たとえば、このチュートリアルの「定義済み PHP テンプレート」および「省略名と Tab キーを使用したコードテンプレートの展開」の各節で示した新規クラステンプレート (cls) をもう一度考えます。このテンプレートには ${ClassName} および $__construct の 2 つのパラメータが含まれます。関数本体には ${cursor} および ${selection} の各パラメータがあります。

class ${ClassName} {

    function ${__construct} {
        ${selection}${cursor}

    }

}

テンプレートが展開されたあとに、プレースホルダ class_name が自動的に選択されます (1)。Enter キーを押すと、プレースホルダ __construct が自動的に選択されます (2)。ほかに編集する値はありません。もう一度 Enter キーを押すと、テンプレートのテキストで ${cursor} によって指示される位置にカーソルが移動します (3)。

ヒントによって定義されるパラメータ

パラメータは、すべて大文字の任意の記述名と 1 つ以上のヒントで構成できます。

${PARAMETER_NAME hint1[=value] [hint2...hint n]}

名前はコード内のどこにも出現しません。ただしこの名前は、コードテンプレート内でパラメータを 2 回以上使用する場合に役立ちます。パラメータは初回のみ定義する必要があり、2 回目以降は名前によってそのパラメータを参照できます。たとえば次のコードテンプレートで、パラメータ ${CONLINK} は最初に一度だけ定義され、以後の 2 回はその名前によって参照されます。

$$${CONLINK newVarName default="link"} = mysql_connect('localhost', 'mysql_user', 'mysql_password');  
if (!$$${CONLINK}) {
      die('Could not connect: ' . mysql_error());  
}  
echo 'Connected successfully';  
mysql_close($$${CONLINK});  
${cursor}  

ヒントは、IDE でコードテンプレートが展開されるときにテンプレートパラメータの値を計算するために参照されます。たとえば、このチュートリアルの「コードをテンプレートで囲む」の節で使用される if(true) テンプレートを見てみましょう。このテンプレートの展開されたテキストは次のとおりです。

if (${CONDITION variableFromPreviousAssignment instanceof="boolean" default="true"}) {
    ${selection}${cursor}
}

パラメータ ${CONDITION variableFromPreviousAssignment instanceof="boolean" default="true"} に注目してください。このパラメータは if 文の条件を設定します。したがって、パラメータの名前は CONDITION です。最初のヒントは variableFromPreviousAssignment で、2 番目のヒントは instanceof="boolean" です。これら 2 つのヒントを組み合わせて、コード内で割り当て済みであり、コードテンプレートよりも前のもっとも近い位置にあるブール型の値を探すよう IDE に指示します。3 番目のヒント default="true" を追加して、「先に出現する最も近いブール型変数の値が true の場合」という条件をパラメータで設定します。

たとえば、次のコードスニペットの「$b = 10」の行を if(true) コードテンプレートで囲みます。

IDE では、これよりも前のもっとも近い位置で割り当てられたブール型変数として $a が検出され、$a[=true] という条件で if 文が生成されます。条件が編集のために自動的に選択されるので、PHP プログラマは $a を別の変数または !$a に変更できます。

${date?date?string("yyyy")}