Rewrite Router->urlFor() to generate complete Urls #2493

Jmp00000001 · 2018-08-22T10:00:08Z

Hello!

Like @splitbrain mentioned in slimphp/Twig-View#101 there is actually no way to generate a complete url while slim runs in a sub directory.

This pull request refactors slimphp/Twig-View#102 TwigExtension->urlFor() to Router->urlFor()

Is there any chance you can merge this?
Let me know if this pull request need improvement.

coveralls · 2018-08-22T10:04:07Z

Coverage increased (+0.006%) to 97.838% when pulling e6ff493 on Jmp00000001:3.x into f0718f6 on slimphp:3.x.

splitbrain · 2018-09-06T12:52:26Z

Slim/Router.php

-        return $this->pathFor($name, $data, $queryParams);
+        // Check if container['request'] is initialized.
+        if (!$this->container->has('request')) {
+            throw new RuntimeException('Request object is not initialized yet.');


For one of the use cases (creating email templates) it might very well happen that this mechanism is called without a request context when emails are generated from a command line script or from a task queue.

There is no way to automatically build the base URL without a Request object. So instead of just throwing an Exception here, it would probably be helpful to be able to configure the base URL from a config setting and fall back to it if no Request is available.

Let's treat this as a separate issue for a subsequent PR.

These should be obsolete now, since the $uri gets passed as argument and $request ist not needed anymore

akrabat · 2018-09-16T10:29:26Z

There's a potential problem here in that this is not backwards compatible.

vlakoff · 2018-09-25T16:12:34Z

Refs #1316.

Actually, the name urlFor was not that wrong, as an URL can be relative (i.e. the scheme and autority are optional). Meanwhile, the "path" is a very specific part of the URL, which doesn't include the query string and the anchor.

I'd suggest:

adding a method fullUrlFor (easy to remember I think),
and replacing again pathFor with urlFor (mainly because "url" is by far the most used name in other PHP frameworks). In Slim 3, allow both pathFor and urlFor (removing the deprecation notice, to ease migration), and in Slim 4, deprecate pathFor.

As a result, in Slim 4 we would have urlFor and fullUrlFor, and we could use fullUrlFor already in Slim 3.

akrabat · 2019-04-06T16:21:43Z

I'd suggest:

adding a method fullUrlFor (easy to remember I think),

and replacing again pathFor with urlFor (mainly because "url" is by far the most used name in other PHP frameworks). In Slim 3, allow both pathFor and urlFor (removing the deprecation notice, to ease migration), and in Slim 4, deprecate pathFor.

As a result, in Slim 4 we would have urlFor and fullUrlFor, and we could use fullUrlFor already in Slim 3.

I agree. Let's call this fullUrlFor and make sure we also create a PR for Slim 4 too.

l0gicgate · 2019-04-06T18:13:49Z

@akrabat I can add this PR as part of the router refactoring process going on at the moment for the Slim 4 branch. It’ll probably be last though.

akrabat · 2019-04-08T10:14:13Z

@akrabat I can add this PR as part of the router refactoring process going on at the moment for the Slim 4 branch. It’ll probably be last though.

Okay. Separate PR :)

akrabat · 2019-04-08T10:15:25Z

Next step for this one is for @Jmp00000001 to update this PR.

Jmp00000001 · 2019-04-08T12:33:13Z

Hello,

I will have a look after work.

This should be updated?

I'd suggest:

adding a method fullUrlFor (easy to remember I think),
and replacing again pathFor with urlFor (mainly because "url" is by far the most used name in other PHP frameworks). In Slim 3, allow both pathFor and urlFor (removing the deprecation notice, to ease migration), and in Slim 4, deprecate pathFor.
As a result, in Slim 4 we would have urlFor and fullUrlFor, and we could use fullUrlFor already in Slim 3.

Jmp00000001 · 2019-04-08T15:50:47Z

I have

refactored my implementation of Router::urlFor() to Router:fullUrlFor()
restored the old Router::urlFor()
removed the deprication warning in Router::urlFor()

Let me know if I missed something :)

vlakoff · 2019-04-08T19:53:12Z

Just a nitpick: we could also reverse the Slim 3 BC alias, i.e. make pathFor() call urlFor(), as the latter should be the preferred/canonical one.

Jmp00000001 · 2019-04-09T08:16:46Z

Here you go :)

akrabat · 2019-04-09T09:32:24Z

Here you go :)

Please remove the This method is deprecated. Use pathFor() from now on. docblock comment.

l0gicgate · 2019-04-20T18:17:01Z

Slim/Router.php

+
+        /** @var Uri $uri */
+        $uri = $this->container->get('request')->getUri();
+        if (is_string($uri)) {


Can you add a test case for this condition as well please?

I think the check that $uri is a string is not required at all.
There is no way Request::getUri() returns something different than a UriInterface object:

Only the Request constructor sets the $uri and expects an UriInterface. The constructor will throw otherwise (at latest when calling class methods like Uri::getPort())

The docblock of Request::getUri() also mentions: This method MUST return a UriInterface instance

No clue what I was thinking..
I simply remove that check.

So this brings me to question the method signature in the first place. Look at the way I implemented it in Slim 4:
https://github.com/slimphp/Slim/blob/4.x/Slim/Routing/RouteParser.php#L129-L136

Since this is a new method, we should force a UriInterface being passed in by the user instead of trying to do gymnastics to get to it.

l0gicgate

Please add test coverage for the to aforementioned conditions and I'll merge. Thanks!

Jmp00000001 · 2019-04-23T07:55:01Z

I will have a look today/tomorrow.
Just got back from vacation :)

vlakoff · 2019-04-23T21:57:29Z

I'd suggest renaming relativePathFor to relativeUrlFor as well.

For the record, refs App->subRequest not working directly with Router->pathFor #1521 and Implement internalPathFor() #1552 which implemented this method.

I'd also like to reference this SO answer: Absolute vs relative URLs.

And here are the correspondences:

Slim	SO answer
`fullUrlFor()`	1. Absolute URL
`urlFor()`	4. Root-relative URL
`relativeUrlFor()`	2. Relative URL

l0gicgate · 2019-04-23T22:18:46Z

@vlakoff we cannot change relativePathFor in the 3.x branch as it would be a BC change.

However, I'm open to that for Slim 4 since we're not even in alpha yet.

vlakoff · 2019-04-24T01:44:47Z

Same as the urlFor() change, keeping the old name as a BC alias in Slim 3.

l0gicgate · 2019-04-24T02:50:08Z

@vlakoff I'm going to PR that for Slim 4 on the RouteParser. I think using the same terminology everywhere makes sense. We'll deprecate relativePathFor() and pathFor() and use as you described:

RouteParser::fullUrlFor() - Absolute URL
RouteParser::urlFor() - Root Relative URl
RouteParser::relativeUrlFor() - Relative URL

I also want to point out that there's not going to be any deprecation warning. Since Router was split into RouteCollector and RouteParser those are entirely new interfaces and there's no point in including deprecated methods/warnings since the user will have to re-learn the new interfaces anyway.

As for Slim 3, I don't think any further changes are warranted since we're so deep in the release cycle. The functionality is there and is usable, that's what matters most.

Jmp00000001 · 2019-04-24T08:06:34Z

Thanks for merging!

vlakoff · 2019-04-24T22:23:57Z

Considering that urlFor() and relativeUrlFor() don't produce URLs strictly speaking, as they don't contain the protocol and server, but only the path + optional query string, I'd like to make sure everyone is comfortable with these new names.

I chose these names trying to apply the best possible the principle of least astonishment. But on second thought, an other acceptable naming scheme could be "relativePathFor() / pathFor() / urlFor()".

This is really worrying me and it's still time to change if necessary, please provide your feedback on this matter!

l0gicgate · 2019-04-25T00:27:40Z

Wouldn’t the term “Uri” instead of path apply here then @vlakoff?

Uri - Uniform Resource Identifier
Url - Uniform Resource Locator

A URL should be with protocol. A URI should be part of a url much like a path is. So relativeUriFor(), uriFor() and fullUrlFor() would make sense.

vlakoff · 2019-04-25T03:39:37Z

That's quite a headache!

I have done some reading, and it (probably arguably) seems that what we are dealing with are really URLs, as they are resources' locations; for the value to be useful, the scheme and domain have to be known, i.e. specified but could also be deduced. In our case, the browser does the latter, by completing the provided URL using the current location.

Further reading: What is the difference between a URI, a URL and a URN?

Also worth noting:

But doesn't the W3C now say that URLs and URIs are the same thing?
Yes. The W3C realized that there is a ton of confusion about this. They issued a URI clarification document that says that it is now OK to use the terms URL and URI interchangeably (to mean URI). It is no longer useful to strictly segment URIs into different types such as URL, URN, and URC.

Finally, using "uri" surely would be very confusing for the users!

l0gicgate · 2019-04-25T17:20:51Z

it is now OK to use the terms URL and URI interchangeably (to mean URI). It is no longer useful to strictly segment URIs into different types such as URL, URN, and URC.

By that logic it's totally fine to use url as a prefix/suffix for these method even when referring to a path. I think the key here is in the documentation.

vlakoff · 2019-04-25T18:38:08Z

Agree with the above.

So, personally I'd bend staying on urlFor()/fullUrlFor()/relativeUrlFor().
(BTW, relativeUrlFor() should only be used for very specific cases)

To summarize:

urlFor(): the regular one, e.g. for the href attributes
fullUrlFor(): when you need… the full url, with scheme and domain
relativeUrlFor(): plz use this one as little as possible, relative paths cause so much troubles!

So, shall we settle on this?

l0gicgate · 2019-04-25T18:45:07Z

@vlakoff

We are going to leave the terminology as in in Slim 3.

But for Slim 4 the RouteParserInterface is as you described:

RouteParser::fullUrlFor()
RouteParser::urlFor()
RouteParser::relativeUrlFor()

So I think this is settled! Thanks for your input.

vlakoff · 2019-04-25T18:59:42Z

I apologize for the extended chat… I really wanted to be sure the new naming convention was good. I would have felt so bad if I had introduced a bad naming scheme in Slim 4!

Carl Aischmann added 4 commits August 22, 2018 11:18

Implement Router->urlFor()

7981dd9

Write test for urlFor()

ee827d0

Cleanup

1da8ef3

Test urlFor() with sub directory

1ee7afd

splitbrain reviewed Sep 6, 2018

View reviewed changes

akrabat added discussion Slim 3 labels Sep 16, 2018

akrabat mentioned this pull request Sep 16, 2018

Static routing with pathFor() #2381

Closed

akrabat added the Slim 4 label Apr 6, 2019

Carl Aischmann added 3 commits April 8, 2019 17:19

Refactor Router:urlFor() to Router::fullUrlFor()

1b3b378

Restore old Router::urlFor()

a7ef49c

Remove deprication notice in Router::urlFor()

4981c74

Carl Aischmann and others added 2 commits April 9, 2019 10:12

Let Router::pathFor() call Router::urlFor()

5b08ef3

Merge branch '3.x' into 3.x

9c4750c

Carl Aischmann added 3 commits April 9, 2019 12:09

Remove 'deprecated' line from Router::urlFor() docblock

b0f193c

Adjust docblock for Router::urlFor() matchin Router::pathFor()

ed2ccab

Add deprecation information to Router::pathFor() docblock

1dfaf7e

l0gicgate mentioned this pull request Apr 17, 2019

[DRAFT] 4.x Refactor Routing #2604

Closed

7 tasks

l0gicgate reviewed Apr 20, 2019

View reviewed changes

l0gicgate requested changes Apr 20, 2019

View reviewed changes

This was referenced Apr 20, 2019

4.x - Port RouteCollector::fullUrlFor() #2638

Merged

Refactor App Router Proxy Methods, RouteGroup, Routable and Route #2583

Closed

Carl Aischmann and others added 10 commits April 23, 2019 17:57

Check if is set when generating full url

bd72ddd

Remove unnecessary check if is string

2fb9ad2

Add test for Router::fullUrlFor() when Container is not set

57e2826

Pass uri via function parameter

a877935

Remove obsolete test: testFullUrlForWithouthContainer()

43a0ed2

Adjust testFullUrlFor()

2810242

Use alias Slim\Http\Uri

c44bfae

Remove return type declaration for Router::fullUrlFor()

e05f430

Remove type declaration in function head fullUrlFor()

4ff4d16

Add white space after comma in function call

e6ff493

l0gicgate merged commit 89c0149 into slimphp:3.x Apr 23, 2019

l0gicgate added this to the 3.12.2 milestone Apr 23, 2019

l0gicgate mentioned this pull request Apr 24, 2019

4.x - Remove pathFor() and rename relativePathFor() with relativeUrlFor() #2654

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite Router->urlFor() to generate complete Urls #2493

Rewrite Router->urlFor() to generate complete Urls #2493

Jmp00000001 commented Aug 22, 2018

coveralls commented Aug 22, 2018 •

edited

Loading

splitbrain Sep 6, 2018

akrabat Apr 9, 2019

Jmp00000001 Apr 23, 2019

akrabat commented Sep 16, 2018

vlakoff commented Sep 25, 2018 •

edited

Loading

akrabat commented Apr 6, 2019

l0gicgate commented Apr 6, 2019

akrabat commented Apr 8, 2019

akrabat commented Apr 8, 2019

Jmp00000001 commented Apr 8, 2019

Jmp00000001 commented Apr 8, 2019

vlakoff commented Apr 8, 2019

Jmp00000001 commented Apr 9, 2019

akrabat commented Apr 9, 2019

l0gicgate Apr 20, 2019

Jmp00000001 Apr 23, 2019

l0gicgate Apr 23, 2019

l0gicgate left a comment

Jmp00000001 commented Apr 23, 2019

vlakoff commented Apr 23, 2019

l0gicgate commented Apr 23, 2019

vlakoff commented Apr 24, 2019

l0gicgate commented Apr 24, 2019 •

edited

Loading

Jmp00000001 commented Apr 24, 2019

vlakoff commented Apr 24, 2019

l0gicgate commented Apr 25, 2019

vlakoff commented Apr 25, 2019

l0gicgate commented Apr 25, 2019

vlakoff commented Apr 25, 2019

l0gicgate commented Apr 25, 2019

vlakoff commented Apr 25, 2019

Rewrite Router->urlFor() to generate complete Urls #2493

Rewrite Router->urlFor() to generate complete Urls #2493

Conversation

Jmp00000001 commented Aug 22, 2018

coveralls commented Aug 22, 2018 • edited Loading

splitbrain Sep 6, 2018

Choose a reason for hiding this comment

akrabat Apr 9, 2019

Choose a reason for hiding this comment

Jmp00000001 Apr 23, 2019

Choose a reason for hiding this comment

akrabat commented Sep 16, 2018

vlakoff commented Sep 25, 2018 • edited Loading

akrabat commented Apr 6, 2019

l0gicgate commented Apr 6, 2019

akrabat commented Apr 8, 2019

akrabat commented Apr 8, 2019

Jmp00000001 commented Apr 8, 2019

Jmp00000001 commented Apr 8, 2019

vlakoff commented Apr 8, 2019

Jmp00000001 commented Apr 9, 2019

akrabat commented Apr 9, 2019

l0gicgate Apr 20, 2019

Choose a reason for hiding this comment

Jmp00000001 Apr 23, 2019

Choose a reason for hiding this comment

l0gicgate Apr 23, 2019

Choose a reason for hiding this comment

l0gicgate left a comment

Choose a reason for hiding this comment

Jmp00000001 commented Apr 23, 2019

vlakoff commented Apr 23, 2019

l0gicgate commented Apr 23, 2019

vlakoff commented Apr 24, 2019

l0gicgate commented Apr 24, 2019 • edited Loading

Jmp00000001 commented Apr 24, 2019

vlakoff commented Apr 24, 2019

l0gicgate commented Apr 25, 2019

vlakoff commented Apr 25, 2019

l0gicgate commented Apr 25, 2019

vlakoff commented Apr 25, 2019

l0gicgate commented Apr 25, 2019

vlakoff commented Apr 25, 2019

coveralls commented Aug 22, 2018 •

edited

Loading

vlakoff commented Sep 25, 2018 •

edited

Loading

l0gicgate commented Apr 24, 2019 •

edited

Loading