Table Of ContentsPrevious topicNext topic |
Class Phalcon\Mvc\Router\Annotations¶extends class Phalcon\Mvc\Router implements Phalcon\DI\InjectionAwareInterface, Phalcon\Mvc\RouterInterface A router that reads routes annotations from classes/resources <?php
$di['router'] = function() {
//Use the annotations router
$router = new \Phalcon\Mvc\Router\Annotations(false);
//This will do the same as above but only if the handled uri starts with /robots
$router->addResource('Robots', '/robots');
return $router;
};
Methods¶public Phalcon\Mvc\Router\Annotations addResource (string $handler, [string $prefix]) Adds a resource to the annotations handler A resource is a class that contains routing annotations public Phalcon\Mvc\Router\Annotations addModuleResource (string $module, string $handler, [string $prefix]) Adds a resource to the annotations handler A resource is a class that contains routing annotations The class is located in a module public handle ([string $uri]) Produce the routing parameters from the rewrite information public processControllerAnnotation (string $handler, unknown $annotation) Checks for annotations in the controller docblock public processActionAnnotation (string $module, string $namespace, string $controller, string $action, Phalcon\Annotations\Annotation $annotation) Checks for annotations in the public methods of the controller public setControllerSuffix (string $controllerSuffix) Changes the controller class suffix public setActionSuffix (string $actionSuffix) Changes the action method suffix public array getResources () Return the registered resources public __construct ([boolean $defaultRoutes]) inherited from Phalcon\Mvc\Router Phalcon\Mvc\Router constructor public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Router Sets the dependency injector public Phalcon\DiInterface getDI () inherited from Phalcon\Mvc\Router Returns the internal dependency injector public string getRewriteUri () inherited from Phalcon\Mvc\Router Get rewrite info. This info is read from $_GET[‘_url’]. This returns ‘/’ if the rewrite information cannot be read public Phalcon\Mvc\Router setUriSource (int $uriSource) inherited from Phalcon\Mvc\Router Sets the URI source. One of the URI_SOURCE_* constants <?php
$router->setUriSource(Router::URI_SOURCE_SERVER_REQUEST_URI);
public Phalcon\Mvc\Router removeExtraSlashes (boolean $remove) inherited from Phalcon\Mvc\Router Set whether router must remove the extra slashes in the handled routes public Phalcon\Mvc\Router setDefaultNamespace (string $namespaceName) inherited from Phalcon\Mvc\Router Sets the name of the default namespace public string getDefaultNamespace () inherited from Phalcon\Mvc\Router Returns the name of the default namespace public Phalcon\Mvc\Router setDefaultModule (string $moduleName) inherited from Phalcon\Mvc\Router Sets the name of the default module public string getDefaultModule () inherited from Phalcon\Mvc\Router Returns the name of the default module public Phalcon\Mvc\Router setDefaultController (string $controllerName) inherited from Phalcon\Mvc\Router Sets the default controller name public string getDefaultController () inherited from Phalcon\Mvc\Router Returns the default controller name public Phalcon\Mvc\Router setDefaultAction (string $actionName) inherited from Phalcon\Mvc\Router Sets the default action name public string getDefaultAction () inherited from Phalcon\Mvc\Router Returns the default action name public Phalcon\Mvc\Router setDefaults (array $defaults) inherited from Phalcon\Mvc\Router Sets an array of default paths. If a route is missing a path the router will use the defined here This method must not be used to set a 404 route <?php
$router->setDefaults(array(
'module' => 'common',
'action' => 'index'
));
public array getDefaults () inherited from Phalcon\Mvc\Router Returns an array of default parameters public Phalcon\Mvc\Router\Route add (string $pattern, [string/array $paths], [string $httpMethods]) inherited from Phalcon\Mvc\Router Adds a route to the router without any HTTP constraint <?php
$router->add('/about', 'About::index');
public Phalcon\Mvc\Router\Route addGet (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is GET public Phalcon\Mvc\Router\Route addPost (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is POST public Phalcon\Mvc\Router\Route addPut (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is PUT public Phalcon\Mvc\Router\Route addPatch (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is PATCH public Phalcon\Mvc\Router\Route addDelete (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is DELETE public Phalcon\Mvc\Router\Route addOptions (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Add a route to the router that only match if the HTTP method is OPTIONS public Phalcon\Mvc\Router\Route addHead (string $pattern, [string/array $paths]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is HEAD public Phalcon\Mvc\Router mount (unknown $group) inherited from Phalcon\Mvc\Router Mounts a group of routes in the router public Phalcon\Mvc\Router notFound (array|string $paths) inherited from Phalcon\Mvc\Router Set a group of paths to be returned when none of the defined routes are matched public clear () inherited from Phalcon\Mvc\Router Removes all the pre-defined routes public string getNamespaceName () inherited from Phalcon\Mvc\Router Returns the processed namespace name public string getModuleName () inherited from Phalcon\Mvc\Router Returns the processed module name public string getControllerName () inherited from Phalcon\Mvc\Router Returns the processed controller name public string getActionName () inherited from Phalcon\Mvc\Router Returns the processed action name public array getParams () inherited from Phalcon\Mvc\Router Returns the processed parameters public Phalcon\Mvc\Router\Route getMatchedRoute () inherited from Phalcon\Mvc\Router Returns the route that matchs the handled URI public array getMatches () inherited from Phalcon\Mvc\Router Returns the sub expressions in the regular expression matched public bool wasMatched () inherited from Phalcon\Mvc\Router Checks if the router macthes any of the defined routes public Phalcon\Mvc\Router\Route [] getRoutes () inherited from Phalcon\Mvc\Router Returns all the routes defined in the router public Phalcon\Mvc\Router\Route | false getRouteById (string $id) inherited from Phalcon\Mvc\Router Returns a route object by its id public Phalcon\Mvc\Router\Route getRouteByName (string $name) inherited from Phalcon\Mvc\Router Returns a route object by its name public isExactControllerName () inherited from Phalcon\Mvc\Router Returns whether controller name should not be mangled |