MetadataField
abstract class MetadataField extends Metadata
Represents a single metadata field. Use one of the derived classes in metadata API calls.
Methods
No description
The MetadataField constructor.
Gets the keys for all the properties of this object.
Returns the type of this field.
Gets the default value of this field.
Sets the default value of this field.
Gets the ID of this field.
Sets the ID of the string (auto-generated if this is left blank).
Gets the label of this field.
Sets the label of this field.
Gets a boolean indicating whether this fields is currently mandatory.
Sets whether this field needs to be mandatory.
Gets the validation rules of this field.
Details
jsonSerialize()
__construct(string $label)
The MetadataField constructor.
string[]
getPropertyKeys()
Gets the keys for all the properties of this object.
string
getType()
Returns the type of this field.
mixed
getDefaultValue()
Gets the default value of this field.
setDefaultValue(mixed $defaultValue)
Sets the default value of this field.
string
getExternalId()
Gets the ID of this field.
setExternalId(string $externalId)
Sets the ID of the string (auto-generated if this is left blank).
string
getLabel()
Gets the label of this field.
setLabel(string $label)
Sets the label of this field.
bool
getMandatory()
Gets a boolean indicating whether this fields is currently mandatory.
setMandatory(bool $mandatory)
Sets whether this field needs to be mandatory.
MetadataValidation
getValidation()
Gets the validation rules of this field.
setValidation(MetadataValidation $validation)
Sets the validation rules of this field.