Skip to content
Phalcondocs

Phalcon Domain

Updated View as Markdown

Domain\Payload\Payload

ClassSource on GitHub

Holds the payload

Uses Throwable

Method Summary

publicThrowable|nullgetException()Gets the potential exception thrown in the domain layerpublicmixedgetExtras()Extra informationpublicmixedgetInput()InputpublicmixedgetMessages()MessagespublicmixedgetOutput()OutputpublicmixedgetStatus()StatuspublicPayloadInterfacesetException( Throwable$exception )Sets an exception thrown in the domainpublicPayloadInterfacesetExtras( mixed$extras )Sets arbitrary extra domain information.publicPayloadInterfacesetInput( mixed$input )Sets the domain input.publicPayloadInterfacesetMessages( mixed$messages )Sets the domain messages.publicPayloadInterfacesetOutput( mixed$output )Sets the domain output.publicPayloadInterfacesetStatus( mixed$status )Sets the payload status.

Properties

protectedThrowable|null$exception = nullException if any
protectedmixed$extrasExtra information
protectedmixed$inputInput
protectedmixed$messagesMessages
protectedmixed$outputOutput
protectedmixed$statusStatus

Methods

Public · 12

getException()

public function getException(): Throwable|null;

Gets the potential exception thrown in the domain layer

getExtras()

public function getExtras(): mixed;

Extra information

getInput()

public function getInput(): mixed;

Input

getMessages()

public function getMessages(): mixed;

Messages

getOutput()

public function getOutput(): mixed;

Output

getStatus()

public function getStatus(): mixed;

Status

setException()

public function setException( Throwable $exception ): PayloadInterface;

Sets an exception thrown in the domain

setExtras()

public function setExtras( mixed $extras ): PayloadInterface;

Sets arbitrary extra domain information.

setInput()

public function setInput( mixed $input ): PayloadInterface;

Sets the domain input.

setMessages()

public function setMessages( mixed $messages ): PayloadInterface;

Sets the domain messages.

setOutput()

public function setOutput( mixed $output ): PayloadInterface;

Sets the domain output.

setStatus()

public function setStatus( mixed $status ): PayloadInterface;

Sets the payload status.

Domain\Payload\PayloadFactory

ClassSource on GitHub

Factory to create payload objects

  • Phalcon\Domain\Payload\PayloadFactory

Method Summary

publicPayloadInterfacenewInstance()Instantiate a new object

Methods

Public · 1

newInstance()

public function newInstance(): PayloadInterface;

Instantiate a new object

Domain\Payload\PayloadInterface

InterfaceSource on GitHub

This interface is used for consumers

Domain\Payload\ReadableInterface

InterfaceSource on GitHub

This interface is used for consumers (read only)

Uses Throwable

Method Summary

publicThrowable|nullgetException()Gets the potential exception thrown in the domain layerpublicmixedgetExtras()Gets arbitrary extra values produced by the domain layer.publicmixedgetInput()Gets the input received by the domain layer.publicmixedgetMessages()Gets the messages produced by the domain layer.publicmixedgetOutput()Gets the output produced from the domain layer.publicmixedgetStatus()Gets the status of this payload.

Methods

Public · 6

getException()

public function getException(): Throwable|null;

Gets the potential exception thrown in the domain layer

getExtras()

public function getExtras(): mixed;

Gets arbitrary extra values produced by the domain layer.

getInput()

public function getInput(): mixed;

Gets the input received by the domain layer.

getMessages()

public function getMessages(): mixed;

Gets the messages produced by the domain layer.

getOutput()

public function getOutput(): mixed;

Gets the output produced from the domain layer.

getStatus()

public function getStatus(): mixed;

Gets the status of this payload.

Domain\Payload\Status

ClassSource on GitHub

Holds the status codes for the payload

  • Phalcon\Domain\Payload\Status

Constants

stringACCEPTED = "ACCEPTED"
stringAUTHENTICATED = "AUTHENTICATED"
stringAUTHORIZED = "AUTHORIZED"
stringCREATED = "CREATED"
stringDELETED = "DELETED"
stringERROR = "ERROR"
stringFAILURE = "FAILURE"
stringFOUND = "FOUND"
stringNOT_ACCEPTED = "NOT_ACCEPTED"
stringNOT_AUTHENTICATED = "NOT_AUTHENTICATED"
stringNOT_AUTHORIZED = "NOT_AUTHORIZED"
stringNOT_CREATED = "NOT_CREATED"
stringNOT_DELETED = "NOT_DELETED"
stringNOT_FOUND = "NOT_FOUND"
stringNOT_UPDATED = "NOT_UPDATED"
stringNOT_VALID = "NOT_VALID"
stringPROCESSING = "PROCESSING"
stringSUCCESS = "SUCCESS"
stringUPDATED = "UPDATED"
stringVALID = "VALID"

Domain\Payload\WriteableInterface

InterfaceSource on GitHub

This interface is used for consumers (write)

  • Phalcon\Domain\Payload\WriteableInterface

Uses Throwable

Method Summary

publicPayloadInterfacesetException( Throwable$exception )Sets an exception produced by the domain layer.publicPayloadInterfacesetExtras( mixed$extras )Sets arbitrary extra values produced by the domain layer.publicPayloadInterfacesetInput( mixed$input )Sets the input received by the domain layer.publicPayloadInterfacesetMessages( mixed$messages )Sets the messages produced by the domain layer.publicPayloadInterfacesetOutput( mixed$output )Sets the output produced from the domain layer.publicPayloadInterfacesetStatus( mixed$status )Sets the status of this payload.

Methods

Public · 6

setException()

public function setException( Throwable $exception ): PayloadInterface;

Sets an exception produced by the domain layer.

setExtras()

public function setExtras( mixed $extras ): PayloadInterface;

Sets arbitrary extra values produced by the domain layer.

setInput()

public function setInput( mixed $input ): PayloadInterface;

Sets the input received by the domain layer.

setMessages()

public function setMessages( mixed $messages ): PayloadInterface;

Sets the messages produced by the domain layer.

setOutput()

public function setOutput( mixed $output ): PayloadInterface;

Sets the output produced from the domain layer.

setStatus()

public function setStatus( mixed $status ): PayloadInterface;

Sets the status of this payload.

Type to search…

↑↓ navigate↵ selectEsc close