PHP Class RCCWP_CustomGroup, Magic-Fields

Mostrar archivo Open project: hunk/Magic-Fields Class Usage Examples

Public Methods

Method Description
Create ( unknown_type $customWritePanelId, unknown_type $name, unknown_type $duplicate, $expanded = 1, unknown_type $at_right ) : the Create a new group in a write panel
Delete ( integer $customGroupId = null ) Delete a group given id
Get ( integer $groupId ) : an Get group properties
GetCustomFields ( integer $customGroupId ) : an Get a list of the custom fields of a group
HasCustomfields ( $customGroupId ) : boolean Has custom fields the group?
Update ( $customGroupId, unknown_type $name, unknown_type $duplicate, $expanded, unknown_type $at_right ) Update the group

Method Details

Create() public static method

Create a new group in a write panel
public static Create ( unknown_type $customWritePanelId, unknown_type $name, unknown_type $duplicate, $expanded = 1, unknown_type $at_right ) : the
$customWritePanelId unknown_type
$name unknown_type group name
$duplicate unknown_type a boolean indicating whether the group can be duplicated
$at_right unknown_type a boolean indicating whether the group should be placed at right side.
return the id of the new group

Delete() public static method

Delete a group given id
public static Delete ( integer $customGroupId = null )
$customGroupId integer

Get() public static method

Get group properties
public static Get ( integer $groupId ) : an
$groupId integer
return an object representing the group

GetCustomFields() public static method

Get a list of the custom fields of a group
public static GetCustomFields ( integer $customGroupId ) : an
$customGroupId integer the group id
return an array of objects containing information about fields. Each object contains 3 objects: properties, options and default_value

HasCustomfields() public static method

Has custom fields the group?
public static HasCustomfields ( $customGroupId ) : boolean
return boolean

Update() public static method

Update the group
public static Update ( $customGroupId, unknown_type $name, unknown_type $duplicate, $expanded, unknown_type $at_right )
$name unknown_type group name
$duplicate unknown_type a boolean indicating whether the group can be duplicated
$at_right unknown_type a boolean indicating whether the group should be placed at right side.