root/afridex/plugins/Flutter/docs/FlutterDatabaseObjects/RCCWP_CustomGroup.html @ 21

Revision 21, 7.7 kB (checked in by admin, 18 years ago)
RevLine 
[21]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4        <title>Docs For Class RCCWP_CustomGroup</title>
5        <link rel="stylesheet" type="text/css" id="layout" href="../media/layout.css" media="screen">
6        <link rel="stylesheet" type="text/css" href="../media/style.css" media="all">
7        <link rel="stylesheet" type="text/css" href="../media/print.css" media="print">
8</head>
9
10<body>
11<div id="header">
12        <div id="navLinks">
13       
14                                   
15                                        [ <a href="../classtrees_FlutterDatabaseObjects.html">Class Tree: FlutterDatabaseObjects</a> ]
16            [ <a href="../elementindex_FlutterDatabaseObjects.html">Index: FlutterDatabaseObjects</a> ]
17                        [ <a href="../elementindex.html">All elements</a> ]             
18        </div>
19        <div id="packagePosition">
20                <div id="packageTitle2">FlutterDatabaseObjects</div>
21                <div id="packageTitle">FlutterDatabaseObjects</div>
22                <div id="elementPath"> &middot; </div>
23        </div>
24</div>
25
26<div id="nav" class="small">
27        <div id="packages">
28                Packages:
29                                        <p><a href="../li_FlutterDatabaseObjects.html">FlutterDatabaseObjects</a></p>
30                        </div>
31
32                                <div id="index">
33                        <div id="files">
34                                                                Files:<br>
35                                                                <a href="../FlutterDatabaseObjects/_RCCWP_CustomField.php.html">                RCCWP_CustomField.php
36                </a><br>
37                        <a href="../FlutterDatabaseObjects/_RCCWP_CustomGroup.php.html">                RCCWP_CustomGroup.php
38                </a><br>
39                        <a href="../FlutterDatabaseObjects/_RCCWP_CustomWriteModule.php.html">          RCCWP_CustomWriteModule.php
40                </a><br>
41                        <a href="../FlutterDatabaseObjects/_RCCWP_CustomWritePanel.php.html">           RCCWP_CustomWritePanel.php
42                </a><br>
43                                </div>
44                        <div id="interfaces">
45                                                        </div>
46                        <div id="classes">
47                                Classes:<br>
48                                                                <a href="../FlutterDatabaseObjects/RCCWP_CustomField.html">             RCCWP_CustomField
49                </a><br>
50                        <a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html">             RCCWP_CustomGroup
51                </a><br>
52                        <a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html">               RCCWP_CustomWriteModule
53                </a><br>
54                        <a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html">                RCCWP_CustomWritePanel
55                </a><br>
56                                </div>
57                </div>
58        </div>
59
60<div id="body">
61                        <h1>Class: RCCWP_CustomGroup</h1>
62        <p style="margin: 0px;">Source Location: /RCCWP_CustomGroup.php</p>
63       
64
65<div class="leftcol">
66        <h3><a href="#class_details">Class Overview</a> <span class="smalllinenumber">[line 11]</span></h3>
67        <div id="classTree"><pre></pre>
68</div>
69        <div class="small">
70        <p>Create/Edit/Delete groups. Groups are just a collection of fields.</p>
71                <h4>Author(s):</h4>
72        <ul>
73                        </ul>
74        <h4>Version:</h4>
75        <ul>
76                        </ul>
77
78        <h4>Copyright:</h4>
79        <ul>
80                        </li>
81        </div>
82</div>
83
84<div class="middlecol">
85        <h3><a href="#class_vars">Variables</a></h3>
86        <ul class="small">
87                        </ul>
88        <h3><a href="#class_consts">Constants</a></h3>
89        <ul class="small">
90                        </ul>
91</div>
92<div class="rightcol">
93        <h3><a href="#class_methods">Methods</a></h3>
94        <ul class="small">
95                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodCreate">Create</a></li>
96                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodDelete">Delete</a></li>
97                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodGet">Get</a></li>
98                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodGetCustomFields">GetCustomFields</a></li>
99                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodUpdate">Update</a></li>
100                        </ul>
101</div>
102
103<div id="content">
104<hr>
105        <div class="contents">
106        </div>
107
108        <div class="leftCol">
109        <h2>Inherited Variables</h2>
110                <h2>Inherited Constants</h2>
111                </div>
112
113        <div class="rightCol">
114        <h2>Inherited Methods</h2>
115                </div>
116        <br clear="all">
117        <hr>
118
119        <a name="class_details"></a>
120        <h2>Class Details</h2>
121        <p align="center"><strong>Create/Edit/Delete groups. Groups are just a collection of fields.
122</strong></p>
123        <p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p>
124
125        <hr>
126        <a name="class_vars"></a>
127        <h2>Class Variables</h2>
128       
129        <hr>
130        <a name="class_methods"></a>
131        <h2>Class Methods</h2>
132       
133        <a name="methodCreate"></a>
134        <p></p>
135        <h3>Create</h3>
136        <div class="indent">
137                <p>
138                <code>the Create(
139unknown_type
140$customWritePanelId, unknown_type
141$name, unknown_type
142$duplicate, unknown_type
143$at_right)</code>
144                </p>
145       
146                <p class="linenumber">[line 23]</p>
147                <p align="center"><strong>Create a new group in a write panel
148</strong></p>
149<h4>Tags:</h4>
150<ul>
151        <li><b>return</b> - id of the new group</li>
152</ul>
153               
154       
155        <h4>Parameters:</h4>
156        <ul>
157                        <li>
158                <span class="type">unknown_type</span>
159                <b>$customWritePanelId</b> 
160                -
161                </li>
162                        <li>
163                <span class="type">unknown_type</span>
164                <b>$name</b> 
165                -
166                group name</li>
167                        <li>
168                <span class="type">unknown_type</span>
169                <b>$duplicate</b> 
170                -
171                a boolean indicating whether the group can be duplicated</li>
172                        <li>
173                <span class="type">unknown_type</span>
174                <b>$at_right</b> 
175                -
176                a boolean indicating whether the group should be placed at right side.</li>
177                </ul>
178        </div>
179        <p class="top">[ <a href="#top">Top</a> ]</p>
180        <a name="methodDelete"></a>
181        <p></p>
182        <h3>Delete</h3>
183        <div class="indent">
184                <p>
185                <code>void Delete(
186[integer
187$customGroupId = null])</code>
188                </p>
189       
190                <p class="linenumber">[line 46]</p>
191                <p align="center"><strong>Delete a group given id
192</strong></p>
193               
194       
195        <h4>Parameters:</h4>
196        <ul>
197                        <li>
198                <span class="type">integer</span>
199                <b>$customGroupId</b> 
200                -
201                </li>
202                </ul>
203        </div>
204        <p class="top">[ <a href="#top">Top</a> ]</p>
205        <a name="methodGet"></a>
206        <p></p>
207        <h3>Get</h3>
208        <div class="indent">
209                <p>
210                <code>an Get(
211integer
212$groupId)</code>
213                </p>
214       
215                <p class="linenumber">[line 75]</p>
216                <p align="center"><strong>Get group properties
217</strong></p>
218<h4>Tags:</h4>
219<ul>
220        <li><b>return</b> - object representing the group</li>
221</ul>
222               
223       
224        <h4>Parameters:</h4>
225        <ul>
226                        <li>
227                <span class="type">integer</span>
228                <b>$groupId</b> 
229                -
230                </li>
231                </ul>
232        </div>
233        <p class="top">[ <a href="#top">Top</a> ]</p>
234        <a name="methodGetCustomFields"></a>
235        <p></p>
236        <h3>GetCustomFields</h3>
237        <div class="indent">
238                <p>
239                <code>an GetCustomFields(
240integer
241$customGroupId)</code>
242                </p>
243       
244                <p class="linenumber">[line 92]</p>
245                <p align="center"><strong>Get a list of the custom fields of a group
246</strong></p>
247<h4>Tags:</h4>
248<ul>
249        <li><b>return</b> - array of objects containing information about fields. Each object contains              3 objects: properties, options and default_value</li>
250</ul>
251               
252       
253        <h4>Parameters:</h4>
254        <ul>
255                        <li>
256                <span class="type">integer</span>
257                <b>$customGroupId</b> 
258                -
259                the group id</li>
260                </ul>
261        </div>
262        <p class="top">[ <a href="#top">Top</a> ]</p>
263        <a name="methodUpdate"></a>
264        <p></p>
265        <h3>Update</h3>
266        <div class="indent">
267                <p>
268                <code>void Update(
269
270$customGroupId, unknown_type
271$name, unknown_type
272$duplicate, unknown_type
273$at_right, unknown_type
274$customWritePanelId)</code>
275                </p>
276       
277                <p class="linenumber">[line 123]</p>
278                <p align="center"><strong>Update the group
279</strong></p>
280               
281       
282        <h4>Parameters:</h4>
283        <ul>
284                        <li>
285                <span class="type">unknown_type</span>
286                <b>$customWritePanelId</b> 
287                -
288                </li>
289                        <li>
290                <span class="type">unknown_type</span>
291                <b>$name</b> 
292                -
293                group name</li>
294                        <li>
295                <span class="type">unknown_type</span>
296                <b>$duplicate</b> 
297                -
298                a boolean indicating whether the group can be duplicated</li>
299                        <li>
300                <span class="type">unknown_type</span>
301                <b>$at_right</b> 
302                -
303                a boolean indicating whether the group should be placed at right side.</li>
304                        <li>
305                <span class="type"></span>
306                <b>$customGroupId</b> 
307                -
308                </li>
309                </ul>
310        </div>
311        <p class="top">[ <a href="#top">Top</a> ]</p>
312
313        <hr>
314        <a name="class_consts"></a>
315        <h2>Class Constants</h2>
316        </div>
317        <div id="credit">
318                <hr>
319                Documentation generated on Tue, 09 Sep 2008 12:47:59 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
320        </div>
321</div>
322</body>
323</html>
Note: See TracBrowser for help on using the browser.