NAME

Mojolicious::Plugin::HeaderCondition - Header condition plugin

SYNOPSIS

  # Mojolicious
  $self->plugin('HeaderCondition');
  $self->routes->route('/:controller/:action')
    ->over(headers => {Referer => qr/example\.com/});

  # Mojolicious::Lite
  plugin 'HeaderCondition';
  get '/' => (headers => {Referer => qr/example\.com/}) => sub {...};

  # All headers need to match
  $self->routes->route('/:controller/:action')->over(headers => {
    'X-Secret-Header' => 'Foo',
    Referer => qr/example\.com/
  });

  # The "agent" condition is a shortcut for the "User-Agent" header
  get '/' => (agent => qr/Firefox/) => sub {...};

  # The "host" condition is a shortcut for the detected host
  # (usually the "Host" or "X-Forwarded-Host" header)
  get '/' => (host => qr/mojolicio\.us/) => sub {...};

DESCRIPTION

Mojolicious::Plugin::HeaderCondition is a routes condition for header based routes. This is a core plugin, that means it is always enabled and its code a good example for learning to build new plugins.

METHODS

Mojolicious::Plugin::HeaderCondition inherits all methods from Mojolicious::Plugin and implements the following new ones.

register

  $plugin->register;

Register condition in Mojolicious application.

SEE ALSO

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