TenantConfigSchema
in package
Validates the safe, non-secret tenant_config surface exposed to platform admins.
Table of Contents
Constants
- ALLOWED_FIELDS : mixed = ['documents_blob_container', 'documents_blob_pr...
- IGNORED_FIELDS : mixed = ['_csrfToken', '_Token']
Methods
- buildFromFormData() : array<string, mixed>
- safeConfig() : array<string, mixed>
- safeConfigFromJson() : array<string, mixed>
- Return only safe, known config keys from existing tenant_config.
- toFormData() : array<string, string>
- addBoolean() : void
- addEmailProviderString() : void
- addEmailString() : void
- addPort() : void
- addSecretRef() : void
- addUrl() : void
- normalizeEmailMode() : string
- Normalize the email transport driver value.
- optionalString() : string|null
- Normalize an optional scalar form value.
- rejectInlineSecret() : void
- Reject inline secrets embedded in otherwise non-secret fields.
- rejectUnknownFields() : void
- sortConfig() : array<string, mixed>
- toRawFormData() : array<string, mixed>
- validateBlobPrefix() : string
- Validate an Azure blob object prefix.
- validateContainer() : string
- Validate an Azure blob container name.
- validateHttpsUrl() : string
- Validate HTTPS URLs and reject secret-bearing query values.
- validateSecretReference() : string
- Validate a secret reference name without accepting plaintext values.
Constants
ALLOWED_FIELDS
private
mixed
ALLOWED_FIELDS
= ['documents_blob_container', 'documents_blob_prefix', 'email_mode', 'email_from_address', 'email_from_name', 'email_endpoint_url', 'email_azure_connection_string_secret_ref', 'email_azure_api_version', 'email_api_secret_ref', 'email_smtp_host', 'email_smtp_port', 'email_smtp_username', 'email_smtp_password_secret_ref', 'email_smtp_tls']
IGNORED_FIELDS
private
mixed
IGNORED_FIELDS
= ['_csrfToken', '_Token']
Methods
buildFromFormData()
public
buildFromFormData(array<string|int, mixed> $data) : array<string, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string, mixed>safeConfig()
public
safeConfig(array<string, mixed> $config) : array<string, mixed>
Parameters
- $config : array<string, mixed>
Return values
array<string, mixed>safeConfigFromJson()
Return only safe, known config keys from existing tenant_config.
public
safeConfigFromJson(string|null $json) : array<string, mixed>
Parameters
- $json : string|null
Return values
array<string, mixed>toFormData()
public
toFormData(array<string, mixed> $config) : array<string, string>
Parameters
- $config : array<string, mixed>
Return values
array<string, string>addBoolean()
private
addBoolean(array<string, mixed> &$email, string $key, mixed $value) : void
Parameters
- $email : array<string, mixed>
- $key : string
- $value : mixed
addEmailProviderString()
private
addEmailProviderString(array<string, mixed> &$email, string $key, mixed $value, int $maxLength) : void
Parameters
- $email : array<string, mixed>
- $key : string
- $value : mixed
- $maxLength : int
addEmailString()
private
addEmailString(array<string, mixed> &$email, string $key, mixed $value, bool $emailAddress) : void
Parameters
- $email : array<string, mixed>
- $key : string
- $value : mixed
- $emailAddress : bool
addPort()
private
addPort(array<string, mixed> &$email, string $key, mixed $value) : void
Parameters
- $email : array<string, mixed>
- $key : string
- $value : mixed
addSecretRef()
private
addSecretRef(array<string, mixed> &$target, string $key, mixed $value) : void
Parameters
- $target : array<string, mixed>
- $key : string
- $value : mixed
addUrl()
private
addUrl(array<string, mixed> &$target, string $key, mixed $value) : void
Parameters
- $target : array<string, mixed>
- $key : string
- $value : mixed
normalizeEmailMode()
Normalize the email transport driver value.
private
normalizeEmailMode(string $mode) : string
Parameters
- $mode : string
Return values
stringoptionalString()
Normalize an optional scalar form value.
private
optionalString(mixed $value) : string|null
Parameters
- $value : mixed
Return values
string|nullrejectInlineSecret()
Reject inline secrets embedded in otherwise non-secret fields.
private
rejectInlineSecret(string $value) : void
Parameters
- $value : string
rejectUnknownFields()
private
rejectUnknownFields(array<string, mixed> $data) : void
Parameters
- $data : array<string, mixed>
sortConfig()
private
sortConfig(array<string, mixed> $config) : array<string, mixed>
Parameters
- $config : array<string, mixed>
Return values
array<string, mixed>toRawFormData()
private
toRawFormData(array<string, mixed> $config) : array<string, mixed>
Parameters
- $config : array<string, mixed>
Return values
array<string, mixed>validateBlobPrefix()
Validate an Azure blob object prefix.
private
validateBlobPrefix(string $prefix) : string
Parameters
- $prefix : string
Return values
stringvalidateContainer()
Validate an Azure blob container name.
private
validateContainer(string $container) : string
Parameters
- $container : string
Return values
stringvalidateHttpsUrl()
Validate HTTPS URLs and reject secret-bearing query values.
private
validateHttpsUrl(string $url, string $label) : string
Parameters
- $url : string
- $label : string
Return values
stringvalidateSecretReference()
Validate a secret reference name without accepting plaintext values.
private
validateSecretReference(string $reference) : string
Parameters
- $reference : string