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
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
$hashes
private
HashDictionary
$hashes
$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
$url
The URL to the external reference.
private
string
$url
Methods
__construct()
public
__construct(ExternalReferenceType $type, string $url) : mixed
Parameters
- $type : ExternalReferenceType
- $url : string
getComment()
public
getComment() : string|null
Return values
string|nullgetHashes()
public
getHashes() : HashDictionary
Return values
HashDictionarygetType()
public
getType() : ExternalReferenceType
Return values
ExternalReferenceTypegetUrl()
public
getUrl() : string
Return values
stringsetComment()
public
setComment(string|null $comment) : $this
Parameters
- $comment : string|null
Return values
$thissetHashes()
public
setHashes(HashDictionary $hashes) : $this
Parameters
- $hashes : HashDictionary
Return values
$thissetType()
public
setType(ExternalReferenceType $type) : $this
Parameters
- $type : ExternalReferenceType
Return values
$thissetUrl()
public
setUrl(string $url) : $this
Parameters
- $url : string