• Home
• yii
• rest
• UrlRule

PHP Class yii\rest\UrlRule

The simplest usage of UrlRule is to declare a rule like the following in the application configuration, php [ 'class' => 'yii\rest\UrlRule', 'controller' => 'user', ] The above code will create a whole set of URL rules supporting the following RESTful API endpoints: - 'PUT,PATCH users/' => 'user/update': update a user - 'DELETE users/' => 'user/delete': delete a user - 'GET,HEAD users/' => 'user/view': return the details/overview/options of a user - 'POST users' => 'user/create': create a new user - 'GET,HEAD users' => 'user/index': return a list/overview/options of users - 'users/' => 'user/options': process all unhandled verbs of a user - 'users' => 'user/options': process all unhandled verbs of user collection You may configure [[only]] and/or [[except]] to disable some of the above rules. You may configure [[patterns]] to completely redefine your own list of rules. You may configure [[controller]] with multiple controller IDs to generate rules for all these controllers. For example, the following code will disable the delete rule and generate rules for both user and post controllers: php [ 'class' => 'yii\rest\UrlRule', 'controller' => ['user', 'post'], 'except' => ['delete'], ] The property [[controller]] is required and should represent one or multiple controller IDs. Each controller ID should be prefixed with the module ID if the controller is within a module. The controller ID used in the pattern will be automatically pluralized (e.g. user becomes users as shown in the above examples). For more details and usage information on UrlRule, see the guide article on rest routing. Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$controller		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'].
$except		list of actions that should be excluded. Any action found in this array will NOT have its URL rules created.
$extraPatterns		patterns for supporting extra actions in addition to those listed in [[patterns]]. The keys are the patterns and the values are the corresponding action IDs. These extra patterns will take precedence over [[patterns]].
$only		list of acceptable actions. If not empty, only the actions within this array will have the corresponding URL rules created.
$patterns		list of possible patterns and the corresponding actions for creating the URL rules. The keys are the patterns and the values are the corresponding actions. The format of patterns is Verbs Pattern, where Verbs stands for a list of HTTP verbs separated by comma (without space). If Verbs is not specified, it means all verbs are allowed. Pattern is optional. It will be prefixed with [[prefix]]/[[controller]]/, and tokens in it will be replaced by [[tokens]].
$pluralize		whether to automatically pluralize the URL names for controllers. If true, a controller ID will appear in plural form in URLs. For example, user controller will appear as users in URLs.
$prefix		the common prefix string shared by all patterns.
$ruleConfig		the default configuration for creating each URL rule contained by this rule.
$suffix		the suffix that will be assigned to [[\yii\web\UrlRule::suffix]] for every generated rule.
$tokens		list of tokens that should be replaced for each pattern. The keys are the token names, and the values are the corresponding replacements.

Public Methods

Method	Description
createUrl ( $manager, $route, $params )
init ( )
parseRequest ( $manager, $request )

Protected Methods

Method	Description
createRule ( string $pattern, string $prefix, string $action ) : yii\web\UrlRuleInterface	Creates a URL rule using the given pattern and action.
createRules ( )

Method Details

Property Details