FormListingRepository.php
124 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Form\Listing; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\FormEntity; |
| 9 | use MailPoet\Listing\ListingDateRangeFilterTrait; |
| 10 | use MailPoet\Listing\ListingDefinition; |
| 11 | use MailPoet\Listing\ListingRepository; |
| 12 | use MailPoetVendor\Doctrine\ORM\QueryBuilder; |
| 13 | |
| 14 | class FormListingRepository extends ListingRepository { |
| 15 | use ListingDateRangeFilterTrait; |
| 16 | |
| 17 | // Keys are the camelCased sort field (ListingRepository::getData converts the |
| 18 | // request's snake_case `sort_by` before calling applySorting). |
| 19 | private const SORT_FIELDS = [ |
| 20 | 'name' => 'name', |
| 21 | 'createdAt' => 'createdAt', |
| 22 | 'updatedAt' => 'updatedAt', |
| 23 | ]; |
| 24 | |
| 25 | public function getGroups(ListingDefinition $definition): array { |
| 26 | $queryBuilder = clone $this->queryBuilder; |
| 27 | $this->applyFromClause($queryBuilder); |
| 28 | $this->applyParameters($queryBuilder, $definition->getParameters()); |
| 29 | |
| 30 | // total count |
| 31 | $countQueryBuilder = clone $queryBuilder; |
| 32 | $countQueryBuilder->select('COUNT(f) AS formCount'); |
| 33 | $countQueryBuilder->andWhere('f.deletedAt IS NULL'); |
| 34 | $totalCount = (int)$countQueryBuilder->getQuery()->getSingleScalarResult(); |
| 35 | |
| 36 | // trashed count |
| 37 | $trashedCountQueryBuilder = clone $queryBuilder; |
| 38 | $trashedCountQueryBuilder->select('COUNT(f) AS formCount'); |
| 39 | $trashedCountQueryBuilder->andWhere('f.deletedAt IS NOT NULL'); |
| 40 | $trashedCount = (int)$trashedCountQueryBuilder->getQuery()->getSingleScalarResult(); |
| 41 | |
| 42 | return [ |
| 43 | [ |
| 44 | 'name' => 'all', |
| 45 | 'label' => __('All', 'mailpoet'), |
| 46 | 'count' => $totalCount, |
| 47 | ], |
| 48 | [ |
| 49 | 'name' => 'trash', |
| 50 | 'label' => __('Trash', 'mailpoet'), |
| 51 | 'count' => $trashedCount, |
| 52 | ], |
| 53 | ]; |
| 54 | } |
| 55 | |
| 56 | protected function applySelectClause(QueryBuilder $queryBuilder) { |
| 57 | $queryBuilder->select("PARTIAL f.{id,name,status,settings,createdAt,updatedAt,deletedAt}"); |
| 58 | } |
| 59 | |
| 60 | protected function applyFromClause(QueryBuilder $queryBuilder) { |
| 61 | $queryBuilder->from(FormEntity::class, 'f'); |
| 62 | } |
| 63 | |
| 64 | protected function applyGroup(QueryBuilder $queryBuilder, string $group) { |
| 65 | // include/exclude deleted |
| 66 | if ($group === 'trash') { |
| 67 | $queryBuilder->andWhere('f.deletedAt IS NOT NULL'); |
| 68 | } else { |
| 69 | $queryBuilder->andWhere('f.deletedAt IS NULL'); |
| 70 | } |
| 71 | } |
| 72 | |
| 73 | protected function applySorting(QueryBuilder $queryBuilder, string $sortBy, string $sortOrder) { |
| 74 | $field = self::SORT_FIELDS[$sortBy] ?? 'updatedAt'; |
| 75 | $queryBuilder->addOrderBy("f.$field", $sortOrder); |
| 76 | $queryBuilder->addOrderBy('f.id', 'asc'); |
| 77 | } |
| 78 | |
| 79 | protected function applySearch(QueryBuilder $queryBuilder, string $search, array $parameters = []) { |
| 80 | $needle = strtolower(trim($search)); |
| 81 | if ($needle === '') { |
| 82 | return; |
| 83 | } |
| 84 | // Escape LIKE wildcards (`%`, `_`) and the escape char itself (`|`) so |
| 85 | // user input matches as a literal substring rather than a pattern. |
| 86 | // Pipe is used as the LIKE ESCAPE character because backslash gets |
| 87 | // double-escaped through the DQL -> SQL layer ("Incorrect arguments to |
| 88 | // ESCAPE" otherwise). |
| 89 | // Order matters: `|` is replaced first so we don't double-escape the |
| 90 | // wildcard escapes added in the next steps. |
| 91 | $escaped = str_replace( |
| 92 | ['|', '%', '_'], |
| 93 | ['||', '|%', '|_'], |
| 94 | $needle |
| 95 | ); |
| 96 | $queryBuilder |
| 97 | ->andWhere("LOWER(f.name) LIKE :search ESCAPE '|'") |
| 98 | ->setParameter('search', '%' . $escaped . '%'); |
| 99 | } |
| 100 | |
| 101 | protected function applyFilters(QueryBuilder $queryBuilder, array $filters) { |
| 102 | $statuses = $filters['status'] ?? null; |
| 103 | if (!empty($statuses)) { |
| 104 | $statuses = is_array($statuses) ? $statuses : [$statuses]; |
| 105 | $statuses = array_values(array_intersect( |
| 106 | $statuses, |
| 107 | [FormEntity::STATUS_ENABLED, FormEntity::STATUS_DISABLED] |
| 108 | )); |
| 109 | if ($statuses) { |
| 110 | $queryBuilder |
| 111 | ->andWhere('f.status IN (:statuses)') |
| 112 | ->setParameter('statuses', $statuses); |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | $this->applyDateRangeFilter($queryBuilder, 'f.createdAt', $filters, 'created_from', 'created_to'); |
| 117 | $this->applyDateRangeFilter($queryBuilder, 'f.updatedAt', $filters, 'updated_from', 'updated_to'); |
| 118 | } |
| 119 | |
| 120 | protected function applyParameters(QueryBuilder $queryBuilder, array $parameters) { |
| 121 | // the parent class requires this method, but forms listing doesn't currently support this feature. |
| 122 | } |
| 123 | } |
| 124 |