Itstructure\MFUploader\traits\ResponseTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getFailResponse()	0	3	1
A	getSuccessResponse()	0	3	1
A	getStatusResponse()	0	18	2

<?php

namespace Itstructure\MFUploader\traits;

/**
 * Trait ResponseTrait
 *
 * @package Itstructure\MFUploader\traits
 *
 * @author Andrey Girnik <girnikandrey@gmail.com>
 */
trait ResponseTrait
{
    /**
     * Returns success response.
     *
     * @param string     $message
     * @param array|null $data
     *
     * @return array
     */
    protected function getSuccessResponse(string $message, array $data = null): array
    {
        return $this->getStatusResponse($message, 'success', $data);
    }

    /**
     * Returns fail response.
     *
     * @param string     $message
     * @param array|null $data
     *
     * @return array
     */
    protected function getFailResponse(string $message, array $data = null): array
    {
        return $this->getStatusResponse($message, 'fail', $data);
    }

    /**
     * Returns status, message and code.
     *
     * @param string     $message
     * @param string     $status
     * @param int        $statusCode
     * @param array|null $data
     *
     * @return array
     */
    protected function getStatusResponse(
        string $message,
        string $status,
        array $data = null,
        int $statusCode = 200): array {

        if (null === $data) {
            $data = (object)[];
        }

        \Yii::$app->response->statusCode = $statusCode;

        return [
            'meta' => [
                'status' => $status,
                'message' => $message,
            ],
            'data' => $data,
        ];
    }
}