Jet\Config_Definition_Property

Basic class for defining properties/configuration values. Abstract class from which other classes representing concrete types inherit.

Method Meaning
public __construct(
string|Config $configuration_class_name,
string $name,
?array $definition_data = null
)		 Parameters:
  • $configuration_class_name
    Name of the configuration class to which the property/configuration value belongs
  • $name
    Name of the property/configuration value
  • $definition_data
    Definition data obtained from attributes.
public setUp(
?array $definition_data = null
): void		 Sets the definition according to the definition data. Internal method.
public getName(
): string		 Returns the name of the property/configuration value.
public getIsRequired(
): bool		 Indicates whether or not the property/configuration value is required.
public setIsRequired(
bool $is_required
): void		 Indicates whether or not the property/configuration value is required.
public getType(
): string		 Returns the type of the property/configuration value.
public prepareValue(
mixed $value,
Config $config
): mixed		 Prepares a configuration value. Specifically, this means that it verifies the type of the value and validates the value (if necessary).
abstract protected checkValueType(
mixed &$value
): void		 Validates the type of the value. This abstract method must be implemented by the classes representing each type.
abstract protected checkValue(
mixed $value
): void		 Validates a value. This abstract method must be implemented by the classes representing each type.
public __toString(
): string
public toString(
): string		 For debugging purposes, the definition can be converted to a string. Returns: Some\Class::property_name.
Previous chapter
Jet\Config_Definition_Config_Section
Next chapter
Jet\Config_Definition_Property_String
GitHub