Tebru\Retrofit\Annotation\REQUEST

Complexity

Total Complexity

3

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	7	1
A	getType()	0	4	1
A	hasBody()	0	4	1

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

declare(strict_types=1);

namespace Tebru\Retrofit\Annotation;

use Tebru\AnnotationReader\AbstractAnnotation;

/**
 * Defines an HTTP request type to a REST path relative to base URL.
 *
 * This is a generic annotation that lets you define an http request
 * outside the standard GET, POST, etc
 *
 * @author Nate Brunette <n@tebru.net>
 *
 * @Annotation
 * @Target({"CLASS", "METHOD"})
 */
class REQUEST extends AbstractAnnotation implements HttpRequest
{
    /**
     * The request method
     *
     * @var string
     */
    private $type;

    /**
     * If the request contains a body
     *
     * @var bool
     */
    private $body;

    /**
     * Initialize annotation data
     */
    protected function init(): void
    {
        $this->assertKey('type');

        $this->type = $this->data['type'];
        $this->body = $this->data['body'] ?? false;
    }


    /**
     * Returns the type of the annotation (get, post, put, etc)
     *
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * Returns true if the request type contains a body
     *
     * @return bool
     */
    public function hasBody(): bool
    {
        return $this->body;
    }
}