turnaev / monitor-bundle

src/Controller/TraitApiCommon.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 JMS\Serializer\Serializer;
use Symfony\Component\HttpFoundation\Response;
use Tvi\MonitorBundle\Reporter\ReporterManager;
use Tvi\MonitorBundle\Runner\RunnerManager;

/**

Missing short description in doc comment

 * @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 TraitApiCommon
{
    /**

Missing short description in doc comment

     * @var RunnerManager
     */
    protected $runnerManager;

    /**

Missing short description in doc comment

     * @var ReporterManager
     */
    protected $reporterManager;

    /**

Missing short description in doc comment

     * @var Serializer
     */
    protected $serializer;

    public function __construct(RunnerManager $runnerManager, ReporterManager $reporterManager, Serializer $serializer)

Missing doc comment for function __construct()

    {
        $this->runnerManager = $runnerManager;
        $this->reporterManager = $reporterManager;
        $this->serializer = $serializer;
    }

    protected function creatResponse($data = null, int $status = Response::HTTP_OK, bool $json = false, array $headers = []): Response

Missing doc comment for function creatResponse()

    {
        if ($json && !\is_string($json)) {
            $data = $this->serializer->serialize($data, 'json');
        }

        if ($json) {
            $headers['Content-Type'] = 'application/json';
        }

        return new Response($data, $status, $headers);
    }
}