Skip to content

Reference

phil/route-access-check
TypeKindRole
Phil\RouteAccessCheck\Attribute\PublicRouteattributeA controller or action public on purpose: reason, MAX_REASON_LENGTH
Phil\RouteAccessCheck\RouteAccessCheckerfinal readonly classThe check: check(RouteCollection, Baseline)
Phil\RouteAccessCheck\RouteReaderfinal readonly classA route read into an AnalysedRoute: read()
Phil\RouteAccessCheck\AnalysedRoutefinal readonly classA route as the detectors see it: methods, controller, samplePath, sampleHost, exactSample, otherSamples, path(), host(), acceptsAnyMethod(), USUAL_METHODS, ANY_OTHER_METHOD
Phil\RouteAccessCheck\RouteSamplefinal readonly classThe sample paths and hosts of a route: all(), of() (the first), MAX_SAMPLES
Phil\RouteAccessCheck\ControllerLocatorfinal readonly classThe controller of a _controller default: locate()
Phil\RouteAccessCheck\Controllerfinal readonly classA controller's class, action, file, line and attributes: attributesNamed(), label()
Phil\RouteAccessCheck\AccessRulefinal readonly classA rule found for a route: source, effect, scope, description, methods, ruleId, appliesTo()
Phil\RouteAccessCheck\AccessEffectenumprotected, public, unsecured, unchecked, conditional; covers()
Phil\RouteAccessCheck\RuleScopeenumroute, configuration
Phil\RouteAccessCheck\IgnoreListfinal readonly classThe routes left aside by prefix: ignores(), FRAMEWORK_ROUTE_NAMES, FRAMEWORK_PATHS
Phil\RouteAccessCheck\Baselinefinal readonly classThe tolerated failures: fromJson(), fromReport(), tolerates(), toJson(), VERSION, MAX_BYTES
Phil\RouteAccessCheck\Detector\SecurityAttributeDetectorfinal readonly class#[IsGranted] and attributes with its arguments: IS_GRANTED, PUBLIC_ACCESS
Phil\RouteAccessCheck\Detector\PublicRouteDetectorfinal readonly class#[PublicRoute] and the route option: DEFAULT_OPTION
Phil\RouteAccessCheck\Detector\SecurityConfigDetectorfinal readonly classFirewalls and access_control entries: UNNAMED_HOST, UNLISTED_METHOD
Phil\RouteAccessCheck\Security\SecurityMapfinal readonly classThe firewalls and entries: fromArray(), isEmpty(), MAX_RULES
Phil\RouteAccessCheck\Security\Firewallfinal readonly classA firewall: name, constraints, security
Phil\RouteAccessCheck\Security\AccessControlEntryfinal readonly classAn entry: position, constraints, roles, allowIf, requiresChannel, id(), effect(), describe()
Phil\RouteAccessCheck\Security\RequestConstraintsfinal readonly classWhat a rule matches: matches(), allowsMethod(), isConditional(), describe()
Phil\RouteAccessCheck\Report\Reportfinal readonly classThe result: verdicts, unusedRules, staleBaselineEntries, failures(), hasFailures(), inexactSamples(), hasWarnings(), counts(), baselinedCount()
Phil\RouteAccessCheck\Report\RouteVerdictfinal readonly classA route's conclusion: status, rules, uncoveredMethods, conflicts, baselined, fails(), problem(), withBaselined()
Phil\RouteAccessCheck\Report\RouteStatusenumprotected, public, mixed, uncovered, conflict, ignored; isFailure()
Phil\RouteAccessCheck\Report\UnusedRulefinal readonly classA declared rule no route reaches: id, description
Phil\RouteAccessCheck\Format\TextFormatterfinal readonly classThe text format
Phil\RouteAccessCheck\Format\JsonFormatterfinal readonly classThe json format
Phil\RouteAccessCheck\Format\GitHubFormatterfinal readonly classThe github format, files relative to the project directory
Phil\RouteAccessCheck\Format\JunitFormatterfinal readonly classThe junit format
Phil\RouteAccessCheck\Format\Describefinal class, internalThe phrases the formats share
Phil\RouteAccessCheck\Contract\AccessRuleDetectorinterfaceA source of rules: detect()
Phil\RouteAccessCheck\Contract\RuleInventoryinterfaceThe rules declared ahead of the routes: declaredRules()
Phil\RouteAccessCheck\Contract\ReportFormatterinterfaceA format: name(), format()
Phil\RouteAccessCheck\Exception\RouteAccessCheckExceptioninterfaceEvery exception of the library
Phil\RouteAccessCheck\Exception\InvalidBaselinefinal classA baseline the library cannot read
Phil\RouteAccessCheck\Exception\InvalidSecurityMapfinal classA security map the library cannot read
Phil\RouteAccessCheck\Exception\InvalidConfigurationfinal classA declaration or an option the library cannot work with