Class: Crypt_GPG_KeyGeneratorStatusHandler

Source Location: /Crypt_GPG-1.4.0b4/Crypt/GPG/KeyGeneratorStatusHandler.php

Class Overview

Status line handler for the key generation operation

Author(s):

Michael Gauthier <mike at silverorange.com>

Copyright:

2011-2013 silverorange

Inherited Variables

Inherited Methods

Class Details

[line 59]
Status line handler for the key generation operation

This class is used internally by Crypt_GPG and does not need be used directly. See the Crypt_GPG class for end-user API.

This class is responsible for parsing the final key fingerprint from the status output and for updating the key generation progress file. See doc/DETAILS in the GPG distribution for detailed information on GPG's status output for the batch key generation operation.

Author: Michael Gauthier <mike@silverorange.com>
Copyright: 2011-2013 silverorange
Link: http://pear.php.net/package/Crypt_GPG
Link: http://www.gnupg.org/
License: LGPL License 2.1

[ Top ]

Class Variables

$errorCode = Crypt_GPG::ERROR_NONE

[line 90]

Error code (if any) caused by key generation

Access: protected

Type:

integer

[ Top ]

$handle = ''

[line 83]

The unique key handle used by this handler

The key handle is used to track GPG status output for a particular key before the key has its own identifier.

See: Crypt_GPG_KeyGeneratorStatusHandler::setHandle()
Access: protected

Type:

string

[ Top ]

$keyFingerprint = ''

[line 71]

The key fingerprint

Ths key fingerprint is emitted by GPG after the key generation is complete.

Access: protected

Type:

string

[ Top ]

Method Detail

getErrorCode [line 165]

integer getErrorCode(
)

Gets the error code resulting from key gneration

Return: the error code resulting from key generation.
Access: public

[ Top ]

getKeyFingerprint [line 152]

array getKeyFingerprint(
)

Gets the key fingerprint parsed by this handler

Return: the key fingerprint parsed by this handler.
Access: public

[ Top ]

handle [line 122]

void handle(
string
$line)

Handles a status line

Access: public

Parameters:

string $line — the status line to handle.

[ Top ]

setHandle [line 106]

Crypt_GPG_KeyGeneratorStatusHandler setHandle(
string
$handle)

Sets the unique key handle used by this handler

The key handle is used to track GPG status output for a particular key before the key has its own identifier.

Return: the current object, for fluent interface.
Access: public

Parameters:

string $handle — the key handle this status handle will use.

[ Top ]