---
title: "Phalcon Domain"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Domain
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Domain\Payload\Payload
Class
Holds the payload
- **`Phalcon\Domain\Payload\Payload`** - implements [`Phalcon\Domain\Payload\PayloadInterface`](#domainpayloadpayloadinterface)
`Throwable`
### Method Summary
Gets the potential exception thrown in the domain layer
Extra information
Input
Messages
Output
Status
Sets an exception thrown in the domain
Sets arbitrary extra domain information.
Sets the domain input.
Sets the domain messages.
Sets the domain output.
Sets the payload status.
### Properties
Exception if any
Extra information
Input
Messages
Output
Status
### Methods
getException()
```php
public function getException(): Throwable|null;
```
Gets the potential exception thrown in the domain layer
getExtras()
```php
public function getExtras(): mixed;
```
Extra information
getInput()
```php
public function getInput(): mixed;
```
Input
getMessages()
```php
public function getMessages(): mixed;
```
Messages
getOutput()
```php
public function getOutput(): mixed;
```
Output
getStatus()
```php
public function getStatus(): mixed;
```
Status
Status values are drawn from the `Status` vocabulary.
@see Status
setException()
```php
public function setException( Throwable $exception ): PayloadInterface;
```
Sets an exception thrown in the domain
setExtras()
```php
public function setExtras( mixed $extras ): PayloadInterface;
```
Sets arbitrary extra domain information.
setInput()
```php
public function setInput( mixed $input ): PayloadInterface;
```
Sets the domain input.
setMessages()
```php
public function setMessages( mixed $messages ): PayloadInterface;
```
Sets the domain messages.
setOutput()
```php
public function setOutput( mixed $output ): PayloadInterface;
```
Sets the domain output.
setStatus()
```php
public function setStatus( mixed $status ): PayloadInterface;
```
Sets the payload status.
Status values are drawn from the `Status` vocabulary.
@see Status
## Domain\Payload\PayloadFactory
Class
Factory to create payload objects.
It exists so that payload creation can be registered as a service in the DI
container and substituted in tests, rather than constructing `Payload`
instances directly.
- **`Phalcon\Domain\Payload\PayloadFactory`**
### Method Summary
Instantiate a new object
### Methods
newInstance()
```php
public function newInstance(): PayloadInterface;
```
Instantiate a new object
## Domain\Payload\PayloadInterface
Interface
This interface is used for consumers
- [`Phalcon\Contracts\Domain\Payload\Readable`](/5.20/api/phalcon_contracts/#contractsdomainpayloadreadable)
- [`Phalcon\Domain\Payload\ReadableInterface`](#domainpayloadreadableinterface)
- **`Phalcon\Domain\Payload\PayloadInterface`** - extends [`Phalcon\Domain\Payload\ReadableInterface`](#domainpayloadreadableinterface), [`Phalcon\Domain\Payload\WriteableInterface`](#domainpayloadwriteableinterface), [`Phalcon\Contracts\Domain\Payload\Payload`](/5.20/api/phalcon_contracts/#contractsdomainpayloadpayload)
`Phalcon\Contracts\Domain\Payload\Payload`
## Domain\Payload\ReadableInterface
Interface
This interface is used for consumers (read only)
- [`Phalcon\Contracts\Domain\Payload\Readable`](/5.20/api/phalcon_contracts/#contractsdomainpayloadreadable)
- **`Phalcon\Domain\Payload\ReadableInterface`**
- [`Phalcon\Domain\Payload\PayloadInterface`](#domainpayloadpayloadinterface)
`Phalcon\Contracts\Domain\Payload\Readable`
## Domain\Payload\Status
Class
Holds the status codes for the payload.
The two failure-related statuses are distinct, following the Aura.Payload
lineage:
- `ERROR` means an exception was raised while the domain layer was running.
By convention, `Payload::setException()` pairs with the `ERROR` status.
- `FAILURE` means the domain layer ran to completion but declined the
request (for example, a business rule was not satisfied); no exception
was raised.
@see Payload
- **`Phalcon\Domain\Payload\Status`**
### Constants
## Domain\Payload\WriteableInterface
Interface
This interface is used for consumers (write)
- [`Phalcon\Contracts\Domain\Payload\Writeable`](/5.20/api/phalcon_contracts/#contractsdomainpayloadwriteable)
- **`Phalcon\Domain\Payload\WriteableInterface`**
`Phalcon\Contracts\Domain\Payload\Writeable`
Source: https://docs.phalcon.io/5.20/api/phalcon_domain/index.mdx