Manipulação de URL usando PHP

Introdução

No desenvolvimento web, é muito comum a utilização de links. Também é comum que os links precisem ser manipulados para incluir ou remover parâmetros. Neste post, veremos como manipular um link e seus parâmetros de forma facilitada e segura.

Quebrando uma URL em partes

Quando um programador não se conhece os recursos do PHP para manipular URLs, é comum que ele se aventure a manipular a string com a URL diretamente, fazendo operações como verificar se existe '?' na URL e obter o conteúdo a esquerda ou a direita, etc.

A principal função para "parsear" uma URL e quebrá-la em partes é a parse_url. Esta função pode ser usada para dois propósitos: para obter todas as partes de uma URL ou para obter uma parte específica de uma URL (por exemplo, o protocolo, o domínio, a query string, etc).

Para obter todas as partes, basta passar a URL como parâmetro e não informar o segundo parâmetro:

$partes = parse_url('http://rubens:senha@teste.com.br:80/a/b/c.php?x=1&y=2#item');

echo $partes['scheme'] . PHP_EOL;     // Obtém o protocolo: "http"
echo $partes['user'] . PHP_EOL;       // Obtém o usuário "rubens"
echo $partes['pass'] . PHP_EOL;       // Obtém a senha "senha"
echo $partes['host'] . PHP_EOL;       // Obtém o domínio "teste.com.br"
echo $partes['port'] . PHP_EOL;       // Obtém a porta "80"
echo $partes['path'] . PHP_EOL;       // Obtém o path "a/b/c.php"
echo $partes['query'] . PHP_EOL;      // Obtém a query string "x=1&y=2"
echo $partes['fragment'] . PHP_EOL;   // Obtém a ancora (ou fragmento) "item"

Para obter uma parte específica, basta passar o segundo parâmetro da função, que especifica qual parte é desejável. Este parâmetro pode receber uma das constantes:

• PHP_URL_SCHEME
• PHP_URL_HOST
• PHP_URL_PORT
• PHP_URL_USER
• PHP_URL_PASS
• PHP_URL_PATH
• PHP_URL_QUERY
• PHP_URL_FRAGMENT

Observação: caso você queira o nome do arquivo, basta aplicar a função basename sobre o valor de $partes['path'], conforme o exemplo:

$arquivo = isset($partes['path']) ? basename($partes['path']) : '';

Quebrando a query string em partes

Como você pode observar, a função parse_url devolve a query string da forma como está na URL e não dividida em partes. Para quebrar a query string em partes, basta usar a função parse_str passando a query string como primeiro parâmetro e um array como segundo parâmetro. O array será preenchido com as variáveis presentes na query string, de forma que o índice do array guarda o nome da variável e cada posição aponta para o respectivo valor da variável (o valor é automaticamente decodificado com urldecode). Veja um exemplo:

// Supondo que $partes['query'] guarda o valor "x=1&y=2"
parse_str($partes['query'], $queryArray);

echo $queryArray['x'] . PHP_EOL; // Obtém "1"
echo $queryArray['y'] . PHP_EOL; // Obtém "2"

Modificando a URL ou Query String

Depois de quebrar a URL e, opcionalmente, a query string, basta manipular o array $partes ou $queryArray da forma desejada. Por exemplo, vamos mudar o protocolo de http para https, mudar a porta de 80 para 81 e remover o parâmetro "x" e incluir o parâmetro "z" com valor "a b c":

// Mudando o protocolo para https
$partes['scheme'] = 'https';

// Mudando a porta para 81
$partes['port'] = 81;

// Removendo a variável "a" do query array
unset($queryArray['x']);

// Incluindo a variável "z" no query array
$queryArray['z'] = 'a b c';

Montando a URL com as partes

Depois de manipular a URL e/ou a query string, agora precisamos montar as partes e formar a URL na forma de string. Para isso, basta usar a função http_build_query para montar o query array para transformá-lo em query string. Esta função já faz a codificação usando urlencode, então você não precisa se preocupar com caracteres reservados.

// Monta a query string
$partes['query'] = http_build_query($queryArray, null, '&');

Infelizmente, a função http_build_url só está disponível via PECL. Porém, é uma função muito simples de se implementar. Veja abaixo:

/**
 * Monta a URL pelas suas partes. (como a funcao http_build_url)
 * @param array $partes Partes da URL (como no retorno de parse_url).
 * @return string
 */
function build_url($partes) {
    $url = '';
    $url .= $partes['scheme'] . '://';
    if (isset($partes['user'])) {
        $url .= urlencode($partes['user']);
        if (isset($partes['pass'])) {
            $url .= ':' . urlencode($partes['pass']);
        }
        $url .= '@';
    }
    $url .= $partes['host'];
    if (isset($partes['port'])) {
        $url .= ':' . number_format($partes['port']);
    }
    if (isset($partes['path'])) {
        $url .= $partes['path'];
    }
    if (isset($partes['query'])) {
        $url .= '?' . $partes['query'];
    }
    if (isset($partes['fragment'])) {
        $url .= '#' . urlencode($partes['fragment']);
    }
    return $url;
}

Bom, agora é só usar essa função e correr para o abraço:

$url = build_url($partes);