Marco d'Itri > Bryar-4.0 > Bryar::Config

Download:
Bryar-4.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  6
Open  3
View/Report Bugs
Module Version: 1.1   Source  

NAME ^

Bryar::Config - A set of configuration settings for Bryar

SYNOPSIS ^

        Bryar::Config->new(...);
        Bryar::Config->load(...);

DESCRIPTION ^

This encapsulates a Bryar configuration. It can be used to load a new configuration from a file, or provide a reasonable set of defaults.

METHODS ^

new

    Bryar::Config->new(...)

Creates a new Bryar configuration instance.

load

    $self->load($file)

Load the configuration file from somewhere and return the arguments as a hash.

renderer

        $self->renderer();    # Get renderer
        $self->renderer(...); # Set renderer

The class used to render this blog; defaults to "Bryar::Renderer::TT", the Template Toolkit renderer.

frontend

        $self->frontend();    # Get frontend
        $self->frontend(...); # Set frontend

The class used to handle input and output from the blog; defaults to Bryar::Frontend::CGI if run via the CGI, Bryar::Frontend::mod_perl from inside Apache.

collector

        $self->collector();    # Get collector
        $self->collector(...); # Set collector

The class used to select which documents to output. You probably don't want to mess with this.

source

        $self->source();    # Get source
        $self->source(...); # Set source

The class which finds the blog posts. Defaults to Bryar::DataSource::FlatFile, the blosxom-compatible data source.

cache

        $self->cache();    # Get cache object
        $self->cache(new Cache::FileCache()); # Set cache object

An instance of a Cache::Cache subclass which will be used to cache the formatted pages.

datadir

        $self->datadir();    # Get datadir
        $self->datadir(...); # Set datadir

Where the templates (and in the case of the flat-file data source, the blog posts) live.

name

        $self->name();    # Get name

The name of this blog.

description

        $self->description();    # Get description

A description for the blog.

depth

        $self->depth();    # Get depth
        $self->depth(...); # Set depth

How far to recurse into sub-blogs. Default is 1, stay in the current directory.

email

    $self->email();     # Get email

Get the owner's email address. This is used for spam reporting.

recent

    $self->recent();    # Get recent
    $self->recent(...); # Set recent

The number of entries to display if there are no other parameters given. Defaults to 20 entries.

baseurl

        $self->baseurl();    # Get baseurl

The base URL of this blog. (Needed for setting up links to archived posts, etc.)

LICENSE ^

This module is free software, and may be distributed under the same terms as Perl itself.

AUTHOR ^

Copyright (C) 2003, Simon Cozens simon@kasei.com

some parts Copyright 2007 David Cantrell david@cantrell.org.uk

syntax highlighting: