CodeQL library for Ruby
codeql/ruby-all 0.8.15-dev (changelog, source)
Search

Class Routing::Route

A route configuration. This defines a combination of HTTP method and URL path which should be routed to a particular controller-action pair. This can arise from an explicit call to a routing method, for example:

get "/photos", to: "photos#index"

or via a convenience method like resources, which defines multiple routes at once:

resources :photos

Import path

import codeql.ruby.frameworks.actiondispatch.internal.Routing

Direct supertypes

Predicates

getACapture

Get a URL capture. This is a wildcard URL segment whose value is placed in params. For example, in ruby get "/foo/:bar/baz", to: "users#index" the capture is :bar.

getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this route belongs.

getAction

Gets the action targeted by this route.

getController

Gets the full controller targeted by this route.

getHttpMethod

Gets the HTTP method of this route. The result is one of [get, post, put, patch, delete].

getLocation

Gets the location of the method call that defines this route.

getPath

Gets the full path of the route.

toString

Gets a string representation of this route.