Comments

Router: Have a routes collection interface & support in Tracy router panel#94

Open

Andrewsville wants to merge 4 commits intonette:master from

BianoCZ:route-lists-update

Open

Router: Have a routes collection interface & support in Tracy router panel #94
Andrewsville wants to merge 4 commits intonette:master from
BianoCZ:route-lists-update

Conversation

@Andrewsville

Copy link

@Andrewsville Andrewsville commented Sep 30, 2015

Feature
Documentation – No change needed, unless you want to mention it in the "Custom Router" chapter.
BC break - no

Currently, the only way to have a collection of routes and have them displayed in the Tracy panel is to use the RouteList class.

This PR generalizes this logic to allow developers to implement their own route collections maybe with some logic inside (the RouteList is just a simple hashmap), maybe immutable (RouteList is mutable), etc. It comes from our use case but I believe it could be useful for others, too.

This PR introduces a new interface for route lists that extends IteratorAggregate (which is the easiest way to implement a Traversable) and adds the getModule() method that is required by the Tracy panel.
Because of the way RouteList is implemented, it can implement this new interface without any changes.
And the last change is the instanceof typecheck in the Panel to display a routes collection.

dg and others added 4 commits

September 30, 2015 03:48

@dg


 added CallbackResponse

6e8dbd3

@dg


 ErrorPresenter: returns CallbackResponse

8b0111a

@Andrewsville


 Interface for route lists

93c8707

@Andrewsville


 Router panel support for any route list

4f9cc60

@pavelkouril

Copy link

Contributor

pavelkouril commented Sep 30, 2015

Personally, I like this idea. :) 👍

[画像:JanTvrdik]

JanTvrdik reviewed

Sep 30, 2015

View reviewed changes

src/Application/IRouteList.php

Copy link

Contributor

@JanTvrdik JanTvrdik Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not extend Traversable?

Copy link

Contributor

@JanTvrdik JanTvrdik Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not extend IRouter?

Copy link

Contributor

@Majkl578 Majkl578 Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User-land code can't extend Traversable directly.

Copy link

Member

@dg dg Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interface can extend, but class can't implement.

Copy link

Member

@dg dg Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is funny:

this works:

interface A extends Traversable 
{}
class B implements IteratorAggregate, A
{
 function getIterator() {}
}

this triggers Fatal error: Class B must implement interface Traversable as part of either Iterator or IteratorAggregate:

interface A extends Traversable 
{}
class B implements A, IteratorAggregate
{
 function getIterator() {}
}

Copy link

Author

@Andrewsville Andrewsville Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have encountered this (the need to have interfaces in the correct order) when developing the PR and it is exactly the reason I won't implement it using Traversable.

Copy link

Member

@dg dg Sep 30, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is documented http://php.net/class.traversable

@JanTvrdik

Copy link

Contributor

JanTvrdik commented Sep 30, 2015

I dislike the getModule() method onIRouteList.

@Andrewsville

Copy link

Author

Andrewsville commented Sep 30, 2015

Well, it is required by the Panel. There's not much I can do about it. You could say the same about the RouteList itself where its sole purpose is to be printed by the panel.