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

Revision 21, 14.9 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_CustomWritePanel</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_CustomWritePanel</h1>
62        <p style="margin: 0px;">Source Location: /RCCWP_CustomWritePanel.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 write panels.</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_CustomWritePanel.html#methodAssignToRole">AssignToRole</a></li>
96                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodCreate">Create</a></li>
97                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodDelete">Delete</a></li>
98                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodExport">Export</a></li>
99                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGet">Get</a></li>
100                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetAssignedCategories">GetAssignedCategories</a></li>
101                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetAssignedCategoryIds">GetAssignedCategoryIds</a></li>
102                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetCapabilityName">GetCapabilityName</a></li>
103                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetCustomGroups">GetCustomGroups</a></li>
104                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetCustomWritePanels">GetCustomWritePanels</a></li>
105                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetStandardFields">GetStandardFields</a></li>
106                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodImport">Import</a></li>
107                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodUpdate">Update</a></li>
108                        </ul>
109</div>
110
111<div id="content">
112<hr>
113        <div class="contents">
114        </div>
115
116        <div class="leftCol">
117        <h2>Inherited Variables</h2>
118                <h2>Inherited Constants</h2>
119                </div>
120
121        <div class="rightCol">
122        <h2>Inherited Methods</h2>
123                </div>
124        <br clear="all">
125        <hr>
126
127        <a name="class_details"></a>
128        <h2>Class Details</h2>
129        <p align="center"><strong>Create/edit/delete write panels.
130</strong></p>
131        <p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p>
132
133        <hr>
134        <a name="class_vars"></a>
135        <h2>Class Variables</h2>
136       
137        <hr>
138        <a name="class_methods"></a>
139        <h2>Class Methods</h2>
140       
141        <a name="methodAssignToRole"></a>
142        <p></p>
143        <h3>AssignToRole</h3>
144        <div class="indent">
145                <p>
146                <code>void AssignToRole(
147integer
148$customWritePanelId, string
149$roleName)</code>
150                </p>
151       
152                <p class="linenumber">[line 40]</p>
153                <p align="center"><strong>Assign a specified write panel to a role.
154</strong></p>
155               
156       
157        <h4>Parameters:</h4>
158        <ul>
159                        <li>
160                <span class="type">integer</span>
161                <b>$customWritePanelId</b> 
162                -
163                panel id</li>
164                        <li>
165                <span class="type">string</span>
166                <b>$roleName</b> 
167                -
168                role name (see roles in wordpress)</li>
169                </ul>
170        </div>
171        <p class="top">[ <a href="#top">Top</a> ]</p>
172        <a name="methodCreate"></a>
173        <p></p>
174        <h3>Create</h3>
175        <div class="indent">
176                <p>
177                <code>the Create(
178string
179$name, [string
180$description = ''], [array
181$standardFields = array()], [array
182$categories = array()], [integer
183$display_order = 1], [string
184$type = FALSE], [boolean
185$createDefaultGroup = true])</code>
186                </p>
187       
188                <p class="linenumber">[line 62]</p>
189                <p align="center"><strong>Create a new write panel.
190</strong></p>
191<h4>Tags:</h4>
192<ul>
193        <li><b>return</b> - id of the write panel</li>
194</ul>
195               
196       
197        <h4>Parameters:</h4>
198        <ul>
199                        <li>
200                <span class="type">string</span>
201                <b>$name</b> 
202                -
203                write panel name</li>
204                        <li>
205                <span class="type">string</span>
206                <b>$description</b> 
207                -
208                write panel description</li>
209                        <li>
210                <span class="type">array</span>
211                <b>$standardFields</b> 
212                -
213                a list of standard fields ids that are to be displayed in                              in the panel. Use $STANDARD_FIELDS defined in RCCWP_Constant.php</li>
214                        <li>
215                <span class="type">array</span>
216                <b>$categories</b> 
217                -
218                array of category ids that are checked by default when the user                              opens Write tab for that panel.</li>
219                        <li>
220                <span class="type">integer</span>
221                <b>$display_order</b> 
222                -
223                the order of the panel in Flutter &gt; Write Panels tab</li>
224                        <li>
225                <span class="type">string</span>
226                <b>$type</b> 
227                -
228                'post' or 'page'</li>
229                        <li>
230                <span class="type">boolean</span>
231                <b>$createDefaultGroup</b> 
232                -
233                indicates whether to create a default group.</li>
234                </ul>
235        </div>
236        <p class="top">[ <a href="#top">Top</a> ]</p>
237        <a name="methodDelete"></a>
238        <p></p>
239        <h3>Delete</h3>
240        <div class="indent">
241                <p>
242                <code>void Delete(
243[integer
244$customWritePanelId = null])</code>
245                </p>
246       
247                <p class="linenumber">[line 126]</p>
248                <p align="center"><strong>Delete a write panel without deleting its modules
249</strong></p>
250               
251       
252        <h4>Parameters:</h4>
253        <ul>
254                        <li>
255                <span class="type">integer</span>
256                <b>$customWritePanelId</b> 
257                -
258                write panel id</li>
259                </ul>
260        </div>
261        <p class="top">[ <a href="#top">Top</a> ]</p>
262        <a name="methodExport"></a>
263        <p></p>
264        <h3>Export</h3>
265        <div class="indent">
266                <p>
267                <code>void Export(
268integer
269$panelID, string
270$exportedFilename)</code>
271                </p>
272       
273                <p class="linenumber">[line 516]</p>
274                <p align="center"><strong>Export a write panel to file
275</strong></p>
276               
277       
278        <h4>Parameters:</h4>
279        <ul>
280                        <li>
281                <span class="type">integer</span>
282                <b>$panelID</b> 
283                -
284                </li>
285                        <li>
286                <span class="type">string</span>
287                <b>$exportedFilename</b> 
288                -
289                the full path of the file to which the panel will be exported</li>
290                </ul>
291        </div>
292        <p class="top">[ <a href="#top">Top</a> ]</p>
293        <a name="methodGet"></a>
294        <p></p>
295        <h3>Get</h3>
296        <div class="indent">
297                <p>
298                <code>an Get(
299unknown_type
300$customWritePanelId)</code>
301                </p>
302       
303                <p class="linenumber">[line 165]</p>
304                <p align="center"><strong>Get the properties of a write panel
305</strong></p>
306<h4>Tags:</h4>
307<ul>
308        <li><b>return</b> - object containing the properties of the write panel which are              id, name, description, display_order, capability_name, type</li>
309</ul>
310               
311       
312        <h4>Parameters:</h4>
313        <ul>
314                        <li>
315                <span class="type">unknown_type</span>
316                <b>$customWritePanelId</b> 
317                -
318                </li>
319                </ul>
320        </div>
321        <p class="top">[ <a href="#top">Top</a> ]</p>
322        <a name="methodGetAssignedCategories"></a>
323        <p></p>
324        <h3>GetAssignedCategories</h3>
325        <div class="indent">
326                <p>
327                <code>array GetAssignedCategories(
328integer
329$customWritePanelId)</code>
330                </p>
331       
332                <p class="linenumber">[line 201]</p>
333                <p align="center"><strong>Get a list of categories assigned to a write panel
334</strong></p>
335<h4>Tags:</h4>
336<ul>
337        <li><b>return</b> - of objects, each object contains cat_id and cat_name</li>
338</ul>
339               
340       
341        <h4>Parameters:</h4>
342        <ul>
343                        <li>
344                <span class="type">integer</span>
345                <b>$customWritePanelId</b> 
346                -
347                write panel id</li>
348                </ul>
349        </div>
350        <p class="top">[ <a href="#top">Top</a> ]</p>
351        <a name="methodGetAssignedCategoryIds"></a>
352        <p></p>
353        <h3>GetAssignedCategoryIds</h3>
354        <div class="indent">
355                <p>
356                <code>array GetAssignedCategoryIds(
357integer
358$customWritePanelId)</code>
359                </p>
360       
361                <p class="linenumber">[line 183]</p>
362                <p align="center"><strong>Get a list of the ids of teh categories assigned to  a write panel
363</strong></p>
364<h4>Tags:</h4>
365<ul>
366        <li><b>return</b> - of ids</li>
367</ul>
368               
369       
370        <h4>Parameters:</h4>
371        <ul>
372                        <li>
373                <span class="type">integer</span>
374                <b>$customWritePanelId</b> 
375                -
376                write panel id</li>
377                </ul>
378        </div>
379        <p class="top">[ <a href="#top">Top</a> ]</p>
380        <a name="methodGetCapabilityName"></a>
381        <p></p>
382        <h3>GetCapabilityName</h3>
383        <div class="indent">
384                <p>
385                <code>string GetCapabilityName(
386string
387$customWritePanelName)</code>
388                </p>
389       
390                <p class="linenumber">[line 240]</p>
391                <p align="center"><strong>Create a capability name for a write panel given its name. This function is  copied from WP's sanitize_title_with_dashes($title) (formatting.php)
392</strong></p>
393<h4>Tags:</h4>
394<ul>
395        <li><b>return</b> - capability name</li>
396</ul>
397               
398       
399        <h4>Parameters:</h4>
400        <ul>
401                        <li>
402                <span class="type">string</span>
403                <b>$customWritePanelName</b> 
404                -
405                panel name</li>
406                </ul>
407        </div>
408        <p class="top">[ <a href="#top">Top</a> ]</p>
409        <a name="methodGetCustomGroups"></a>
410        <p></p>
411        <h3>GetCustomGroups</h3>
412        <div class="indent">
413                <p>
414                <code>array GetCustomGroups(
415
416$customWritePanelId, integer
417$customWriteModuleId)</code>
418                </p>
419       
420                <p class="linenumber">[line 428]</p>
421                <p align="center"><strong>Retrieves the groups of a module
422</strong></p>
423<h4>Tags:</h4>
424<ul>
425        <li><b>return</b> - of objects representing basic information of the group,                  each object contains id, name and module_id</li>
426</ul>
427               
428       
429        <h4>Parameters:</h4>
430        <ul>
431                        <li>
432                <span class="type">integer</span>
433                <b>$customWriteModuleId</b> 
434                -
435                module id</li>
436                        <li>
437                <span class="type"></span>
438                <b>$customWritePanelId</b> 
439                -
440                </li>
441                </ul>
442        </div>
443        <p class="top">[ <a href="#top">Top</a> ]</p>
444        <a name="methodGetCustomWritePanels"></a>
445        <p></p>
446        <h3>GetCustomWritePanels</h3>
447        <div class="indent">
448                <p>
449                <code>array GetCustomWritePanels(
450)</code>
451                </p>
452       
453                <p class="linenumber">[line 20]</p>
454                <p align="center"><strong>Get all Write Panels.
455</strong></p>
456<h4>Tags:</h4>
457<ul>
458        <li><b>return</b> - of objects containing all write panels. Each object contains              id, name, description, display_order, capability_name, type, always_show</li>
459</ul>
460               
461       
462        <h4>Parameters:</h4>
463        <ul>
464                </ul>
465        </div>
466        <p class="top">[ <a href="#top">Top</a> ]</p>
467        <a name="methodGetStandardFields"></a>
468        <p></p>
469        <h3>GetStandardFields</h3>
470        <div class="indent">
471                <p>
472                <code>array GetStandardFields(
473integer
474$customWritePanelId)</code>
475                </p>
476       
477                <p class="linenumber">[line 281]</p>
478                <p align="center"><strong>Get a list of the standard fields of a the wrie panel
479</strong></p>
480<h4>Tags:</h4>
481<ul>
482        <li><b>return</b> - of ids of the standard fields (see $STANDARD_FIELDS defined in RCCWP_Constant.php)</li>
483</ul>
484               
485       
486        <h4>Parameters:</h4>
487        <ul>
488                        <li>
489                <span class="type">integer</span>
490                <b>$customWritePanelId</b> 
491                -
492                panel id</li>
493                </ul>
494        </div>
495        <p class="top">[ <a href="#top">Top</a> ]</p>
496        <a name="methodImport"></a>
497        <p></p>
498        <h3>Import</h3>
499        <div class="indent">
500                <p>
501                <code>the Import(
502string
503$panelFilePath, [string
504$writePanelName = false])</code>
505                </p>
506       
507                <p class="linenumber">[line 450]</p>
508                <p align="center"><strong>Import a write panel given the file path.
509</strong></p>
510<h4>Tags:</h4>
511<ul>
512        <li><b>return</b> - panel id, or false in case of error.</li>
513</ul>
514               
515       
516        <h4>Parameters:</h4>
517        <ul>
518                        <li>
519                <span class="type">string</span>
520                <b>$panelFilePath</b> 
521                -
522                the full path of the panel file</li>
523                        <li>
524                <span class="type">string</span>
525                <b>$writePanelName</b> 
526                -
527                the write panel name, if this value if false, the function will                              use the pnl filename as the write panel name. The default value is false</li>
528                </ul>
529        </div>
530        <p class="top">[ <a href="#top">Top</a> ]</p>
531        <a name="methodUpdate"></a>
532        <p></p>
533        <h3>Update</h3>
534        <div class="indent">
535                <p>
536                <code>void Update(
537integer
538$customWritePanelId, string
539$name, [string
540$description = ''], [array
541$standardFields = array()], [array
542$categories = array()], [integer
543$display_order = 1], string
544$type)</code>
545                </p>
546       
547                <p class="linenumber">[line 306]</p>
548                <p align="center"><strong>Updates the properties of a write panel
549</strong></p>
550               
551       
552        <h4>Parameters:</h4>
553        <ul>
554                        <li>
555                <span class="type">integer</span>
556                <b>$customWritePanelId</b> 
557                -
558                panel id</li>
559                        <li>
560                <span class="type">string</span>
561                <b>$name</b> 
562                -
563                write panel name</li>
564                        <li>
565                <span class="type">string</span>
566                <b>$description</b> 
567                -
568                write panel description</li>
569                        <li>
570                <span class="type">array</span>
571                <b>$standardFields</b> 
572                -
573                a list of standard fields ids that are to be displayed in                              in the panel. Use $STANDARD_FIELDS defined in RCCWP_Constant.php</li>
574                        <li>
575                <span class="type">array</span>
576                <b>$categories</b> 
577                -
578                array of category ids that are checked by default when the user                              opens Write tab for that panel.</li>
579                        <li>
580                <span class="type">integer</span>
581                <b>$display_order</b> 
582                -
583                the order of the panel in Flutter &gt; Write Panels tab</li>
584                        <li>
585                <span class="type">string</span>
586                <b>$type</b> 
587                -
588                'post' or 'page'</li>
589                </ul>
590        </div>
591        <p class="top">[ <a href="#top">Top</a> ]</p>
592
593        <hr>
594        <a name="class_consts"></a>
595        <h2>Class Constants</h2>
596        </div>
597        <div id="credit">
598                <hr>
599                Documentation generated on Tue, 09 Sep 2008 12:47:59 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
600        </div>
601</div>
602</body>
603</html>
Note: See TracBrowser for help on using the browser.