BlogController::view() - Code Metrics - yiisoft/demo - Measure and Improve Code Quality continuously with Scrutinizer

BlogController::view() A
last analyzed 2024-09-10 12:21 UTC

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	46
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	31
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	46
rs	9.424

<?php

declare(strict_types=1);

namespace App\Blog;

use App\Formatter\PaginatorFormatter;
use App\User\UserRequest;
use OpenApi\Attributes as OA;
filter:
    dependency_paths: ["lib/*"]
use Psr\Http\Message\ResponseInterface as Response;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\DataResponse\DataResponseFactoryInterface;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Input\Http\Attribute\Parameter\Query;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Router\HydratorAttribute\RouteArgument;
filter:
    dependency_paths: ["lib/*"]

#[OA\Tag(name: 'blog', description: 'Blog')]
#[OA\Parameter(parameter: 'PageRequest', name: 'page', in: 'query', schema: new OA\Schema(type: 'int', example: '2'))]
final class BlogController
{
    private DataResponseFactoryInterface $responseFactory;
    private PostRepository $postRepository;
    private PostFormatter $postFormatter;
    private PostBuilder $postBuilder;
    private BlogService $blogService;

    public function __construct(
        PostRepository $postRepository,
        DataResponseFactoryInterface $responseFactory,
        PostFormatter $postFormatter,
        PostBuilder $postBuilder,
        BlogService $blogService
    ) {
        $this->postRepository = $postRepository;
        $this->responseFactory = $responseFactory;
        $this->postFormatter = $postFormatter;
        $this->postBuilder = $postBuilder;
        $this->blogService = $blogService;
    }

    #[OA\Get(
        path: '/blog/',
        description: '',
        summary: 'Returns paginated blog posts',
        tags: ['blog'],
        parameters: [
            new OA\Parameter(ref: '#/components/parameters/PageRequest'),
        ],
        responses: [
            new OA\Response(
                response:'200',
                description:'Success',
                content: new OA\JsonContent(
                    allOf: [
                        new OA\Schema(ref: '#/components/schemas/Response'),
                        new OA\Schema(properties: [
                            new OA\Property(
                                property: 'data',
                                properties: [
                                    new OA\Property(property: 'posts', type: 'array', items: new OA\Items(ref:'#/components/schemas/Post')),
                                    new OA\Property(property: 'paginator', ref: '#/components/schemas/Paginator', type: 'object'),
                                ],
                                type: 'object'
                            ),
                        ]),
                    ]
                ),
            ),
        ]
    )]
    public function index(PaginatorFormatter $paginatorFormatter, #[Query('page')] int $page = 1): Response
    {
        $paginator = $this->blogService->getPosts($page);

        $posts = [];
        foreach ($paginator->read() as $post) {
            $posts[] = $this->postFormatter->format($post);

        }

        return $this->responseFactory->createResponse(

            [
                'paginator' => $paginatorFormatter->format($paginator),
                'posts' => $posts,
            ]
        );
    }

    #[OA\Get(
        path: '/blog/{id}',
        description: '',
        summary: 'Returns a post with a given ID',
        tags: ['blog'],
        parameters: [
            new OA\Parameter(parameter: 'id', name: 'id', in: 'path', schema: new OA\Schema(type: 'int', example: '2')),
        ],
        responses: [
            new OA\Response(
                response:'200',
                description:'Success',
                content: new OA\JsonContent(
                    allOf: [
                        new OA\Schema(ref: '#/components/schemas/Response'),
                        new OA\Schema(properties: [
                            new OA\Property(
                                property: 'data',
                                properties: [
                                    new OA\Property(property: 'post', ref: '#/components/schemas/Post', type: 'object'),
                                ],
                                type: 'object'
                            ),
                        ]),
                    ]
                ),
            ),
            new OA\Response(
                response: '404',
                description: 'Not found',
                content: new OA\JsonContent(allOf: [
                    new OA\Schema(ref:  '#/components/schemas/BadResponse'),
                    new OA\Schema(properties: [
                        new OA\Property(property:'error_message', example:'Entity not found'),
                        new OA\Property(property: 'error_code', example: 404, nullable: true),
                    ]),
                ])
            ),
        ]
    )]
    public function view(#[RouteArgument('id')] int $id): Response
    {
        return $this->responseFactory->createResponse(

            [
                'post' => $this->postFormatter->format(

                    $this->blogService->getPost($id)

                ),
            ]
        );
    }

    #[OA\Post(
        path: '/blog/',
        description: '',
        summary: 'Creates a blog post',
        security: [new OA\SecurityScheme(ref: '#/components/securitySchemes/ApiKey')],
        requestBody: new OA\RequestBody(required: true, content: new OA\JsonContent(
            allOf: [
                new OA\Schema(ref: '#/components/schemas/EditPostRequest'),
            ]
        )),
        tags: ['blog'],
        responses: [
            new OA\Response(
                response: '200',
                description: 'Success',
                content: new OA\JsonContent(ref: '#/components/schemas/Response')
            ),
            new OA\Response(
                response: '400',
                description: 'Bad request',
                content: new OA\JsonContent(ref:  '#/components/schemas/BadResponse')
            ),
        ]
    )]
    public function create(EditPostRequest $postRequest, UserRequest $userRequest): Response
    {
        $post = $this->postBuilder->build(new Post(), $postRequest);

        $post->setUser($userRequest->getUser());

        $this->postRepository->save($post);


        return $this->responseFactory->createResponse();

    }

    #[OA\Put(
        path: '/blog/{id}',
        description: '',
        summary: 'Updates a blog post with a given ID',
        security: [new OA\SecurityScheme(ref: '#/components/securitySchemes/ApiKey')],
        requestBody: new OA\RequestBody(required: true, content: new OA\JsonContent(
            allOf: [
                new OA\Schema(ref: '#/components/schemas/EditPostRequest'),
            ]
        )),
        tags: ['blog'],
        parameters: [
            new OA\Parameter(parameter: 'id', name: 'id', in: 'path', schema: new OA\Schema(type: 'int', example: '2')),
        ],
        responses: [
            new OA\Response(
                response: '200',
                description: 'Success',
                content: new OA\JsonContent(ref: '#/components/schemas/Response')
            ),
            new OA\Response(
                response: '400',
                description: 'Bad request',
                content: new OA\JsonContent(ref:  '#/components/schemas/BadResponse')
            ),
        ]
    )]
    public function update(EditPostRequest $postRequest, #[RouteArgument('id')] int $id): Response
    {
        $post = $this->postBuilder->build(

            $this->blogService->getPost($id),

            $postRequest
        );

        $this->postRepository->save($post);


        return $this->responseFactory->createResponse();

    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace App\Blog;
6
7			use App\Formatter\PaginatorFormatter;
8			use App\User\UserRequest;
9			use OpenApi\Attributes as OA;
			0 ignored issues – show Bug introduced 2024-02-20 16:45 UTC by Report Bug Copy Issue Report The type `OpenApi\Attributes` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use Psr\Http\Message\ResponseInterface as Response;
			0 ignored issues – show Bug introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The type `Psr\Http\Message\ResponseInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11			use Yiisoft\DataResponse\DataResponseFactoryInterface;
			0 ignored issues – show Bug introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The type `Yiisoft\DataResponse\DataResponseFactoryInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
12			use Yiisoft\Input\Http\Attribute\Parameter\Query;
			0 ignored issues – show Bug introduced 2023-05-15 15:04 UTC by Report Bug Copy Issue Report The type `Yiisoft\Input\Http\Attribute\Parameter\Query` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
13			use Yiisoft\Router\HydratorAttribute\RouteArgument;
			0 ignored issues – show Bug introduced 2023-05-16 13:50 UTC by Report Bug Copy Issue Report The type `Yiisoft\Router\HydratorAttribute\RouteArgument` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14
15			#[OA\Tag(name: 'blog', description: 'Blog')]
16			#[OA\Parameter(parameter: 'PageRequest', name: 'page', in: 'query', schema: new OA\Schema(type: 'int', example: '2'))]
17			final class BlogController
18			{
19			private DataResponseFactoryInterface $responseFactory;
20			private PostRepository $postRepository;
21			private PostFormatter $postFormatter;
22			private PostBuilder $postBuilder;
23			private BlogService $blogService;
24
25			public function __construct(
26			PostRepository $postRepository,
27			DataResponseFactoryInterface $responseFactory,
28			PostFormatter $postFormatter,
29			PostBuilder $postBuilder,
30			BlogService $blogService
31			) {
32			$this->postRepository = $postRepository;
33			$this->responseFactory = $responseFactory;
34			$this->postFormatter = $postFormatter;
35			$this->postBuilder = $postBuilder;
36			$this->blogService = $blogService;
37			}
38
39			#[OA\Get(
40			path: '/blog/',
41			description: '',
42			summary: 'Returns paginated blog posts',
43			tags: ['blog'],
44			parameters: [
45			new OA\Parameter(ref: '#/components/parameters/PageRequest'),
46			],
47			responses: [
48			new OA\Response(
49			response:'200',
50			description:'Success',
51			content: new OA\JsonContent(
52			allOf: [
53			new OA\Schema(ref: '#/components/schemas/Response'),
54			new OA\Schema(properties: [
55			new OA\Property(
56			property: 'data',
57			properties: [
58			new OA\Property(property: 'posts', type: 'array', items: new OA\Items(ref:'#/components/schemas/Post')),
59			new OA\Property(property: 'paginator', ref: '#/components/schemas/Paginator', type: 'object'),
60			],
61			type: 'object'
62			),
63			]),
64			]
65			),
66			),
67			]
68			)]
69			public function index(PaginatorFormatter $paginatorFormatter, #[Query('page')] int $page = 1): Response
70			{
71			$paginator = $this->blogService->getPosts($page);
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `blogService` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
72			$posts = [];
73			foreach ($paginator->read() as $post) {
74			$posts[] = $this->postFormatter->format($post);
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `postFormatter` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
75			}
76
77			return $this->responseFactory->createResponse(
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `responseFactory` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
78			[
79			'paginator' => $paginatorFormatter->format($paginator),
80			'posts' => $posts,
81			]
82			);
83			}
84
85			#[OA\Get(
86			path: '/blog/{id}',
87			description: '',
88			summary: 'Returns a post with a given ID',
89			tags: ['blog'],
90			parameters: [
91			new OA\Parameter(parameter: 'id', name: 'id', in: 'path', schema: new OA\Schema(type: 'int', example: '2')),
92			],
93			responses: [
94			new OA\Response(
95			response:'200',
96			description:'Success',
97			content: new OA\JsonContent(
98			allOf: [
99			new OA\Schema(ref: '#/components/schemas/Response'),
100			new OA\Schema(properties: [
101			new OA\Property(
102			property: 'data',
103			properties: [
104			new OA\Property(property: 'post', ref: '#/components/schemas/Post', type: 'object'),
105			],
106			type: 'object'
107			),
108			]),
109			]
110			),
111			),
112			new OA\Response(
113			response: '404',
114			description: 'Not found',
115			content: new OA\JsonContent(allOf: [
116			new OA\Schema(ref: '#/components/schemas/BadResponse'),
117			new OA\Schema(properties: [
118			new OA\Property(property:'error_message', example:'Entity not found'),
119			new OA\Property(property: 'error_code', example: 404, nullable: true),
120			]),
121			])
122			),
123			]
124			)]
125			public function view(#[RouteArgument('id')] int $id): Response
126			{
127			return $this->responseFactory->createResponse(
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `responseFactory` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
128			[
129			'post' => $this->postFormatter->format(
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `postFormatter` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
130			$this->blogService->getPost($id)
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `blogService` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
131			),
132			]
133			);
134			}
135
136			#[OA\Post(
137			path: '/blog/',
138			description: '',
139			summary: 'Creates a blog post',
140			security: [new OA\SecurityScheme(ref: '#/components/securitySchemes/ApiKey')],
141			requestBody: new OA\RequestBody(required: true, content: new OA\JsonContent(
142			allOf: [
143			new OA\Schema(ref: '#/components/schemas/EditPostRequest'),
144			]
145			)),
146			tags: ['blog'],
147			responses: [
148			new OA\Response(
149			response: '200',
150			description: 'Success',
151			content: new OA\JsonContent(ref: '#/components/schemas/Response')
152			),
153			new OA\Response(
154			response: '400',
155			description: 'Bad request',
156			content: new OA\JsonContent(ref: '#/components/schemas/BadResponse')
157			),
158			]
159			)]
160			public function create(EditPostRequest $postRequest, UserRequest $userRequest): Response
161			{
162			$post = $this->postBuilder->build(new Post(), $postRequest);
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `postBuilder` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
163			$post->setUser($userRequest->getUser());
164
165			$this->postRepository->save($post);
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `postRepository` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
166
167			return $this->responseFactory->createResponse();
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `responseFactory` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
168			}
169
170			#[OA\Put(
171			path: '/blog/{id}',
172			description: '',
173			summary: 'Updates a blog post with a given ID',
174			security: [new OA\SecurityScheme(ref: '#/components/securitySchemes/ApiKey')],
175			requestBody: new OA\RequestBody(required: true, content: new OA\JsonContent(
176			allOf: [
177			new OA\Schema(ref: '#/components/schemas/EditPostRequest'),
178			]
179			)),
180			tags: ['blog'],
181			parameters: [
182			new OA\Parameter(parameter: 'id', name: 'id', in: 'path', schema: new OA\Schema(type: 'int', example: '2')),
183			],
184			responses: [
185			new OA\Response(
186			response: '200',
187			description: 'Success',
188			content: new OA\JsonContent(ref: '#/components/schemas/Response')
189			),
190			new OA\Response(
191			response: '400',
192			description: 'Bad request',
193			content: new OA\JsonContent(ref: '#/components/schemas/BadResponse')
194			),
195			]
196			)]
197			public function update(EditPostRequest $postRequest, #[RouteArgument('id')] int $id): Response
198			{
199			$post = $this->postBuilder->build(
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `postBuilder` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
200			$this->blogService->getPost($id),
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `blogService` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
201			$postRequest
202			);
203
204			$this->postRepository->save($post);
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `postRepository` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
205
206			return $this->responseFactory->createResponse();
			0 ignored issues – show Bug Best Practice introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The property `responseFactory` does not exist on `App\Blog\BlogController`. Did you maybe forget to declare it? Loading history...
207			}
208			}
209

yiisoft / demo

BlogController::view() A last analyzed 2024-09-10 12:21 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BlogController::view() A
last analyzed 2024-09-10 12:21 UTC