Inconsistent syntax for creating links

[samdark]

// helpers
Html::a($text, ['/site/view', 'id' => 100]);
Html::url(['/site/view', 'id' => 100]);

// controller
$this->redirect(['/site/view', 'id' => 100]);
$this->createAbsoluteUrl('/site/view', ['id' => 100]);
$this->createUrl('/site/view', ['id' => 100]);

// url manager
Yii::$app->getUrlManager()->createUrl('/site/view', ['id' => 100]);
Yii::$app->getUrlManager()->createAbsoluteUrl('/site/view', ['id' => 100]);

So we have 2 signatures for URLs. It's either ($route, [$params]) or ([$route, $params]). I think we'd better choose one and use it consistently.

[slavcodev]

I agree, and vote for using array to route
echo Html::url(['/site/view', 'id' => 100]);

and string to relative url
echo Html::url('/images/photo.jpg'); instead of echo Yii::app()->baseUrl . '/images/photo.jpg'

[Mirocow]

i agree with this issue

[Ragazzo]

i am for the second too.

[mgrechanik]

The current situation is all right with me.
We just need to remember that there are two formats:

1. "classic" for UrlManager().
2. "advanced" for Html::url() and all methods that rely upon Html::url() such as controller->redirect()

@slavcodev

and string to relative url ... instead of ...

Html::url() already works like that

[samdark]

@mgrechanik what about controller's redirect vs createUrl?

[mgrechanik]

controller's redirect could redirect to any urls when controller's createUrl is used for a different purpose (creating some very specific set of urls).
So if the signatures here are different it is not very bad.

[samdark]

The question is now how bad it is, the question is how to make it better.

[mgrechanik]

Changing controller's method's signatures to ([$route, $params]) (as people above proposed) won't make it better at all because controller->crealeUrl will differ too much from UrlManager->crealeUrl.

As I see the question is mainly about redirect method, is it not?
What if teach it to accept both formats?

    public function redirect($url, $params = [], $statusCode = 302)
    {
        $url = (empty($params) || !is_string($url)) ? Html::url($url) : $this->createUrl($url, $params);
        //var_dump($url);
        return Yii::$app->getResponse()->redirect($url, $statusCode);
    }   

[samdark]

@mgrechanik well, it's about unifying ALL signatures. Leaving some with different format doesn't make sense.

[qiangxue]

I'm fine with unifying the format to be ['route', 'name1' => 'value1', 'name2' => 'value2', ...]. There are many places to be changed.

[samdark]

What about URL parsing? Should format be changed there as well?

[qiangxue]

Why URL parsing is related with this?

On Saturday, February 15, 2014, Alexander Makarov notifications@github.com
wrote:

What about URL parsing? Should format be changed there as well?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/2426#issuecomment-35160790
.

[samdark]

It's not. Confused it with something else...

[samdark]

I'm not sure ['route', 'name1' => 'value1', 'name2' => 'value2', ...] is optimal. For example, forming parameters dynamically could require array_merge:

$params = [];
if ($sortBy) {
  $params['sortBy'] = $sortBy;
}
if ($limit) {
  $params['limit'] = $limit;
}
$this->createUrl(array_merge(['orders/index'], $params));

[zelenin]

maybe

$params = [];
if ($sortBy) {
  $params['sortBy'] = $sortBy;
}
if ($limit) {
  $params['limit'] = $limit;
}
$this->createUrl( 'orders/index', $params );

?

[mgrechanik]

@zelenin

maybe ?
$this->createUrl( 'orders/index', $params );

That is how it works now.
And we are discussing the possibility to "unifying the format to be ['route', 'name1' => 'value1', 'name2' => 'value2', ...]".

[zelenin]

@mgrechanik
yes, I propose a version where route is separated from the params. It's clearer and more readable I think.

[RdeWilde]

I'd choose the first signature, because this is most clear (as in the signature itself, documentation and autocompletion). It makes clear the route is required, parameters are optional. Also, these two are complete different types of data to me, so seperating those seems logical.

I would unify them all.

For Html::a it would make more sense for the second argument to be the string url (result from the routing), as it could also be a manual URL that doesnt have to be routed.

[yupe]

I vote for Html::a('link', [...params])...and same signature for other methods

[Mirocow]

yes i vote to like this format Html::a('link', [...params], [...options])...
and in the params write such ['lik', [...params], [...options]]
and in the img like this Html:img('link', [...params], [...options])

and all except the reference should not be required

[samdark]

I'm thinking about ['route', [$params]] for all cases.

[samdark]

// helpers
Html::a($text, ['/site/view', ['id' => 100]]);
Html::url(['/site/view', ['id' => 100]]);

// controller
$this->redirect(['/site/view', ['id' => 100]]);
$this->createAbsoluteUrl(['/site/view', ['id' => 100]]);
$this->createUrl(['/site/view', ['id' => 100]]);

// url manager
Yii::$app->getUrlManager()->createUrl(['/site/view', ['id' => 100]]);
Yii::$app->getUrlManager()->createAbsoluteUrl(['/site/view', ['id' => 100]]);

[cebe]

I'm thinking about ['route', [$params]] for all cases.

Why do we need the brackets around params in this case?

[samdark]

In order to be able to pass an array of parameters w/o doing any merging.

[qiangxue]

I think this format requires more typing and is more error prone.
It's much more common to create a URL from scratch by writing parameters one by one than modifying an existing parameter array.

[samdark]

OK. Implementing ['/site/view', 'id' => 100] variant then.

[RdeWilde]

It requires more typing this way, is difficult to phpdoc and makes no sense, for example if you just have an url with no params your creating an Array object for nothing, not efficient at all.

[cebe]

@samdark is '/site/view' also a valid URL in your implementation?

[samdark]

Yes.

[RusAlex]

On my opinion, current way (yii1.x) is good.
Sometimes i just mess how to write "route to module" , but i never
getting mistakes in route array
['/controller/action','param1'=>'value1',...] .
Current way is very easy to remember.

Thanks