webinarium / DataTablesBundle

src/DataTables.php

<?php

//----------------------------------------------------------------------
//
//  Copyright (C) 2015-2022 Artem Rodygin
//
//  This file is part of DataTables Symfony bundle.
//
//  You should have received a copy of the MIT License along with
//  the bundle. If not, see <http://opensource.org/licenses/MIT>.
//
//----------------------------------------------------------------------

namespace DataTables;

use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * DataTables lookup service.
 */
class DataTables implements DataTablesInterface
{
    protected $logger;
    protected $validator;

    /** @var DataTableHandlerInterface[] List of registered DataTable services */
    protected $services = [];

    /**
     * @codeCoverageIgnore Dependency Injection constructor.
     */
    public function __construct(LoggerInterface $logger, ValidatorInterface $validator)
    {
        $this->logger    = $logger;
        $this->validator = $validator;
    }

    /**
     * Registers specified DataTable handler.
     *
     * @param DataTableHandlerInterface $service Service of the DataTable handler
     * @param null|string               $id      DataTable ID
     */
    public function addService(DataTableHandlerInterface $service, string $id = null)
    {
        $service_id = $id ?? $service::ID;

        if (null !== $service_id) {
            $this->services[$service_id] = $service;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function handle(Request $request, string $id, array $context = []): DataTableResults
    {
        $this->logger->debug('Handle DataTable request', [$id]);

        // Retrieve sent parameters.
        $params = new Parameters();

        $keyParams = [
            'draw',
            'start',
            'length',
            'search',
            'order',
            'columns',
        ];

        $params->draw    = $request->get('draw');
        $params->start   = $request->get('start');
        $params->length  = $request->get('length');
        $params->search  = $request->get('search');
        $params->order   = $request->get('order')   ?? [];
        $params->columns = $request->get('columns') ?? [];

        $allParams = $request->isMethod(Request::METHOD_POST)
            ? $request->request->all()
            : $request->query->all();

        $params->customData = array_diff_key($allParams, array_flip($keyParams));

        // Validate sent parameters.
        $violations = $this->validator->validate($params);

        if (count($violations)) {
            $message = $violations->get(0)->getMessage();
            $this->logger->error($message, ['request']);

            throw new DataTableException($message);
        }

        // Check for valid handler is registered.
        if (!array_key_exists($id, $this->services)) {
            $message = 'Unknown DataTable ID.';
            $this->logger->error($message, [$id]);

            throw new DataTableException($message);
        }

        // Convert sent parameters into data model.
        $query = new DataTableQuery($params);

        // Pass the data model to the handler.
        $result = null;

The assignment to $result is dead and can be removed.

        $timer_started = microtime(true);

        try {
            $result = $this->services[$id]->handle($query, $context);
        } catch (\Exception $e) {
            $this->logger->error($e->getMessage(), [$this->services[$id]]);

            throw new DataTableException($e->getMessage());
        } finally {
            $timer_stopped = microtime(true);
            $this->logger->debug('DataTable processing time', [$timer_stopped - $timer_started, $this->services[$id]]);
        }

        // Validate results returned from handler.
        $violations = $this->validator->validate($result);

        if (count($violations)) {
            $message = $violations->get(0)->getMessage();
            $this->logger->error($message, ['response']);

            throw new DataTableException($message);
        }

        $reflection = new \ReflectionProperty(DataTableResults::class, 'draw');
        $reflection->setAccessible(true);
        $reflection->setValue($result, $params->draw);

        return $result;
    }
}