App\Containers\Documentation\Objects\PublicApi

Complexity

Total Complexity

4

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDocumentationPath()	0	4	1
A	getJsonFilePath()	0	4	1
A	getType()	0	4	1
A	getUrl()	0	4	1

<?php

namespace App\Containers\Documentation\Objects;

use App\Containers\Documentation\Contracts\ApiTypeInterface;

/**
 * Class PublicApi.
 *
 * @author Mahmoud Zalt <mahmoud@zalt.me>
 */
class PublicApi implements ApiTypeInterface
{

    CONST TYPE = 'public';

    /**
     * @var  string
     */
    protected $url = 'api/documentation';

    /**
     * Where to generate the new documentation.
     *
     * @return  string
     */
    public function getDocumentationPath()
    {
        return 'public/' . $this->url;
    }

    /**
     * @return  string
     */
    public function getJsonFilePath()
    {
        return "app/Containers/Documentation/ApiDocJs/{$this->getType()}";
    }

    /**
     * @return  string
     */
    public function getType()
    {
        return self::TYPE;
    }

    /**
     * @return  string
     */
    public function getUrl()
    {
        return $this->url;
    }

}