Class Phalcon\Domain\Payload\Payload

Holds the payload

Properties¶

/**
 * Exception if any
 *
 * @var Throwable|null
 */
protected exception;

/**
 * Extra information
 *
 * @var mixed
 */
protected extras;

/**
 * Input
 *
 * @var mixed
 */
protected input;

/**
 * Messages
 *
 * @var mixed
 */
protected messages;

/**
 * Status
 *
 * @var mixed
 */
protected status;

/**
 * Output
 *
 * @var mixed
 */
protected output;

Methods¶

public function getException(): Throwable | null;

Gets the potential exception thrown in the domain layer

public function getExtras(): mixed

public function getInput(): mixed

public function getMessages(): mixed

public function getOutput(): mixed

public function getStatus(): mixed

public function setException( Throwable $exception ): PayloadInterface;

Sets an exception thrown in the domain

public function setExtras( mixed $extras ): PayloadInterface;

Sets arbitrary extra domain information.

public function setInput( mixed $input ): PayloadInterface;

Sets the domain input.

public function setMessages( mixed $messages ): PayloadInterface;

Sets the domain messages.

public function setOutput( mixed $output ): PayloadInterface;

Sets the domain output.

public function setStatus( mixed $status ): PayloadInterface;

Sets the payload status.

Class Phalcon\Domain\Payload\PayloadFactory

Source on GitHub

| Namespace | Phalcon\Domain\Payload |

Factory to create payload objects

Methods¶

public function newInstance(): PayloadInterface;

Instantiate a new object

Interface Phalcon\Domain\Payload\PayloadInterface

Source on GitHub

This interface is used for consumers

Interface Phalcon\Domain\Payload\ReadableInterface

Source on GitHub

This interface is used for consumers (read only)

Methods¶

public function getException(): Throwable | null;

Gets the potential exception thrown in the domain layer

public function getExtras(): mixed;

Gets arbitrary extra values produced by the domain layer.

public function getInput(): mixed;

Gets the input received by the domain layer.

public function getMessages(): mixed;

Gets the messages produced by the domain layer.

public function getOutput(): mixed;

Gets the output produced from the domain layer.

public function getStatus(): mixed;

Gets the status of this payload.

Class Phalcon\Domain\Payload\Status

Source on GitHub

| Namespace | Phalcon\Domain\Payload |

Holds the status codes for the payload

Constants¶

const ACCEPTED = ACCEPTED;
const AUTHENTICATED = AUTHENTICATED;
const AUTHORIZED = AUTHORIZED;
const CREATED = CREATED;
const DELETED = DELETED;
const ERROR = ERROR;
const FAILURE = FAILURE;
const FOUND = FOUND;
const NOT_ACCEPTED = NOT_ACCEPTED;
const NOT_AUTHENTICATED = NOT_AUTHENTICATED;
const NOT_AUTHORIZED = NOT_AUTHORIZED;
const NOT_CREATED = NOT_CREATED;
const NOT_DELETED = NOT_DELETED;
const NOT_FOUND = NOT_FOUND;
const NOT_UPDATED = NOT_UPDATED;
const NOT_VALID = NOT_VALID;
const PROCESSING = PROCESSING;
const SUCCESS = SUCCESS;
const UPDATED = UPDATED;
const VALID = VALID;

Methods¶

final private function __construct();

Instantiation not allowed.

Interface Phalcon\Domain\Payload\WriteableInterface

Source on GitHub

This interface is used for consumers (write)

Methods¶

public function setException( Throwable $exception ): PayloadInterface;

Sets an exception produced by the domain layer.

public function setExtras( mixed $extras ): PayloadInterface;

Sets arbitrary extra values produced by the domain layer.

public function setInput( mixed $input ): PayloadInterface;

Sets the input received by the domain layer.

public function setMessages( mixed $messages ): PayloadInterface;

Sets the messages produced by the domain layer.

public function setOutput( mixed $output ): PayloadInterface;

Sets the output produced from the domain layer.

public function setStatus( mixed $status ): PayloadInterface;

Sets the status of this payload.