Yii2: yii\rest\UrlRule doesn't support route params.

[Faryshta]

What steps will reproduce the problem?

on config/main.php

'urlManager' => [
    'rules' => [
        [
            'class' => \yii\rest\UrlRule::class,
            'controller' => ['store/<store_id:\d+>/employee' => 'store-employee'],
        ],
    ],
],

What is the expected result?

use the StoreEmployeeController controller when accessing the route store/1/employee

What do you get instead?

http status 404 the rest rule is not even parsed.

Additional info

caused by line https://github.com/yiisoft/yii2/blob/master/framework/rest/UrlRule.php#L221 since it executes

strpos('store/1/employee', 'store/<store_id:\d+>/employee')

which obviously will return false. there is no work-around this. when removing this line (and the ending bracket) the url is parsed properly.

[cebe]

Your config looks really weird, why are you configuring the class of UrlManager to be yii\rest\UrlRule?
Also, a controller name can not contain variables. Please provide more detailed/correct information.

[Faryshta]

@cebe my bad i fixed the original example

[cebe]

From the PHPdoc:

the controller ID (e.g. user, post-comment) that the rules in this composite rule are dealing with.

what makes you think it could contain parameters?

[Faryshta]

if it doesn't support route params then lets add support to route params.

http://www.yiiframework.com/doc-2.0/yii-rest-urlrule.html#$controller-detail

you want to explicitly specify how the controller ID should appear in the patterns, you may use an array with the array key being as the controller ID in the pattern, and the array value the actual controller ID. For example, ['u' => 'user'].

it make sense to be able to have a pattern like the one i mention on my example.

[Faryshta]

@cebe so can i make a pr with the support for this?

[cebe]

I do not think this is a good idea to support this inside $controller property. Using $prefix looks like a better solution to me.

[tunecino]

@Faryshta see https://github.com/yiisoft/yii2/issues/9474

[Faryshta]

@cebe thats suboptimal specially when handling all the controllers in an api

    'rules' => [
        [
            'prefix' => 'api/v1/',
            'class' => \yii\rest\UrlRule::class,
            'controller' => [
                'store',
                'store/<store_id:\d+>/employee' => 'store-employee'
            ],
        ],
    ],

make more sense than your alternative.

adding the support can be done with removing just one line of code and as @tunecino pointed this feature has been requested since 2015.

[Faryshta]

@samdark @SilverFire any input on this?

[samdark]

Controller ID should not contain anything but controller ID.

[samdark]

So that leaves us with either extra patterns and prefixes.

[Faryshta]

@samdark the docs mentions that the key can support patterns and the value is the controller id it points to

[samdark]

Nope:

 /**
     * @var string|array the controller ID (e.g. `user`, `post-comment`) that the rules in this composite rule
     * are dealing with. It should be prefixed with the module ID if the controller is within a module (e.g. `admin/user`).
     *
     * By default, the controller ID will be pluralized automatically when it is put in the patterns of the
     * generated rules. If you want to explicitly specify how the controller ID should appear in the patterns,
     * you may use an array with the array key being as the controller ID in the pattern, and the array value
     * the actual controller ID. For example, `['u' => 'user']`.
     *
     * You may also pass multiple controller IDs as an array. If this is the case, this composite rule will
     * generate applicable URL rules for EVERY specified controller. For example, `['user', 'post']`.
     */

[tunecino]

It could be done using prefixes and 2 different rules:

'rules' => [
    [
        'prefix' => 'api/v1/',
        'class' => \yii\rest\UrlRule::class,
        'controller' => ['store'],
    ],
    [
        'prefix' => 'api/v1/store/<store_id:\d+>/',
        'class' => \yii\rest\UrlRule::class,
        'controller' => [
            'employee' => 'store-employee'
        ],
    ]
],

This is also related to https://github.com/yiisoft/yii2/issues/7878 as we can also introduce a new advanced UrlRule class for it. My attempt for it was this one which was based on this idea: https://github.com/yiisoft/yii2/issues/7878#issuecomment-86485350

[Faryshta]

I don't see how that is easier to maintain, understand or add new resources than

'rules' => [
    [
        'prefix' => 'api/v1/',
        'class' => \yii\rest\UrlRule::class,
        'controller' => [
            'store',
            'store/<store_id:\d+>/employee' => 'store-employee'
        ],
    ],
],

Specially when dealing with several resources in the same api.

The fix will be just deleting one line of code and it would be 100% backward compatible and would fix several issues such as #8153 and #9474

[tunecino]

well. I agree with you in that. I think if $controller accepts a custom urlName then why not parsing it too for dynamique tokens same as it is done with $prefix. but I don't know how it could be easily achieved by creating the correct yii\web\UrlRule instance for it without too much change.

[Faryshta]

@tunecino https://github.com/tecnocen-com/yii2-roa/blob/master/src/UrlRule.php i only removed an if statement from https://github.com/yiisoft/yii2/blob/master/framework/rest/UrlRule.php#L221 and it works exactly as i mention in my example.

@samdark which tests should i write on the pr?

[samdark]

@Faryshta first of all, tests which are missing for validating current behavior. These should go in a separate pull request which doesn't change framework code. Then changes + tests for new behavior.

Overall I see why it could be handy. I still find it a bit confusing about using patterns in controller but since there's key=>value syntax anyway I think it's acceptable.

[yii-bot]

Issue moved to https://github.com/yiisoft/yii2-rest/issues/7