Fixed \XF::repository does not understand class aliases, breaking the invariant that a repository is created once

[Xon]

Affected version

2.3.6

If you call

\XF::repository('XF:EmailBounce')

and then

\XF::repository('XF\Repository\EmailBounceRepository')

This will result in two different repository objects, each with a different slot in the property $repositories in XF\Mvc\Entity\Manager.

The repository itself will have 'XF:EmailBounce' for both stored in the $identifier property on the repository.

public function getRepository($identifier)
{
    $identifier = \XF::classToString($identifier, '%s\Repository\%s');
    if (isset($this->repositories[$identifier]))
    {
        return $this->repositories[$identifier];
    }

    $repositoryClass = \XF::stringToClass($identifier, '%s\Repository\%s');
    $repositoryClass = $this->extension->extendClass($repositoryClass, Repository::class);
    if (!$repositoryClass || !class_exists($repositoryClass))
    {
        throw new \LogicException("Could not find repository '$repositoryClass' for '$identifier'");
    }

    $repository = new $repositoryClass($this, $identifier);
    $this->repositories[$identifier] = $repository;

    return $repository;
}
...
public function __construct(Manager $em, $identifier)
{
    $this->em = $em;

    if (substr($identifier, -10) === 'Repository')
    {
        $identifier = substr($identifier, 0, -10);
    }
    $this->identifier = $identifier;
}

getRepository should either remove or add the trailing Repository when computing the cache key to ensure things are consistent.

Either would work as the class-loader appends/removes that so it'll resolve to a class properly.

 

[Xon]

Maybe calling \XF::getClassForAlias() rather than directly adding/removing Repository would work best to match how class extensions works.

 

[XF Bug Bot]

Thank you for reporting this issue, it has now been resolved. We are aiming to include any changes that have been made in a future XF release (2.3.7).

Change log:

Normalize entity manager repository cache keys

There may be a delay before changes are rolled out to the XenForo Community.