Skip to content

Builder


Properties

value

private mixed $value

parent

private mixed $parent

columns

private ?array $columns

field

private ?string $field

key

private ?string $key

contextKey

private ?string $contextKey

expose

private bool $expose

protected

private bool $protected

Methods

getValue

public getValue(): mixed

setValue

public setValue(mixed $value = null): void

Parameters:

Parameter Type Description
$value mixed

getParent

public getParent(): mixed

setParent

public setParent(mixed $parent = null): void

Parameters:

Parameter Type Description
$parent mixed

getKey

public getKey(): ?string

setKey

public setKey(?string $key = null): void

Parameters:

Parameter Type Description
$key ?string

getContextKey

public getContextKey(): ?string

setContextKey

public setContextKey(?string $contextKey = null): void

Parameters:

Parameter Type Description
$contextKey ?string

getField

public getField(): ?string

setField

public setField(?string $field = null): void

Parameters:

Parameter Type Description
$field ?string

getColumns

public getColumns(): ?array

setColumns

public setColumns(?array $columns = null): void

Parameters:

Parameter Type Description
$columns ?array

getExpose

public getExpose(): bool

setExpose

public setExpose(bool $expose): void

Parameters:

Parameter Type Description
$expose bool

getProtected

public getProtected(): bool

setProtected

public setProtected(bool $protected): void

Parameters:

Parameter Type Description
$protected bool

getFullKey

Retrieves the full key constructed from the context and the key.

public getFullKey(): string|null

The full key is determined based on the following conditions: - If the key is empty, the context is returned. - If the context is empty, the key is returned. - If both are present, the result is a concatenation of context and key separated by a dot.

Return Value:

The constructed full key or null if both key and context are null.


processKey

Processes the given key by normalizing its format.

public static processKey(string|null $key = null): string|null
  • This method is static. Parameters:
Parameter Type Description
$key string|null The input key to be processed. It can be null, an empty string, or a string.

Return Value:

Returns the processed key in a normalized format or an empty string if the input is null, empty, or a valid integer string.