Ace::Browser::SiteDefs(3pm)
NAME
Ace::Browser::SiteDefs - Access to AceBrowser configuration files
SYNOPSIS
use Ace;
use Ace::Browser::AceSubs;
use CGI qw(:standard);
my $configuration = Configuration;
my $docroot = $configuration->Docroot;
my @pictures = @{$configuration->Pictures};
my %displays = %{$configuration->Displays};
my $coderef = $configuration->Url_mapper;
$coderef->($param1,$param2);
DESCRIPTION
Ace::Browser::SiteDefs evaluates an AceBrowser configuration file and
returns a configuration object ("config object" for short). A config
object is a bag of dynamically-generated methods, derived from the
scalar variables, arrays, hashes and subroutines in the configuration
file.
- The config object methods are a canonicalized form of the configuration
file variables, in which the first character of the method is
uppercase, and subsequent characters are lower case. For example, if
the configuration variable was $ROOT, the method will be
$config_object->Root. - Working with Configuration Objects
- To fetch a configuration object, use the Ace::Browser::AceSubs
Configuration() function. This will return a configuration object for the current database:
$config_object = Configuration(); - Thereafter, it's just a matter of making the proper method calls.
If the Configuration file is a.... The method call returns a...
---------------------------------- ----------------------------Scalar variable Scalar
Array variable Array reference
Hash variable Hash reference
Subroutine Code reference - If a variable is not defined, the corresponding method will return
undef.
BUGS
Please report them.
SEE ALSO
Ace::Object, Ace::Browser::AceSubs, Ace::Browsr::SearchSubs, the
README.ACEBROWSER file.
AUTHOR
Lincoln Stein <lstein@cshl.org>.
Copyright (c) 2001 Cold Spring Harbor Laboratory
- This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. See DISCLAIMER.txt for
disclaimers of warranty.