class Analyzer::Php::Slim

Defined in:

analyzer/analyzers/php/slim.cr

Constant Summary

FOREIGN_ROUTE_COLLECTORS = Set {"routes", "router", "route", "builder"}

Cheap pre-filter: avoid heavy regex work on files that clearly aren't Slim. Any file that reaches this analyzer via detection is usually in a Slim project, but project-wide scans still feed unrelated PHP here. Route-collector handles that belong to a different PHP framework by convention: $routes is CodeIgniter 4 and CakePHP, $builder is CakePHP's RouteBuilder, $router is Lumen. Slim's own docs and skeleton use $app and $group throughout.

This only gates the marker-less fallback below. Every PHP analyzer is fed every .php file in the scan, so in a repo holding more than one PHP framework that fallback read $routes->get('users/(:num)', …) out of CodeIgniter's app/Config/Routes.php and $builder->get('/status', …) out of CakePHP's config/routes.php, and emitted both as Slim routes. A genuine Slim file naming Slim\ keeps working regardless of what it calls its variables.

MEZZIO_MARKER_RE = /Mezzio\\/

Mezzio registers its programmatic routes on $app->get('/x', Handler::class) — the same expression Slim uses — so Slim read Mezzio's route table as its own. Mezzio\ is the one unambiguous marker: a Mezzio application names it, and Slim never does.

Laminas\ deliberately isn't on this list. Slim apps pull in Laminas\Diactoros for PSR-7 all the time, so excluding on it would drop their routes.

PARAM_PATTERNS = [{/\$args\s*\[\s*['"]([^'"]+)['"]\s*\]/, "path"}, {/->getQueryParams\s*\(\s*\)\s*\[\s*['"]([^'"]+)['"]\s*\]/, "query"}, {/->getParsedBody\s*\(\s*\)\s*\[\s*['"]([^'"]+)['"]\s*\]/, "form"}, {/->getHeaderLine\s*\(\s*['"]([^'"]+)['"]\s*\)/, "header"}, {/->getHeader\s*\(\s*['"]([^'"]+)['"]\s*\)/, "header"}, {/->getCookieParams\s*\(\s*\)\s*\[\s*['"]([^'"]+)['"]\s*\]/, "cookie"}]
RELEVANCE_MARKER_RE = /Slim\\|SlimFramework|AppFactory|RouteCollectorProxy/

Precompiled once at load: these four markers used to be four separate String#includes? scans of the whole file ORed together. Crystal's String#includes? is measurably slower than a single precompiled Regex#matches? call, and this runs on every .php file fed into the analyzer during a project-wide scan.

VERB_CALL_RECEIVER_RE = /\$(\w+)->(?:get|post|put|patch|delete|options|head|map|group)\s*\(/i

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]