CycloneDX Library

ExternalReference
in package

External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.

Tags
author

jkowalleck

Table of Contents

Properties

$comment  : string|null
An optional comment describing the external reference.
$hashes  : HashDictionary
$type  : ExternalReferenceType
Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.
$url  : string
The URL to the external reference.

Methods

__construct()  : mixed
getComment()  : string|null
getHashes()  : HashDictionary
getType()  : ExternalReferenceType
getUrl()  : string
setComment()  : $this
setHashes()  : $this
setType()  : $this
setUrl()  : $this

Properties

$comment

An optional comment describing the external reference.

private string|null $comment = null

$type

Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.

private ExternalReferenceType $type

Methods

setComment()

public setComment(string|null $comment) : $this
Parameters
$comment : string|null
Return values
$this

setUrl()

public setUrl(string $url) : $this
Parameters
$url : string
Return values
$this

        
On this page

Search results