documentation and webdemo updates
[freeside.git] / htdocs / docs / man / FS / UI / CGI.html
1 <HTML>
2 <HEAD>
3 <TITLE>FS::UI::CGI - Base class for CGI user-interface objects</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
5 </HEAD>
6
7 <BODY>
8
9 <A NAME="__index__"></A>
10 <!-- INDEX BEGIN -->
11
12 <UL>
13
14         <LI><A HREF="#name">NAME</A></LI>
15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16         <LI><A HREF="#description">DESCRIPTION</A></LI>
17         <LI><A HREF="#methods">METHODS</A></LI>
18         <LI><A HREF="#version">VERSION</A></LI>
19         <LI><A HREF="#bugs">BUGS</A></LI>
20         <LI><A HREF="#see also">SEE ALSO</A></LI>
21         <LI><A HREF="#history">HISTORY</A></LI>
22 </UL>
23 <!-- INDEX END -->
24
25 <HR>
26 <P>
27 <H1><A NAME="name">NAME</A></H1>
28 <P>FS::UI::CGI - Base class for CGI user-interface objects</P>
29 <P>
30 <HR>
31 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
32 <PRE>
33   use FS::UI::CGI;
34   use FS::UI::some_table;</PRE>
35 <PRE>
36   $interface = new FS::UI::some_table;</PRE>
37 <PRE>
38   $error = $interface-&gt;browse;
39   $error = $interface-&gt;search;
40   $error = $interface-&gt;view;
41   $error = $interface-&gt;edit;
42   $error = $interface-&gt;process;</PRE>
43 <P>
44 <HR>
45 <H1><A NAME="description">DESCRIPTION</A></H1>
46 <P>An FS::UI::CGI object represents a CGI interface object.</P>
47 <P>
48 <HR>
49 <H1><A NAME="methods">METHODS</A></H1>
50 <DL>
51 <DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
52 <DD>
53 <DT><STRONG><A NAME="item__header">_header</A></STRONG><BR>
54 <DD>
55 <DT><STRONG><A NAME="item__footer">_footer</A></STRONG><BR>
56 <DD>
57 <DT><STRONG><A NAME="item_interface">interface</A></STRONG><BR>
58 <DD>
59 Returns the string `CGI'.  Useful for the author of a table-specific UI class
60 to conditionally specify certain behaviour.
61 <P></P></DL>
62 <P>
63 <HR>
64 <H1><A NAME="version">VERSION</A></H1>
65 <P>$Id: CGI.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
66 <P>
67 <HR>
68 <H1><A NAME="bugs">BUGS</A></H1>
69 <P>This documentation is incomplete.</P>
70 <P>In _Tableborder, headers should be links that sort on their fields.</P>
71 <P>_Link uses a constant $BASE_URL</P>
72 <P>_Link passes the arguments as a manually-constructed GET string instead
73 of POSTing, for compatability while the web interface is upgraded.  Once
74 this is done it should pass arguements properly (i.e. as a POST, 8-bit clean)</P>
75 <P>Still some small bits of widget code same as FS::UI::Gtk.</P>
76 <P>
77 <HR>
78 <H1><A NAME="see also">SEE ALSO</A></H1>
79 <P><A HREF="../.././FS/UI/Base.html">the FS::UI::Base manpage</A></P>
80 <P>
81 <HR>
82 <H1><A NAME="history">HISTORY</A></H1>
83 <P>$Log: CGI.html,v $
84 <P>Revision 1.3  2001-04-23 12:40:31  ivan
85 <P>documentation and webdemo updates
86 <P>
87 Revision 1.1  1999/08/04 09:03:53  ivan
88 initial checkin of module files for proper perl installation</P>
89 <P>Revision 1.1  1999/01/20 09:30:36  ivan
90 skeletal cross-UI UI code.</P>
91
92 </BODY>
93
94 </HTML>