Docs For Class Crypt_GPG

addErrorHandler [line 412]

void addErrorHandler(
callback
$callback, [array
$args = array()])

Adds an error handler method

The method is run every time a new error line is received from the GPG subprocess. The handler method must accept the error line to be handled as its first parameter.

Access: public

Parameters:

callback	`$callback`	—	the callback method to use.
array	`$args`	—	optional. Additional arguments to pass as parameters to the callback method.

[ Top ]

addStatusHandler [line 436]

void addStatusHandler(
callback
$callback, [array
$args = array()])

Adds a status handler method

The method is run every time a new status line is received from the GPG subprocess. The handler method must accept the status line to be handled as its first parameter.

Access: public

Parameters:

callback	`$callback`	—	the callback method to use.
array	`$args`	—	optional. Additional arguments to pass as parameters to the callback method.

[ Top ]

__construct (Constructor) [line 329]

Crypt_GPG_Engine __construct(
[array
$options = array()])

Creates a new GPG engine

Available options:

string homedir - the directory where the GPG keyring files are stored. If not specified, Crypt_GPG uses the default of ~/.gnupg.
string gpgBinary - the location of the GPG binary. If not specified, the driver attempts to auto-detect the GPG binary location using a list of known default locations for the current operating system.
boolean debug - whether or not to use debug mode. When debug mode is on, all communication to and from the GPG subprocess is logged. This can be useful to diagnose errors when using Crypt_GPG.

Throws: PEAR_Exception if the provided gpgBinary is invalid, or if no gpgBinary is provided and no suitable binary could be found.
Throws: Crypt_GPG_FileException if the homedir does not exist and cannot be created. This can happen if homedir is not specified, Crypt_GPG is run as the web user, and the web user has no home directory.
Access: public

Parameters:

array $options — optional. An array of options used to create the GPG object. All options must be optional and are represented as key-value pairs.

[ Top ]

__destruct (Destructor) [line 391]

void __destruct(
)

Closes open GPG subprocesses when this object is destroyed

Subprocesses should never be left open by this class unless there is an unknown error and unexpected script termination occurs.

Access: public

[ Top ]

getErrorCode [line 540]

integer getErrorCode(
)

Gets the error code of the last executed operation

This value is only meaningful after Crypt_GPG_Engine::run() has been executed.

Return: the error code of the last executed operation.
Access: public

[ Top ]

reset [line 475]

void reset(
)

Resets the GPG engine, preparing it for a new operation

See: Crypt_GPG_Engine::run()
See: Crypt_GPG_Engine::setOperation()
Access: public

[ Top ]

run [line 516]

void run(
)

Runs the current GPG operation

This creates and manages the GPG subprocess.

The operation must be set with Crypt_GPG_Engine::setOperation() before this method is called.

See: Crypt_GPG_Engine::setOperation()
See: Crypt_GPG_Engine::reset()
Throws: Crypt_GPG_InvalidOperationException if no operation is specified.
Access: public

[ Top ]

sendCommand [line 457]

void sendCommand(
string
$command)

Sends a command to the GPG subprocess over the command file-descriptor pipe

Access: public

Parameters:

string $command — the command to send.

[ Top ]

setInput [line 558]

void setInput(
string|resource
&$input)

Sets the input source for the current GPG operation

Access: public

Parameters:

string|resource &$input — either a reference to the string containing the input data or an open stream resource containing the input data.

[ Top ]

setMessage [line 576]

void setMessage(
string|resource
&$message)

Sets the message source for the current GPG operation

Access: public

Parameters:

string|resource &$message — either a reference to the string containing the message data or an open stream resource containing the message data.

[ Top ]

setOperation [line 618]

void setOperation(
string
$operation, [array
$arguments = array()])

Sets the operation to perform

See: Crypt_GPG_Engine::reset()
See: Crypt_GPG_Engine::run()
Access: public

Parameters:

string	`$operation`	—	the operation to perform. This should be one of GPG's operations. For example, `--encrypt`, `--decrypt`, `--sign`, etc.
array	`$arguments`	—	optional. Additional arguments for the GPG subprocess. See the GPG manual for specific values.

[ Top ]

setOutput [line 594]

void setOutput(
string|resource
&$output)

Sets the output destination for the current GPG operation

Access: public

Parameters:

string|resource &$output — either a reference to the string in which to store GPG output or an open stream resource to which the output data should be written.

[ Top ]

Class: Crypt_GPG_Engine

Class Overview

Author(s):

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

addErrorHandler [line 412]

Parameters:

addStatusHandler [line 436]

Parameters:

__construct (Constructor) [line 329]

Parameters:

__destruct (Destructor) [line 391]

getErrorCode [line 540]

reset [line 475]

run [line 516]

sendCommand [line 457]

Parameters:

setInput [line 558]

Parameters:

setMessage [line 576]

Parameters:

setOperation [line 618]

Parameters:

setOutput [line 594]

Parameters: