69bff56717b9208b22fe9305413b8ba6c2b76ec0
[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:none">
5 </HEAD>
6
7 <BODY>
8
9 <!-- INDEX BEGIN -->
10
11 <UL>
12
13         <LI><A HREF="#NAME">NAME</A>
14         <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15         <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16         <LI><A HREF="#METHODS">METHODS</A>
17         <LI><A HREF="#VERSION">VERSION</A>
18         <LI><A HREF="#BUGS">BUGS</A>
19         <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
20         <LI><A HREF="#HISTORY">HISTORY</A>
21 </UL>
22 <!-- INDEX END -->
23
24 <HR>
25 <P>
26 <H1><A NAME="NAME">NAME</A></H1>
27 <P>
28 FS::UI::CGI - Base class for CGI user-interface objects
29
30 <P>
31 <HR>
32 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <P>
34 <PRE>  use FS::UI::CGI;
35   use FS::UI::some_table;
36 </PRE>
37 <P>
38 <PRE>  $interface = new FS::UI::some_table;
39 </PRE>
40 <P>
41 <PRE>  $error = $interface-&gt;browse;
42   $error = $interface-&gt;search;
43   $error = $interface-&gt;view;
44   $error = $interface-&gt;edit;
45   $error = $interface-&gt;process;
46 </PRE>
47 <P>
48 <HR>
49 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
50 <P>
51 An FS::UI::CGI object represents a CGI interface object.
52
53 <P>
54 <HR>
55 <H1><A NAME="METHODS">METHODS</A></H1>
56 <DL>
57 <DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
58 <DT><STRONG><A NAME="item__header">_header</A></STRONG><DD>
59 <DT><STRONG><A NAME="item__footer">_footer</A></STRONG><DD>
60 <DT><STRONG><A NAME="item_interface">interface</A></STRONG><DD>
61 <P>
62 Returns the string `CGI'. Useful for the author of a table-specific UI
63 class to conditionally specify certain behaviour.
64
65 </DL>
66 <P>
67 <HR>
68 <H1><A NAME="VERSION">VERSION</A></H1>
69 <P>
70 $Id: CGI.html,v 1.2 2000-03-03 18:22:44 ivan Exp $
71
72 <P>
73 <HR>
74 <H1><A NAME="BUGS">BUGS</A></H1>
75 <P>
76 This documentation is incomplete.
77
78 <P>
79 In _Tableborder, headers should be links that sort on their fields.
80
81 <P>
82 _Link uses a constant <CODE>$BASE_URL</CODE>
83
84 <P>
85 _Link passes the arguments as a manually-constructed GET string instead of
86 POSTing, for compatability while the web interface is upgraded. Once this
87 is done it should pass arguements properly (i.e. as a POST, 8-bit clean)
88
89 <P>
90 Still some small bits of widget code same as FS::UI::Gtk.
91
92 <P>
93 <HR>
94 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
95 <P>
96 <A HREF="../../FS/UI/Base.html">FS::UI::Base</A>
97
98
99
100 <P>
101 <HR>
102 <H1><A NAME="HISTORY">HISTORY</A></H1>
103 <P>
104 $Log: CGI.html,v $
105 Revision 1.2  2000-03-03 18:22:44  ivan
106 changes from 1.2.3 release, fixes from webdemo
107  Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of
108 module files for proper perl installation
109
110 <P>
111 Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code.
112
113 </BODY>
114
115 </HTML>