urlManager for module Yii2

Question

I've got a basic Yii2 project, in which i created a separate module "rest". I have set up urlManager in config/web.php file. It works fine for common url, but it seems to me it is not working with url starting with my module name: rest/.. I have actionAuth() in AuthController in my rest module, and it is accessible with this url: test.ru/auth/auth. But i want it to be accessible with this url:test.ru/auth. I tried to write like this in web.php :

  'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'rules' => [

           [
              'class' => 'yii\rest\UrlRule',
              'controller' => 'rest\auth',
              'extraPatterns' => [
                  'POST /' => 'auth',
              ],
              'pluralize' => false,
            ],

      ],
    ],

But it does not work(not found error in browser). I also tried like this:

'rules' => [

           [
              'class' => 'yii\rest\UrlRule',
              'controller' => 'rest\auth',
              'extraPatterns' => [
                  'POST rest/auth' => 'auth',
              ],
              'pluralize' => false,
            ],

      ],
    ],

It seems to me that urlManager does not want to work for module. Next i tried to write the same code in my Module.php in rest/ directory. But it produced many errors. I think because of the same error things like that dont work too:`

    'class' => 'yii\rest\UrlRule',
                      'controller' => 'rest\city',
                      'extraPatterns' => [
                        'DELETE {id}' => 'delete',
                      ],
    `

So my question is: how to set up urlManager for module in Yii2? I need to configure HTTP DELETE method, post methods work without any settings in urlManager.

The whole web.php file:

<?php

 $params = require(__DIR__ . '/params.php');

  $config = [
'id' => 'basic',
'basePath' => dirname(__DIR__),
'bootstrap' => ['log'],
'language' => 'ru',
'components' => [
'authManager' => [
        'class' => 'yii\rbac\DbManager',
    ],
    'request' => [
        // !!! insert a secret key in the following (if it is empty) - this              is required by cookie validation
        'cookieValidationKey' => 'xxxxxxx',
        'parsers' => [
            'application/json' => 'yii\web\JsonParser',
            ]
    ],
    'cache' => [
        'class' => 'yii\caching\FileCache',
    ],
     'user' => [
        'identityClass' => 'app\models\User',
    //    'loginUrl' => ['site/login'],

    ],
    'errorHandler' => [
        'errorAction' => 'site/error',
    ],
    'mailer' => [
        'class' => 'yii\swiftmailer\Mailer',
        // send all mails to a file by default. You have to set
        // 'useFileTransport' to false and configure a transport
        // for the mailer to send real emails.
        'useFileTransport' => true,
    ],
    'log' => [
        'traceLevel' => YII_DEBUG ? 3 : 0,
        'targets' => [
            [
                'class' => 'yii\log\FileTarget',
                'levels' => ['error', 'warning'],
            ],
        ],
    ],
    'db' => require(__DIR__ . '/db.php'),

    'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'rules' => [
            [
              'class' => 'yii\rest\UrlRule',
              'controller' => 'rest\user',
              'except' => ['delete', 'create', 'update', 'index'],
              'extraPatterns' => [
                  'GET all' => 'all',
              ]
           ],
           [
              'class' => 'yii\rest\UrlRule',
              'controller' => 'rest\auth',
              'extraPatterns' => [
                  'POST reg' => 'reg',
                  'POST auth' => 'auth',
                  'POST rest/auth' => 'auth',
              ],
              'pluralize' => false,
            ],
            [
              'class' => 'yii\rest\UrlRule',
              'controller' => 'rest\city',
              'extraPatterns' => [
                'DELETE {id}' => 'delete',
              ],

            ], 



      ],
    ],



        'i18n' => [
    'translations' => [
        '*' => [
            'class' => 'yii\i18n\PhpMessageSource',
           // 'basePath' => '@app/messages', // if advanced application, set @frontend/messages
            'sourceLanguage' => 'en',
            'fileMap' => [
                //'main' => 'main.php',
            ],
        ],
    ],
],


],
'modules' => [
    'admin' => [
        'class' => 'app\modules\admin\Module',
    ],
    'manager' => [
        'class' => 'app\modules\manager\Module',
    ],
    'rest' => [
        'class' => 'app\modules\rest\Module',
    ],

    'rbac' => [
       'class' => 'mdm\admin\Module',
       'controllerMap' => [
             'assignment' => [
                'class' => 'mdm\admin\controllers\AssignmentController',
                /* 'userClassName' => 'app\models\User', */
                'idField' => 'id',
                'usernameField' => 'username',
            ],
        ],
    'layout' => 'left-menu',
    'mainLayout' => '@app/views/layouts/admin.php',
    ]

],


'aliases' => [
    //'@mdm/admin' => 'app/mdm/admin',
],

'params' => $params,
 ];

if (YII_ENV_DEV) {
// configuration adjustments for 'dev' environment
$config['bootstrap'][] = 'debug';
$config['modules']['debug'] = [
    'class' => 'yii\debug\Module',
    // uncomment the following to add your IP if you are not connecting from    localhost.
    //'allowedIPs' => ['127.0.0.1', '::1'],
 ];

$config['bootstrap'][] = 'gii';
$config['modules']['gii'] = [
    'class' => 'yii\gii\Module',
    // uncomment the following to add your IP if you are not connecting from localhost.
    //'allowedIPs' => ['127.0.0.1', '::1'],
 ];
}

   return $config;

My Module.php code(commented code shows my attempt to write urlManager):

    <?php

     namespace app\modules\rest;

     /**
     * rest module definition class
     */
     class Module extends \yii\base\Module
     {
    /**
     * @inheritdoc
     */
    public $controllerNamespace = 'app\modules\rest\controllers';

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
    // custom initialization code goes here
     \Yii::$app->user->enableSession = false;
      $config = [

      'components' => [
        'basePath' => dirname(__DIR__),
        // 'user' => [
        //           'identityClass' => 'app\models\User',
        //           'class' => 'app\models\User',
        //           'enableSession' => false
        //       ],

        //   'urlManager' => [
        //               'enablePrettyUrl' => true,
        //               'enableStrictParsing' => true,
        //               'showScriptName' => false,
        //               'rules' => [
        //                    [
        //                     'class' => 'yii\rest\UrlRule',
        //                     'controller' => 'rest\city',
        //                     'extraPatterns' => [
        //                     'DELETE {id}' => 'delete',
        //                 ],
        //               ],
        // ],
        //   ],


        'response' => [
                  'format' => \yii\web\Response::FORMAT_JSON,
                  'charset' => 'UTF-8',
                  'class' => 'yii\web\Response',

                  'on beforeSend' => function ($event) {

                      $response = $event->sender;

                      if(( $response->statusCode >= 200) && ( $response->statusCode < 300)) {

                          if(isset($response->data['_appErr'])) {
                              unset($response->data['_appErr']);
                              $response->data = [
                                  'success' => false,
                                  'error' => $response->data,
                                  'data' => null,
                              ];
                          } else {

                              $response->data = [
                                  'success' => $response->isSuccessful,
                                  'error' => null,
                                  'data' => $response->data,
                              ];
                          }

                      } else {

                          if($response->statusCode == 401) {
                              $response->data = [
                                  'success' => false,
                                  'error' => [
                                      'code' => 9,
                                      'message' => 'Unauthorized',
                                      'user_msg' => 'You need to be authorized',
                                  ],
                                  'data' => null,
                              ];
                          }
                        //   else {
                        //       $response->data = [
                        //           'success' => false,
                        //           'error' => [
                        //               'code' => 1,
                        //               'message' => 'server has returned   '.$response->statusCode.' error',
                        //           ],
                        //           'data' => null,
                        //       ];
                        //   }
                      }
                  },
              ],

      ],
      ];


        \Yii::configure(\Yii::$app, $config);
      }
     }

Answer 1

Use forward slash(/) while defining the controller value in the rules array.

This will work:

'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName' => false,
    'rules' => [
        [
          'class' => 'yii\rest\UrlRule',
          'controller' => 'rest/user',
          'except' => ['delete', 'create', 'update', 'index'],
          'extraPatterns' => [
              'GET all' => 'all',
          ]
       ],
       [
          'class' => 'yii\rest\UrlRule',
          'controller' => 'rest/auth',
          'extraPatterns' => [
              'POST reg' => 'reg',
              'POST auth' => 'auth',

          ],
          'pluralize' => false,
        ],
        [
          'class' => 'yii\rest\UrlRule',
          'controller' => 'rest/city',
          'extraPatterns' => [
            'DELETE {id}' => 'delete',
          ],

        ], 
  ]

Check out the documentation here: http://www.yiiframework.com/doc-2.0/guide-rest-versioning.html

Answer 2

Try this:

namespace yii\rest;

class UrlRule extends Object implements UrlRuleInterface {

    public function parseRequest($manager, $request) {
        list($e1, $e2) = sscanf($request->getPathInfo(), '%[a-zA-Z]/%[a-zA-Z]');
        if ($e1 === 'auth' && $e2 === '') {
            return ['/auth/auth', $request->queryParams];
        }
        return false;
    }
}