GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOJOLICIOUS::PLUGIN::JSONCONFIG (3)

.ds Aq ’

NAME

Mojolicious::Plugin::JSONConfig - JSON configuration plugin

CONTENTS

SYNOPSIS



  # myapp.json (its just JSON with embedded Perl)
  {
    %# Just a value
    "foo": "bar",

    %# Nested data structures are fine too
    "baz": ["X"],

    %# You have full access to the application
    "music_dir": "<%= app->home->rel_dir(music) %>"
  }

  # Mojolicious
  my $config = $app->plugin(JSONConfig);
  say $config->{foo};

  # Mojolicious::Lite
  my $config = plugin JSONConfig;
  say $config->{foo};

  # foo.html.ep
  %= $config->{foo}

  # The configuration is available application-wide
  my $config = app->config;
  say $config->{foo};

  # Everything can be customized with options
  my $config = plugin JSONConfig => {file => /etc/myapp.conf};



DESCRIPTION

Mojolicious::Plugin::JSONConfig is a JSON configuration plugin that preprocesses its input with Mojo::Template.

The application object can be accessed via $app or the app function. You can extend the normal configuration file $moniker.json with mode specific ones like $moniker.$mode.json. A default configuration filename will be generated from the value of moniker in Mojolicious.

The code of this plugin is a good example for learning to build new plugins, you’re welcome to fork it.

See PLUGINS in Mojolicious::Plugins for a list of plugins that are available by default.

OPTIONS

Mojolicious::Plugin::JSONConfig inherits all options from Mojolicious::Plugin::Config and supports the following new ones.

    template



  # Mojolicious::Lite
  plugin JSONConfig => {template => {line_start => .}};



Attribute values passed to Mojo::Template object used to preprocess configuration files.

METHODS

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

    parse



  $plugin->parse($content, $file, $conf, $app);



Process content with render and parse it with Mojo::JSON.



  sub parse {
    my ($self, $content, $file, $conf, $app) = @_;
    ...
    $content = $self->render($content, $file, $conf, $app);
    ...
    return $hash;
  }



    register



  my $config = $plugin->register(Mojolicious->new);
  my $config = $plugin->register(Mojolicious->new, {file => /etc/foo.conf});



Register plugin in Mojolicious application and merge configuration.

    render



  $plugin->render($content, $file, $conf, $app);



Process configuration file with Mojo::Template.



  sub render {
    my ($self, $content, $file, $conf, $app) = @_;
    ...
    return $content;
  }



SEE ALSO

Mojolicious, Mojolicious::Guides, <http://mojolicious.org>.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOJOLICIOUS::PLUGIN::JSONCONFIG (3) 2016-03-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.