1Ace::Browser::SiteDefs(U3s)er Contributed Perl DocumentatAicoen::Browser::SiteDefs(3)
2
3
4

NAME

6       Ace::Browser::SiteDefs - Access to AceBrowser configuration files
7

SYNOPSIS

9         use Ace;
10         use Ace::Browser::AceSubs;
11         use CGI qw(:standard);
12
13         my $configuration = Configuration;
14         my $docroot  = $configuration->Docroot;
15         my @pictures = @{$configuration->Pictures};
16         my %displays = %{$configuration->Displays};
17         my $coderef  = $configuration->Url_mapper;
18         $coderef->($param1,$param2);
19

DESCRIPTION

21       Ace::Browser::SiteDefs evaluates an AceBrowser configuration file and
22       returns a configuration object ("config object" for short).  A config
23       object is a bag of dynamically-generated methods, derived from the
24       scalar variables, arrays, hashes and subroutines in the configuration
25       file.
26
27       The config object methods are a canonicalized form of the configuration
28       file variables, in which the first character of the method is upper‐
29       case, and subsequent characters are lower case.  For example, if the
30       configuration variable was $ROOT, the method will be $con‐
31       fig_object->Root.
32
33       Working with Configuration Objects
34
35       To fetch a configuration object, use the Ace::Browser::AceSubs Configu‐
36       ration() function.  This will return a configuration object for the
37       current database:
38
39         $config_object = Configuration();
40
41       Thereafter, it's just a matter of making the proper method calls.
42
43          If the Configuration file is a....    The method call returns a...
44          ----------------------------------    ----------------------------
45
46          Scalar variable                       Scalar
47          Array variable                        Array reference
48          Hash variable                         Hash reference
49          Subroutine                            Code reference
50
51       If a variable is not defined, the corresponding method will return
52       undef.
53

BUGS

55       Please report them.
56

SEE ALSO

58       Ace::Object, Ace::Browser::AceSubs, Ace::Browsr::SearchSubs, the
59       README.ACEBROWSER file.
60

AUTHOR

62       Lincoln Stein <lstein@cshl.org>.
63
64       Copyright (c) 2001 Cold Spring Harbor Laboratory
65
66       This library is free software; you can redistribute it and/or modify it
67       under the same terms as Perl itself.  See DISCLAIMER.txt for dis‐
68       claimers of warranty.
69
70
71
72perl v5.8.8                       2001-02-20         Ace::Browser::SiteDefs(3)
Impressum