Abstract method rename in v2.10.0 is a braking change

[karpilin]

Be aware that v2.10.0 introduced a braking change that is not mentioned in release notes.

abstract customiseFunction() of BaseFunction was renamed to customizeFunction() as part of #273

[martin-georgiev]

Thanks for bringing this up, @karpilin. I see where you’re coming from. For clarity, could you provide more details on how you’re using the protected customizeFunction() and any version constraints you have for the library? Code snippets and further context would be helpful.

Since customizeFunction() is a protected method, it’s intended for internal use within the library’s architecture rather than for external overrides. It’s not part of the public API, which has remained unchanged. It might be worth adding an annotation in the documentation to clarify this.

That said, I acknowledge that this change affected more than just documentation, so it might have been better categorized in the releases.

[janklan]

I ran into the same thing and sent a PR before I found this issue.

In my case, I wanted to add a function that didn't exist in your scope at the time, but I like your library and I use it for many other things, so I wanted it to do the heavy lifting for me:

<?php

declare(strict_types=1);

namespace App\Doctrine\ORM\Query\Functions;

use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseFunction;

/**
 * Implementation of PostgreSql JSONB_EXISTS_ANY().
 *
 * @see https://www.postgresql.org/docs/9.4/static/functions-json.html
 * @since 0.1
 * @see https://github.com/martin-georgiev/postgresql-for-doctrine/blob/main/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbExists.php
 */
class JsonbExistsAny extends BaseFunction
{
    protected function customizeFunction(): void
    {
        $this->setFunctionPrototype('jsonb_exists_any(%s, %s)');
        $this->addNodeMapping('StringPrimary');
        $this->addNodeMapping('StringPrimary');
    }
}

Upon installing the latest version, I started receiving this when clearing the cache and everywhere else:

!!  PHP Fatal error:  Class App\Doctrine\ORM\Query\Functions\JsonbExistsAny contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseFunction::customizeFunction) in /Users/janklan/dev/app/src/Doctrine/ORM/Query/Functions/JsonbExistsAny.php on line 26
!!  
!!  Fatal error: Class App\Doctrine\ORM\Query\Functions\JsonbExistsAny contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseFunction::customizeFunction) in /Users/janklan/dev/app/src/Doctrine/ORM/Query/Functions/JsonbExistsAny.php on line 26
!!  Symfony\Component\ErrorHandler\Error\FatalError {#198
!!    #message: "Error: Class App\Doctrine\ORM\Query\Functions\JsonbExistsAny contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseFunction::customizeFunction)"
!!    #code: 0
!!    #file: "./bundles/core-bundle/src/Doctrine/ORM/Query/Functions/JsonbExistsAny.php"
!!    #line: 26
!!    -error: array:4 [
!!      "type" => 1
!!      "message" => "Class App\Doctrine\ORM\Query\Functions\JsonbExistsAny contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseFunction::customizeFunction)"
!!      "file" => "/Users/janklan/dev/app/src/Doctrine/ORM/Query/Functions/JsonbExistsAny.php"
!!      "line" => 26
!!    ]
!!  }

---

Since customizeFunction() is a protected method, it’s intended for internal use within the library’s architecture rather than for external overrides.

If you want to stop people from using your internal API, make the BaseFunction final. But ... Please don't! :)

[martin-georgiev]

Thank you for the extra context, @janklan. I updated the v2.10.0 changelog to highlight this change. It will be awesome when you open some PRs with your library enhancements so others can benefit directly from your work.

[janklan]

It will be awesome when you open some PRs with your library enhancements so others can benefit directly from your work.

I'd love to see the multirange support, however, I have implemented it in my projects using fully custom types, so it's not like I have a ready-to-ship thing to contribute.

I'll send the jsonb_exists_any, though.

[martin-georgiev]

@karpilin @janklan this shall now be resolved with v2.10.2