38577605491

Committed 14 Oct 2026 02:06PM UTC coverage: 84.066% (+4.2%) from 79.825%

Build # 38577605491

Build Type

push

github

Committed by

web-flow

Commit Message

Add search vector field (#108)

* add search vector field

* remove build in stemmer, add preparation for snowball stemmer

* enhance tokenizer, info about default locate

* adjust comments

* update language loading

* add normalizer

* fix issues with contao 5.3

* drop 4.13 support

* make indexing async

* update test data

* apply rector

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* address review comments

- Declare an explicit ESCAPE '!' for the LIKE patterns, so escaped wildcards
  match literally on every platform, and test it against stored rows
- Add the missing imports to the README configuration example
- Complete the locale description of BuildSearchVectorEvent
- Replace Contao's internal LegacyLocaleSwitcher in the indexer test with a
  test double

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* move search vector field documentation to docs

Keep a short example in the README like for the other fields and move the
full documentation to docs/dca_fields/search_vector_field.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* add createCondition method

* reject several search vector fields per table

A second registration for the same table silently replaced the first one.
Now loading the DCA throws an exception that names the conflicting fields.
Loading a DCA several times in one process, each time registering the field
once, is still allowed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* address review comments on indexing

- Lock the record while its vector is rebuilt (SELECT ... FOR UPDATE in a
  transaction), so concurrent rebuilds cannot overwrite a newer vector;
  requires Doctrine DBAL 3.8
- Expand Contao 5.7 virtual fields before resolving the configured fields
- Reject invalid --id values in the rebuild command instead of rebuilding
  the whole table
- Replace the deprecated Connection::quoteIdentifier() with the platform's
  quoteSingleIdentifier() and report Doctrine deprecat... (continued)

Coverage Stats

392 of 407 new or added lines in 16 files covered. (96.31%)

1588 of 1889 relevant lines covered (84.07%)

8.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.67

/src/SearchVector/SearchVectorDataContainer.php

<?php

namespace HeimrichHannot\UtilsBundle\SearchVector;

use Contao\DataContainer;

/**
 * Minimal data container for resolving field values outside the backend, e.g. in the rebuild command.
 *
 * Options callbacks get table, id and the current record, nothing else. getCurrentRecord() returns the given row
 * without the permission check of the backend driver, as there is usually no logged-in user.
 *
 * @internal
 */
class SearchVectorDataContainer extends DataContainer
{
    /**
     * @param array<string, mixed> $row
     */
    public function __construct(string $table, private readonly array $row)
    {
        parent::__construct();

        $this->strTable = $table;
        $this->intId = (int) ($row['id'] ?? 0);
        // For callbacks that still read the deprecated $dc->activeRecord
        $this->objActiveRecord = (object) $row;
    }

    public function getCurrentRecord(int|string|null $id = null, ?string $table = null): ?array
    {
        if ((!$id || (int) $id === $this->intId) && (!$table || $table === $this->strTable)) {
            return $this->row;
        }

        return parent::getCurrentRecord($id, $table);
    }

    public function getPalette(): string
    {
        return '';
    }

    protected function save($varValue): void
    {
    }
}

1	<?php
2
3	namespace HeimrichHannot\UtilsBundle\SearchVector;
4
5	use Contao\DataContainer;
6
7	/**
8	* Minimal data container for resolving field values outside the backend, e.g. in the rebuild command.
9	*
10	* Options callbacks get table, id and the current record, nothing else. getCurrentRecord() returns the given row
11	* without the permission check of the backend driver, as there is usually no logged-in user.
12	*
13	* @internal
14	*/
15	class SearchVectorDataContainer extends DataContainer
16	{
17	/**
18	* @param array<string, mixed> $row
19	*/
20	public function __construct(string $table, private readonly array $row)
21	{
22	parent::__construct();	17 ✔
23
24	$this->strTable = $table;	17 ✔
25	$this->intId = (int) ($row['id'] ?? 0);	17 ✔
26	// For callbacks that still read the deprecated $dc->activeRecord
27	$this->objActiveRecord = (object) $row;	17 ✔
28	}
29
30	public function getCurrentRecord(int\|string\|null $id = null, ?string $table = null): ?array
31	{
32	if ((!$id \|\| (int) $id === $this->intId) && (!$table \|\| $table === $this->strTable)) {	1 ✔
33	return $this->row;	1 ✔
34	}
35
NEW 36	return parent::getCurrentRecord($id, $table);	×
37	}
38
39	public function getPalette(): string
40	{
NEW 41	return '';	×
42	}
43
44	protected function save($varValue): void
45	{
NEW 46	}	×
47	}

heimrichhannot / contao-utils-bundle / 38577605491

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous