ResponseTrait::getSuccessResponse() - Code Metrics - itstructure/yii2-multi-format-uploader - Measure and Improve Code Quality continuously with Scrutinizer

ResponseTrait::getSuccessResponse() A
last analyzed 2023-01-23 00:02 UTC

↳ Parent: ResponseTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10

<?php

namespace Itstructure\MFUploader\traits;

/**
 * Trait ResponseTrait
 *
 * @package Itstructure\MFUploader\traits
 *
 * @author Andrey Girnik <[email protected]>
 */
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,
        ];
    }
}


1			<?php
2
3			namespace Itstructure\MFUploader\traits;
4
5			/**
6			* Trait ResponseTrait
7			*
8			* @package Itstructure\MFUploader\traits
9			*
10			* @author Andrey Girnik <[email protected]>
11			*/
12			trait ResponseTrait
13			{
14			/**
15			* Returns success response.
16			*
17			* @param string $message
18			* @param array\|null $data
19			*
20			* @return array
21			*/
22			protected function getSuccessResponse(string $message, array $data = null): array
23			{
24			return $this->getStatusResponse($message, 'success', $data);
25			}
26
27			/**
28			* Returns fail response.
29			*
30			* @param string $message
31			* @param array\|null $data
32			*
33			* @return array
34			*/
35			protected function getFailResponse(string $message, array $data = null): array
36			{
37			return $this->getStatusResponse($message, 'fail', $data);
38			}
39
40			/**
41			* Returns status, message and code.
42			*
43			* @param string $message
44			* @param string $status
45			* @param int $statusCode
46			* @param array\|null $data
47			*
48			* @return array
49			*/
50			protected function getStatusResponse(
51			string $message,
52			string $status,
53			array $data = null,
54			int $statusCode = 200): array {
55
56			if (null === $data) {
57			$data = (object)[];
58			}
59
60			\Yii::$app->response->statusCode = $statusCode;
61
62			return [
63			'meta' => [
64			'status' => $status,
65			'message' => $message,
66			],
67			'data' => $data,
68			];
69			}
70			}
71

itstructure / yii2-multi-format-uploader

ResponseTrait::getSuccessResponse() A last analyzed 2023-01-23 00:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ResponseTrait::getSuccessResponse() A
last analyzed 2023-01-23 00:02 UTC