9c4f7f43d6dece62a8cd03631d96557e2694eb51
[freeside.git] / htdocs / docs / man / FS / dbdef_colgroup.html
1 <HTML>
2 <HEAD>
3 <TITLE>FS::dbdef_colgroup - Column group objects</TITLE>
4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
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="#BUGS">BUGS</A>
18         <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
19 </UL>
20 <!-- INDEX END -->
21
22 <HR>
23 <P>
24 <H1><A NAME="NAME">NAME</A></H1>
25 <P>
26 FS::dbdef_colgroup - Column group objects
27
28 <P>
29 <HR>
30 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
31 <P>
32 <PRE>  use FS::dbdef_colgroup;
33 </PRE>
34 <P>
35 <PRE>  $colgroup = new FS::dbdef_colgroup ( $lol );
36   $colgroup = new FS::dbdef_colgroup (
37     [
38       [ 'single_column' ],
39       [ 'multiple_columns', 'another_column', ],
40     ]
41   );
42 </PRE>
43 <P>
44 <PRE>  @sql_lists = $colgroup-&gt;sql_list;
45 </PRE>
46 <P>
47 <PRE>  @singles = $colgroup-&gt;singles;
48 </PRE>
49 <P>
50 <HR>
51 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
52 <P>
53 FS::dbdef_colgroup objects represent sets of sets of columns.
54
55 <P>
56 <HR>
57 <H1><A NAME="METHODS">METHODS</A></H1>
58 <DL>
59 <DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
60 <P>
61 Creates a new FS::dbdef_colgroup object.
62
63 <DT><STRONG><A NAME="item_sql_list">sql_list</A></STRONG><DD>
64 <P>
65 Returns a flat list of comma-separated values, for SQL statements.
66
67 <DT><STRONG><A NAME="item_singles">singles</A></STRONG><DD>
68 <P>
69 Returns a flat list of all single item lists.
70
71 </DL>
72 <P>
73 <HR>
74 <H1><A NAME="BUGS">BUGS</A></H1>
75 <P>
76 <HR>
77 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
78 <P>
79 <A HREF="../FS/dbdef_table.html">FS::dbdef_table</A>, <A HREF="../FS/dbdef_unique.html">FS::dbdef_unique</A>, <A HREF="../FS/dbdef_index.html">FS::dbdef_index</A>,
80 <A HREF="../FS/dbdef_column.html">FS::dbdef_column</A>, <A HREF="../FS/dbdef.html">FS::dbdef</A>, <EM>perldsc</EM>
81
82
83
84 </BODY>
85
86 </HTML>