1Ace::Browser::SiteDefs(U3s)er Contributed Perl DocumentatAicoen::Browser::SiteDefs(3)
2
3
4
6 Ace::Browser::SiteDefs - Access to AceBrowser configuration files
7
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
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
29 uppercase, and subsequent characters are lower case. For example, if
30 the configuration variable was $ROOT, the method will be
31 $config_object->Root.
32
33 Working with Configuration Objects
34 To fetch a configuration object, use the Ace::Browser::AceSubs
35 Configuration() function. This will return a configuration object for
36 the current database:
37
38 $config_object = Configuration();
39
40 Thereafter, it's just a matter of making the proper method calls.
41
42 If the Configuration file is a.... The method call returns a...
43 ---------------------------------- ----------------------------
44
45 Scalar variable Scalar
46 Array variable Array reference
47 Hash variable Hash reference
48 Subroutine Code reference
49
50 If a variable is not defined, the corresponding method will return
51 undef.
52
54 Please report them.
55
57 Ace::Object, Ace::Browser::AceSubs, Ace::Browsr::SearchSubs, the
58 README.ACEBROWSER file.
59
61 Lincoln Stein <lstein@cshl.org>.
62
63 Copyright (c) 2001 Cold Spring Harbor Laboratory
64
65 This library is free software; you can redistribute it and/or modify it
66 under the same terms as Perl itself. See DISCLAIMER.txt for
67 disclaimers of warranty.
68
69
70
71perl v5.28.1 2006-11-01 Ace::Browser::SiteDefs(3)