for testing and deploying your application
for finding and fixing issues
for empowering human code reviews
<?php
namespace BrightComponents\Common\Payloads\Contracts;
interface PayloadContract extends Status
{
/**
* Set the Payload status.
*
* @param string $status
* @return $this
*/
public function setStatus($status);
* Get the status of the payload.
* @return string
public function getStatus();
* Set the Payload output.
* @param mixed $output
* @param string|null $wrapper
public function setOutput($output, ? string $wrapper = null);
* Get the Payload output.
* @return array
public function getOutput();
* Get the unwrapped Payload output.
public function getUnwrappedOutput();
* 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);
* Get messages array from the payload.
public function getMessages();
* Get the wrapper for the output.
public function getOutputWrapper();
* Get the wrapper for messages.
public function getMessagesWrapper();
}
bright-components /
common
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.