Modelos de Código no NetBeans IDE para PHP

Os modelos de código são snippets pré-escritos de código fornecidos pelo NetBeans IDE. Você pode colar um snippet no código utilizando a funcionalidade autocompletar código ou a abreviação do modelo seguida da tecla Tab. Você também pode incluir o código entre snippets apropriados de PHP. Finalmente, você pode definir seus próprios modelos de código. Este tutorial mostra como utilizar os modelos de código e sugere casos úteis para definição de seus próprios modelos de código.

Conteúdo

O conteúdo desta página se aplica ao NetBeans IDE 7.2, 7.3, 7.4 e 8.0

Para concluir este tutorial, você precisa dos seguintes recursos e softwares.

Software ou Recurso Versão Necessária
NetBeans IDE Pacote de download do PHP
JDK (Java Development Kit) 7 ou 8

 

Modelos de Código PHP Definidos

Para exibir os modelos de código definidos no NetBeans, abra Ferramentas > Opções (NetBeans > Preferências no Mac), selecione as funcionalidades do Editor e selecione a guia Modelos de Código. Para ver os modelos de código PHP, selecione PHP na lista drop-down Linguagens. Uma tabela de abreviações e textos expandidos de modelos de códigos será exibida. Se selecionar um modelo de código na tabela, o seu texto expandido será exibido na guia Texto Expandido.

Modelos de código PHP na janela Opções, com o modelo cli selecionado

Nesta imagem, o novo modelo de código classe (cls) está selecionado e na guia Texto Expandido você vê como fica o modelo quando está expandido. Na próxima seção, você usa a função Tab para expandir este modelo no código.

Observação: a sintaxe do novo modelo de código classe (cls) é explorada na seção Sintaxe do Modelo de Código PHP.

Usando Modelos de Código PHP

Há três formas de inserir modelos de código no código PHP. Cada forma de inserção de modelos de código tem sua utilidade, dependendo do caso. As três formas de inserir modelos de código são:

  • Expanda o modelo utilizando a abreviação do modelo seguida da tecla Tab (ou de outra tecla ou de uma combinação de teclas definida por você).
  • Insira o modelo expandido utilizando a função autocompletar código.
  • Inclua o código no modelo utilizando dicas da margem ou Alt-Enter.

Após a inserção do modelo, o IDE ajuda você a editar os parâmetros do código de modelo expandido.

Expandindo o modelo de código usando abreviação + Tab

Examine novamente a guia Modelos de Código da caixa de diálogo Opções. Na parte inferior há um campo drop-down para selecionar a combinação de teclas Expandir Modelo Em. Esta será a combinação de teclas que você pressionará depois de digitar a abreviação do modelo de código para expandir o modelo de código. A tecla Tab está selecionada por default, mas você pode selecionar outras combinações.

Caixa drop-down Expandir Modelo Em

O restante desta seção pressupõe que a tecla Tab esteja selecionada por default no campo Expandir Modelo em:.

Quando a abreviatura de um modelo também fizer parte de uma palavra-chave da funcionalidade autocompletar código, pode ser difícil expandir a abreviação. Neste caso, será mais fácil utilizar autocompletar código para inserir o modelo.

Para expandir o novo modelo de código de classe utilizando sua abreviação + Tab:

  1. Crie um arquivo PHP vazio.
  2. No bloco PHP desse arquivo, digite cls e pressione Tab. O modelo de código cls se expandirá.

    Advertência: digite corretamente a abreviação! A expansão não funcionará, caso a abreviação esteja mal escrita.

    Expandindo um modelo de código
  3. O nome de classe do placeholder (class_name) é selecionado automaticamente. Você pode mover-se entre os placeholders pressionando Tab. Você pode digitar imediatamente o nome desejado para a classe e este nome substitui o placeholder. Pressione Enter quando tiver terminado e o IDE selecionará o nome da primeira função, que neste caso é o construtor.

    Observação: os nomes do placeholder são abordados com mais detalhes na seção Nome do Placeholder.

    Nome da função do construtor selecionado depois do nome da classe editado
  4. Edite o nome da função ou aceite o default. Pressione Enter novamente e o cursor irá para dentro do corpo da função. Em uma situação real, você poderia agora começar a codificar a função e o resto da classe.

    A posição final do cursor é determinada pelo parâmetro ${cursor}. Este parâmetro será descrito na seção Nomes Reservados.

Inserindo o modelo de código com a função autocompletar código

Para inserir um modelo de código utilizando a função autocompletar código, digite o início do snippet expandido (e não a abreviação do modelo). A caixa de diálogo da função autocompletar código será aberta para mostrar o snippet.

Para inserir o novo modelo de código de classe utilizando a função autocompletar código:

  1. Digite cla no bloco PHP de um arquivo PHP.
  2. Espere que a caixa de diálogo da função autocompletar código seja aberta.
  3. Localize o novo modelo de classe, que está listado com a abreviação (cls). O quadro do PHPDoc mostra o modelo expandido.
    Caixa de diálogo da funcionalidade autocompletar mostrando novo modelo de classe
  4. Selecione o novo modelo de classe e pressione Enter. O IDE o insere no código.
  5. O nome de classe do placeholder (class_name) é selecionado automaticamente. Você pode mover-se entre os placeholders pressionando Tab. Você pode digitar imediatamente o nome desejado para a classe e este nome substitui o placeholder. Pressione Enter quando tiver terminado e o IDE selecionará o nome da primeira função, que neste caso é o construtor.
    Nome da função do construtor selecionado depois do nome da classe editado
  6. Edite o nome da função ou aceite o default. Pressione Enter novamente e o cursor irá para dentro do corpo da função. Em uma situação real, você poderia agora começar a codificar a função e o resto da classe.

Incluindo o código em um modelo

Você pode incluir o código nos seguintes modelos de PHP:

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

Além disso, você pode criar um novo modelo que pode circundar o código, se o modelo incluir allowSurround parameter hint. (Dica para o Blog My Beloved PHP.)

Para circundar o código com um modelo, selecione o código e abra a caixa de diálogo Circundar com... Para abrir a caixa de diálogo Circundar com..., pressione Alt-Enter ou clique no ícone Dica Ícone Dica.

Para circundar o código em um modelo if(true):

  1. Crie um bloco PHP com as variáveis $a = true e $b = 10.
    <?php
    $a = false;

    $b = 10;
    ?>
  2. Selecione a linha $b = 10;
    Variável selecionada $b = 10
  3. Clique no ícone Dica Ícone Dica ou pressione Alt-Enter. A caixa de diálogo Circundar com... será aberta.
    Abrir a caixa de diálogo circundar com
  4. Clique em Circundar com if{true){...
    Caixa de diálogo Circundar com if(true) selecionado
  5. O IDE circunda a linha $b = 10; com um modelo if(true){....
    Modelo if (true) inserido

O IDE insere automaticamente a variável apropriada precedente mais próxima como a condição da instrução if. Neste caso, essa variável é $a, porque $a é um booliana e a instrução if(true){}toma uma variável booliana como sua condição. Além disso, a condição é selecionada automaticamente para edição caso a variável que o IDE insira na condição não seja a variável correta. Isso significa que você pode começar a digitar a variável correta imediatamente depois que o modelo tiver sido inserido. A funcionalidade autocompletar código pode ajudar você a selecionar a variável correta neste caso.

Observação: o modelo if(true){} é descrito com detalhes na seção Parâmetro definido por dicas.

Selecionando a variável para usar como uma condição, a partir da funcionalidade autocompletar código

Pressione Enter para sair da condição de instrução. O cursor se desloca para o local apropriado, que neste caso é o fim da linha $b = 10;. Você pode editar a condição e pressionar Enter ou aceitar a condição inserida automaticamente e pressionar Enter. Em qualquer um dos casos, o cursor sai da condição e se desloca para o local apropriado.

Cursor depois da não ediçãoCursor depois da edição

A próxima seção contém mais detalhes sobre a edição de parâmetros nos modelos expandidos.

Editando parâmetros em modelos expandidos

Nas seções sobre inserção de modelos no código, você viu como o IDE selecionou automaticamente o nome da classe para edição quando o novo modelo de classe foi expandido, e como o IDE selecionou automaticamente o nome da condição para edição quando o modelo if(true) foi expandido. Agora veremos mais algumas formas de como o IDE ajuda a editar os parâmetros nos modelos expandidos.

Para editar simultaneamente várias instâncias de um parâmetro:

  1. Em um bloco PHP vazio, digite for e pressione Ctrl-Espaço para abrir a funcionalidade autocompletar código. Selecione o modelo de iteração (abreviação iter) e pressione Enter. Uma nova iteração será inserida no seu código.
    Função autocompletar código que mostra o modelo de iteração selecionado
  2. A iteração tem duas variáveis como parâmetros, $index e $array. $index é selecionada automaticamente para edição. (Pressionando Tab elas são movidas entre os parâmetros.)
    Linha de iteração com parâmetros inserida, como parâmetro $index selecionado para edição

    Digite i. Todas as três instâncias de $index mudam para $i.

    Linha de iteração inserida com o parâmetro $index alterado para $i
  3. Pressione Enter ou Tab. O parâmetro $array é selecionado.
  4. Pressione Enter. O cursor insere o corpo do método da iteração.

A funcionalidade de refatoração do nome da variável no NetBeans permite alterar todas as instâncias de nome da variável editando somente uma instância. Aqui você pode ver como essa funcionalidade é útil quando aplicada nos parâmetros do modelo.

O editor PHP do NetBeans IDE também ajuda a identificar o método correto para as variáveis.

Para associar uma variável de um modelo ao método correto:

  1. Em um bloco PHP vazio, digite o seguinte código:
    <?php

    $arr = array(new ArrayIterator($array()), new ArrayObject($array()));

    ?>
  2. Depois da linha que declara o array $arr, digite fore e use a funcionalidade de autocompletar código para inserir o modelo foreach (abreviação: fore).
    Funcionalidade autocompletar código para inserção do modelo foreach
  3. Coloque o cursor no corpo da função foreach (você pode pressionar Enter duas vezes para tirar o cursor de lá) e digite $value, ou digite somente $ e selecione $value na funcionalidade autocompletar código.
    <?php

    $arr = array(new ArrayIterator($array()), new ArrayObject($array()));

    foreach ($arr as $value) {
    $value
    }

    ?>
  4. Depois de $value, digite ->. A funcionalidade autocompletar código oferece os métodos corretos para a variável $value, que se deriva do array $arr.
    Funcionalidade autocompletar código para a variável $value, onde $value é um método Array Iterator

Sintaxe de Modelo de Código PHP

O NetBeans IDE oferece modelos de código a todas as linguagens que suporta. Algumas das sintaxes são comuns para todas as linguagens. Outra sintaxe é específica para uma linguagem. Nesta seção, você vê a sintaxe de modelo geral mais relevante e a sintaxe específica para modelos PHP.

Um modelo de código PHP pode conter código PHP e parâmetros de modelo. Um modelo PHP pode consistir em somente código PHP, somente parâmetros ou código e parâmetros.

A sintaxe de um parâmetro de modelo de código é um cifrão, $, seguido de uma definição do parâmetro entre chaves {...}. Dentro desta sintaxe, os parâmetros do modelo têm uma destas quatro formas:

As seções a seguir abordam cada uma das formas de um parâmetro de modelo de código.

Observação: $$${VARIABLE...} às vezes, é exibido um modelo de código PHP no qual a sintaxe parece ser três cifrões seguidos das chaves $$${...}. Neste caso, o modelo de código inclui uma variável e seu nome. A sintaxe aqui é um cifrão com escape, escrito como dois cifrões $$, seguido de um parâmetro do nome da variável, ${VARIABLE...}. Por exemplo, o modelo de código catch ${Exception} $$${exc} é expandido como catch Exception $exc.

Nome do placeholder


Nos casos mais simples, o parâmetro de modelo de código é um valor arbitrário de placeholder. Quando o modelo é expandido, o IDE seleciona o nome desse placeholder para edição.


Por exemplo, examine o novo modelo de classe (cls) que este tutorial mostra nas seções Modelos de PHP Definidos e Expandindo o modelo de código usando abreviação + Tab. O texto expandido do novo modelo classe começa com class ${className}. Aqui, a palavra class é o código PHP e ${className} é um parâmetro. Este parâmetro é apenas um valor arbitrário de placeholder para o nome da classe. Quando o IDE expande o modelo, ${className} se transforma em class_name. O IDE espera que class_name seja somente um valor de placeholder e seleciona automaticamente este valor para que seja editado.

Expandindo um modelo de código

Nomes reservados

O IDE reserva dois nomes de parâmetros para serem utilizados como instruções de operação.

  • ${cursor} define o local do cursor depois que você finaliza a edição de todos os valores selecionados automaticamente no modelo expandido.
  • ${selection} define a posição para colar o conteúdo da seleção do editor. É usado pelos chamados "modelos de seleção" que aparecem como dicas sempre que o usuário seleciona texto no editor. Se um modelo incluir ${selection}, ele geralmente fará referência ao mesmo local que ${cursor}.

Por exemplo, novamente examine o novo modelo de classe (cls) que este tutorial mostra nas seções Modelos de PHP Definidos e Expandindo o modelo de código usando abreviação + Tab. Ele contém dois parâmetros de nome do placeholder ${ClassName} e $__construct. No corpo da função, há os parâmetros ${cursor} e ${selection}.

class ${ClassName} {

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

}

}

Depois que o modelo se expandir, o placeholder class_name será automaticamente selecionado (1). Pressione Enter e o placeholder __construct será automaticamente selecionado (2). Não há outros valores a serem editados. Pressione Enter novamente, e o cursor se deslocará para o local indicado pelo ${cursor} no texto do modelo (3).

Três snippets de código que mostram que a posição do cursor muda do nome do placeholder para nome do placeholder para a posição ${cursor}

Parâmetros definidos por dicas


Os parâmetros podem ter um nome arbitrário e descritivo em MAIÚSCULAS e uma ou mais dicas.

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

O nome não aparece em nenhum lugar do código. No entanto, é útil se você quiser utilizar o parâmetro mais de uma vez em um modelo de código. Você só precisa definir o parâmetro na primeira vez e pode fazer referência a ele usando o nome todas as vezes seguintes. Por exemplo, no modelo de código a seguir, o parâmetro ${CONLINK} é definido somente na primeira vez, mas é mencionado pelo seu nome duas vezes mais.


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

As dicas ajudam o IDE a calcular o valor do parâmetro do modelo quando o IDE expande o modelo de código. Veja, por exemplo, o modelo if(true), utilizado neste tutorial na seção circundando o código com um modelo. O texto expandido deste modelo é

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

Examine o parâmetro ${CONDITION variableFromPreviousAssignment instanceof="boolean" default="true"}. Este parâmetro define a condição da instrução if. Portanto, o parâmetro é denominado CONDITION. A primeira dica é variableFromPreviousAssignment e a segunda dica é instanceof="boolean". Juntas, estas duas dicas dizem ao IDE para procurar a variável booliana mais próxima que está designada no código anterior ao modelo de código. Adicione a terceira dica, default="true", e o parâmetro define a condição como "se o valor da variável booliana anterior mais próxima for verdadeiro".

Por exemplo, quando a linha $b = 10 do snippet de código a seguir estiver circundada por um modelo de código if(true) ...

Snippet $a = false $b = 10

...o IDE procura a variável booliana mais próxima designada anteriormente, localiza $a e gera uma instrução if com a condição $a[=true]. A condição é automaticamente selecionada para edição, de modo que o programador de PHP pode alterar $a para outra variável ou para !$a.

Modelo expandido se $a=true then $b=10, com a condição $a=true selecionada para edição

A tabela a seguir lista as dicas utilizadas nos modelos de código PHP e as descrições das dicas.

Dica Descrição
newVarName O valor do parâmetro deve ser um nome de variável "fresco", não utilizado. Geralmente utilizado com default.
default="" O valor default do parâmetro.
instanceof="" Tipo de variável PHP definida no parâmetro.
variableFromPreviousAssignment O valor do parâmetro a variável mais próxima designada anteriormente. Geralmente utilizada com instanceof e default.
variableFromNextAssignmentName O valor do parâmetro é o nome da variável mais próxima designada depois do modelo de código. Geralmente utilizado com default.
variableFromNextAssignmentType O valor do parâmetro é o tipo da variável mais próxima designada depois do modelo de código. Geralmente utilizado com default.
editable=false O valor do parâmetro não pode ser editado depois que o modelo for expandido.
allowSurround Permite que o modelo seja usado para circundar o código.

Criando Seus Próprios Modelos de Código

Você também pode criar seus próprios modelos de código no NetBeans IDE. Esta seção explica como criar modelos de código, explora sua sintaxe e sugere alguns modelos úteis para criar.

Para criar um modelo de código:

  1. Abra Ferramentas > Opções (NetBeans > Preferências no Mac), selecione as funcionalidades do Editor e selecione a guia Modelos de Código.
    Modelos de código PHP na janela Opções, com o modelo cli selecionado
  2. Clique em Novo para abrir a caixa de diálogo Novo Modelo de Código. Digite a abreviação que deseja para o modelo e clique em OK.
    Caixa de diálogo Novo Modelo de Código que pede a abreviação do modelo
  3. É adicionada uma nova linha à tabela de modelos de código. Esta linha contém somente a abreviação fornecida. O cursor está na guia Texto Expandido, onde o IDE colocou o cursor automaticamente. Você pode começar a digitar imediatamente o código do modelo.

    Observação: para saber mais sobre a sintaxe do texto expandido do modelo de código, consulte a seção Sintaxe do Modelo de Código PHP.

    Digitando o texto expandido do novo modelo abb

As seções a seguir descrevem alguns casos de uso para a criação dos seus próprios modelos de código PHP. Se tiver algum outro caso de uso para sugerir, compartilhe-o com a comunidade no Fórum dos Usuários de PHP.

Caso de uso: inserindo PHP no HTML

Se inserir frequentemente snippets de PHP em um bloco de HTML, você poderá criar um modelo de código HTML que insere o PHP sem que seja necessário digitar <?php ?> repetidamente.

O modelo de código a seguir insere uma instrução echo do PHP no HTML.

Linguagem: HTML
Abreviação: php
Texto expandido:
<?php echo ${cursor}   ?>

Janela Opções que mostra novo modelo php em html

Caso de uso: Joomla

Os modelos de código podem ajudá-lo a utilizar os frameworks PHP no NetBeans IDE, especialmente frameworks que não apresentam suporte incorporado. Este é o modelo de código que um usuário desenvolveu para ser utilizado com Joomla.

Linguagem: PHP
Abreviação: joomdef
Texto expandido:
defined('_JEXEC')
or die('Restricted access');
${cursor}

Caixa de diálogo Opções com novo modelo de código joomdef

Caso de uso: conexão MySQL

Os desenvolvedores de PHP precisam geralmente criar uma conexão com um banco de dados MySQL. Este modelo de código cria uma conexão para você. A variável designada para a conexão MySQL tem o nome do placeholder link. Observe o uso do cifrão "triplo" $$$, na realidade um cifrão duplo, que produz um único cifrão quando expandido, seguido pelo parâmetro do nome da variável.

Linguagem: PHP
Abreviação: my_con
Texto expandido:
$$${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}

Novo modelo de código para conexão MySQL

Caso de uso: ação no controlador Zend

Em vez de utilizar o assistente do NetBeans para criar uma ação, você pode utilizar um modelo de código para inserir uma ação em um controlador Zend Framework, como indexController{}.

Linguagem: PHP
Abreviação: zf_act
Texto expandido:
public function ${functionName}Action () {
${selection}${cursor}
}

Novo modelo de código de ação Zend

Caso de uso: elemento de form Zend

Este modelo insere um elemento em um form Zend. Use-o depois de gerar um form chamando o comando Zend create form <name>.

Linguagem: PHP
Abreviação: zf_element
Texto expandido:
$$${ELEMENT newVarName default="element"} = new Zend_Form_Element_Submit('submit', array('label' => 'Send data to server'));  
$$this->addElement($$${ELEMENT});
${cursor}
Novo modelo de código para elementos do Zend Framework para inserir em forms ZF

 


Consulte Também

Para obter mais informações sobre a tecnologia PHP no netbeans.org, consulte os seguintes recursos:

Para enviar comentários e sugestões, obter suporte e manter-se informado sobre os desenvolvimentos mais recentes das funcionalidades de desenvolvimento em PHP no NetBeans IDE, junte-se à lista de correspondência de

get support for the NetBeans

Support


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2013, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo