| Current Path : /home/scoots/www/wp-content/plugins/fresh-page/docs/FlutterDatabaseObjects/ |
Linux webm002.cluster010.gra.hosting.ovh.net 5.15.167-ovh-vps-grsec-zfs-classid #1 SMP Tue Sep 17 08:14:20 UTC 2024 x86_64 |
| Current File : /home/scoots/www/wp-content/plugins/fresh-page/docs/FlutterDatabaseObjects/RCCWP_CustomGroup.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Docs For Class RCCWP_CustomGroup</title>
<link rel="stylesheet" type="text/css" id="layout" href="../media/layout.css" media="screen">
<link rel="stylesheet" type="text/css" href="../media/style.css" media="all">
<link rel="stylesheet" type="text/css" href="../media/print.css" media="print">
</head>
<body>
<div id="header">
<div id="navLinks">
[ <a href="../classtrees_FlutterDatabaseObjects.html">Class Tree: FlutterDatabaseObjects</a> ]
[ <a href="../elementindex_FlutterDatabaseObjects.html">Index: FlutterDatabaseObjects</a> ]
[ <a href="../elementindex.html">All elements</a> ]
</div>
<div id="packagePosition">
<div id="packageTitle2">FlutterDatabaseObjects</div>
<div id="packageTitle">FlutterDatabaseObjects</div>
<div id="elementPath"> · </div>
</div>
</div>
<div id="nav" class="small">
<div id="packages">
Packages:
<p><a href="../li_FlutterDatabaseObjects.html">FlutterDatabaseObjects</a></p>
</div>
<div id="index">
<div id="files">
Files:<br>
<a href="../FlutterDatabaseObjects/_RCCWP_CustomField.php.html"> RCCWP_CustomField.php
</a><br>
<a href="../FlutterDatabaseObjects/_RCCWP_CustomGroup.php.html"> RCCWP_CustomGroup.php
</a><br>
<a href="../FlutterDatabaseObjects/_RCCWP_CustomWriteModule.php.html"> RCCWP_CustomWriteModule.php
</a><br>
<a href="../FlutterDatabaseObjects/_RCCWP_CustomWritePanel.php.html"> RCCWP_CustomWritePanel.php
</a><br>
</div>
<div id="interfaces">
</div>
<div id="classes">
Classes:<br>
<a href="../FlutterDatabaseObjects/RCCWP_CustomField.html"> RCCWP_CustomField
</a><br>
<a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html"> RCCWP_CustomGroup
</a><br>
<a href="../FlutterDatabaseObjects/RCCWP_CustomWriteModule.html"> RCCWP_CustomWriteModule
</a><br>
<a href="../FlutterDatabaseObjects/RCCWP_CustomWritePanel.html"> RCCWP_CustomWritePanel
</a><br>
</div>
</div>
</div>
<div id="body">
<h1>Class: RCCWP_CustomGroup</h1>
<p style="margin: 0px;">Source Location: /RCCWP_CustomGroup.php</p>
<div class="leftcol">
<h3><a href="#class_details">Class Overview</a> <span class="smalllinenumber">[line 11]</span></h3>
<div id="classTree"><pre></pre>
</div>
<div class="small">
<p>Create/Edit/Delete groups. Groups are just a collection of fields.</p>
<h4>Author(s):</h4>
<ul>
</ul>
<h4>Version:</h4>
<ul>
</ul>
<h4>Copyright:</h4>
<ul>
</li>
</div>
</div>
<div class="middlecol">
<h3><a href="#class_vars">Variables</a></h3>
<ul class="small">
</ul>
<h3><a href="#class_consts">Constants</a></h3>
<ul class="small">
</ul>
</div>
<div class="rightcol">
<h3><a href="#class_methods">Methods</a></h3>
<ul class="small">
<li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodCreate">Create</a></li>
<li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodDelete">Delete</a></li>
<li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodGet">Get</a></li>
<li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodGetCustomFields">GetCustomFields</a></li>
<li><a href="../FlutterDatabaseObjects/RCCWP_CustomGroup.html#methodUpdate">Update</a></li>
</ul>
</div>
<div id="content">
<hr>
<div class="contents">
</div>
<div class="leftCol">
<h2>Inherited Variables</h2>
<h2>Inherited Constants</h2>
</div>
<div class="rightCol">
<h2>Inherited Methods</h2>
</div>
<br clear="all">
<hr>
<a name="class_details"></a>
<h2>Class Details</h2>
<p align="center"><strong>Create/Edit/Delete groups. Groups are just a collection of fields.
</strong></p>
<p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p>
<hr>
<a name="class_vars"></a>
<h2>Class Variables</h2>
<hr>
<a name="class_methods"></a>
<h2>Class Methods</h2>
<a name="methodCreate"></a>
<p></p>
<h3>Create</h3>
<div class="indent">
<p>
<code>the Create(
unknown_type
$customWritePanelId, unknown_type
$name, unknown_type
$duplicate, unknown_type
$at_right)</code>
</p>
<p class="linenumber">[line 23]</p>
<p align="center"><strong>Create a new group in a write panel
</strong></p>
<h4>Tags:</h4>
<ul>
<li><b>return</b> - id of the new group</li>
</ul>
<h4>Parameters:</h4>
<ul>
<li>
<span class="type">unknown_type</span>
<b>$customWritePanelId</b>
-
</li>
<li>
<span class="type">unknown_type</span>
<b>$name</b>
-
group name</li>
<li>
<span class="type">unknown_type</span>
<b>$duplicate</b>
-
a boolean indicating whether the group can be duplicated</li>
<li>
<span class="type">unknown_type</span>
<b>$at_right</b>
-
a boolean indicating whether the group should be placed at right side.</li>
</ul>
</div>
<p class="top">[ <a href="#top">Top</a> ]</p>
<a name="methodDelete"></a>
<p></p>
<h3>Delete</h3>
<div class="indent">
<p>
<code>void Delete(
[integer
$customGroupId = null])</code>
</p>
<p class="linenumber">[line 46]</p>
<p align="center"><strong>Delete a group given id
</strong></p>
<h4>Parameters:</h4>
<ul>
<li>
<span class="type">integer</span>
<b>$customGroupId</b>
-
</li>
</ul>
</div>
<p class="top">[ <a href="#top">Top</a> ]</p>
<a name="methodGet"></a>
<p></p>
<h3>Get</h3>
<div class="indent">
<p>
<code>an Get(
integer
$groupId)</code>
</p>
<p class="linenumber">[line 75]</p>
<p align="center"><strong>Get group properties
</strong></p>
<h4>Tags:</h4>
<ul>
<li><b>return</b> - object representing the group</li>
</ul>
<h4>Parameters:</h4>
<ul>
<li>
<span class="type">integer</span>
<b>$groupId</b>
-
</li>
</ul>
</div>
<p class="top">[ <a href="#top">Top</a> ]</p>
<a name="methodGetCustomFields"></a>
<p></p>
<h3>GetCustomFields</h3>
<div class="indent">
<p>
<code>an GetCustomFields(
integer
$customGroupId)</code>
</p>
<p class="linenumber">[line 92]</p>
<p align="center"><strong>Get a list of the custom fields of a group
</strong></p>
<h4>Tags:</h4>
<ul>
<li><b>return</b> - array of objects containing information about fields. Each object contains 3 objects: properties, options and default_value</li>
</ul>
<h4>Parameters:</h4>
<ul>
<li>
<span class="type">integer</span>
<b>$customGroupId</b>
-
the group id</li>
</ul>
</div>
<p class="top">[ <a href="#top">Top</a> ]</p>
<a name="methodUpdate"></a>
<p></p>
<h3>Update</h3>
<div class="indent">
<p>
<code>void Update(
$customGroupId, unknown_type
$name, unknown_type
$duplicate, unknown_type
$at_right, unknown_type
$customWritePanelId)</code>
</p>
<p class="linenumber">[line 123]</p>
<p align="center"><strong>Update the group
</strong></p>
<h4>Parameters:</h4>
<ul>
<li>
<span class="type">unknown_type</span>
<b>$customWritePanelId</b>
-
</li>
<li>
<span class="type">unknown_type</span>
<b>$name</b>
-
group name</li>
<li>
<span class="type">unknown_type</span>
<b>$duplicate</b>
-
a boolean indicating whether the group can be duplicated</li>
<li>
<span class="type">unknown_type</span>
<b>$at_right</b>
-
a boolean indicating whether the group should be placed at right side.</li>
<li>
<span class="type"></span>
<b>$customGroupId</b>
-
</li>
</ul>
</div>
<p class="top">[ <a href="#top">Top</a> ]</p>
<hr>
<a name="class_consts"></a>
<h2>Class Constants</h2>
</div>
<div id="credit">
<hr>
Documentation generated on Tue, 09 Sep 2008 12:47:59 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
</div>
</div>
</body>
</html>