for testing and deploying your application
for finding and fixing issues
for empowering human code reviews
<?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
$output
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter $italy is not defined by the method finale(...).
$italy
finale(...)
/** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; }
The most likely cause is that the parameter was removed, but the annotation was not.
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;
}
perfect-oblivion /
payload
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.