Yaf_Route_Regex::__construct

Yaf_Route_Regex constructor

&reftitle.description; public `Yaf_Route_Regex::__construct` `string` `match` `array` `route` `array` `map` `array` `verify` `string` `reverse`

&reftitle.parameters;

`match`

- A complete Regex pattern, will be used to match a request uri, if doesn't matched, `Yaf_Route_Regex` will return &false;.

`route`

- When the match pattern matches the request uri, `Yaf_Route_Regex` will use this to decide which m/c/a to routed.

  either of m/c/a in this array is optianl, if you don't assgian a specific value, it will be routed to default.

`map`

- A array to assign name to the captrues in the match result.

`verify`

`reverse`

- a string, used to assemble url, see `Yaf_Route_Regex::assemble`.

  this parameter is introduced in 2.3.0

&reftitle.returnvalues;

&reftitle.examples;

### `Yaf_Route_Regex`example

    <?php
       /**
        * Add a regex route to Yaf_Router route stack
        */
        Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
            new Yaf_Route_Regex(
               "#^/product/([^/]+)/([^/])+#", //match request uri leading "/product"
               array(
                   'controller' => "product",  //route to product controller,
               ),
               array(
                  1 => "name",   // now you can call $request->getParam("name")
                  2 => "id",     // to get the first captrue in the match pattern.
               )
            )
        );
    ?>

### `Yaf_Route_Regex(as of 2.3.0)`example

    <?php
       /**
        * Use match result as MVC name
        */
        Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
            new Yaf_Route_Regex(
               "#^/product/([^/]+)/([^/])+#i", //match request uri leading "/product"
               array(
                  'controller' => ":name", // route to :name, which is $1 in the match result as controller name
               ),
               array(
                  1 => "name",   // now you can call $request->getParam("name")
                  2 => "id",     // to get the first captrue in the match pattern.
               )
            )
        );
    ?>

### `Yaf_Route_Regex and named capture ground(as of 2.3.0)`example

    <?php
       /**
        * Use match result as MVC name
        */
        Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
            new Yaf_Route_Regex(
               "#^/product/(?<name>[^/]+)/([^/])+#i", //match request uri leading "/product"
               array(
               'controller' => ":name", // route to :name,
                                        // which is named capture group 'name' in the match result as controller name
               ),
               array(
                  2 => "id",     // to get the first captrue in the match pattern.
               )
            )
        );
    ?>

### `Yaf_Route_Regex`example

    <?php
       /**
        * Add a regex route to Yaf_Router route stack by calling addconfig
        */
        $config = array(
            "name" => array(
               "type"  => "regex",          //Yaf_Route_Regex route
               "match" => "#(.*)#",         //match arbitrary request uri
               "route" => array(
                   'controller' => "product",  //route to product controller,
                   'action'     => "dummy",    //route to dummy action
               ),
               "map" => array(
                  1 => "uri",   // now you can call $request->getParam("uri")
               ),
            ),
        );
        Yaf_Dispatcher::getInstance()->getRouter()->addConfig(
            new Yaf_Config_Simple($config));
    ?>

&reftitle.seealso;

- `Yaf_Router::addRoute`
- `Yaf_Router::addConfig`
- `Yaf_Route_Static`
- `Yaf_Route_Supervar`
- `Yaf_Route_Simple`
- `Yaf_Route_Rewrite`
- `Yaf_Route_Map`