vistart\Models\traits\RestModuleTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	responseBeforeSend()	0	16	3
A	transRouteToName()	0	4	1
A	getApiName()	0	4	1
A	getApiRateLimiterName()	0	4	1

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link http://vistart.name/
 * @copyright Copyright (c) 2016 vistart
 * @license http://vistart.name/license/
 */

namespace vistart\Models\traits;

/**
 * This trait is used for building module with RESTful API.
 *
 * @version 2.0
 * @author vistart <i@vistart.name>
 */
trait RestModuleTrait
{

    /**
     * This event will move response data into array which contains `success` and
     * `data` elements, and replace status code with 200.
     * @param \yii\base\Event $event
     */
    protected function responseBeforeSend($event)
    {
        $response = $event->sender;
        /* @var $response \yii\web\Response */
        if ($response->data !== null) {
            // Clear the 'type' property in all responses.
            if (isset($response->data['type'])) {
                unset($response->data['type']);
            }
            $response->data = [
                'success' => $response->isSuccessful,
                'data' => $response->data
            ];
            $response->statusCode = 200;
        }
    }

    /**
     * replace '_' with '/'.
     * @param string $route
     * @return string 
     */
    public static function transRouteToName($route)
    {
        return str_replace('/', '_', $route);
    }

    /**
     * Get API name.
     * @param string $route
     * @return string
     */
    public static function getApiName($route)
    {
        return 'api_' . self::transRouteToName($route);
    }

    public static function getApiRateLimiterName($route)
    {
        return static::getApiName($route) . '_ratelimiter';
    }
}