Skip to content

PayloadAware

  • Full name: \Codefy\CommandBus\Traits\PayloadAware

Properties

payload

private array $payload

REQUIRED_FIELDS

protected static array $REQUIRED_FIELDS
  • This property is static.

ALLOWED_FIELDS

protected static array $ALLOWED_FIELDS
  • This property is static.

Methods

__construct

public __construct(array $payload = []): mixed

Parameters:

Parameter Type Description
$payload array

fromPayload

public static fromPayload(array $payload): static
  • This method is static.

Parameters:

Parameter Type Description
$payload array

with

public with(string $key, mixed $value = null): static

Parameters:

Parameter Type Description
$key string
$value mixed

without

public without(string $key): static

Parameters:

Parameter Type Description
$key string

get

public get(string $key, mixed $default = null): mixed

Parameters:

Parameter Type Description
$key string
$default mixed

getOrFail

public getOrFail(string $key): mixed

Parameters:

Parameter Type Description
$key string

Throws:

payload

public payload(): array

validate

public static validate(array $payload = []): array
  • This method is static.

Parameters:

Parameter Type Description
$payload array

Throws:

Automatically generated on 2025-10-13