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

Revision 21, 9.1 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_CustomWriteModule</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_CustomWriteModule</h1>
62        <p style="margin: 0px;">Source Location: /RCCWP_CustomWriteModule.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 modules</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_CustomWriteModule.html#methodCreate">Create</a></li>
96                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodDelete">Delete</a></li>
97                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodGet">Get</a></li>
98                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodGetByName">GetByName</a></li>
99                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodGetCustomModules">GetCustomModules</a></li>
100                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodImport">Import</a></li>
101                                <li><a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodUpdate">Update</a></li>
102                        </ul>
103</div>
104
105<div id="content">
106<hr>
107        <div class="contents">
108        </div>
109
110        <div class="leftCol">
111        <h2>Inherited Variables</h2>
112                <h2>Inherited Constants</h2>
113                </div>
114
115        <div class="rightCol">
116        <h2>Inherited Methods</h2>
117                </div>
118        <br clear="all">
119        <hr>
120
121        <a name="class_details"></a>
122        <h2>Class Details</h2>
123        <p align="center"><strong>Create/edit/delete modules
124</strong></p>
125        <p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p>
126
127        <hr>
128        <a name="class_vars"></a>
129        <h2>Class Variables</h2>
130       
131        <hr>
132        <a name="class_methods"></a>
133        <h2>Class Methods</h2>
134       
135        <a name="methodCreate"></a>
136        <p></p>
137        <h3>Create</h3>
138        <div class="indent">
139                <p>
140                <code>the Create(
141string
142$name, string
143$description, [boolean
144$create_folders = true])</code>
145                </p>
146       
147                <p class="linenumber">[line 44]</p>
148                <p align="center"><strong>Create a new module
149</strong></p>
150<h4>Tags:</h4>
151<ul>
152        <li><b>return</b> - id of the module or -1 if the module name already exist</li>
153</ul>
154               
155       
156        <h4>Parameters:</h4>
157        <ul>
158                        <li>
159                <span class="type">string</span>
160                <b>$name</b> 
161                -
162                module name, the name will be sanitized.</li>
163                        <li>
164                <span class="type">string</span>
165                <b>$description</b> 
166                -
167                module description</li>
168                        <li>
169                <span class="type">boolean</span>
170                <b>$create_folders</b> 
171                -
172                whether to create a folder for the module containing sample template</li>
173                </ul>
174        </div>
175        <p class="top">[ <a href="#top">Top</a> ]</p>
176        <a name="methodDelete"></a>
177        <p></p>
178        <h3>Delete</h3>
179        <div class="indent">
180                <p>
181                <code>void Delete(
182[integer
183$customWriteModuleId = null])</code>
184                </p>
185       
186                <p class="linenumber">[line 148]</p>
187                <p align="center"><strong>Deletes a module and all its child fields as well as the module folder.
188</strong></p>
189               
190       
191        <h4>Parameters:</h4>
192        <ul>
193                        <li>
194                <span class="type">integer</span>
195                <b>$customWriteModuleId</b> 
196                -
197                module id.</li>
198                </ul>
199        </div>
200        <p class="top">[ <a href="#top">Top</a> ]</p>
201        <a name="methodGet"></a>
202        <p></p>
203        <h3>Get</h3>
204        <div class="indent">
205                <p>
206                <code>an Get(
207integer
208$customWriteModuleId)</code>
209                </p>
210       
211                <p class="linenumber">[line 209]</p>
212                <p align="center"><strong>Retrieves the basic information of the module.
213</strong></p>
214<h4>Tags:</h4>
215<ul>
216        <li><b>return</b> - object containing id, name and description</li>
217</ul>
218               
219       
220        <h4>Parameters:</h4>
221        <ul>
222                        <li>
223                <span class="type">integer</span>
224                <b>$customWriteModuleId</b> 
225                -
226                module id</li>
227                </ul>
228        </div>
229        <p class="top">[ <a href="#top">Top</a> ]</p>
230        <a name="methodGetByName"></a>
231        <p></p>
232        <h3>GetByName</h3>
233        <div class="indent">
234                <p>
235                <code>an GetByName(
236string
237$customWriteModuleName)</code>
238                </p>
239       
240                <p class="linenumber">[line 227]</p>
241                <p align="center"><strong>Retrieves the basic information of the module given module name.
242</strong></p>
243<h4>Tags:</h4>
244<ul>
245        <li><b>return</b> - object containing id, name and description</li>
246</ul>
247               
248       
249        <h4>Parameters:</h4>
250        <ul>
251                        <li>
252                <span class="type">string</span>
253                <b>$customWriteModuleName</b> 
254                -
255                module name</li>
256                </ul>
257        </div>
258        <p class="top">[ <a href="#top">Top</a> ]</p>
259        <a name="methodGetCustomModules"></a>
260        <p></p>
261        <h3>GetCustomModules</h3>
262        <div class="indent">
263                <p>
264                <code>array GetCustomModules(
265)</code>
266                </p>
267       
268                <p class="linenumber">[line 20]</p>
269                <p align="center"><strong>Get all modules
270</strong></p>
271<h4>Tags:</h4>
272<ul>
273        <li><b>return</b> - of objects containing all modules.</li>
274</ul>
275               
276       
277        <h4>Parameters:</h4>
278        <ul>
279                </ul>
280        </div>
281        <p class="top">[ <a href="#top">Top</a> ]</p>
282        <a name="methodImport"></a>
283        <p></p>
284        <h3>Import</h3>
285        <div class="indent">
286                <p>
287                <code>the Import(
288string
289$zipFilePath, [string
290$moduleName = false])</code>
291                </p>
292       
293                <p class="linenumber">[line 301]</p>
294                <p align="center"><strong>Import a module given the zip file path. Importing a module means inserting it in  the database and copying its folder to modules folder. If a module with the same  name already exists, the function will append a number to the module name. You must  have either php ZipArchive extension or unzip program installed.
295</strong></p>
296<h4>Tags:</h4>
297<ul>
298        <li><b>return</b> - module id, or false in case of error.</li>
299</ul>
300               
301       
302        <h4>Parameters:</h4>
303        <ul>
304                        <li>
305                <span class="type">string</span>
306                <b>$zipFilePath</b> 
307                -
308                the full path of the zip file</li>
309                        <li>
310                <span class="type">string</span>
311                <b>$moduleName</b> 
312                -
313                the module name, if this value if false, the function will                              use the zip filename as the module name. The default value is false</li>
314                </ul>
315        </div>
316        <p class="top">[ <a href="#top">Top</a> ]</p>
317        <a name="methodUpdate"></a>
318        <p></p>
319        <h3>Update</h3>
320        <div class="indent">
321                <p>
322                <code>the Update(
323integer
324$customWriteModuleId, string
325$name, string
326$description)</code>
327                </p>
328       
329                <p class="linenumber">[line 248]</p>
330                <p align="center"><strong>Updates the basic information of a module
331</strong></p>
332<h4>Tags:</h4>
333<ul>
334        <li><b>return</b> - id of the module or -1 if the module name already exist</li>
335</ul>
336               
337       
338        <h4>Parameters:</h4>
339        <ul>
340                        <li>
341                <span class="type">integer</span>
342                <b>$customWriteModuleId</b> 
343                -
344                the id of the module that will be updated</li>
345                        <li>
346                <span class="type">string</span>
347                <b>$name</b> 
348                -
349                new name</li>
350                        <li>
351                <span class="type">string</span>
352                <b>$description</b> 
353                -
354                new description</li>
355                </ul>
356        </div>
357        <p class="top">[ <a href="#top">Top</a> ]</p>
358
359        <hr>
360        <a name="class_consts"></a>
361        <h2>Class Constants</h2>
362        </div>
363        <div id="credit">
364                <hr>
365                Documentation generated on Tue, 09 Sep 2008 12:47:59 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
366        </div>
367</div>
368</body>
369</html>
Note: See TracBrowser for help on using the browser.