À medida que uma aplicação Web cresce, torna-se necessário organizar melhor o código e evitar repetir as mesmas instruções em diferentes páginas. Nesta aula vamos aprender a utilizar include, require, include_once e require_once, permitindo dividir uma aplicação PHP em vários ficheiros, reutilizar componentes e facilitar a manutenção do projeto.
1. Porque devemos organizar o código?
Imagine um site com cinco páginas: Início, Produtos, Serviços, Contactos e Sobre Nós.
Todas utilizam o mesmo cabeçalho, menu de navegação e rodapé.
Se escrevermos o código HTML completo em cada página, teremos de repetir esses elementos cinco vezes.
Se quisermos alterar o menu, teremos de modificar cinco ficheiros.
A solução passa por separar os elementos comuns em ficheiros próprios e reutilizá-los nas diferentes páginas.
Por exemplo:
Desta forma, uma alteração no header.php será refletida em todas as páginas que o utilizem.
2. A instrução include
A instrução include permite inserir e executar o conteúdo de outro ficheiro PHP.
Vamos criar um ficheiro chamado header.php:
Na página index.php, podemos utilizar:
Quando o PHP encontra o include, carrega e processa o conteúdo do ficheiro indicado.
O navegador recebe o HTML resultante, como se estivesse escrito diretamente na página.
3. A instrução require
A instrução require tem uma finalidade semelhante ao include, mas existe uma diferença importante quando o ficheiro não é encontrado.
Se o ficheiro não existir, o PHP emite um aviso, mas pode continuar a executar as instruções seguintes.
Se o ficheiro não existir, ocorre um erro fatal e a execução do programa é interrompida.
|
|
|---|---|
Insere outro ficheiro | Insere outro ficheiro |
Permite continuar após uma falha de inclusão | Interrompe a execução se a inclusão falhar |
Adequado a componentes opcionais | Adequado a ficheiros indispensáveis |
Por exemplo, um ficheiro de configuração essencial para a aplicação deverá normalmente ser carregado com require.
4. include_once e require_once
Por vezes, podemos tentar carregar o mesmo ficheiro mais do que uma vez.
Imagine um ficheiro funcoes.php que contém:
Se o carregarmos duas vezes através de include, o PHP tentará declarar novamente a função, originando um erro.
Para evitar esta situação, podemos utilizar:
O sufixo _once garante que o ficheiro é incluído apenas uma vez durante a execução do pedido.
Existem, portanto, quatro possibilidades:
Instrução | Comportamento |
|---|---|
| Inclui um ficheiro |
| Inclui um ficheiro obrigatório |
| Inclui apenas uma vez |
| Inclui apenas uma vez e exige que exista |
5. Criar uma estrutura organizada
Vamos construir um pequeno site com a seguinte organização:
O ficheiro header.php contém o início da estrutura HTML:
O ficheiro footer.php contém:
Agora a página index.php fica muito mais simples:
E a página produtos.php:
As duas páginas utilizam o mesmo cabeçalho e rodapé, mas apresentam conteúdos diferentes.
Nota: neste exemplo, os caminhos do CSS e dos links do menu são interpretados pelo navegador relativamente ao endereço da página apresentada. Como as páginas estão todas na pasta principal, os caminhos funcionam corretamente.
6. Utilizar variáveis em ficheiros incluídos
Os ficheiros incluídos podem aceder às variáveis disponíveis no local onde são incluídos.
Por exemplo, no index.php:
No header.php:
.
Desta forma, podemos definir um título diferente para cada página sem duplicar o código HTML do cabeçalho.
Esta técnica permite começar a criar componentes reutilizáveis e configuráveis.
7. Utilizar __DIR__ para localizar ficheiros
Quando a aplicação começa a ter várias pastas, podemos encontrar dificuldades com os caminhos dos ficheiros.
O PHP disponibiliza a constante especial __DIR__, que contém o caminho da pasta onde se encontra o ficheiro atual.
Por exemplo:
Desta forma, o caminho é construído a partir da localização do próprio ficheiro PHP, evitando depender da pasta de execução.
É uma boa prática que será especialmente útil quando começarmos a trabalhar com ficheiros de configuração e ligações ao MySQL.
8. O que aprendemos nesta aula?
Nesta aula aprendemos a organizar uma aplicação PHP em vários ficheiros, evitando a repetição desnecessária de código.
Conhecemos as instruções include, require, include_once e require_once, compreendemos as suas diferenças e utilizámos __DIR__ para construir caminhos mais seguros.
A principal ideia a reter é:
Um código bem organizado é mais fácil de compreender, reutilizar, corrigir e manter.
Esta organização será importante quando começarmos a desenvolver aplicações com formulários, funções e bases de dados.