Расширение шаблона кода путем ввода аббревиатуры с нажатием клавиши TAB

Снова откройте вкладку "Шаблоны кода" в диалоговом окне "Параметры". В нижней части этого окна расположено раскрывающееся поле для выбора сочетания клавиш для развертывания шаблона. Это сочетание клавиш пользователь нажимает после ввода аббревиатуры шаблона для развертывания шаблона кода. Клавиша TAB выбрана по умолчанию, но вместо нее можно задать другие сочетания клавиш.

Далее в этом разделе предполагается, что в поле "Раскрыть шаблон по" по умолчанию выбрана клавиша TAB.

Если аббревиатура для шаблона также используется в дополнении кода, развернуть ее может быть сложно. В этом случае для вставки шаблона предпочтительно использовать дополнение кода.

Для развертывания шаблона кода нового класса с помощью ввода аббревиатуры с нажатием клавиши TAB выполните следующее:

1. Создайте пустой файл PHP.
2. В блоке PHP для этого файла введите текст cls и нажмите клавишу TAB. Будет развернут шаблон кода cls.

   Внимание! Аббревиатуру необходимо ввести корректно! В случае ошибок при вводе шаблон не будет развернут.

   
3. Имя класса метки-заполнителя (class_name) выбирается автоматически. Можно сразу указать требуемое имя класса, которое будет перезаписано для метки-заполнителя. После завершения ввода нажмите клавишу ВВОД. В среде IDE будет выбрано имя первой функции, которой в данном варианте является конструктор.

   Примечание. Имена меток-заполнителей более подробно рассматриваются в разделе Имя метки-заполнителя.

   
4. Отредактируйте имя функции или примите значение по умолчанию. Затем снова нажмите клавишу ВВОД. Курсор переместится в тело функции. В реальном сценарии после этого начинается кодирование функции и остального класса.

   Итоговое положение курсора определяется параметром ${cursor}. Этот параметр описывается в разделе Зарезервированные имена.

Вставка шаблона кода путем дополнения кода

Для вставки шаблона кода путем дополнения кода введите начало расширенного фрагмента (не сокращение шаблона). Откроется диалоговое окно дополнения кода, в котором будет отображаться фрагмент.

Для вставки шаблона кода нового класса путем дополнения кода выполните следующее:

1. Введите в блоке PHP файла PHP значение cla.
2. Дождитесь открытия диалогового окна дополнения кода.
3. Выполните поиск шаблона нового класса, рядом с которым указана аббревиатура (cls). Развернутый шаблон отображается в рамке PHPDoc.
   
4. Щелкните шаблон нового класса. В среде IDE выполняется его вставка в код.
5. Имя класса метки-заполнителя (class_name) выбирается автоматически. Можно сразу указать требуемое имя класса, которое будет перезаписано для метки-заполнителя. После завершения ввода нажмите клавишу ВВОД. В среде IDE будет выбрано имя первой функции, которой в данном варианте является конструктор.
   
6. Отредактируйте имя функции или примите значение по умолчанию. Затем снова нажмите клавишу ВВОД. Курсор переместится в тело функции. В реальном сценарии после этого начинается кодирование функции и остального класса.

Добавление шаблона вокруг кода

Вокруг кода можно добавить следующие шаблоны PHP:

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

Чтобы добавить шаблон вокруг кода, выберите код и откройте диалоговое окно "Окружение...". Для открытия диалогового окна "Окружение..." используйте сочетание клавиш ALT+INSERT или щелкните значок "Подсказка" .

Для добавления шаблона if(true) вокруг кода выполните следующее:

1. Создайте блок PHP с переменными $a = true и $b = 10.

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

2. Выберите строку $b = 10;.
   /li>
3. Дважды щелкните значок "Подсказка" или нажмите сочетание клавиш ALT+ВВОД. Откроется диалоговое окно "Окружение...".
   
4. Выберите "Окружение с помощью if{true){..."
   
5. В среде IDE строка $b = 10; будет окружена шаблоном if(true){... .
   

В среде IDE в качестве условия оператора if автоматически вставляется ближайшая предшествующая допустимая переменная. В данном варианте используется переменная $a, поскольку $a является логическим значением, а условие оператора if(true){} подразумевает логическую переменную. Более того, если переменная, вставленная в среде IDE в условие, неправильна, это условие автоматически выделяется для редактирования. Это означает, что ввод корректной переменной можно начать сразу после вставки шаблона. В этом случае выбрать переменную можно с помощью дополнения кода.

Примечание. Шаблон if(true){} подробно описан в разделе Параметр, заданный с помощью подсказок.

Для выхода из условия оператора нажмите клавишу ВВОД. Курсор переместится в соответствующее местоположение, в данном случае — в конец строки $b = 10;. Пользователь может отредактировать условие и нажать клавишу ВВОД или принять автоматически подставляемое условие, после чего нажать клавишу ВВОД. В любом случае курсор будет перемещен из условия в соответствующее местоположение.

В следующем разделе редактирование параметров в развернутых шаблонах описано более подробно.

Изменение параметров в развернутых шаблонах

В разделах, посвященных вставке шаблонов в код, в среде IDE автоматически выбиралось имя класса для редактирования после развертывания шаблона нового класса. Также автоматически выбиралось имя условия для редактирования после развертывания шаблона if(true). В данном разделе описаны другие возможности редактирования параметров в среде IDE в развернутых шаблонах.

Одновременное редактирование нескольких экземпляров параметра:

1. В пустом блоке PHP введите for и нажмите сочетание клавиш CTRL+ПРОБЕЛ для открытия дополнения кода. Выберите шаблон итерации (аббревиатура iter) и щелкните его. В код будет вставлена новая итерация.
   
2. В итерации в качестве параметров используются две переменных: $index и $array. Переменная $index выбирается для редактирования автоматически.
   

   Введите i. Все три экземпляра параметра $index изменятся на $i.

   
3. Нажмите клавишу ВВОД. Будет выбран параметр $array.
4. Нажмите клавишу ВВОД еще раз. Курсор переместится в тело метода итерации.

Функция реорганизации имен переменных в NetBeans позволяет изменить все экземпляры имени переменной путем редактирования только одного экземпляра. В данном разделе рассматривается ее использование для параметров шаблона.

Редактор PHP среды IDE NetBeans также позволяет определить корректный метод для переменных.

Привязка переменной в шаблоне к корректному методу:

1. В пустом блоке PHP введите следующий код:

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

2. После строки с объявлением массива $arr введите fore и с помощью дополнения кода вставьте шаблон foreach (аббревиатура: fore).
   
3. Поместите курсор в тело функции foreach (для перемещения курсора можно дважды нажать клавишу ВВОД) и введите значение $value или введите только $ и выберите $value из дополнения кода.

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

4. После $value введите ->. Дополнение кода обеспечивает корректные методы для переменной $value, значение которой можно получить из массива $arr.
   

Имя метки-заполнителя

В самом простом случае параметр шаблона кода является произвольным значением метки-заполнителя. При развертывании шаблона это имя метки-заполнителя выбирается в среде IDE для редактирования.

Например, в шаблоне нового класса (cls), который в данном учебном курсе приводится в качестве примера в разделах Заданные шаблоны кода PHP и Расширение шаблона кода путем ввода аббревиатуры с нажатием клавиши TAB. Развернутый текст шаблона нового класса начинается с class ${className}. В данном случае class — это код PHP, а ${className} — параметр. Этот параметр является произвольным значением метки-заполнителя для имени класса. При развертывании шаблона в среде IDE ${className} преобразуется в class_name. Предполагается, что class_name является только лишь значением метки-заполнителя, и это значение автоматически предлагается для редактирования.

Зарезервированные имена

В среде IDE резервируются два имени параметра, используемые в качестве указаний по обработке.

• ${cursor} определяет местоположение курсора после завершения редактирования всех автоматически выбранных значений в развернутом шаблоне.
• ${selection} определяет положение для вставки содержимого, выбранного редактором. Этот параметр используется так называемыми "шаблонами выбора", которые всегда отображаются в качестве подсказок при выборе текста в редакторе. Если шаблон включает параметр ${selection}, он всегда относится к тому же местоположению, что и ${cursor}.

Например, снова рассмотрим шаблон нового класса (cls), который в данном учебном курсе приводится в качестве примера в разделах Заданные шаблоны кода PHP и Расширение шаблона кода путем ввода аббревиатуры с нажатием клавиши TAB. Он содержит два параметра имени метки-заполнителя: ${ClassName} и $__construct. В теле функции содержатся параметры ${cursor} и ${selection}.

class ${ClassName} {

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

    }

}

После развертывания шаблона параметр метки-заполнителя class_name выбирается автоматически (1). Нажмите клавишу ВВОД, и параметр метки-заполнителя __construct (2) будет выбран автоматически. Другие значения для редактирования отсутствуют. Нажмите клавишу ВВОД еще раз. Курсор переместится в местоположение, определенное параметром ${cursor} в тексте шаблона (3).

Параметр, заданный с помощью подсказок

Параметр может содержать произвольное описательное имя В ВЕРХНЕМ РЕГИСТРЕ и одну или несколько подсказок.

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

Имя не отображается в коде. Однако оно необходимо при многократном использовании параметра в шаблоне кода. В этом случае параметр определяется только один раз, после чего может подставляться по имени. Например, в следующем шаблоне кода параметр ${CONLINK} определяется только один раз, а затем два раза подставляется по имени.

$$${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, а второй - instanceof="boolean". Сочетание этих двух подсказок в среде IDE говорят о необходимости поиска ближайшей логической переменной, которая присвоена в коде, предшествующем шаблону кода. Добавьте третью подсказку default="true", и параметр будет определять условие "если значение ближайшей предшествующей логической переменной верно".

Например, если строка $b = 10 в следующем фрагменте кода окружена шаблоном кода if(true) :

в среде IDE выполняется поиск ближайшей логической переменной, присвоенной ранее, результатом которого является $a, после чего создается оператор if с условием $a[=true]. Условие автоматически выбирается для редактирования, и программист PHP может изменить $a на другую переменную или на !$a.

В следующей таблице перечислены подсказки, используемые в шаблонах кода PHP, с описаниями.

Предварительно определенные параметры

В NetBeans существует ряд предварительно определенных параметров, которые можно использовать при создании шаблонов кода. Кроме того, в диспетчере шаблонов можно определить дополнительные параметры. Обратите внимание на то, что для изменения формата переменной ${date} существуют особые правила.

• ${date}: вставка текущей даты в формате "Feb 16, 2008"
• ${encoding}: вставка кодировки по умолчанию, например UTF-8
• ${name}: вставка имени файла.
• ${nameAndExt}: вставка имени файла вместе с расширением.
• ${package}: вставка имени пакета Java, в котором создан файл. (только для Java)
  
• ${time}: вставка текущего времени в формате "7:37:58 PM"
• ${project.license}: поиск заголовка лицензии по значению (например, "CDDL") и вставка его в шаблон.
• ${project.name}: вставка имени проекта.
• ${project.displayName}: вставка отображаемого имени проекта.

Добавление определений параметров

Дополнительные параметры можно определить в диспетчере шаблонов.

Определение параметра:

1. Выберите в строке меню среды IDE команды "Сервис" > "Шаблоны". Откроется диспетчер шаблонов.
   
2. Разверните категорию "Другой". Дважды нажмите кнопку "Свойства". В редакторе откроется файл User.properties.
3. Определите параметр. Например, задайте параметр ${user} для добавления собственного имени в создаваемые шаблоны. Синтаксис будет выглядеть следующим образом:

   user=LorumIpsum@mycompany.com

   При развертывании шаблона кода все экземпляры ${user} в этом шаблоне будут заменены на "LorumIpsum@mycompany.com".

4. Добавьте все необходимые дополнительные параметры с использованием синтаксиса name=value.

При определении параметров используется язык шаблона Java FreeMarker. Для получения подробных сведений перейдите на вики-страницу NetBeans по FreeMarker.

Форматирование параметра ${date}

Переменная ${date} имеет тип String, а не Date. Для изменения формата ${date} необходимо изменить ее тип на Date. Например, чтобы отображался только год, введите в шаблоне кода:

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

Вариант использования: вставка PHP в HTML

При необходимости частой вставки фрагментов PHP в блок HTML можно создать шаблон кода HTML для вставки кода PHP без ввода <?php ?>.

Следующий шаблон кода используется для вставки в HTML оператора PHP echo.

<?php echo ${cursor}   ?>

Вариант использования: Joomla

Шаблоны кода позволяют использовать в среде IDE NetBeans платформы PHP, в т.ч. без встроенной поддержки. Далее приведен шаблон кода, разработанный для Joomla.

defined('_JEXEC')
   	or die('Restricted access');
${cursor}  

Вариант использования: соединение с MySQL

Разработчикам PHP часто требуется установить соединение с базой данных MySQL. Это можно сделать с помощью шаблона кода. Переменная, присваиваемая соединению с MySQL, содержит имя метки-заполнителя link. Обратите внимание на использование трех знаков доллара $$$. На самом деле это двойной знак, который при развертывании преобразуется в один знак с последующим указанием параметра для имени переменной.

$$${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}  

Вариант использования: действие в контроллере Zend

Вместо использования мастера NetBeans для создания действия для вставки действия в контроллере Zend Framework, например indexController{}, можно использовать шаблон кода.

public function ${functionName}Action () {
      ${selection}${cursor}  
}  

Вариант использования: элемент формы Zend

Этот шаблон используется для вставки элемента в форму Zend. Он применяется после создания формы с помощью команды Zend create form <name>.

$$${ELEMENT newVarName default="element"} = new Zend_Form_Element_Submit('submit', array('label' => 'Send data to server'));  
$$this->addElement($$${ELEMENT});  
${cursor}