FormListingRepository.php

<?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing

namespace MailPoet\Form\Listing;

if (!defined('ABSPATH')) exit;


use MailPoet\Entities\FormEntity;
use MailPoet\Listing\ListingDefinition;
use MailPoet\Listing\ListingRepository;
use MailPoetVendor\Doctrine\ORM\QueryBuilder;

class FormListingRepository extends ListingRepository {
  private const SORT_FIELDS = [
    'name' => 'name',
    'updatedAt' => 'updatedAt',
  ];

  public function getGroups(ListingDefinition $definition): array {
    $queryBuilder = clone $this->queryBuilder;
    $this->applyFromClause($queryBuilder);
    $this->applyParameters($queryBuilder, $definition->getParameters());

    // total count
    $countQueryBuilder = clone $queryBuilder;
    $countQueryBuilder->select('COUNT(f) AS formCount');
    $countQueryBuilder->andWhere('f.deletedAt IS NULL');
    $totalCount = (int)$countQueryBuilder->getQuery()->getSingleScalarResult();

    // trashed count
    $trashedCountQueryBuilder = clone $queryBuilder;
    $trashedCountQueryBuilder->select('COUNT(f) AS formCount');
    $trashedCountQueryBuilder->andWhere('f.deletedAt IS NOT NULL');
    $trashedCount = (int)$trashedCountQueryBuilder->getQuery()->getSingleScalarResult();

    return [
      [
        'name' => 'all',
        'label' => __('All', 'mailpoet'),
        'count' => $totalCount,
      ],
      [
        'name' => 'trash',
        'label' => __('Trash', 'mailpoet'),
        'count' => $trashedCount,
      ],
    ];
  }

  protected function applySelectClause(QueryBuilder $queryBuilder) {
    $queryBuilder->select("PARTIAL f.{id,name,status,settings,createdAt,updatedAt,deletedAt}");
  }

  protected function applyFromClause(QueryBuilder $queryBuilder) {
    $queryBuilder->from(FormEntity::class, 'f');
  }

  protected function applyGroup(QueryBuilder $queryBuilder, string $group) {
    // include/exclude deleted
    if ($group === 'trash') {
      $queryBuilder->andWhere('f.deletedAt IS NOT NULL');
    } else {
      $queryBuilder->andWhere('f.deletedAt IS NULL');
    }
  }

  protected function applySorting(QueryBuilder $queryBuilder, string $sortBy, string $sortOrder) {
    $field = self::SORT_FIELDS[$sortBy] ?? 'updatedAt';
    $queryBuilder->addOrderBy("f.$field", $sortOrder);
    $queryBuilder->addOrderBy('f.id', 'asc');
  }

  protected function applySearch(QueryBuilder $queryBuilder, string $search, array $parameters = []) {
    $needle = strtolower(trim($search));
    if ($needle === '') {
      return;
    }
    // Escape LIKE wildcards (`%`, `_`) and the escape char itself (`|`) so
    // user input matches as a literal substring rather than a pattern.
    // Pipe is used as the LIKE ESCAPE character because backslash gets
    // double-escaped through the DQL -> SQL layer ("Incorrect arguments to
    // ESCAPE" otherwise).
    // Order matters: `|` is replaced first so we don't double-escape the
    // wildcard escapes added in the next steps.
    $escaped = str_replace(
      ['|', '%', '_'],
      ['||', '|%', '|_'],
      $needle
    );
    $queryBuilder
      ->andWhere("LOWER(f.name) LIKE :search ESCAPE '|'")
      ->setParameter('search', '%' . $escaped . '%');
  }

  protected function applyFilters(QueryBuilder $queryBuilder, array $filters) {
    // the parent class requires this method, but forms listing doesn't currently support this feature.
  }

  protected function applyParameters(QueryBuilder $queryBuilder, array $parameters) {
    // the parent class requires this method, but forms listing doesn't currently support this feature.
  }
}