poet::manual::configuring(3pm) [debian man page]

Poet::Manual::Configuring(3pm)				User Contributed Perl Documentation			    Poet::Manual::Configuring(3pm)

NAME

       Poet::Manual::Configuring - Built-in Poet configuration options

DESCRIPTION

       This is a list of configuration keys used by Poet itself. These may be placed in any Poet conf file, e.g. "local.cfg" or
       "conf/global/*.cfg".

       Entries like "foo.bar" can be listed either in dot notation

	   foo.bar: 5

       or as part of a hash:

	   foo:
	      bar: 5

       See Dot notation for details.

       cache
	   The entire hash under this entry will be passed to Poet::Cache->config(). See Poet::Cache for examples. e.g.

	      cache:
		 defaults:
		    expires_variance: 0.2
		 storage:
		    file:
		       driver: File
		       root_dir: ${root}/data/cache
		    memcached:
		       driver: Memcached
		       servers: ["10.0.0.15:11211", "10.0.0.15:11212"]
		       compress_threshold: 4096
		 namespace:
		    /some/component:	   { storage: file, expires_in: 5min }
		    /some/other/component: { storage: memcached, expires_in: 1h }
		    Some::Library:	   { storage: memcached, expires_in: 10min }

       env.bin_dir, env.comps_dir, etc.
	   These entries affect what is returned from "$poet->bin_dir", "$poet->bin_path", "$poet->comps_dir", etc., and thus where various Poet
	   resources are kept. See Poet::Environment. For example, to move data and logs into external directories outside the environment:

	       env:
		 data_dir: /some/external/data/dir
		 logs_dir: /some/external/logs/dir

       log.defaults, log.category
	   Specify the log level, output location, and layout string for logging, in the default case and for particular categories respectively.
	   See Poet::Log for examples. e.g.

	       log:
		 defaults:
		   level: info
		   output: poet.log
		   layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c - %m - %F:%L - %P%n"
		 category:
		   CHI:
		     level: debug
		     output: chi.log
		     layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} %m - %P%n"
		   MyApp::Foo:
		     output: stdout

       log.log4perl_conf
	   Bypass Poet's simplified logging configuration and specify a log4perl conf file directly. e.g.

	       log:
		 log4perl_conf: /path/to/log4perl.conf

       mason
	   The hash under this entry will be treated as options that are passed to "Mason->new" for the main Mason instance, overriding any
	   default options.  See Poet::Mason. e.g.

	       mason:
		 static_source: 1
		 static_source_touch_file: ${root}/data/purge.dat

       server.default_content_type
	   Content type for requests that don't explicitly set one. Defaults to "text/html".

       server.host
	   The IP address to listen on.

       server.load_modules
	   A list of modules to load on server startup, e.g.

	       server.load_modules:
		  - DBI
		  - List::Util
		  - MyApp::Foo
		  - MyApp::Bar

       server.port
	   The port to listen on.

SEE ALSO

       Poet

AUTHOR

       Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Jonathan Swartz.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-06-05					    Poet::Manual::Configuring(3pm)

Poet::Import(3pm)					User Contributed Perl Documentation					 Poet::Import(3pm)

NAME

       Poet::Import -- Import Poet quick vars and utilities

SYNOPSIS

	   # In a script...
	   use Poet::Script qw($conf $poet $log :file);

	   # In a module...
	   use Poet qw($conf $poet $log :file);

DESCRIPTION

       Poet makes it easy to import certain variables (known as "quick vars") and utility sets into any script or module in your environment.

       In a script:

	   use Poet::Script qw(...);

       and in a module:

	   use Poet qw(...);

       where "..." contains one or more quick var names (e.g. $conf, $poet) and/or utility tags (e.g. ":file", ":web").

       (Note that "use Poet::Script" is also necessary for initializing the environment, even if you don't care to import anything, whereas "use
       Poet" has no effect other than importing.)

QUICK VARS

       Here is the built-in list of quick vars you can import. Some of the variables are singletons, and some of them are specific to each package
       they are imported into.

       $poet
	   The global environment object, provided by Poet::Environment. This provides information such as the root directory and paths to
	   subdirectories.

	   For backward compatibility this is also available as $env.

       $conf
	   The global configuration object, provided by Poet::Conf.

       $cache
	   The cache for the current package, provided by Poet::Cache.

       $log
	   The logger for the current package, provided by Poet::Log.

UTILITIES

   Default utilities
       The utilities in Poet::Util::Debug are always imported, with no tag necessary.

   :file
       This tag imports all the utilities in Poet::Util::File.

   :web
       This tag imports all the utilities in Poet::Util::Web. It is automatically included in all Mason components.

MASON COMPONENTS

       Every Mason component automatically gets this on top:

	   use Poet qw($conf $poet :web);

       "$m->cache" and "$m->log" will get you the cache and log objects for a particular Mason component.

CUSTOMIZING

   Adding variables
       To add your own variable, define a method called provide_var_varname in "MyApp::Import". For example to add a variable $dbh:

	   package MyApp::Import;
	   use Poet::Moose;
	   extends 'Poet::Import';

	   method provide_var_dbh ($caller) {
	       # Generate and return a dbh.
	       # $caller is the package importing the variable.
	       # $poet is the current Poet environment.
	   }

       "provide_dbh" can return a single global value, or a dynamic value depending on $caller.

       Now your scripts and libraries can do

	   use Poet::Script qw($dbh);
	   use Poet qw($dbh);

   Adding utility tags
       To add your own utility tag, define a class "MyApp::Util::Mytagname" that exports a set of functions via the ':all' tag. For example:

	   package MyApp::Util::Hash;
	   use Hash::Util qw(hash_seed all_keys);
	   use Hash::MoreUtils qw(slice slice_def slice_exists);

	   our @EXPORT_OK = qw(hash_seed all_keys slice slice_def slice_exists);
	   our %EXPORT_TAGS = ( 'all' => @EXPORT_OK );

	   1;

       Now your scripts and libraries can do

	   use Poet::Script qw(:hash);
	   use Poet qw(:hash);

SEE ALSO

       Poet

AUTHOR

       Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Jonathan Swartz.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-06-05							 Poet::Import(3pm)