Skip to content

Added a doctrine querybuilder adapter #275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
/vendor
/tests/Fixtures/var/
*~
/.idea
107 changes: 107 additions & 0 deletions src/Adapter/Doctrine/DBALAdapter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<?php declare(strict_types=1);

namespace Omines\DataTablesBundle\Adapter\Doctrine;

use Doctrine\Common\Collections\Expr\Comparison;
use Doctrine\DBAL\Query\QueryBuilder;
use Doctrine\ORM\Query\Expr;
use Omines\DataTablesBundle\Adapter\AbstractAdapter;
use Omines\DataTablesBundle\Adapter\AdapterQuery;

use Omines\DataTablesBundle\Column\AbstractColumn;
use Symfony\Component\OptionsResolver\OptionsResolver;

class DBALAdapter extends AbstractAdapter
{
private QueryBuilder $queryBuilder;

public function configure(array $options)
{
$resolver = new OptionsResolver();
$this->configureOptions($resolver);
$options = $resolver->resolve($options);

$this->queryBuilder = $options['queryBuilder'];
$this->validateQueryBuilder();
}

private function validateQueryBuilder()
{
if ($this->queryBuilder->getMaxResults() !== null) {
throw new \RuntimeException('QueryBuilder should not have a set maxResults. This is handled by the adapter.');
}
if ($this->queryBuilder->getFirstResult() !== 0) {
throw new \RuntimeException('QueryBuilder should not have a set firstResult. This is handled by the adapter.');
}
}

protected function prepareQuery(AdapterQuery $query)
{
foreach ($query->getState()->getDataTable()->getColumns() as $column) {
if (null === $column->getField()) {
$column->setOption('field', $column->getName());
}
}
}

protected function mapPropertyPath(AdapterQuery $query, AbstractColumn $column)
{
return "[{$column->getField()}]";
}

protected function getResults(AdapterQuery $query): \Traversable
{
$totalsQueryBuilder = (clone $this->queryBuilder)->select('COUNT(*)');
$totalRows = (int)$totalsQueryBuilder->executeQuery()->fetchOne();
$query->setTotalRows($totalRows);
unset($totalsQueryBuilder);

// Set order
foreach ($query->getState()->getOrderBy() as [$column, $direction]) {
/** @var AbstractColumn $column */
if ($column->isOrderable()) {
$this->queryBuilder->addOrderBy("`{$column->getOrderField()}`", $direction);
}
}

// Deal with pagination
if ($query->getState()->getLength() > 0) {
$this->queryBuilder
->setFirstResult($query->getState()->getStart())
->setMaxResults($query->getState()->getLength())
;
}

// Handle global search
if (!empty($globalSearch = $query->getState()->getGlobalSearch())) {
$globalSearchCriteria = [];
foreach ($query->getState()->getDataTable()->getColumns() as $column) {
if ($column->isGlobalSearchable()) {
$globalSearchCriteria[] = $this->queryBuilder->expr()->like("`{$column->getField()}`", "'%{$globalSearch}%'");
}
}
$this->queryBuilder->andWhere($this->queryBuilder->expr()->orX(...$globalSearchCriteria));
}

// @todo Implement column filtering

$result = $this->queryBuilder->executeQuery();

$query->setFilteredRows($totalRows-$result->rowCount());

while ($row = $result->fetchAssociative()) {
yield $row;
}

}

protected function configureOptions(OptionsResolver $resolver)
{
$resolver
->setDefaults([])
->setRequired(['queryBuilder'])
->setAllowedTypes('queryBuilder', QueryBuilder::class)
;
}

}