mojolicious::plugin::config(3pm) [debian man page]

Mojolicious::Plugin::Config(3pm)			User Contributed Perl Documentation			  Mojolicious::Plugin::Config(3pm)

NAME

       Mojolicious::Plugin::Config - Perl-ish configuration plugin

SYNOPSIS

	 # myapp.conf
	 {
	   foo	     => "bar",
	   music_dir => app->home->rel_dir('music')
	 };

	 # Mojolicious
	 my $config = $self->plugin('Config');

	 # Mojolicious::Lite
	 my $config = plugin 'Config';

	 # Reads "myapp.conf" by default
	 my $config = app->config;

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

DESCRIPTION

       Mojolicious::Plugin::Config is a Perl-ish configuration plugin.

       The application object can be accessed via $app or the "app" function. You can extend the normal configuration file "myapp.conf" with
       "mode" specific ones like "myapp.$mode.conf". A default configuration filename will be generated by decamelizing the application class with
       "decamelize" in Mojo::Util or from the application filename.

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

OPTIONS

       Mojolicious::Plugin::Config supports the following options.

   "default"
	 # Mojolicious::Lite
	 plugin Config => {default => {foo => 'bar'}};

       Default configuration, making configuration files optional.

   "ext"
	 # Mojolicious::Lite
	 plugin Config => {ext => 'stuff'};

       File extension for generated configuration filenames, defaults to "conf".

   "file"
	 # Mojolicious::Lite
	 plugin Config => {file => 'myapp.conf'};
	 plugin Config => {file => '/etc/foo.stuff'};

       Full path to configuration file, defaults to the value of the "MOJO_CONFIG" environment variable or "myapp.conf" in the application home
       directory.

METHODS

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

   "load"
	 $plugin->load($file, $conf, $app);

       Loads configuration file and passes the content to "parse".

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

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

       Parse configuration file.

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

   "register"
	 my $config = $plugin->register($app, $conf);

       Register plugin in Mojolicious application.

SEE ALSO

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

perl v5.14.2							    2012-09-05					  Mojolicious::Plugin::Config(3pm)

Mojo(3pm)						User Contributed Perl Documentation						 Mojo(3pm)

NAME

       Mojo - Duct tape for the HTML5 web!

SYNOPSIS

	 use Mojo::Base 'Mojo';

	 # All the complexities of CGI, PSGI, HTTP and WebSockets get reduced to a
	 # single method call!
	 sub handler {
	   my ($self, $tx) = @_;

	   # Request
	   my $method = $tx->req->method;
	   my $path   = $tx->req->url->path;

	   # Response
	   $tx->res->code(200);
	   $tx->res->headers->content_type('text/plain');
	   $tx->res->body("$method request for $path!");

	   # Resume transaction
	   $tx->resume;
	 }

DESCRIPTION

       Mojo provides a flexible runtime environment for Perl real-time web frameworks. It provides all the basic tools and helpers needed to write
       simple web applications and higher level web frameworks such as Mojolicious.

       See Mojolicious for more!

ATTRIBUTES

       Mojo implements the following attributes.

   "home"
	 my $home = $app->home;
	 $app	  = $app->home(Mojo::Home->new);

       The home directory of your application, defaults to a Mojo::Home object which stringifies to the actual path.

	 # Generate portable path relative to home directory
	 my $path = $app->home->rel_file('data/important.txt');

   "log"
	 my $log = $app->log;
	 $app	 = $app->log(Mojo::Log->new);

       The logging layer of your application, defaults to a Mojo::Log object.

	 # Log debug message
	 $app->log->debug('It works!');

   "ua"
	 my $ua = $app->ua;
	 $app	= $app->ua(Mojo::UserAgent->new);

       A full featured HTTP 1.1 user agent for use in your applications, defaults to a Mojo::UserAgent object. Note that this user agent should
       not be used in plugins, since non-blocking requests that are already in progress will interfere with new blocking ones.

	 # Perform blocking request
	 my $body = $app->ua->get('mojolicio.us')->res->body;

METHODS

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

   "new"
	 my $app = Mojo->new;

       Construct a new Mojo application. Will automatically detect your home directory and set up logging to "log/mojo.log" if there's a "log"
       directory.

   "build_tx"
	 my $tx = $app->build_tx;

       Transaction builder, defaults to building a Mojo::Transaction::HTTP object.

   "config"
	 my $config = $app->config;
	 my $foo    = $app->config('foo');
	 $app	    = $app->config({foo => 'bar'});
	 $app	    = $app->config(foo => 'bar');

       Application configuration.

	 # Manipulate configuration
	 $app->config->{foo} = 'bar';
	 my $foo = $app->config->{foo};
	 delete $app->config->{foo};

   "handler"
	 $app->handler($tx);

       The handler is the main entry point to your application or framework and will be called for each new transaction, which will usually be a
       Mojo::Transaction::HTTP or Mojo::Transaction::WebSocket object. Meant to be overloaded in a subclass.

	 sub handler {
	   my ($self, $tx) = @_;
	   ...
	 }

SEE ALSO

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

perl v5.14.2							    2012-09-05								 Mojo(3pm)