[ Class Tree: FlutterDatabaseObjects ] [ Index: FlutterDatabaseObjects ] [ All elements ]
FlutterDatabaseObjects
FlutterDatabaseObjects
·

# Class: RCCWP_CustomGroup

Source Location: /RCCWP_CustomGroup.php

### Class Overview [line 11]

Create/Edit/Delete groups. Groups are just a collection of fields.

#### Author(s):

#### Version:

#### Copyright:

### Variables

### Constants

### Methods

- Create
- Delete
- Get
- GetCustomFields
- Update

## Inherited Variables

## Inherited Constants

## Inherited Methods

## Class Details

Create/Edit/Delete groups. Groups are just a collection of fields.

[ Top ]

## Class Variables

## Class Methods

### Create

`the Create( unknown_type $customWritePanelId, unknown_type $name, unknown_type $duplicate, unknown_type $at_right)`

[line 23]

Create a new group in a write panel

#### Tags:

- return - id of the new group

#### Parameters:

- unknown_type $customWritePanelId -
- unknown_type $name - group name
- unknown_type $duplicate - a boolean indicating whether the group can be duplicated
- unknown_type $at_right - a boolean indicating whether the group should be placed at right side.

[ Top ]

### Delete

`void Delete( [integer $customGroupId = null])`

[line 46]

Delete a group given id

#### Parameters:

- integer $customGroupId -

[ Top ]

### Get

`an Get( integer $groupId)`

[line 75]

Get group properties

#### Tags:

- return - object representing the group

#### Parameters:

- integer $groupId -

[ Top ]

### GetCustomFields

`an GetCustomFields( integer $customGroupId)`

[line 92]

Get a list of the custom fields of a group

#### Tags:

- return - array of objects containing information about fields. Each object contains 3 objects: properties, options and default_value

#### Parameters:

- integer $customGroupId - the group id

[ Top ]

### Update

`void Update( $customGroupId, unknown_type $name, unknown_type $duplicate, unknown_type $at_right, unknown_type $customWritePanelId)`

[line 123]

Update the group

#### Parameters:

- unknown_type $customWritePanelId -
- unknown_type $name - group name
- unknown_type $duplicate - a boolean indicating whether the group can be duplicated
- unknown_type $at_right - a boolean indicating whether the group should be placed at right side.
- $customGroupId -

[ Top ]

## Class Constants

Documentation generated on Tue, 09 Sep 2008 12:47:59 +0000 by phpDocumentor 1.4.2