PerfectOblivion\Payload\Contracts\PayloadContract

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
	setStatus()	0	1	?
	getStatus()	0	1	?
	setMessages()	0	1	?
	getMessages()	0	1	?
	setOutput()	0	1	?
	getOutput()	0	1	?
	getRawOutput()	0	1	?
	getWrappedOutput()	0	1	?
	getOutputWrapper()	0	1	?
	getMessagesWrapper()	0	1	?
	all()	0	1	?

<?php

namespace PerfectOblivion\Payload\Contracts;

interface PayloadContract extends Status
{
    /**
     * Set the Payload status.
     *
     * @param  int  $status
     */
    public function setStatus(int $status): PayloadContract;

    /**
     * Get the status of the payload.
     */
    public function getStatus(): int;

    /**
     * Set the Payload messages.
     *
     * @param  array  $output

There is no parameter named $output. Was it maybe removed?

     */
    public function setMessages(array $messages): PayloadContract;

    /**
     * Get messages array from the payload.
     */
    public function getMessages(): array;

    /**
     * Set the Payload output.
     *
     * @param  mixed  $output
     * @param  string|null  $wrapper
     */
    public function setOutput($output, ? string $wrapper = null): PayloadContract;

    /**
     * Get the Payload output.
     */
    public function getOutput(): array;

    /**
     * Get the raw Payload output.
     *
     * @return mixed
     */
    public function getRawOutput();

    /**
     * Get the wrapped Payload output.
     */
    public function getWrappedOutput(): array;

    /**
     * Get the wrapper for the output.
     */
    public function getOutputWrapper(): string;

    /**
     * Get the wrapper for messages.
     */
    public function getMessagesWrapper(): string;

    /**
     * Return all of the components of the payload in array format.
     */
    public function all(): array;
}