SoliDry\Documentation\RelationsDoc

Complexity

Total Complexity

5

Size/Duplication

Total Lines	212
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setDeleteRelation()	0	35	1
A	setRelations()	0	41	1
A	setRelated()	0	41	1
A	setCreateRelation()	0	35	1
A	setUpdateRelation()	0	35	1

<?php

namespace SoliDry\Documentation;

use SoliDry\Extension\JSONApiInterface;
use SoliDry\Helpers\Classes;
use SoliDry\Helpers\MigrationsHelper;
use SoliDry\Types\DefaultInterface;
use SoliDry\Types\DocumentationInterface;
use SoliDry\Types\PhpInterface;

trait RelationsDoc
{
    /**
     *  Sets OAS documentation for a related method
     */
    private function setRelated(): void
    {
        $this->openComment();

It seems like openComment() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->setStarredComment(DocumentationInterface::OA_GET . PhpInterface::OPEN_PARENTHESES);

It seems like setStarredComment() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
            . MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/{related}",', 1, 1);

        $this->setStarredComment('summary="Get ' . Classes::getClassName($this->generator->objectName) . ' related objects",', 1, 1);

        $this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
            . '"},', 1, 1);

        $this->setParameter([

It seems like setParameter() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'in'       => '"query"',
            'name'     => '"data"',
            'required' => 'false',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"id"',
            'required' => 'true',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"related"',
            'required' => 'true',
        ]);

        $this->setResponse([

It seems like setResponse() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'response'    => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
            'description' => '"' . self::SUCCESSFUL_OPERATION . '"',

The constant SoliDry\Documentation\RelationsDoc::SUCCESSFUL_OPERATION was not found. Maybe you did not declare it correctly or list all dependencies?

        ]);

        $this->setStarredComment(PhpInterface::CLOSE_PARENTHESES);

        $this->closeComment();

It seems like closeComment() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->setNewLines();

It seems like setNewLines() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     *  Sets OAS documentation for getting relations method
     */
    private function setRelations(): void
    {
        $this->openComment();

        $this->setStarredComment(DocumentationInterface::OA_GET . PhpInterface::OPEN_PARENTHESES);

        $this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
            . MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);

        $this->setStarredComment('summary="Get ' . Classes::getClassName($this->generator->objectName) . ' relations objects",', 1, 1);

        $this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
            . '"},', 1, 1);

        $this->setParameter([
            'in'       => '"query"',
            'name'     => '"data"',
            'required' => 'false',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"id"',
            'required' => 'true',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"relations"',
            'required' => 'true',
        ]);

        $this->setResponse([
            'response'    => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
            'description' => '"' . self::SUCCESSFUL_OPERATION . '"',

The constant SoliDry\Documentation\RelationsDoc::SUCCESSFUL_OPERATION was not found. Maybe you did not declare it correctly or list all dependencies?

        ]);

        $this->setStarredComment(PhpInterface::CLOSE_PARENTHESES);

        $this->closeComment();
        $this->setNewLines();
    }

    /**
     *  Sets OAS documentation for creating relation method
     */
    private function setCreateRelation(): void
    {
        $this->openComment();

        $this->setStarredComment(DocumentationInterface::OA_POST . PhpInterface::OPEN_PARENTHESES);

        $this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
            . MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);

        $this->setStarredComment('summary="Create ' . Classes::getClassName($this->generator->objectName) . ' relation object",', 1, 1);

        $this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
            . '"},', 1, 1);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"id"',
            'required' => 'true',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"relations"',
            'required' => 'true',
        ]);

        $this->setResponse([
            'response'    => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_CREATED . '"',
            'description' => '"' . self::SUCCESSFUL_OPERATION . '"',

The constant SoliDry\Documentation\RelationsDoc::SUCCESSFUL_OPERATION was not found. Maybe you did not declare it correctly or list all dependencies?

        ]);

        $this->setStarredComment(PhpInterface::CLOSE_PARENTHESES);

        $this->closeComment();
        $this->setNewLines();
    }

    /**
     *  Sets OAS documentation for updating relation method
     */
    private function setUpdateRelation(): void
    {
        $this->openComment();

        $this->setStarredComment(DocumentationInterface::OA_PATCH . PhpInterface::OPEN_PARENTHESES);

        $this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
            . MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);

        $this->setStarredComment('summary="Update ' . Classes::getClassName($this->generator->objectName) . ' relation object",', 1, 1);

        $this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
            . '"},', 1, 1);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"id"',
            'required' => 'true',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"relations"',
            'required' => 'true',
        ]);

        $this->setResponse([
            'response'    => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_OK . '"',
            'description' => '"' . self::SUCCESSFUL_OPERATION . '"',

The constant SoliDry\Documentation\RelationsDoc::SUCCESSFUL_OPERATION was not found. Maybe you did not declare it correctly or list all dependencies?

        ]);

        $this->setStarredComment(PhpInterface::CLOSE_PARENTHESES);

        $this->closeComment();
        $this->setNewLines();
    }

    /**
     *  Sets OAS documentation for deleting relation method
     */
    private function setDeleteRelation(): void
    {
        $this->openComment();

        $this->setStarredComment(DocumentationInterface::OA_DELETE . PhpInterface::OPEN_PARENTHESES);

        $this->setStarredComment('path="' . PhpInterface::SLASH . $this->generator->version . PhpInterface::SLASH
            . MigrationsHelper::getTableName($this->generator->objectName) . PhpInterface::SLASH . '{id}/relationships/{relations}",', 1, 1);

        $this->setStarredComment('summary="Delete ' . Classes::getClassName($this->generator->objectName) . ' relation object",', 1, 1);

        $this->setStarredComment('tags={"' . Classes::getClassName($this->generator->objectName) . DefaultInterface::CONTROLLER_POSTFIX
            . '"},', 1, 1);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"id"',
            'required' => 'true',
        ]);

        $this->setParameter([
            'in'       => '"path"',
            'name'     => '"relations"',
            'required' => 'true',
        ]);

        $this->setResponse([
            'response'    => '"' . JSONApiInterface::HTTP_RESPONSE_CODE_NO_CONTENT . '"',
            'description' => '"' . self::SUCCESSFUL_OPERATION . '"',

The constant SoliDry\Documentation\RelationsDoc::SUCCESSFUL_OPERATION was not found. Maybe you did not declare it correctly or list all dependencies?

        ]);

        $this->setStarredComment(PhpInterface::CLOSE_PARENTHESES);

        $this->closeComment();
        $this->setNewLines();
    }
}