NAME¶

Mojo::Headers - Headers

SYNOPSIS¶

  use Mojo::Headers;
  my $headers = Mojo::Headers->new;
  $headers->content_type('text/plain');
  $headers->parse("Content-Type: text/html\n\n");

DESCRIPTION¶

Mojo::Headers is a container and parser for HTTP headers.

ATTRIBUTES¶

Mojo::Headers implements the following attributes.

"max_line_size"¶

  my $size = $headers->max_line_size;
  $headers = $headers->max_line_size(1024);

Maximum line size in bytes, defaults to the value of the "MOJO_MAX_LINE_SIZE" environment variable or 10240.

METHODS¶

Mojo::Headers inherits all methods from Mojo::Base and implements the following new ones.

"accept"¶

  my $accept = $headers->accept;
  $headers   = $headers->accept('application/json');

Shortcut for the "Accept" header.

"accept_language"¶

  my $accept_language = $headers->accept_language;
  $headers            = $headers->accept_language('de, en');

Shortcut for the "Accept-Language" header.

"accept_ranges"¶

  my $ranges = $headers->accept_ranges;
  $headers   = $headers->accept_ranges('bytes');

Shortcut for the "Accept-Ranges" header.

"add"¶

  $headers = $headers->add('Content-Type', 'text/plain');

Add one or more header lines.

"authorization"¶

  my $authorization = $headers->authorization;
  $headers          = $headers->authorization('Basic Zm9vOmJhcg==');

Shortcut for the "Authorization" header.

"cache_control"¶

  my $cache_control = $headers->cache_control;
  $headers          = $headers->cache_control('max-age=1, no-cache');

Shortcut for the "Cache-Control" header.

"clone"¶

  my $clone = $headers->clone;

Clone headers.

"connection"¶

  my $connection = $headers->connection;
  $headers       = $headers->connection('close');

Shortcut for the "Connection" header.

"content_disposition"¶

  my $content_disposition = $headers->content_disposition;
  $headers                = $headers->content_disposition('foo');

Shortcut for the "Content-Disposition" header.

"content_length"¶

  my $content_length = $headers->content_length;
  $headers           = $headers->content_length(4000);

Shortcut for the "Content-Length" header.

"content_range"¶

  my $range = $headers->content_range;
  $headers  = $headers->content_range('bytes 2-8/100');

Shortcut for the "Content-Range" header.

"content_transfer_encoding"¶

  my $encoding = $headers->content_transfer_encoding;
  $headers     = $headers->content_transfer_encoding('foo');

Shortcut for the "Content-Transfer-Encoding" header.

"content_type"¶

  my $content_type = $headers->content_type;
  $headers         = $headers->content_type('text/plain');

Shortcut for the "Content-Type" header.

"cookie"¶

  my $cookie = $headers->cookie;
  $headers   = $headers->cookie('f=b');

Shortcut for the "Cookie" header.

"date"¶

  my $date = $headers->date;
  $headers = $headers->date('Sun, 17 Aug 2008 16:27:35 GMT');

Shortcut for the "Date" header.

"dnt"¶

  my $dnt  = $headers->dnt;
  $headers = $headers->dnt(1);

Shortcut for the "DNT" (Do Not Track) header.

"etag"¶

  my $etag = $headers->etag;
  $headers = $headers->etag('abc321');

Shortcut for the "ETag" header.

"expect"¶

  my $expect = $headers->expect;
  $headers   = $headers->expect('100-continue');

Shortcut for the "Expect" header.

"expires"¶

  my $expires = $headers->expires;
  $headers    = $headers->expires('Thu, 01 Dec 1994 16:00:00 GMT');

Shortcut for the "Expires" header.

"from_hash"¶

  $headers = $headers->from_hash({'Content-Type' => 'text/html'});

Parse headers from a hash reference.

"header"¶

  my $string = $headers->header('Content-Type');
  my @lines  = $headers->header('Content-Type');
  $headers   = $headers->header('Content-Type' => 'text/plain');

Get or replace the current header values.

  # Multiple headers with the same name
  for my $header ($headers->header('Set-Cookie')) {
    say 'Set-Cookie:';
    # Multiple lines per header
    say for @$header;
  }

"host"¶

  my $host = $headers->host;
  $headers = $headers->host('127.0.0.1');

Shortcut for the "Host" header.

"if_modified_since"¶

  my $m    = $headers->if_modified_since;
  $headers = $headers->if_modified_since('Sun, 17 Aug 2008 16:27:35 GMT');

Shortcut for the "If-Modified-Since" header.

"is_finished"¶

  my $success = $headers->is_finished;

Check if header parser is finished.

"is_limit_exceeded"¶

  my $success = $headers->is_limit_exceeded;

Check if a header has exceeded "max_line_size".

"last_modified"¶

  my $m    = $headers->last_modified;
  $headers = $headers->last_modified('Sun, 17 Aug 2008 16:27:35 GMT');

Shortcut for the "Last-Modified" header.

"leftovers"¶

  my $leftovers = $headers->leftovers;

Leftovers.

"location"¶

  my $location = $headers->location;
  $headers     = $headers->location('http://127.0.0.1/foo');

Shortcut for the "Location" header.

"names"¶

  my $names = $headers->names;

Generate a list of all currently defined headers.

"parse"¶

  $headers = $headers->parse("Content-Type: text/foo\n\n");

Parse formatted headers.

"proxy_authenticate"¶

  my $authenticate = $headers->proxy_authenticate;
  $headers         = $headers->proxy_authenticate('Basic "realm"');

Shortcut for the "Proxy-Authenticate" header.

"proxy_authorization"¶

  my $proxy_authorization = $headers->proxy_authorization;
  $headers = $headers->proxy_authorization('Basic Zm9vOmJhcg==');

Shortcut for the "Proxy-Authorization" header.

"range"¶

  my $range = $headers->range;
  $headers  = $headers->range('bytes=2-8');

Shortcut for the "Range" header.

"referrer"¶

  my $referrer = $headers->referrer;
  $headers     = $headers->referrer('http://mojolicio.us');

Shortcut for the "Referer" header, there was a typo in RFC 2068 which resulted in "Referer" becoming an official header.

"remove"¶

  $headers = $headers->remove('Content-Type');

Remove a header.

"sec_websocket_accept"¶

  my $accept = $headers->sec_websocket_accept;
  $headers   = $headers->sec_websocket_accept('s3pPLMBiTxaQ9kYGzzhZRbK+xOo=');

Shortcut for the "Sec-WebSocket-Accept" header.

"sec_websocket_key"¶

  my $key  = $headers->sec_websocket_key;
  $headers = $headers->sec_websocket_key('dGhlIHNhbXBsZSBub25jZQ==');

Shortcut for the "Sec-WebSocket-Key" header.

"sec_websocket_origin"¶

  my $origin = $headers->sec_websocket_origin;
  $headers   = $headers->sec_websocket_origin('http://example.com');

Shortcut for the "Sec-WebSocket-Origin" header.

"sec_websocket_protocol"¶

  my $protocol = $headers->sec_websocket_protocol;
  $headers     = $headers->sec_websocket_protocol('sample');

Shortcut for the "Sec-WebSocket-Protocol" header.

"sec_websocket_version"¶

  my $version = $headers->sec_websocket_version;
  $headers    = $headers->sec_websocket_version(13);

Shortcut for the "Sec-WebSocket-Version" header.

"server"¶

  my $server = $headers->server;
  $headers   = $headers->server('Mojo');

Shortcut for the "Server" header.

"set_cookie"¶

  my $set_cookie = $headers->set_cookie;
  $headers       = $headers->set_cookie('f=b; path=/');

Shortcut for the "Set-Cookie" header.

"status"¶

  my $status = $headers->status;
  $headers   = $headers->status('200 OK');

Shortcut for the "Status" header.

"to_hash"¶

  my $single = $headers->to_hash;
  my $multi  = $headers->to_hash(1);

Turn headers into hash reference, nested array references to represent multi line values are disabled by default.

"to_string"¶

  my $string = $headers->to_string;

Turn headers into a string, suitable for HTTP 1.1 messages.

"trailer"¶

  my $trailer = $headers->trailer;
  $headers    = $headers->trailer('X-Foo');

Shortcut for the "Trailer" header.

"transfer_encoding"¶

  my $transfer_encoding = $headers->transfer_encoding;
  $headers              = $headers->transfer_encoding('chunked');

Shortcut for the "Transfer-Encoding" header.

"upgrade"¶

  my $upgrade = $headers->upgrade;
  $headers    = $headers->upgrade('websocket');

Shortcut for the "Upgrade" header.

"user_agent"¶

  my $user_agent = $headers->user_agent;
  $headers       = $headers->user_agent('Mojo/1.0');

Shortcut for the "User-Agent" header.

"www_authenticate"¶

  my $authenticate = $headers->www_authenticate;
  $headers         = $headers->www_authenticate('Basic realm="realm"');

Shortcut for the "WWW-Authenticate" header.

SEE ALSO¶

Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.