PHP Class Airship\Engine\Continuum\Updaters\UpdateInfo

Contains metadata about an update.
Show file Open project: paragonie/airship Class Usage Examples

Protected Properties

Property Type Description
$channel string
$checksum string
$merkleRoot string
$packageName string
$releaseInfo *
$response array
$supplierName string

Public Methods

Method Description
__construct ( array $json, string $channelURL, SignaturePublicKey $channelPublicKey, string $supplierName, string $packageName ) UpdateInfo constructor.
getChannel ( ) : string Get the channel that we retrieved this update from.
getChannelPublicKey ( ) : SignaturePublicKey Get the channel's public key
getChecksum ( ) : string Get the checksum of the file.
getMerkleRoot ( boolean $raw = false ) : string Get the expected Merkle root (verify with Keyggdrasil's cache)
getPackageName ( ) : string Get the name of the package we're updating
getResponse ( ) : array Get the full response body
getSignature ( boolean $hex = false ) : string Get the signature
getSupplierName ( ) : string Get the supplier's name
getVersion ( ) : string Get the version for this particular update
getVersionExpanded ( ) : integer Get the expanded version for this particular update

Method Details

__construct() public method

UpdateInfo constructor.
public __construct ( array $json, string $channelURL, SignaturePublicKey $channelPublicKey, string $supplierName, string $packageName )
$json array
$channelURL string
$channelPublicKey ParagonIE\Halite\Asymmetric\SignaturePublicKey
$supplierName string
$packageName string

getChannel() public method

Get the channel that we retrieved this update from.
public getChannel ( ) : string
return string

getChannelPublicKey() public method

Get the channel's public key
public getChannelPublicKey ( ) : SignaturePublicKey
return ParagonIE\Halite\Asymmetric\SignaturePublicKey

getChecksum() public method

Get the checksum of the file.
public getChecksum ( ) : string
return string

getMerkleRoot() public method

Get the expected Merkle root (verify with Keyggdrasil's cache)
public getMerkleRoot ( boolean $raw = false ) : string
$raw boolean
return string

getPackageName() public method

Get the name of the package we're updating
public getPackageName ( ) : string
return string

getResponse() public method

Get the full response body
public getResponse ( ) : array
return array

getSignature() public method

Get the signature
public getSignature ( boolean $hex = false ) : string
$hex boolean
return string

getSupplierName() public method

Get the supplier's name
public getSupplierName ( ) : string
return string

getVersion() public method

Get the version for this particular update
public getVersion ( ) : string
return string

getVersionExpanded() public method

Get the expanded version for this particular update
public getVersionExpanded ( ) : integer
return integer

Property Details

$channel protected property

protected string $channel
return string

$checksum protected property

protected string $checksum
return string

$merkleRoot protected property

protected string $merkleRoot
return string

$packageName protected property

protected string $packageName
return string

$releaseInfo protected property

*
protected $releaseInfo

$response protected property

protected array $response
return array

$supplierName protected property

protected string $supplierName
return string