Principais conclusões:
- O PHP Artisan é uma ferramenta de linha de comando que simplifica as tarefas comuns de desenvolvimento do Laravel, desde a geração de código até à gestão de migrações.
- Podem ser criados comandos Artisan personalizados para automatizar tarefas repetitivas específicas do projeto, melhorando a eficiência do programador.
- O Artisan oferece uma gama de comandos integrados para acções como a execução de um servidor de desenvolvimento, a gestão de caches e a interação com o sistema de filas.
Alguma vez quiseste automatizar tarefas repetitivas na tua aplicação Laravel?
Bem, o PHP Artisan, uma ferramenta de linha de comando útil que vem com o Laravel, pode ajudar-te a fazer isso mesmo. Permite-te automatizar tarefas, gerir recursos e interagir com a estrutura Laravel sem problemas.
Para criar um novo comando Artisan, utiliza o comando make:command. Isto criará uma nova classe de comando no diretório app/Console/Commands. É utilizada para configurar migrações, listagens de rotas, filas de espera, criação de classes e outras tarefas.
Desde os conceitos básicos dos comandos Artisan até à criação e execução dos teus próprios comandos personalizados, este artigo abrange tudo o que precisas de saber sobre o PHP Artisan no Laravel 11.
Visão geral do PHP Artisan
Os desenvolvedores usam os comandos do Laravel Artisan para concluir tarefas importantes, como criar migrações e publicar ativos de pacotes.
Existem comandos Laravel incorporados e a opção de criar comandos personalizados. O Laravel Artisan tem muitos comandos pré-fabricados disponíveis.
Para ver uma lista desses comandos, digite php artisan list em seu terminal. Isso fornecerá uma lista de todos os comandos disponíveis do Laravel Artisan.
Estes comandos ajudam os programadores a trabalhar de forma mais eficiente, poupando-lhes assim tempo precioso. Usando estes comandos do Laravel Artisan, podes criar auth, controller, model, mail, migration e muitas outras funções.
Experimenta hoje os comandos personalizados no Laravel 11 na Cloudways!
Cria e gerencia comandos personalizados sem esforço no Cloudways, com recursos ilimitados e a flexibilidade do PHP 8.
Noções básicas sobre os comandos do Laravel Artisan
Os comandos do Laravel Artisan são importantes para a estrutura do Laravel. Oferece aos programadores uma interface de linha de comandos (CLI) para facilitar e acelerar o seu trabalho.
A classe Illuminate\Console\Application é a base do Artisan. Ela estende a classe
Por exemplo, um comando simples pode ser assim:
namespace App\Console\Commands;
utiliza o comando Illuminate\Console\Command;
class ExampleCommand extends Command
{
protected $signature = 'example:run {name}';
protected $description = 'Executa um comando de exemplo';
função pública handle()
{
$name = $this->argumento('nome');
$este->info("Olá, {$nome}!");
}
}
Executa o Laravel com o PHP Artisan Server
O comando Laravel PHP Artisan Serve facilita a execução de aplicações no servidor de desenvolvimento PHP. Como desenvolvedor, podes usar o Laravel Artisan para criar e testar diferentes recursos de aplicativos.
Quando executas o comando php artisan serve, podes iniciar rapidamente um servidor em http://localhost:8000. Isso permite que você teste e desenvolva seus aplicativos localmente. Também é possível personalizar o servidor para usar hosts e portas diferentes.
O comando php artisan serve funciona com o ecossistema Laravel. Isso inclui recursos como migrações de banco de dados, agendamento de tarefas e gerenciamento de filas.
Criar e executar comandos personalizados
O Artisan do Laravel fornece uma lista de comandos. Também podes criar os teus próprios comandos Artisan personalizados. Podes escolher onde os armazenar, desde que o Composer os possa carregar. Para criar, registar e executar os teus comandos personalizados, segue estes 8 passos simples:
Passo 1: Cria um novo comando
O Artisan CLI do Laravel fornece uma maneira conveniente de gerar classes de comando personalizadas. Para criar um novo comando, simplesmente usa o comando make:command Artisan.
Isto cria automaticamente uma nova classe de comando no diretório app/Console/Commands. Se este diretório não existir, ele será gerado para ti.
Escreve o seguinte comando na Consola Artisan:
php artisan make:command customcommand
O ficheiro pode ter o seguinte aspeto:
namespace App\Console\Commands;
utiliza o comando Illuminate\Console\Command;
class CustomCommand extends Command
{
Protegido $signature = 'custom:command';
protected $description = 'Descrição do comando personalizado';
função pública __construct()
{
parent::__construct();
}
função pública handle()
{
// A lógica do comando fica aqui
}
}
Passo 2: Define o comando
Ao criar comandos de consola, muitas vezes precisas de recolher informações do utilizador. O Laravel lida com isso através da propriedade signature .
Podes utilizar esta sintaxe curta para definir argumentos e sinalizadores obrigatórios e opcionais. Isto facilita a conceção da forma como o teu comando funciona com o utilizador.
protected $signature = 'user:update {id} {--nome=} {--email=}';
Neste exemplo, o comando espera um argumento ID e opções opcionais de nome e e-mail.
Passo 3: Comando I/O
Quando executas um comando, o Laravel dá-te formas fáceis de obter os valores dos argumentos e opções. No método handle do teu comando, usa os métodos $this->argument() e $this->option().
Se o argumento ou a opção que procuras não existir, estes métodos devolverão null.
Para solicitar a introdução de dados
Podes obter a entrada do utilizador enquanto o teu comando está a ser executado, para além de apresentar a saída. O método ask mostra uma pergunta ao utilizador, recolhe a sua resposta e envia-a de volta para o teu comando.
$name = $this->ask('Qual é o teu nome?', 'Taylor');
Para pedir a confirmação
se ($this->confirma('Desejas continuar?')) {
// Continua
}
Podes fazer com que o pedido de confirmação retorne sempre verdadeiro. Para isso, passa true como segundo argumento do método confirm.
Passo 4: Registar comandos
O Laravel, por padrão, registra todos os comandos localizados no diretório app/Console/Commands. Podes configurar o Laravel para procurar em mais diretórios os comandos do PHP Artisan. Para fazer isso, use o método withCommands no arquivo bootstrap/app.php do seu aplicativo.
->withCommands([ __DIR__.'/../app/Domínio/Ordens/Comandos', ])
Quando utilizas o Artisan, o contentor de serviços encontra e regista todos os comandos da tua aplicação no Artisan.
Etapa 5: Executa as exigências
Por vezes, podes querer executar um comando Artisan fora do CLI, como por exemplo a partir de uma rota ou controlador. Podes conseguir isto utilizando o método de chamada na fachada do Artisan.
Este método tem dois argumentos. O primeiro argumento é o nome ou a classe do comando. O segundo argumento é uma lista de parâmetros de comando. O método devolve o código de saída.
Também podes passar o comando Artisan completo para o método de chamada como uma cadeia de caracteres:
Artisan::call('mail:send 1 --queue=default');
Para colocar os comandos Artisan em fila de espera
Podes utilizar o método de fila na fachada do Artisan para enviar comandos do Artisan para os teus trabalhadores de fila. Esses comandos serão processados em segundo plano. Antes de usar esse método, certifica-te de que a fila está configurada e que um ouvinte de fila está em execução.
usa Iluminação\Suporte\Facadas\Artesão;
Route::post('/user/{user}/mail', function (string $user) {
Artisan::queue('mail:send', [
'utilizador' => $user, '--queue' => 'padrão'
]);
// ...
});
Passo 6: Manuseamento de sinais
Os comandos do Laravel Artisan podem manipular sinais do sistema como SIGINT. Podes incorporar o tratamento de sinais no teu comando utilizando o método trap.
$este->trap(SIGINT, function () {
$este->info('Comando interrompido');
});
Passo 7: Personalização do Stub
Podes personalizar os ficheiros modelo utilizados pelo comando make:command Artisan para facilitar a criação de comandos com estruturas consistentes.
Para isso, tens de publicar os ficheiros stub no teu projeto.
php artisan stub:publica
Etapa 8: Eventos
Há três eventos que o Artisan envia quando executa comandos:
- Iluminar\Console\Eventos\ArtisanIniciar
- Iluminar\Console\Eventos\ComandoIniciar
- Iluminar\Console\Eventos\ComandoFinalizado
Utiliza o método event para disparar um evento:
evento(new CustomCommandExecuted($this));
Cria migrações com make:migration
php artisan make:migration é um comando do Laravel Artisan usado para criar um novo ficheiro de migração. As migrações são essencialmente esquemas para o teu esquema de base de dados. Elas definem a estrutura das tuas tabelas, colunas, índices e relacionamentos.
Eis o aspeto do processo:
- Cria uma Migração: Quando você executa o comando make:migration, ele cria um novo arquivo PHP na pasta database/migrations.
- Define modificações: O ficheiro de migração contém métodos up e down. O método up define alterações na base de dados, como criar tabelas ou adicionar colunas. O método down desfaz essas alterações.
- Executa a migração: Para aplicar as alterações ao seu banco de dados, use o comando php artisan migrate.
Exemplo
Bash php artisan make:migration create_users_table
Esse comando criará um novo arquivo chamado create_users_table na pasta database/migrations. Podes então definir a estrutura da tabela de utilizadores dentro do ficheiro de migração.
Vantagens da make:migration
- Controlo de versões: Acompanha as alterações da base de dados ao longo do tempo.
- Colaboração: Partilha facilmente a estrutura da base de dados com os membros da equipa.
- Semeadura de base de dados: Preenche a tua base de dados com dados de teste utilizando semeadores.
- Reversões da base de dados: Reverte facilmente as alterações à base de dados, se necessário.
As migrações ajudam-te a manter o esquema da tua base de dados claro e organizado. Isto facilita a gestão e a atualização da tua aplicação.
Lista de comandos do Laravel Artisan
O Artisan CLI do Laravel é uma ferramenta útil para trabalhar com a tua aplicação. Tem diferentes comandos para diferentes tarefas, como criar código e gerir o ambiente da aplicação.
Uma lista completa dos comandos do Laravel PHP Artisan seria extensa. Podes utilizar o comando PHP Artisan list para a obter, mas aqui está uma lista das principais categorias de comandos no Laravel 11:
Comandos principais
- cache: Gere a cache da aplicação (limpa, esquece, etc.)
- config: Armazena em cache, limpa ou publica arquivos de configuração
- desce: Desactiva temporariamente a aplicação
- env: Gere as variáveis de ambiente
- chave: Gera uma nova chave de aplicação
- migra: Executa migrações de bases de dados
- optimiza: Optimiza a aplicação para produção
- fila de espera: Gere o sistema de filas de espera
- rota: Lista ou limpa as rotas
- armazenamento: Gere o diretório de armazenamento
- fornecedor: Gerir as dependências do Composer
Comandos de geração de código
- cria: Gera várias estruturas de código (controlador, modelo, migração, etc.)
- modelo: Cria modelos Eloquent
- migração: Cria ficheiros de migração
- semente: Semeia a base de dados com dados fictícios
Comandos de teste
- testa: Executa testes de aplicação
- dusk: Executa testes de navegador com o Dusk
Outros comandos
- auth: Gere as operações relacionadas com a autenticação
- brisa: Instala o sistema de autenticação Breeze
- config: Gere os ficheiros de configuração
- horizon: Gere o sistema de filas do Laravel Horizon
- Passaporte: Gere o servidor OAuth2
- sanctum: gere a autenticação de token da API
- telescope: Gere a ferramenta de depuração Telescope
Resumo
Neste artigo, mostrámos como criar comandos personalizados utilizando o comando Artisan. O Artisan é uma ferramenta PHP que te permite desenvolver diferentes comandos com base nas necessidades do teu projeto.
Se tiveres alguma dúvida sobre este artigo ou sobre o comando Artisan, não hesites em deixar um comentário abaixo. Teremos todo o gosto em ajudar-te.
Perguntas frequentes
Q. Qual é o objetivo dos comandos Laravel PHP Artisan?
A. Os comandos do Artisan são uma ferramenta de linha de comando no Laravel. Eles ajudam-te a automatizar tarefas, gerir migrações e gerar andaimes de código. Também podes usá-los para executar testes e fazer outras tarefas de desenvolvimento e gestão nas tuas aplicações Laravel.
Q. Porquê utilizar o PHP Artisan Serve?
A. O comando PHP Artisan serve lança rapidamente um servidor de desenvolvimento local para sua aplicação Laravel. É ideal para prototipagem rápida e testes durante o desenvolvimento.
Q. Como executar comandos do PHP Artisan no cpanel?
- Abre o Terminal a partir do cPanel.
- Navega para o diretório do teu projeto Laravel usando cd /path/to/your/project.
- Executa o comando com o PHP: /usr/local/bin/php artisan {command}.
Certifica-te de que substituis /usr/local/bin/php pelo caminho PHP correto para o teu servidor, que podes encontrar no MultiPHP Manager no cPanel.
Q. Posso substituir ou ampliar comandos Artisan existentes no Laravel?
A. Com certeza! No Laravel, tens a capacidade de modificar ou estender os comandos Artisan existentes. Para fazer isso, cria um comando personalizado que herda da classe de comando base. Dentro deste comando personalizado, podes implementar a lógica ou funcionalidade específica que desejas.
Q. Posso utilizar comandos Artisan personalizados para automatizar tarefas comuns no meu projeto Laravel?
A. Claro que podes utilizar comandos Artisan personalizados no Laravel para automatizar tarefas comuns. Essas tarefas podem incluir a execução de migrações, a propagação do banco de dados, a geração de código, a execução de tarefas agendadas e a execução de qualquer lógica personalizada. Os comandos Artisan personalizados fornecem uma maneira conveniente e eficiente de automatizar ações repetitivas em seu projeto Laravel.
Hafsa Tahir
Hafsa é uma profissional de marketing de conteúdos que tem estado no espaço de crescimento orgânico nos últimos três anos. Com formação em Psicologia e UX, gosta de ler as mentes dos utilizadores e está interessada em experimentar os ângulos de marketing de produtos mais criativos. As suas cópias gritam: "não és apenas um salário para nós". Adora contar piadas sem graça, pagar a mensalidade do ginásio e não ir, e escrever contos psicologicamente perturbadores por alguma razão.
