ValueConversion.php

<?php

declare(strict_types=1);

/*
 * This file is part of the RollerworksSearch package.
 *
 * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Rollerworks\Component\Search\Doctrine\Orm;

use Rollerworks\Component\Search\Doctrine\Dbal\ConversionHints;

/**
 * A ValueConversion allows to convert the value "model" to a valid
 * DQL statement to be used a column value.
 *
 * @author Sebastiaan Stok <s.stok@rollerscapes.net>
 */
interface ValueConversion
{
    /**
     * Returns the converted value as an DQL statement.
     *
     * The returned result must a be a valid DQL statement that can be used
     * as a column's value.
     *
     * When using custom functions these need to be registered before usage.
     *
     * Used values must be registered as parameters using `$hints->createParamReferenceFor($value)`
     * with an option DBAL Type as second argument (converted afterwards).
     *
     * @param mixed           $value   The "model" value format
     * @param array           $options Options of the Field configuration
     * @param ConversionHints $hints   Special information for the conversion process
     */
    public function convertValue($value, array $options, ConversionHints $hints): string;
}