Ace::Browser::AceSubs - Subroutines for AceBrowser
use Ace; use Ace::Browser::AceSubs; use CGI qw(:standard); use CGI::Cookie;
my $obj = GetAceObject() || AceNotFound(); PrintTop($obj); print $obj->asHTML; PrintBottom();
Ace::Browser::AceSubs exports a set of routines that are useful for creating search pages and displays for AceBrowser CGI pages. See http://stein.cshl.org/AcePerl/AceBrowser.
The following subroutines are exported by default:
AceError AceMissing AceNotFound Configuration DoRedirect GetAceObject Object2URL ObjectLink OpenDatabase PrintTop PrintBottom Url
The following subroutines are exported if explicitly requested:
AceAddCookie AceInit AceHeader AceMultipleChoices AceRedirect DB_Name Footer Header ResolveUrl Style Toggle TypeSelector
To load the default subroutines load the module with:
use Ace::Browser::AceSubs;
To bring in a set of optionally routines, load the module with:
use Ace::Browser::AceSubs qw(AceInit AceRedirect);
To bring in all the default subroutines, plus some of the optional ones:
use Ace::Browser::AceSubs qw(:DEFAULT AceInit AceRedirect);
There are two main types of AceBrowser scripts:
GetAceObject()
will return the requested object, or
undef if the object does not exist.
To retrieve the parameters, use the CGI.pm param()
method:
$name = param('name'); $class = param('class');
The following sections describe the exported subroutines.
AceError($message)
AceHeader()
AceAddCookie(@cookies)
OpenDatabase()
and/or
GetAceObject()
and b<before> PrintTop(), will add one or more cookies
to the outgoing HTTP headers that are emitted by AceHeader().
Cookies must be CGI::Cookie objects.
AceInit()
PrintTop()
and Header()
internally.
AceMissing([$class,$name])
param()
function.
AceMultipleChoices($symbol,$report,$objects)
The three arguements are:
$symbol The keyword or query string the user was searching on, undef if none.
$report The symbolic name of the current display, or undef if none.
$objects An array reference containing the Ace objects in question.
This subroutine is not exported by default.
AceNotFound([$class,$name])
param()
function.
AcePicRoot($directory)
AceRedirect($report,$object)
$obj = GetAceObject(); if ($obj->CDS) { my $protein = $obj->Corresponding_protein; AceRedirect('protein',$protein); }
AceRedirect must be called b<before> PrintTop()
or AceHeader(). It
invokes exit(), so it will not return.
This subroutine is not exported by default. It differs from
DoRedirect()
in that it displays a message to the user for two seconds
before it generates the new page. It also allows the display to be set
explicitly, rather than determined automatically by the AceBrowser
system.
Configuration()
Configuration()
function returns the Ace::Browser::SiteDefs object
for the current session. From this object you can retrieve
information from the configuration file.
DB_Name()
DoRedirect($object)
PrintTop()
or any other HTML-generating code. It
differs from AceRedirect()
in that it generates a fast redirect
without alerting the user.
This function is not exported by default.
Footer()
GetAceObject()
If a single object is found, the function returns it as the function
result. If no objects are found, it returns undef. If more than one
object is found, the function invokes AceMultipleChoices()
and exits
the script.
Header()
Object2URL($object)
Object2URL($name,$class)
It is also possible to pass Object2URL an object name and class, in the case that an AceDB object isn't available.
The return value is a URL.
This function is used extensively to create cross references between Ace::Objects on AceBrowser pages.
Example:
my $author = $db->fetch(Author => 'Sulston JE'); print ObjectLink($author,$author->Full_name);
This will print out a link to a page that will display details on the author page. The text of the link will be the value of the Full_name tag.
OpenDatabase()
This function is not exported by default.
PrintTop($object,$class,$title,@html_headers)
PrintTop()
function generates all the boilerplate at the top of a
typical AceBrowser page, including the HTTP header information, the
page title, the navigation bar for searches, the web site banner, the
type selector for choosing alternative displays, and a level-one
header.
Call it with one or more arguments. The arguments are:
$object An AceDB object. The navigation bar and title will be customized for the object.
$class If no AceDB object is available, then you can pass a string containing the AceDB class that this page is designed to display.
$title A title to use for the HTML page and the first level-one header. If not provided, a generic title "Report for Object" is generated.
@html_headers Additional HTML headers to pass to the the CGI.pm start_html.
PrintBottom()
PrintBottom()
function outputs all the boilerplate at the bottom
of a typical AceBrowser page. If a user-defined footer is present in
the configuration file, that is printed. Otherwise, the method prints
a horizontal rule followed by links to the site home page, the AcePerl
home page, the privacy policy, and the feedback page.
Style()
{ -src => '/ace/stylesheets/current_stylesheet.css' }
This hash is suitable for passing to the -style argument of CGI.pm's
start_html()
function, or for use as an additional header in
PrintTop(). You may add locally-defined stylesheet elements to the
hash before calling start_html(). See the pic script for an example
of how this is done this.
This function is not exported by default.
ResolveUrl($url,$param)
A typical call is:
$url = ResolveUrl('/cgi-bin/ace/generic/tree','name=fred;class=Author');
This function is not exported by default.
Toggle($section,[$label,$object_count,$add_plural,$add_count])
Toggle($section,$label,$object_count,$add_plural,$add_count)
Toggle()
subroutine makes it easy to create HTML sections that
open and close when the user selects a toggle icon (a yellow
triangle).
Toggle()
can be used to manage multiple collapsible HTML sections, but
each section must have a unique name. The required first argument is
the section name. Optional arguments are:
$label The text of the generated link, for example "sequence"
$object_count The number of objects that opening the section will reveal
$add_plural If true, the label will be pluralized when appropriate
$add_count If true, the label will have the object count added when appropriate
In a scalar context, Toggle()
prints the link HTML and returns a
boolean flag. A true result indicates that the section is expanded
and should be generated. A false result indicates that the section is
collapsed.
In a list context, Toggle()
returns a two-element list. The first
element is the HTML link that expands and contracts the section. The
second element is a boolean that indicates whether the section is
currently open or closed.
This example indicates typical usage:
my $sequence = GetAceObject(); print "sequence name = ",$sequence,"\n"; print "sequence clone = ",$sequence->Clone,"\n"; if (Toggle('dna','Sequence DNA')) { print $sequence->asDNA; }
An alternative way to do the same thing:
my $sequence = GetAceObject(); print "sequence name = ",$sequence,"\n"; print "sequence clone = ",$sequence->Clone,"\n"; my ($link,$open) = Toggle('dna','Sequence DNA'); print $link; print $sequence->asDNA if $open;
TypeSelector($name,$class)
Url($display,$params)
ResolveUrl()
to create a
single Url.
When hard-coding relative URLs into AceBrowser scripts, it is important to pass them through Url(). The reason for this is that AceBrowser may need to attach the database name to the URL in order to identify it.
Example:
my $url = Url('../sequence_dump',"name=$name;long_dump=yes"); print a({-href=>$url},'Dump this sequence');
Please report them.
the Ace::Object manpage, the Ace::Browser::SiteDefs manpage, the Ace::Browsr::SearchSubs manpage, the README.ACEBROWSER file.
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.