SettingsValidator Class Reference

Public Member Functions
	__construct ()
	validate ( $plugin, array $original_settings, array $settings_to_validate)
	Validates settings. More...

Private Member Functions
	add_custom_validation_rules ()
	Adds custom validation rules (these match custom Yup rules added in the UI). More...
	run_validator ( $rule, $value)
	Performs validation. More...

Private Attributes
	$file_loader
	$filesystem
	$translator
	$validator_factory

Detailed Description

Definition at line 18 of file SettingsValidator.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Definition at line 47 of file SettingsValidator.php.

Member Function Documentation

add_custom_validation_rules()

add_custom_validation_rules ( )

private

Adds custom validation rules (these match custom Yup rules added in the UI).

Since

1.0.0

See also

UI/src/lib/validation.js

Definition at line 63 of file SettingsValidator.php.

References $value.

run_validator()

run_validator (   $rule,   $value  )

private

Performs validation.

Since

1.0.0

Parameters

string	$rule	Validation rule (see https://laravel.com/docs/5.4/validation#available-validation-rules).
string	$value	Validation value.

Exceptions

ValidatorException

Returns

bool

Definition at line 111 of file SettingsValidator.php.

References $value.

validate()

validate	(		$plugin,
		array	$original_settings,
		array	$settings_to_validate
	)

Validates settings.

Since

1.0.0

Parameters

string	$plugin	Plugin ID.
array	$original_settings	Flattened settings object (i.e., not split by sections) as defined by the plugin (see gk/foundation/settings/data/plugins filter).
array	$settings_to_validate	Setting/value pair to validate.

Exceptions

ValidatorException

Returns

bool

Runs Actions:

gk/foundation/settings/{plugin}/validation/{setting_id} Runs when validation rules are not specified and before the setting is marked as validated.

Since

1.0.0

Parameters

array	$setting	Original setting.
string	$value_to_validate	Value to validate.

Definition at line 142 of file SettingsValidator.php.

Field Documentation

$file_loader

$file_loader

private

Definition at line 31 of file SettingsValidator.php.

$filesystem

$filesystem

private

Definition at line 24 of file SettingsValidator.php.

$translator

$translator

private

Definition at line 38 of file SettingsValidator.php.

$validator_factory

$validator_factory

private

Definition at line 45 of file SettingsValidator.php.

---

The documentation for this class was generated from the following file:

• SettingsValidator.php