class Analyzer::Php::Laravel

Defined in:

analyzer/analyzers/php/laravel.cr

Constant Summary

ACTION_FILTER_RES = {"only" => Regex.new("->\\s*only\\s*\\((.*?)\\)", Regex::Options::IGNORE_CASE | Regex::Options::MULTILINE), "except" => Regex.new("->\\s*except\\s*\\((.*?)\\)", Regex::Options::IGNORE_CASE | Regex::Options::MULTILINE)}
ANY_REGEX = /Route::any\s*\(\s*['"]([^'"]+)['"]\s*,/im

Route::any('/x', …): capture 1 is the path; the verbs are implied.

ANY_ROUTE_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"]

Methods a single Route::any registration stands for.

API_RESOURCE_ACTIONS = ["index", "store", "show", "update", "destroy"]
CHAINED_MATCH_REGEX = /Route::((?:\w+\s*\([^;]*?\)\s*->\s*)+)(?:match|addRoute)\s*\(\s*(\[[^\]]+\]|['"][^'"]+['"])\s*,\s*['"]([^'"]+)['"]\s*,/im

The match/addRoute routes behind a fluent prelude. Capture 1 is the prelude, capture 2 the verb specification, capture 3 the path.

CHAINED_STATIC_ROUTE_REGEX = /Route::((?:\w+\s*\([^;]*?\)\s*->\s*)+)(view|redirect|permanentRedirect)\s*\(\s*['"]([^'"]+)['"]\s*,/im

The static routes behind a fluent prelude. Capture 1 is the prelude, capture 2 the (unread) static verb, capture 3 the path.

CHAINED_VERB_REGEX = /Route::((?:\w+\s*\([^;]*?\)\s*->\s*)+)(get|post|put|patch|delete|options|head|query)\s*\(\s*['"]([^'"]+)['"]\s*,/im

The same, behind a fluent prelude — Route::middleware('auth')->prefix('v1')->get('/x', …). Capture 1 is the whole prelude (a ->-separated chain of calls; the inner [^;]*? keeps each call's argument list inside one statement), capture 2 the verb, capture 3 the path.

EMPTY_IMPORTS = {} of String => String
EMPTY_RESOURCE_PARAMS = {} of String => String
MATCH_REGEX = /Route::(?:match|addRoute)\s*\(\s*(\[[^\]]+\]|['"][^'"]+['"])\s*,\s*['"]([^'"]+)['"]\s*,/im

Route::match(['get', 'post'], '/x', …) or Route::addRoute('QUERY', '/x', …): capture 1 is the verb specification (array literal or string literal), capture 2 the path.

RESOURCE_ACTIONS = ["index", "create", "store", "show", "edit", "update", "destroy"]
RESOURCE_CALL_RES = {"resource" => Regex.new("Route::resource\\s*\\(\\s*['\"]([^'\"]+)['\"]", Regex::Options::IGNORE_CASE | Regex::Options::MULTILINE), "apiResource" => Regex.new("Route::apiResource\\s*\\(\\s*['\"]([^'\"]+)['\"]", Regex::Options::IGNORE_CASE | Regex::Options::MULTILINE)}

Hoisted patterns for extract_resource_route_calls / extract_resource_action_filter — both call sites pass literal names ("resource"/"apiResource", "only"/"except"), and the previous Regex.new interpolation recompiled the pattern on every call (per file, and per resource statement respectively).

ROUTE_REGISTRATION_RE = /Route::(?:\w+\s*\([^;]*?\)\s*->\s*)*\w+\s*\(\s*(?:(?:\[[^\]]*\]|['"][^'"]*['"])\s*,\s*)?['"][^'"]*['"]\s*,/im

Any Route::…('path', … registration, whatever verb or chain precedes it. Used only to locate handler-closure bodies up front; the six scans above are what actually decide which registrations become endpoints.

STATIC_ROUTE_REGEX = /Route::(view|redirect|permanentRedirect)\s*\(\s*['"]([^'"]+)['"]\s*,/im

Route::view / redirect / permanentRedirect: capture 1 is the verb alternation, matched but never read — Laravel serves all three over GET only — and capture 2 is the path.

VERB_REGEX = /Route::(get|post|put|patch|delete|options|head|query)\s*\(\s*['"]([^'"]+)['"]\s*,/im

Route::get('/x', …) and friends: the verb is capture 1, the path capture 2.

Class Method Summary

Instance Method Summary

Class methods inherited from class Analyzer::Php::PhpEngine

test_path?(relative_path : String) : Bool test_path?

Instance methods inherited from class FileScanEngine

analyze analyze, analyze_file(path : String) : Array(Endpoint) analyze_file

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze_file(path : String) : Array(Endpoint) #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]