turnaev / monitor-bundle

src/Controller/TraitApiInfoCheck.php

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use JMS\Serializer\Serializer;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Tvi\MonitorBundle\Exception\HttpException;
use Tvi\MonitorBundle\Reporter\ReporterManager;
use Tvi\MonitorBundle\Runner\RunnerManager;

/**

Missing short description in doc comment

 * @property RunnerManager   $runnerManager
 * @property ReporterManager $reporterManager
 * @property Serializer      $serializer
 *
 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait TraitApiInfoCheck
{
    public function checkInfoAction(Request $request, $id, string $version): Response

The parameter $request is not used and could be removed.

The parameter $version is not used and could be removed.

Missing doc comment for function checkInfoAction()

    {
        try {
            $checks = $this->runnerManager->findChecks($id);
            if (1 === \count($checks)) {
                $check = current($checks);

                return $this->creatResponse($check, Response::HTTP_OK, true);

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

            }

            throw new NotFoundHttpException(sprintf('Check "%s" not found', $id));
        } catch (NotFoundHttpException $e) {
            $e = new HttpException($e->getStatusCode(), $e->getMessage());

            return $this->creatResponse($e->toArray(), $e->getStatusCode(), true);
        } catch (\Exception $e) {
            return $this->creatResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
        }
    }

    public function checkInfosAction(Request $request, string $version): Response

The parameter $version is not used and could be removed.

Missing doc comment for function checkInfosAction()

    {
        try {
            list($ids, $checks, $groups, $tags) = $this->getFilterParams($request);

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

            $checks = $checks ? $checks : $ids;

            $checks = $this->runnerManager->findChecks($checks, $groups, $tags);
            $checks = array_values($checks);

            return $this->creatResponse($checks, Response::HTTP_OK, true);
        } catch (\Exception $e) {
            return $this->creatResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
        }
    }
}