398 lines
7.9 KiB
HTML
398 lines
7.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>/tmp/glist/private/lib/GT/Plugins/Installer.pm</title>
|
|
<link rev="made" href="mailto:root@penguin.office.gossamer-threads.com" />
|
|
|
|
<style type="text/css">
|
|
/* $MVD$:fontset("Untitled Font Set 1","ARIEL","HELVETICA","HELV","SANSERIF") */
|
|
/* $MVD$:fontset("Arial","Arial") */
|
|
/* $MVD$:fontset("Arial Black","Arial Black") */
|
|
/* $MVD$:fontset("Algerian","Algerian") */
|
|
|
|
|
|
body {
|
|
background-color: white;
|
|
font-family: Verdana, Arial, sans-serif;
|
|
font-size: small;
|
|
color: black;
|
|
}
|
|
|
|
|
|
p {
|
|
background-color : white;
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
h1 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : bold;
|
|
font-size : medium;
|
|
background-color : white;
|
|
color : maroon;
|
|
}
|
|
|
|
|
|
h2 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : medium;
|
|
font-weight : bold;
|
|
color : blue;
|
|
background-color : white;
|
|
}
|
|
|
|
|
|
h3 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : bold;
|
|
font-size : medium;
|
|
color : black;
|
|
background-color : white;
|
|
}
|
|
|
|
|
|
h4 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : bold;
|
|
font-size : small;
|
|
color : maroon;
|
|
background-color : white;
|
|
}
|
|
|
|
|
|
h5 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : bold;
|
|
font-size : small;
|
|
color : blue;
|
|
background-color : white;
|
|
}
|
|
|
|
|
|
h6 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : bold;
|
|
font-size : small;
|
|
color : black;
|
|
background-color : white;
|
|
}
|
|
|
|
|
|
ul {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
ol {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
dl {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
li {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
th {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
td {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
dl {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
dd {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
dt {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
code {
|
|
font-family : Courier;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
|
|
pre {
|
|
font-family : Courier;
|
|
font-size : small;
|
|
color : black;
|
|
}
|
|
|
|
.mvd-H1 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : bold;
|
|
font-size : 14.0pt;
|
|
background-color : transparent;
|
|
background-image : none;
|
|
color : maroon;
|
|
}
|
|
|
|
|
|
.mvd-H2 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : 12.0pt;
|
|
color : blue;
|
|
}
|
|
|
|
|
|
p.indent {
|
|
font-family : "Verdana, Arial, sans-serif";
|
|
list-style-type : circle;
|
|
list-style-position : inside;
|
|
color : black;
|
|
margin-left : 16.0pt;
|
|
}
|
|
|
|
|
|
.mvd-P-indent {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
list-style-type : circle;
|
|
list-style-position : inside;
|
|
color : black;
|
|
margin-left : 16.0pt;
|
|
}
|
|
|
|
|
|
pre.programlisting {
|
|
font-size : 9.0pt;
|
|
list-style-type : disc;
|
|
margin-left : 16.0pt;
|
|
margin-top : -14.0pt;
|
|
}
|
|
|
|
|
|
.mvd-PRE-programlisting {
|
|
font-size : 9.0pt;
|
|
list-style-type : disc;
|
|
margin-left : 16.0pt;
|
|
margin-top : -14.0pt;
|
|
}
|
|
|
|
|
|
.mvd-PRE {
|
|
font-size : 9.0pt;
|
|
}
|
|
|
|
|
|
p.note {
|
|
margin-left : 28.0pt;
|
|
}
|
|
|
|
|
|
.mvd-P-note {
|
|
margin-left : 28.0pt;
|
|
}
|
|
|
|
|
|
.mvd-H4 {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-weight : normal;
|
|
font-size : 9.0pt;
|
|
color : black;
|
|
margin-left : 6.0pt;
|
|
margin-top : -14.0pt;
|
|
}
|
|
|
|
|
|
.mvd-P {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
font-size : 10.0pt;
|
|
color : black;
|
|
}
|
|
|
|
.mvd-BODY {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
background-color : white;
|
|
}
|
|
|
|
|
|
p.indentnobullet {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
list-style-type : none;
|
|
}
|
|
|
|
|
|
.mvd-P-indentnobullet {
|
|
font-family : Verdana, Arial, sans-serif;
|
|
list-style-type : none;
|
|
}
|
|
</style>
|
|
|
|
|
|
</head>
|
|
|
|
<body style="background-color: white">
|
|
|
|
<p><a name="__index__"></a></p>
|
|
<!-- INDEX BEGIN -->
|
|
|
|
<ul>
|
|
|
|
<li><a href="#name">NAME</a></li>
|
|
<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
<li><a href="#description">DESCRIPTION</a></li>
|
|
<ul>
|
|
|
|
<li><a href="#install_hooks">install_hooks</a></li>
|
|
<li><a href="#install_menu">install_menu</a></li>
|
|
<li><a href="#install_options">install_options</a></li>
|
|
</ul>
|
|
|
|
<li><a href="#copyright">COPYRIGHT</a></li>
|
|
<li><a href="#version">VERSION</a></li>
|
|
</ul>
|
|
<!-- INDEX END -->
|
|
|
|
<hr />
|
|
<p>
|
|
</p>
|
|
<h1><a name="name">NAME</a></h1>
|
|
<p>GT::Plugins::Installer</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
|
<pre>
|
|
$mgr->install_hooks('PluginName', ['hook_name', 'PRE|POST', 'code']);
|
|
$mgr->install_menu('PluginName', ['menu_name', 'menu_url', 'enabled']);
|
|
$mgr->install_options('PluginName', ['option_key', 'option_val', 'instructions']);</pre>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="description">DESCRIPTION</a></h1>
|
|
<p>The installer is an object that is passed into plugins during installation.
|
|
It provides methods to add hooks, menu options, admin options or copy files
|
|
into the users application.</p>
|
|
<p>
|
|
</p>
|
|
<h2><a name="install_hooks">install_hooks</a></h2>
|
|
<p><code>install_hooks</code> takes as arguments the plugin name and an array of:</p>
|
|
<dl>
|
|
<dt><strong><a name="item_hook_name">hook_name</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
The hook you want to override.
|
|
</dd>
|
|
<p></p>
|
|
<dt><strong><a name="item_pre_2fpost">PRE/POST</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
Either the string PRE or POST depending on whether the hook should be run
|
|
before the main code, or after.
|
|
</dd>
|
|
<p></p>
|
|
<dt><strong><a name="item_code">code</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
The name of the code to run. It should be Plugins::PACKAGE::YourPluginName::function.
|
|
Where PACKAGE is the name of the Gossamer Product the plugin is for. For example
|
|
Plugins::GMail::Wap::header
|
|
</dd>
|
|
<p></p></dl>
|
|
<p><code>install_hooks</code> returns 1 on success, undef on failure with the error
|
|
message in $GT::Plugins::error.</p>
|
|
<p>
|
|
</p>
|
|
<h2><a name="install_menu">install_menu</a></h2>
|
|
<p><code>install_menu</code> takes as arguments the plugin name and an array of:</p>
|
|
<dl>
|
|
<dt><strong><a name="item_menu_name">menu_name</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
The name that will show up in the admin menu.
|
|
</dd>
|
|
<p></p>
|
|
<dt><strong><a name="item_menu_url">menu_url</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
The URL for the menu option.
|
|
</dd>
|
|
<p></p>
|
|
<dt><strong><a name="item_enabled">enabled</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
Either true or false depending on whether the menu option should be shown.
|
|
</dd>
|
|
<p></p></dl>
|
|
<p><code>install_menu</code> returns 1 on success, undef on failure with the error
|
|
message in $GT::Plugins::error.</p>
|
|
<p>
|
|
</p>
|
|
<h2><a name="install_options">install_options</a></h2>
|
|
<p><code>install_options</code> takes as arguments the plugin name and an array of:</p>
|
|
<dl>
|
|
<dt><strong><a name="item_option_key">option_key</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
This is the key, and is used when accessing the options hash.
|
|
</dd>
|
|
<p></p>
|
|
<dt><strong><a name="item_option_value">option_value</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
This is the default value.
|
|
</dd>
|
|
<p></p>
|
|
<dt><strong><a name="item_instructions">instructions</a></strong><br />
|
|
</dt>
|
|
<dd>
|
|
A string instruction users on what the plugin does.
|
|
</dd>
|
|
<p></p></dl>
|
|
<p><code>install_options</code> returns 1 on success, undef on failure with the error
|
|
message in $GT::Plugins::error.</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="copyright">COPYRIGHT</a></h1>
|
|
<p>Copyright (c) 2004 Gossamer Threads Inc. All Rights Reserved.
|
|
<a href="http://www.gossamer-threads.com/">http://www.gossamer-threads.com/</a></p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="version">VERSION</a></h1>
|
|
<p>Revision: $Id: Installer.pm,v 1.13 2004/08/23 19:54:27 jagerman Exp $</p>
|
|
|
|
</body>
|
|
|
|
</html>
|