Jet\InputCatcher

Abstract class representing the base of a catcher in the InputCatcher subsystem

Method Meaning
public __construct(
string $name,
mixed $default_value
)		 Parameters:
  • $name: The name of the catcher, but also the key for retrieving the raw value from input data formatted as an array.
  • $default_value: Default value that will be returned if the value is not found in the input data at all.
public static getType() : string Returns the string code of the catcher type.
public catchInput(
array|Data_Array $data
) : void		 Performs the entire input value catching operation.
abstract protected checkValue(
) : void		 This method performs the actual type casting, validation, and other operations on the input value to ensure the data is valid and safe. This is an abstract method, so each catcher naturally has its own implementation.
public setName(
string $name
) : void		 Allows changing the name / key setting. See constructor.
public getName(
) : string		 Returns the name / key. See constructor.
public getDefaultValue(
) : mixed		 Returns the configured default value. See constructor.
public setDefaultValue(
mixed $default_value
) : void		 Allows changing the default value. See constructor.
public valueExistsInTheInput(
) : bool		 Indicates whether the value was found in the input data.
public getValue(
) : mixed		 Returns the caught and already sanitized input value.
public setValue(
mixed $value
) : void		 The input value can also be set manually. However, even in this case, value verification is performed.
public getValueRaw(
) : mixed		 Returns the value exactly in the form it was found in the input data - unchanged.
public static getInputCatcherOptionsDefinition(
) : Entity_InputCatcher_Definition_InputCatcherOption[]		 Returns the definition of configuration options that the given catcher can have.
Previous chapter
Jet\Entity_InputCatcher_Definition_Exception
Next chapter
Validator
GitHub