PHP Class RCCWP_CustomGroup, Magic-Fields

Afficher le fichier Open project: hunk/Magic-Fields Class Usage Examples

Méthodes publiques

Méthode	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 méthode

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.
Résultat	the	id of the new group

Delete() public static méthode

Delete a group given id

public static Delete ( integer $customGroupId = null )
$customGroupId	integer

Get() public static méthode

Get group properties

public static Get ( integer $groupId ) : an
$groupId	integer
Résultat	an	object representing the group

GetCustomFields() public static méthode

Get a list of the custom fields of a group

public static GetCustomFields ( integer $customGroupId ) : an
$customGroupId	integer	the group id
Résultat	an	array of objects containing information about fields. Each object contains 3 objects: properties, options and default_value

HasCustomfields() public static méthode

Has custom fields the group?

public static HasCustomfields ( $customGroupId ) : boolean
Résultat	boolean

Update() public static méthode

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.