Laravelでリクエストヘッダー情報(リファラ, UserAgent)を取得する方法

Laravelを使用しているときに、リファラーを取得する必要があったのでやってみました。
今回はリファラーやユーザーエージェントなどのリクエストヘッダー情報を取得する方法を書いています。

リクエストヘッダー取得はRequestから

コントローラーでリクエストを、Requestクラス(Illuminate\Http\Request)を使用して受けると思います。
リクエストヘッダー情報は受けたリクエストから参照できます。

public function send(Request $request) {
    dd($request->headers);
}

$request->headersでヘッダー情報を取得できます。
上記のように書くと、このメソッドにリクエストした時のヘッダー情報が下記のように取得できます。

headersの配列のキーを指定して、getメソッドを使ってそれぞれ取得することが可能です。

$request->headers->get('キー名');

リファラーは先程のheadersからgetメソッドを使用して、下記のように取得可能です。

public function send(Request $request) {
    dd($request->headers->get('referer'));
}

もしくは、$request->header('referer')やrequest()->header('referer')といった書き方もできます。

同様にして、下記のように書くことが可能です。

public function send(Request $request) {
    dd($request->headers->get('user-agent'));
}

他には、$request->header('user-agent')やrequest()->header('user-agent')で取得できます。

同様にして、下記のように書くことが可能です。

public function send(Request $request) {
    dd($request->headers->get('content-type'));
}

他には、$request->header('content-type')やrequest()->header('content-type')で取得できます。

同様にして、下記のように書くことが可能です。

public function send(Request $request) {
    dd($request->headers->get('cookie'));
}

ヘッダーについているクッキーをそのままの状態で取得されます。

Laravelでクッキーを使う場合は自動的に暗号化されるので、Laravelで暗号化されたものを複合化した状態で取得したい場合には下記のようにcookieメソッドを使うと良いです。

$request->cookie('項目名');

引数に項目名を入れると、値が複合化されて取得できます。

今回はリクエストヘッダー情報を取得してみました。
ユーザーエージェントやリファラなどは、たまに使うこともあるので覚えておきたいです。

$request->headers自体はSymfony\Component\HttpFoundation\HeaderBagクラスのインスタンスを返しています。
内部ではheadersの配列に対して、渡したキーで入っている内容を返しています。

その際にキーは大文字から小文字に変換されているので、渡す時には大文字でも取れるようになっています。

例えばrefererの場合は、$request->headers->get('Referer')や$request->headers->get('REFERER')でも取得可能となっています。