Is the IdPrefixListener really needed

[uwej711]

I started to work on a simple multi site bundle. The main idea is to have the sites direclty below /cms and have routes, content etc. as descendants of each site. For menu repository and route repository I can set the prefix based on the site (which is selected based on the host in a listener).

But this does not work for the IdPrefixListener when you want to generate Urls cross-site (the routes of the other site would have the wrong id prefix!).

So first I came up with referencing the site in each Route but realised that it is already (indirectly referenced through the parent). Currently I use this code, which would make the IdPrefixListener obsolete in all cases (not only multi site):

public function getStaticPrefix()
{
    return $this->generateStaticPrefix($this->id, $this->getRoutesRoot()->getId());
}

/**
 * return the first parent that is not instance of a route
 */
protected function getRoutesRoot()
{
    $root = $this;
    while ($root && $root instanceof \Symfony\Component\Routing\Route) {
        $root = $root->getParent();
    }
    return $root;
}

If we used a "RouteDirectory" document as discussed before the class check could check for that document.

[dbu]

indeed this could work. i see 2 problems: if you have deep nested routes, walking up the tree one by one could become rather expensive (and needs to be done for every route loaded). also, we sometimes do things like /cms/routes/en/news/archive/2013/08/08 where the year / month / day nodes are not routes. your algorithm would stumble over that.

now we could go the other way round, similar to the way the route provider looks for all candidates. split the id by / and fetch all potential parents and walk down from the top looking for the RouteDirectory. that would solve the issue with non-routes mixed in the tree and alleviate the performance issue. but it would need the document manager available in the model, which it normally is not.

could we change the id prefix listener to dynamically find the id prefix this way?

[uwej711]

I think that should be possible but we need the RouteDirectory first ... and I guess it would be nice to have the getCandidates method only once.

[sjopet]

We implemented the multi site routing in the same manor except that our node structure is a bit different.
we have:

routes:
    site1:
        route1
        route2
    site2:
        route1
        route2
        route3

Not sure if or why it matters at this moment but I'll get back to you about that ;)

[dbu]

RouteDirectory is a 1.2 topic for me. changing the id prefix listener to be more dynamic (maybe it can still cache prefixes it found, to keep the overhead reasonable) would be at most a minor bc break when the config option for the route root goes away (or we could even keep it but change the default behaviour when its not configured)

[uwej711]

I will see whether I can do a PR for this (although I will be away for a week starting this Thursday)

[dbu]

ok. i am away too :-)
but as said, that might well go into 1.2 anyways.

[uwej711]

Btw, @sveriger is working on a PR for that ...

[dbu]

we cleaned up simplecms and routing. we still use the prefix things but in a more sane way.