CSAppParameter
extends CSAppObject
in package
This class represents the base class of all app related objects.
Tags
Table of Contents
- createForNameAndDefinition() : CSAppParameter
- Creates a parameter object based on its name and definition.
- createForNameAndType() : CSAppParameter
- Creates a parameter object based on its name and type.
- getLabel() : string
- Getter method for getting Label of the Parameter
- getName() : string
- Getter method for getting Name of the Parameter
- getTab() : bool
- Getter method for getting tab name
- getType() : string
- Getter method for getting Type of the Parameter
- isRequired() : bool
- Getter method for checking if parameter is required.
- toArray() : mixed
- Transforms the parameter to an associative array.
Methods
createForNameAndDefinition()
Creates a parameter object based on its name and definition.
public
static createForNameAndDefinition(string $sName, array<string|int, mixed> $aDefinition) : CSAppParameter
Parameters
- $sName : string
-
The name of the parameter.
- $aDefinition : array<string|int, mixed>
-
The parameter definition.
Tags
Return values
CSAppParameter —The parameter object.
createForNameAndType()
Creates a parameter object based on its name and type.
public
static createForNameAndType(string $sName, string $sType) : CSAppParameter
Parameters
- $sName : string
-
The name of the parameter.
- $sType : string
-
A valid parameter type like string, number...
Tags
Return values
CSAppParameter —The parameter object.
getLabel()
Getter method for getting Label of the Parameter
public
getLabel() : string
Tags
Return values
string —@access public
getName()
Getter method for getting Name of the Parameter
public
getName() : string
Tags
Return values
string —@access public
getTab()
Getter method for getting tab name
public
getTab() : bool
Tags
Return values
bool —@access public
getType()
Getter method for getting Type of the Parameter
public
getType() : string
Tags
Return values
string —@access public
isRequired()
Getter method for checking if parameter is required.
public
isRequired() : bool
Tags
Return values
bool —@access public
toArray()
Transforms the parameter to an associative array.
public
toArray() : mixed
return array The array representation of the parameter.