root/afridex/plugins/Flutter/docs/elementindex.html

Revision 21, 13.4 kB (checked in by admin, 18 years ago)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4        <title>Element Index</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                                                [ <a href="elementindex.html">All elements</a> ]               
15        </div>
16        <div id="packagePosition">
17                <div id="packageTitle2"></div>
18                <div id="packageTitle"></div>
19                <div id="elementPath"> &middot; </div>
20        </div>
21</div>
22
23<div id="nav" class="small">
24        <div id="packages">
25                Packages:
26                                        <p><a href="li_FlutterDatabaseObjects.html">FlutterDatabaseObjects</a></p>
27                        </div>
28
29                </div>
30
31<div id="body">
32                <a name="top"></a>
33<h1>Index of All Elements</h1>
34        <a href="elementindex.html#a">a</a>
35        <a href="elementindex.html#c">c</a>
36        <a href="elementindex.html#d">d</a>
37        <a href="elementindex.html#e">e</a>
38        <a href="elementindex.html#g">g</a>
39        <a href="elementindex.html#i">i</a>
40        <a href="elementindex.html#r">r</a>
41        <a href="elementindex.html#u">u</a>
42
43        <a name="a"></a>
44        <a href="elementindex.html#top">top</a><br>
45        <div>
46                <h2>a</h2>
47                <dl class="lettercontents">
48                                                        <dt>AssignToRole</dt>
49                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodAssignToRole">RCCWP_CustomWritePanel::AssignToRole()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Assign a specified write panel to a role.</dd>
50                                        </dl>
51        </div>
52        <a name="c"></a>
53        <a href="elementindex.html#top">top</a><br>
54        <div>
55                <h2>c</h2>
56                <dl class="lettercontents">
57                                                        <dt>Create</dt>
58                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodCreate">RCCWP_CustomWritePanel::Create()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create a new write panel.</dd>
59                                                        <dt>Create</dt>
60                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodCreate">RCCWP_CustomWriteModule::Create()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create a new module</dd>
61                                                        <dt>Create</dt>
62                                <dd>in file RCCWP_CustomGroup.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodCreate">RCCWP_CustomGroup::Create()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create a new group in a write panel</dd>
63                                                        <dt>Create</dt>
64                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodCreate">RCCWP_CustomField::Create()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create a new custom field</dd>
65                                        </dl>
66        </div>
67        <a name="d"></a>
68        <a href="elementindex.html#top">top</a><br>
69        <div>
70                <h2>d</h2>
71                <dl class="lettercontents">
72                                                        <dt>Delete</dt>
73                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodDelete">RCCWP_CustomWritePanel::Delete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Delete a write panel without deleting its modules</dd>
74                                                        <dt>Delete</dt>
75                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodDelete">RCCWP_CustomWriteModule::Delete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Deletes a module and all its child fields as well as the module folder.</dd>
76                                                        <dt>Delete</dt>
77                                <dd>in file RCCWP_CustomGroup.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodDelete">RCCWP_CustomGroup::Delete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Delete a group given id</dd>
78                                                        <dt>Delete</dt>
79                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodDelete">RCCWP_CustomField::Delete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Delete a field</dd>
80                                        </dl>
81        </div>
82        <a name="e"></a>
83        <a href="elementindex.html#top">top</a><br>
84        <div>
85                <h2>e</h2>
86                <dl class="lettercontents">
87                                                        <dt>Export</dt>
88                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodExport">RCCWP_CustomWritePanel::Export()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Export a write panel to file</dd>
89                                        </dl>
90        </div>
91        <a name="g"></a>
92        <a href="elementindex.html#top">top</a><br>
93        <div>
94                <h2>g</h2>
95                <dl class="lettercontents">
96                                                        <dt>Get</dt>
97                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodGet">RCCWP_CustomField::Get()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get the field information including properties, options and default value(s)</dd>
98                                                        <dt>Get</dt>
99                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGet">RCCWP_CustomWritePanel::Get()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get the properties of a write panel</dd>
100                                                        <dt>Get</dt>
101                                <dd>in file RCCWP_CustomGroup.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodGet">RCCWP_CustomGroup::Get()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get group properties</dd>
102                                                        <dt>Get</dt>
103                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodGet">RCCWP_CustomWriteModule::Get()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the basic information of the module.</dd>
104                                                        <dt>GetAssignedCategories</dt>
105                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetAssignedCategories">RCCWP_CustomWritePanel::GetAssignedCategories()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get a list of categories assigned to a write panel</dd>
106                                                        <dt>GetAssignedCategoryIds</dt>
107                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetAssignedCategoryIds">RCCWP_CustomWritePanel::GetAssignedCategoryIds()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get a list of the ids of teh categories assigned to  a write panel</dd>
108                                                        <dt>GetByName</dt>
109                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodGetByName">RCCWP_CustomWriteModule::GetByName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the basic information of the module given module name.</dd>
110                                                        <dt>GetCapabilityName</dt>
111                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetCapabilityName">RCCWP_CustomWritePanel::GetCapabilityName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;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)</dd>
112                                                        <dt>GetCustomFields</dt>
113                                <dd>in file RCCWP_CustomGroup.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodGetCustomFields">RCCWP_CustomGroup::GetCustomFields()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get a list of the custom fields of a group</dd>
114                                                        <dt>GetCustomFieldTypes</dt>
115                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetCustomFieldTypes">RCCWP_CustomField::GetCustomFieldTypes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrievies information about a specified type</dd>
116                                                        <dt>GetCustomFieldValues</dt>
117                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetCustomFieldValues">RCCWP_CustomField::GetCustomFieldValues()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the value of a custom field for a specified post</dd>
118                                                        <dt>GetCustomGroups</dt>
119                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetCustomGroups">RCCWP_CustomWritePanel::GetCustomGroups()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the groups of a module</dd>
120                                                        <dt>GetCustomModules</dt>
121                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodGetCustomModules">RCCWP_CustomWriteModule::GetCustomModules()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get all modules</dd>
122                                                        <dt>GetCustomWritePanels</dt>
123                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetCustomWritePanels">RCCWP_CustomWritePanel::GetCustomWritePanels()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get all Write Panels.</dd>
124                                                        <dt>GetFieldDuplicates</dt>
125                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetFieldDuplicates">RCCWP_CustomField::GetFieldDuplicates()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;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.</dd>
126                                                        <dt>GetFieldGroupDuplicates</dt>
127                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetFieldGroupDuplicates">RCCWP_CustomField::GetFieldGroupDuplicates()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;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.</dd>
128                                                        <dt>GetIDByName</dt>
129                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodGetIDByName">RCCWP_CustomField::GetIDByName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the id of a custom field given field name for the current post.</dd>
130                                                        <dt>GetStandardFields</dt>
131                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodGetStandardFields">RCCWP_CustomWritePanel::GetStandardFields()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get a list of the standard fields of a the wrie panel</dd>
132                                        </dl>
133        </div>
134        <a name="i"></a>
135        <a href="elementindex.html#top">top</a><br>
136        <div>
137                <h2>i</h2>
138                <dl class="lettercontents">
139                                                        <dt>Import</dt>
140                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodImport">RCCWP_CustomWritePanel::Import()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Import a write panel given the file path.</dd>
141                                                        <dt>Import</dt>
142                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodImport">RCCWP_CustomWriteModule::Import()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;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.</dd>
143                                        </dl>
144        </div>
145        <a name="r"></a>
146        <a href="elementindex.html#top">top</a><br>
147        <div>
148                <h2>r</h2>
149                <dl class="lettercontents">
150                                                        <dt>RCCWP_CustomField</dt>
151                                <dd>in file RCCWP_CustomField.php, class <a href="FlutterDatabaseObjects/RCCWP_CustomField.html">RCCWP_CustomField</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create/Edit/Delete custom fields</dd>
152                                                        <dt>RCCWP_CustomField.php</dt>
153                                <dd>procedural page <a href="FlutterDatabaseObjects/_RCCWP_CustomField.php.html">RCCWP_CustomField.php</a></dd>
154                                                        <dt>RCCWP_CustomGroup</dt>
155                                <dd>in file RCCWP_CustomGroup.php, class <a href="FlutterDatabaseObjects/RCCWP_CustomGroup.html">RCCWP_CustomGroup</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create/Edit/Delete groups. Groups are just a collection of fields.</dd>
156                                                        <dt>RCCWP_CustomGroup.php</dt>
157                                <dd>procedural page <a href="FlutterDatabaseObjects/_RCCWP_CustomGroup.php.html">RCCWP_CustomGroup.php</a></dd>
158                                                        <dt>RCCWP_CustomWriteModule</dt>
159                                <dd>in file RCCWP_CustomWriteModule.php, class <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html">RCCWP_CustomWriteModule</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create/edit/delete modules</dd>
160                                                        <dt>RCCWP_CustomWriteModule.php</dt>
161                                <dd>procedural page <a href="FlutterDatabaseObjects/_RCCWP_CustomWriteModule.php.html">RCCWP_CustomWriteModule.php</a></dd>
162                                                        <dt>RCCWP_CustomWritePanel</dt>
163                                <dd>in file RCCWP_CustomWritePanel.php, class <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html">RCCWP_CustomWritePanel</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Create/edit/delete write panels.</dd>
164                                                        <dt>RCCWP_CustomWritePanel.php</dt>
165                                <dd>procedural page <a href="FlutterDatabaseObjects/_RCCWP_CustomWritePanel.php.html">RCCWP_CustomWritePanel.php</a></dd>
166                                        </dl>
167        </div>
168        <a name="u"></a>
169        <a href="elementindex.html#top">top</a><br>
170        <div>
171                <h2>u</h2>
172                <dl class="lettercontents">
173                                                        <dt>Update</dt>
174                                <dd>in file RCCWP_CustomWritePanel.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWritePanel.html#methodUpdate">RCCWP_CustomWritePanel::Update()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Updates the properties of a write panel</dd>
175                                                        <dt>Update</dt>
176                                <dd>in file RCCWP_CustomWriteModule.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomWriteModule.html#methodUpdate">RCCWP_CustomWriteModule::Update()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Updates the basic information of a module</dd>
177                                                        <dt>Update</dt>
178                                <dd>in file RCCWP_CustomGroup.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodUpdate">RCCWP_CustomGroup::Update()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Update the group</dd>
179                                                        <dt>Update</dt>
180                                <dd>in file RCCWP_CustomField.php, method <a href="FlutterDatabaseObjects/RCCWP_CustomField.html#methodUpdate">RCCWP_CustomField::Update()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Updates the properties of a custom field.</dd>
181                                        </dl>
182        </div>
183        <div id="credit">
184                <hr>
185                Documentation generated on Tue, 09 Sep 2008 12:47:58 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
186        </div>
187</div>
188</body>
189</html>
Note: See TracBrowser for help on using the browser.