Skip to content

suppression object

A suppression object describes a request to suppress a result.

suppression object

Tip

Generated with following command : php ./resources/serialize.php suppression docs/assets/sarif 192

docs/assets/sarif/suppression.json
{
    "$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"
                }
            },
            "results": [
                {
                    "message": {
                        "text": "Request to suppress a result"
                    },
                    "suppressions": [
                        {
                            "kind": "inSource",
                            "guid": "11111111-1111-1111-8888-111111111111",
                            "status": "underReview",
                            "justification": "result outdated"
                        }
                    ]
                }
            ]
        }
    ]
}
examples/suppression.php
<?php declare(strict_types=1);
/**
 * This file is part of the Sarif-PHP-SDK package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Laurent Laville
 */

use Bartlett\Sarif\Definition\Message;
use Bartlett\Sarif\Definition\Result;
use Bartlett\Sarif\Definition\Run;
use Bartlett\Sarif\Definition\Suppression;
use Bartlett\Sarif\Definition\Tool;
use Bartlett\Sarif\Definition\ToolComponent;
use Bartlett\Sarif\SarifLog;

require_once dirname(__DIR__) . '/vendor/autoload.php';

$driver = new ToolComponent();
$driver->setName('Psalm');
$driver->setInformationUri('https://psalm.de');
$driver->setVersion('4.x-dev');

$tool = new Tool();
$tool->setDriver($driver);

$suppression = new Suppression();
$suppression->setKind('inSource');
$suppression->setGuid('11111111-1111-1111-8888-111111111111');
$suppression->setStatus('underReview');
$suppression->setJustification('result outdated');

$message = new Message();
$message->setText('Request to suppress a result');

$result = new Result();
$result->setMessage($message);
$result->addSuppressions([$suppression]);

$run = new Run();
$run->setTool($tool);
$run->addResults([$result]);

$log = new SarifLog([$run]);

Note

This alternative API is available since release 1.5.0

examples/builder/suppression.php
<?php declare(strict_types=1);
/**
 * This file is part of the Sarif-PHP-SDK package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Laurent Laville
 */

require_once dirname(__DIR__, 2) . '/vendor/autoload.php';

use Bartlett\Sarif\Factory\BuilderFactory;

$factory = new BuilderFactory();

// @link https://github.com/llaville/sarif-php-sdk/blob/1.1/docs/reference/suppression.md
$spec = $factory->specification('2.1.0')
    ->addRun(
        $factory->run()
            ->tool(
                $factory->tool()
                    ->driver(
                        $factory->driver()
                            ->name('Psalm')
                            ->version('4.x-dev')
                            ->informationUri('https://psalm.de')
                    )
            )
            ->addResult(
                $factory->result()
                    ->message(
                        $factory->message()
                            ->text('Request to suppress a result')
                    )
                    ->addSuppression(
                        $factory->suppression()
                            ->kind('inSource')
                            ->guid('11111111-1111-1111-8888-111111111111')
                            ->status('underReview')
                            ->justification('result outdated')
                    )
            )
    )
;