Documentation

Construct extends ASNObject
in package
implements Countable, ArrayAccess, Iterator, Parsable

Class ASNObject is the base class for all concrete ASN.1 objects.

Interfaces, Classes, Traits and Enums

Countable
ArrayAccess
Iterator
Parsable
The Parsable interface describes classes that can be parsed from their binary DER representation.

Table of Contents

$children  : array<string|int, ASNObject>
$contentLength  : mixed
$iteratorPosition  : mixed
$nrOfLengthOctets  : mixed
__construct()  : mixed
__toString()  : mixed
addChild()  : mixed
addChildren()  : mixed
count()  : mixed
current()  : mixed
fromBinary()  : Construct|static
Parse an instance of this class from its binary DER encoded representation.
getBinary()  : string
Encode this object using DER encoding.
getChildren()  : array<string|int, ASNObject>
getContent()  : mixed
Return the content of this object in a non encoded form.
getFirstChild()  : ASNObject
getIdentifier()  : string
Returns all identifier octets. If an inheriting class models a tag with the long form identifier format, it MUST reimplement this method to return all octets of the identifier.
getIterator()  : mixed
getNumberOfChildren()  : mixed
getObjectLength()  : mixed
Returns the length of the whole object (including the identifier and length octets).
getType()  : int
Return the object type octet.
getTypeName()  : mixed
Returns the name of the ASN.1 Type of this object.
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
valid()  : mixed
calculateContentLength()  : int
Must return the number of octets of the content part.
getContentLength()  : mixed
getEncodedValue()  : string
Encode the object using DER encoding.
getNumberOfLengthOctets()  : mixed
parseBinaryIdentifier()  : mixed
parseContentLength()  : mixed
parseIdentifier()  : mixed
setContentLength()  : mixed
createLengthPart()  : mixed

Properties

$iteratorPosition

private mixed $iteratorPosition

$nrOfLengthOctets

private mixed $nrOfLengthOctets

Methods

__construct()

public __construct(array<string|int, ASNObject...$children) : mixed
Parameters
$children : array<string|int, ASNObject>

the variadic type hint is commented due to https://github.com/facebook/hhvm/issues/4858

Return values
mixed

__toString()

public __toString() : mixed
Return values
mixed

addChildren()

public addChildren(array<string|int, mixed> $children) : mixed
Parameters
$children : array<string|int, mixed>
Return values
mixed

count()

public count([mixed $mode = COUNT_NORMAL ]) : mixed
Parameters
$mode : mixed = COUNT_NORMAL
Return values
mixed

current()

public current() : mixed
Return values
mixed

fromBinary()

Parse an instance of this class from its binary DER encoded representation.

public static fromBinary(string &$binaryData[, int &$offsetIndex = 0 ]) : Construct|static
Parameters
$binaryData : string
$offsetIndex : int = 0
Tags
throws
ParserException
Return values
Construct|static

getBinary()

Encode this object using DER encoding.

public getBinary() : string
Return values
string

the full binary representation of the complete object

getContent()

Return the content of this object in a non encoded form.

public getContent() : mixed

This can be used to print the value in human readable form.

Return values
mixed

getIdentifier()

Returns all identifier octets. If an inheriting class models a tag with the long form identifier format, it MUST reimplement this method to return all octets of the identifier.

public getIdentifier() : string
Tags
throws
LogicException

If the identifier format is long form

Return values
string

Identifier as a set of octets

getIterator()

public getIterator() : mixed
Return values
mixed

getNumberOfChildren()

public getNumberOfChildren() : mixed
Return values
mixed

getObjectLength()

Returns the length of the whole object (including the identifier and length octets).

public getObjectLength() : mixed
Return values
mixed

getType()

Return the object type octet.

public abstract getType() : int

This should use the class constants of Identifier.

Tags
see
Identifier
Return values
int

getTypeName()

Returns the name of the ASN.1 Type of this object.

public getTypeName() : mixed
Tags
see
Identifier::getName()
Return values
mixed

key()

public key() : mixed
Return values
mixed

next()

public next() : mixed
Return values
mixed

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

rewind()

public rewind() : mixed
Return values
mixed

valid()

public valid() : mixed
Return values
mixed

calculateContentLength()

Must return the number of octets of the content part.

protected calculateContentLength() : int
Return values
int

getContentLength()

protected getContentLength() : mixed
Return values
mixed

getEncodedValue()

Encode the object using DER encoding.

protected getEncodedValue() : string
Return values
string

the binary representation of an objects value

getNumberOfLengthOctets()

protected getNumberOfLengthOctets([mixed $contentLength = null ]) : mixed
Parameters
$contentLength : mixed = null
Return values
mixed

parseBinaryIdentifier()

protected static parseBinaryIdentifier(mixed $binaryData, mixed &$offsetIndex) : mixed
Parameters
$binaryData : mixed
$offsetIndex : mixed
Return values
mixed

parseContentLength()

protected static parseContentLength(mixed &$binaryData, mixed &$offsetIndex[, mixed $minimumLength = 0 ]) : mixed
Parameters
$binaryData : mixed
$offsetIndex : mixed
$minimumLength : mixed = 0
Return values
mixed

parseIdentifier()

protected static parseIdentifier(mixed $identifierOctet, mixed $expectedIdentifier, mixed $offsetForExceptionHandling) : mixed
Parameters
$identifierOctet : mixed
$expectedIdentifier : mixed
$offsetForExceptionHandling : mixed
Return values
mixed

setContentLength()

protected setContentLength(mixed $newContentLength) : mixed
Parameters
$newContentLength : mixed
Return values
mixed

createLengthPart()

private createLengthPart() : mixed
Return values
mixed

Search results