SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Signer
  1. X509
    1. Certificate
    2. Chain
    3. Collection
    4. CollectionInterface
    5. Crl
    6. Extension
    7. Extensions
    8. Format

setasign\SetaPDF2\Signer\X509

Chain Helper class to build certificate paths.

File: /SetaPDF v2/Signer/X509/Chain.php
Old class name (alias): \SetaPDF_Signer_X509_Chain

Class hierarchy

Chain

Summary

Methods

__construct()
_buildPaths()
_findIssuer()
buildPath()
buildPaths()
getExtraCertificates()
getLogger()
getTrustedCertificates()
setLogger()

Properties

$_extraCertificates
$_logger
$_trustedCertificates

Properties

$_extraCertificates

protected Collection Chain::$_extraCertificates

The extra certificates.

$_logger

protected \setasign\SetaPDF2\Signer\ValidationRelatedInfo\LoggerInterface Chain::$_logger

The logger instance.

$_trustedCertificates

protected Collection Chain::$_trustedCertificates

The trusted certificates.

Methods

__construct()

public Chain::__construct (

null|string|Certificate|Certificate[]|CollectionInterface $trustedCertificates = null

)

The constructor.

Parameters

$trustedCertificates : null|string|Certificate|Certificate[]|CollectionInterface: $trustedCertificates

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

_buildPaths()

protected Chain::_buildPaths (

Certificate $certificate,
string[] &$paths,
Certificate[] $currentPath = array ( )

): void

Build all possible paths.

Parameters

$certificate : Certificate
$paths : string[]
$currentPath : Certificate[]

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

_findIssuer()

protected Chain::_findIssuer (

Certificate $certificate

Find issuers by a certificate.

Parameters

$certificate : Certificate

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

buildPath()

public Chain::buildPath (

Certificate $certificate,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $timeZone = null

): false|Certificate[]

Build a valid certificate path.

Parameters

$certificate : Certificate
$dateTime : ?\DateTimeInterface: If a date time is given only certificates which are valid at this will be part of the path.
$timeZone : ?\DateTimeZone

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

buildPaths()

public Chain::buildPaths (

Certificate $certificate

): Certificate[]

Build all possible paths.

Parameters

$certificate : Certificate

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

getExtraCertificates()

public Chain::getExtraCertificates (

void

Get the extra certificates collection instance.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getLogger()

public Chain::getLogger (

void

): \setasign\SetaPDF2\Signer\ValidationRelatedInfo\LoggerInterface

Get the logger instance.

If no logger instance was passed before a new instance of \setasign\SetaPDF2\Signer\ValidationRelatedInfo\Logger is returned.

getTrustedCertificates()

public Chain::getTrustedCertificates (

void

Get the trusted certificates collection instance.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

setLogger()

public Chain::setLogger (

\setasign\SetaPDF2\Signer\ValidationRelatedInfo\LoggerInterface $logger

): void

Set a logger instance.

Parameters

$logger : \setasign\SetaPDF2\Signer\ValidationRelatedInfo\LoggerInterface