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
Prophet::Config(3) User Contributed Perl Documentation Prophet::Config(3)

Prophet::Config - Prophet's configuration object

version 0.751

From, for example, a class that inherits from Prophet::App:

    has config => (
        is      => 'rw',
        isa     => 'Prophet::Config',
        default => sub {
            my $self = shift;
            return Prophet::Config->new(
                app_handle => $self,
                confname => 'prophetrc',
            );
        },
    );

This class represents the configuration of Prophet and the application built on top of it. It's just an instance of Config::GitLike with a few small customizations and additions.

A convenience method that gets you a hash (or a hashref, depending on context) of all currently defined aliases. (Basically, every entry in the 'alias' section of the config file.)

If a filename is passed in, this method will only return the aliases that are defined in that particular config file.

A convenience method that gets you a hash (or a hashref, depending on context) of all currently defined source replicas, in the format { 'name' => 'URL' }, or { 'URL' => 'name' } if the argument "by_url" is passed in.

The replica-specific configuration file, or the configuration file given by "PROPHET_APP_CONFIG" if that environmental variable is set.

Initialize the configuration. Does NOT load the config for you! You need to call load for that. The configuration will also load automatically the first time your prophet application tries to get a config variable.

Both constructor arguments are required.

The following config variables are currently used in various places in Prophet:
  • <record-type>.summary-format
  • record.summary-format
  • user.email-address
  • alias.<alias>

Most of the useful methods for getting and setting configuration variables actually come from Config::GitLike. See that module's documentation for details.

  • Jesse Vincent <jesse@bestpractical.com>
  • Chia-Liang Kao <clkao@bestpractical.com>
  • Christine Spang <christine@spang.cc>

This software is Copyright (c) 2009 by Best Practical Solutions.

This is free software, licensed under:

  The MIT (X11) License

You can make new bug reports, and view existing ones, through the web interface at <https://rt.cpan.org/Public/Dist/Display.html?Name=Prophet>.

  • Alex Vandiver <alexmv@bestpractical.com>
  • Casey West <casey@geeknest.com>
  • Cyril Brulebois <kibi@debian.org>
  • Florian Ragwitz <rafl@debian.org>
  • Ioan Rogers <ioanr@cpan.org>
  • Jonas Smedegaard <dr@jones.dk>
  • Kevin Falcone <falcone@bestpractical.com>
  • Lance Wicks <lw@judocoach.com>
  • Nelson Elhage <nelhage@mit.edu>
  • Pedro Melo <melo@simplicidade.org>
  • Rob Hoelz <rob@hoelz.ro>
  • Ruslan Zakirov <ruz@bestpractical.com>
  • Shawn M Moore <sartak@bestpractical.com>
  • Simon Wistow <simon@thegestalt.org>
  • Stephane Alnet <stephane@shimaore.net>
  • Unknown user <nobody@localhost>
  • Yanick Champoux <yanick@babyl.dyndns.org>
  • franck cuny <franck@lumberjaph.net>
  • robertkrimen <robertkrimen@gmail.com>
  • sunnavy <sunnavy@bestpractical.com>
2022-04-08 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

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