RazonYang\JSend\PayloadFactory

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	fail()	0	5	1
A	success()	0	5	1
A	error()	0	13	3

<?php
namespace RazonYang\JSend;

/**
 * MessageFactory is a factory that provides shortcuts to generate message.
 */
class PayloadFactory
{
    /**
     * Generates success payload.
     *
     * @param mixed $data
     *
     * @return MessageInterface

The type RazonYang\JSend\MessageInterface was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public static function success($data): PayloadInterface
    {
        return (new Payload())

The expression return new RazonYang\JSend\Payload()->setStatus(RazonYang\JSend\Status::SUCCESS)->setData($data) returns the type RazonYang\JSend\Payload which is incompatible with the documented return type RazonYang\JSend\MessageInterface.

            ->setStatus(Status::SUCCESS)
            ->setData($data);
    }

    /**
     * Generates fail payload.
     *
     * @param mixed $data
     *
     * @return MessageInterface
     */
    public static function fail($data): PayloadInterface
    {
        return (new Payload())

The expression return new RazonYang\JSend\Payload()->setStatus(RazonYang\JSend\Status::FAIL)->setData($data) returns the type RazonYang\JSend\Payload which is incompatible with the documented return type RazonYang\JSend\MessageInterface.

            ->setStatus(Status::FAIL)
            ->setData($data);
    }

    /**
     * Generates error payload.
     *
     * @param mixed $data
     *
     * @param string $message error message.
     * @param int    $code    error code.
     * @param mixed  $data    error data, i.e. stack traces.
     *
     * @return MessageInterface
     */
    public static function error(string $message, ?int $code = null, $data = null): PayloadInterface
    {
        $payload = (new Payload())
            ->setStatus(Status::ERROR)
            ->setMessage($message);
        if ($code !== null) {
            $payload->setCode($code);
        }
        if ($data !== null) {
            $payload->setData($data);
        }
        
        return $payload;

The expression return $payload returns the type RazonYang\JSend\Payload which is incompatible with the documented return type RazonYang\JSend\MessageInterface.

    }
}