Class Phalcon\Mvc\Router\Route¶

Methods¶

public __construct (string $pattern, [array $paths], [array|string $httpMethods], [array $regex])

Phalcon\Mvc\Router\Route constructor

public string compilePattern (string $pattern, [unknown $regex])

Replaces placeholders from pattern returning a valid PCRE regular expression

public Phalcon\Mvc\Router\Route via (string|array $httpMethods)

Set one or more HTTP methods that constraint the matching of the route

<?php

 $route->via('GET');
 $route->via(array('GET', 'POST'));

public reConfigure (string $pattern, [string|array $paths], [array $regex])

Reconfigure the route adding a new pattern and a set of paths

public string getName ()

Returns the route’s name

public Phalcon\Mvc\Router\Route setName (string $name)

Sets the route’s name

<?php

 $router->add('/about', array(
     'controller' => 'about'
 ))->setName('about');

public Phalcon\Mvc\Router\Route beforeMatch (callback $callback)

Sets a callback that is called if the route is matched. The developer can implement any arbitrary conditions here If the callback returns false the route is treaded as not matched

public mixed getBeforeMatch ()

Returns the ‘before match’ callback if any

public string getRouteId ()

Returns the route’s id

public string getPattern ()

Returns the route’s pattern

public string getCompiledPattern ()

Returns the route’s compiled pattern

public array getPaths ()

Returns the paths

public array getReversedPaths ()

Returns the paths using positions as keys and names as values

public Phalcon\Mvc\Router\Route setHttpMethods (string|array $httpMethods)

Sets a set of HTTP methods that constraint the matching of the route (alias of via)

<?php

 $route->setHttpMethods('GET');
 $route->setHttpMethods(array('GET', 'POST'));

public string|array getHttpMethods ()

Returns the HTTP methods that constraint matching the route

public Phalcon\Mvc\Router\Route setPrefix (string $prefix)

Set a common uri prefix for the route

public string getPrefix ()

Returns the common prefix for the route

public Phalcon\Mvc\Router\Route setHostname (unknown $hostname)

Sets a hostname restriction to the route

<?php

 $route->setHostname('localhost');

public string getHostname ()

Returns the hostname restriction if any

public Phalcon\Mvc\RouteInterface setGroup (Phalcon\Mvc\Router\Group $group)

Sets the group associated with the route

public Phalcon\Mvc\Router\Group |null getGroup ()

Returns the group associated with the route

public Phalcon\Mvc\Router\Route convert (string $name, callable $converter)

Adds a converter to perform an additional transformation for certain parameter

public array getConverters ()

Returns the router converter

public static reset ()

Resets the internal route id generator

public Phalcon\Mvc\Router\Route setDefaults (array $defaults)

Sets an array of default paths.

public array getDefaults ()

Returns an array of default parameters

public string getDefaultNamespace ()

Returns the name of the default namespace

public string getDefaultModule ()

Returns the name of the default module

public string getDefaultController ()

Returns the default controller name

public string getDefaultAction ()

Returns the default action name

public mixed getDefaultParams ()

Returns the default params

public string setUrlGenerator (Closure $handler)

Sets the Url Generator

public callable getUrlGenerator ()

Returns the Url Generator

public string setCaseSensitive (boolean $caseSensitive)

Sets the case sensitive

public boolean getCaseSensitive ()

Returns the case sensitive

public setMode (int $mode)

Sets the mode

public getMode ()

Gets the mode