logicalLocation.md

logicalLocation object

A logicalLocation object describes a logical location. A logical location is a location specified by a programmatic construct such as a namespace, a type, or a method, without regard to the physical location where the construct occurs.

Example

{
    "$schema": "https://json.schemastore.org/sarif-2.1.0.json",
    "version": "2.1.0",
    "runs": [
        {
            "tool": {
                "driver": {
                    "name": "Psalm",
                    "version": "4.x-dev",
                    "informationUri": "https://psalm.de"
                }
            },
            "logicalLocations": [
                {
                    "name": "Hook",
                    "fullyQualifiedName": "Psalm\\Plugin\\Hook",
                    "kind": "namespace"
                },
                {
                    "name": "afterAnalysis",
                    "fullyQualifiedName": "Psalm\\Plugin\\Hook\\AfterAnalysisInterface\\afterAnalysis",
                    "kind": "function"
                }
            ],
            "results": []
        }
    ]
}

How to generate

See full examples/logicalLocation.php script into repository.

Note

Since release 1.5.0, you may use fluent builders API as alternative. See full examples/builder/logicalLocation.php script into repository.

<?php declare(strict_types=1);

use Bartlett\Sarif\Definition\LogicalLocation;
use Bartlett\Sarif\Definition\Run;

$nsLocation = new LogicalLocation();
$nsLocation->setName('Hook');
$nsLocation->setFullyQualifiedName('Psalm\Plugin\Hook');
$nsLocation->setKind('namespace');

$funcLocation = new LogicalLocation();
$funcLocation->setName('afterAnalysis');
$funcLocation->setFullyQualifiedName('Psalm\Plugin\Hook\AfterAnalysisInterface\afterAnalysis');
$funcLocation->setKind('function');

$run = new Run($tool);
$run->addLogicalLocations([$nsLocation, $funcLocation]);