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

Revision 21, 14.0 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_CustomField</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_CustomField</h1>
62        <p style="margin: 0px;">Source Location: /RCCWP_CustomField.php</p>
63       
64
65<div class="leftcol">
66        <h3><a href="#class_details">Class Overview</a> <span class="smalllinenumber">[line 12]</span></h3>
67        <div id="classTree"><pre></pre>
68</div>
69        <div class="small">
70        <p>Create/Edit/Delete custom 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_CustomField.html#methodCreate">Create</a></li>
96                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodDelete">Delete</a></li>
97                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodGet">Get</a></li>
98                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetCustomFieldTypes">GetCustomFieldTypes</a></li>
99                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetCustomFieldValues">GetCustomFieldValues</a></li>
100                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetFieldDuplicates">GetFieldDuplicates</a></li>
101                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetFieldGroupDuplicates">GetFieldGroupDuplicates</a></li>
102                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetIDByName">GetIDByName</a></li>
103                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomField.html#methodUpdate">Update</a></li>
104                        </ul>
105</div>
106
107<div id="content">
108<hr>
109        <div class="contents">
110        </div>
111
112        <div class="leftCol">
113        <h2>Inherited Variables</h2>
114                <h2>Inherited Constants</h2>
115                </div>
116
117        <div class="rightCol">
118        <h2>Inherited Methods</h2>
119                </div>
120        <br clear="all">
121        <hr>
122
123        <a name="class_details"></a>
124        <h2>Class Details</h2>
125        <p align="center"><strong>Create/Edit/Delete custom fields
126</strong></p>
127        <p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p>
128
129        <hr>
130        <a name="class_vars"></a>
131        <h2>Class Variables</h2>
132       
133        <hr>
134        <a name="class_methods"></a>
135        <h2>Class Methods</h2>
136       
137        <a name="methodCreate"></a>
138        <p></p>
139        <h3>Create</h3>
140        <div class="indent">
141                <p>
142                <code>the Create(
143id
144$customGroupId, string
145$name, string
146$label, [integer
147$order = 1], [integer
148$required_field = 0], integer
149$type, [array
150$options = null], [array
151$default_value = null], [array
152$properties = null],
153$duplicate)</code>
154                </p>
155       
156                <p class="linenumber">[line 35]</p>
157                <p align="center"><strong>Create a new custom field
158</strong></p>
159<h4>Tags:</h4>
160<ul>
161        <li><b>return</b> - new field id</li>
162</ul>
163               
164       
165        <h4>Parameters:</h4>
166        <ul>
167                        <li>
168                <span class="type">id</span>
169                <b>$customGroupId</b> 
170                -
171                the id of the group that will contain the field</li>
172                        <li>
173                <span class="type">string</span>
174                <b>$name</b> 
175                -
176                the name of the field, the name is used to uniquely identify the field                              when retrieving its value.</li>
177                        <li>
178                <span class="type">string</span>
179                <b>$label</b> 
180                -
181                the label of the field, the label is displayed beside the field                              in Write tab.</li>
182                        <li>
183                <span class="type">integer</span>
184                <b>$order</b> 
185                -
186                the order of the field when it is displayed in                              the Write tab.</li>
187                        <li>
188                <span class="type">integer</span>
189                <b>$required_field</b> 
190                -
191                whether this field is a required field. Required fields                              doesn't allow users to save a post if they are null.</li>
192                        <li>
193                <span class="type">integer</span>
194                <b>$type</b> 
195                -
196                the type of the field. Use $FIELD_TYPES defined in RCCWP_Constant.php</li>
197                        <li>
198                <span class="type">array</span>
199                <b>$options</b> 
200                -
201                array of strings that represent the list of the field if                              its type is list.</li>
202                        <li>
203                <span class="type">array</span>
204                <b>$default_value</b> 
205                -
206                array of strings that represent default value(s) of                              of the field if    its type is list.</li>
207                        <li>
208                <span class="type">array</span>
209                <b>$properties</b> 
210                -
211                an array containing extra properties of the field.</li>
212                        <li>
213                <span class="type"></span>
214                <b>$duplicate</b> 
215                -
216                </li>
217                </ul>
218        </div>
219        <p class="top">[ <a href="#top">Top</a> ]</p>
220        <a name="methodDelete"></a>
221        <p></p>
222        <h3>Delete</h3>
223        <div class="indent">
224                <p>
225                <code>void Delete(
226[integer
227$customFieldId = null])</code>
228                </p>
229       
230                <p class="linenumber">[line 107]</p>
231                <p align="center"><strong>Delete a field
232</strong></p>
233               
234       
235        <h4>Parameters:</h4>
236        <ul>
237                        <li>
238                <span class="type">integer</span>
239                <b>$customFieldId</b> 
240                -
241                field id</li>
242                </ul>
243        </div>
244        <p class="top">[ <a href="#top">Top</a> ]</p>
245        <a name="methodGet"></a>
246        <p></p>
247        <h3>Get</h3>
248        <div class="indent">
249                <p>
250                <code>an Get(
251integer
252$customFieldId)</code>
253                </p>
254       
255                <p class="linenumber">[line 138]</p>
256                <p align="center"><strong>Get the field information including properties, options and default value(s)
257</strong></p>
258<h4>Tags:</h4>
259<ul>
260        <li><b>return</b> - object containing information about fields. The object contains              3 objects: properties, options and default_value</li>
261</ul>
262               
263       
264        <h4>Parameters:</h4>
265        <ul>
266                        <li>
267                <span class="type">integer</span>
268                <b>$customFieldId</b> 
269                -
270                field id</li>
271                </ul>
272        </div>
273        <p class="top">[ <a href="#top">Top</a> ]</p>
274        <a name="methodGetCustomFieldTypes"></a>
275        <p></p>
276        <h3>GetCustomFieldTypes</h3>
277        <div class="indent">
278                <p>
279                <code>a GetCustomFieldTypes(
280[integer
281$customFieldTypeId = null])</code>
282                </p>
283       
284                <p class="linenumber">[line 162]</p>
285                <p align="center"><strong>Retrievies information about a specified type
286</strong></p>
287<h4>Tags:</h4>
288<ul>
289        <li><b>return</b> - list/object containing information about the specified type. The information              includes id, name, description, has_options, has_properties, and              allow_multiple_values (whether fields of that type can have more than one default value)</li>
290</ul>
291               
292       
293        <h4>Parameters:</h4>
294        <ul>
295                        <li>
296                <span class="type">integer</span>
297                <b>$customFieldTypeId</b> 
298                -
299                the type id, if null, a list of all types will be returned</li>
300                </ul>
301        </div>
302        <p class="top">[ <a href="#top">Top</a> ]</p>
303        <a name="methodGetCustomFieldValues"></a>
304        <p></p>
305        <h3>GetCustomFieldValues</h3>
306        <div class="indent">
307                <p>
308                <code>a GetCustomFieldValues(
309boolean
310$single, integer
311$postId, string
312$customFieldName, [integer
313$groupIndex = 1], [integer
314$fieldIndex = 1])</code>
315                </p>
316       
317                <p class="linenumber">[line 214]</p>
318                <p align="center"><strong>Retrieves the value of a custom field for a specified post
319</strong></p>
320               
321       
322        <h4>Parameters:</h4>
323        <ul>
324                        <li>
325                <span class="type">boolean</span>
326                <b>$single</b> 
327                -
328                </li>
329                        <li>
330                <span class="type">integer</span>
331                <b>$postId</b> 
332                -
333                </li>
334                        <li>
335                <span class="type">string</span>
336                <b>$customFieldName</b> 
337                -
338                </li>
339                        <li>
340                <span class="type">integer</span>
341                <b>$groupIndex</b> 
342                -
343                </li>
344                        <li>
345                <span class="type">integer</span>
346                <b>$fieldIndex</b> 
347                -
348                </li>
349                </ul>
350        </div>
351        <p class="top">[ <a href="#top">Top</a> ]</p>
352        <a name="methodGetFieldDuplicates"></a>
353        <p></p>
354        <h3>GetFieldDuplicates</h3>
355        <div class="indent">
356                <p>
357                <code>number GetFieldDuplicates(
358integer
359$postId,
360$fieldName,
361$groupIndex, integer
362$fieldID)</code>
363                </p>
364       
365                <p class="linenumber">[line 262]</p>
366                <p align="center"><strong>Get number of group duplicates given field name. The function returns 1  if there are no duplicates (just he original group), 2 if there is one  duplicate and so on.
367</strong></p>
368<h4>Tags:</h4>
369<ul>
370        <li><b>return</b> - of groups</li>
371</ul>
372               
373       
374        <h4>Parameters:</h4>
375        <ul>
376                        <li>
377                <span class="type">integer</span>
378                <b>$postId</b> 
379                -
380                post id</li>
381                        <li>
382                <span class="type">integer</span>
383                <b>$fieldID</b> 
384                -
385                the name of any field in the group</li>
386                        <li>
387                <span class="type"></span>
388                <b>$fieldName</b> 
389                -
390                </li>
391                        <li>
392                <span class="type"></span>
393                <b>$groupIndex</b> 
394                -
395                </li>
396                </ul>
397        </div>
398        <p class="top">[ <a href="#top">Top</a> ]</p>
399        <a name="methodGetFieldGroupDuplicates"></a>
400        <p></p>
401        <h3>GetFieldGroupDuplicates</h3>
402        <div class="indent">
403                <p>
404                <code>number GetFieldGroupDuplicates(
405integer
406$postId,
407$fieldName, integer
408$fieldID)</code>
409                </p>
410       
411                <p class="linenumber">[line 246]</p>
412                <p align="center"><strong>Get number of group duplicates given field name. The function returns 1  if there are no duplicates (just he original group), 2 if there is one  duplicate and so on.
413</strong></p>
414<h4>Tags:</h4>
415<ul>
416        <li><b>return</b> - of groups</li>
417</ul>
418               
419       
420        <h4>Parameters:</h4>
421        <ul>
422                        <li>
423                <span class="type">integer</span>
424                <b>$postId</b> 
425                -
426                post id</li>
427                        <li>
428                <span class="type">integer</span>
429                <b>$fieldID</b> 
430                -
431                the name of any field in the group</li>
432                        <li>
433                <span class="type"></span>
434                <b>$fieldName</b> 
435                -
436                </li>
437                </ul>
438        </div>
439        <p class="top">[ <a href="#top">Top</a> ]</p>
440        <a name="methodGetIDByName"></a>
441        <p></p>
442        <h3>GetIDByName</h3>
443        <div class="indent">
444                <p>
445                <code>custom GetIDByName(
446string
447$customFieldName)</code>
448                </p>
449       
450                <p class="linenumber">[line 275]</p>
451                <p align="center"><strong>Retrieves the id of a custom field given field name for the current post.
452</strong></p>
453<h4>Tags:</h4>
454<ul>
455        <li><b>return</b> - field id</li>
456</ul>
457               
458       
459        <h4>Parameters:</h4>
460        <ul>
461                        <li>
462                <span class="type">string</span>
463                <b>$customFieldName</b> 
464                -
465                </li>
466                </ul>
467        </div>
468        <p class="top">[ <a href="#top">Top</a> ]</p>
469        <a name="methodUpdate"></a>
470        <p></p>
471        <h3>Update</h3>
472        <div class="indent">
473                <p>
474                <code>void Update(
475integer
476$customFieldId, string
477$name, string
478$label, [integer
479$order = 1], [integer
480$required_field = 0], integer
481$type, [array
482$options = null], [array
483$default_value = null], [array
484$properties = null],
485$duplicate)</code>
486                </p>
487       
488                <p class="linenumber">[line 320]</p>
489                <p align="center"><strong>Updates the properties of a custom field.
490</strong></p>
491               
492       
493        <h4>Parameters:</h4>
494        <ul>
495                        <li>
496                <span class="type">integer</span>
497                <b>$customFieldId</b> 
498                -
499                the id of the field to be updated</li>
500                        <li>
501                <span class="type">string</span>
502                <b>$name</b> 
503                -
504                the name of the field, the name is used to uniquely identify the field                              when retrieving its value.</li>
505                        <li>
506                <span class="type">string</span>
507                <b>$label</b> 
508                -
509                the label of the field, the label is displayed beside the field                              in Write tab.</li>
510                        <li>
511                <span class="type">integer</span>
512                <b>$order</b> 
513                -
514                the order of the field when it is displayed in                              the Write tab.</li>
515                        <li>
516                <span class="type">integer</span>
517                <b>$required_field</b> 
518                -
519                whether this field is a required field. Required fields                              doesn't allow users to save a post if they are null.</li>
520                        <li>
521                <span class="type">integer</span>
522                <b>$type</b> 
523                -
524                the type of the field. Use $FIELD_TYPES defined in RCCWP_Constant.php</li>
525                        <li>
526                <span class="type">array</span>
527                <b>$options</b> 
528                -
529                array of strings that represent the list of the field if                              its type is list.</li>
530                        <li>
531                <span class="type">array</span>
532                <b>$default_value</b> 
533                -
534                array of strings that represent default value(s) of                              of the field if    its type is list.</li>
535                        <li>
536                <span class="type">array</span>
537                <b>$properties</b> 
538                -
539                an array containing extra properties of the field.</li>
540                        <li>
541                <span class="type"></span>
542                <b>$duplicate</b> 
543                -
544                </li>
545                </ul>
546        </div>
547        <p class="top">[ <a href="#top">Top</a> ]</p>
548
549        <hr>
550        <a name="class_consts"></a>
551        <h2>Class Constants</h2>
552        </div>
553        <div id="credit">
554                <hr>
555                Documentation generated on Tue, 09 Sep 2008 12:47:59 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
556        </div>
557</div>
558</body>
559</html>
Note: See TracBrowser for help on using the browser.