PHP Class Horde_Crypt_Pgp_Parse, horde

Since: 2.4.0
Author: Michael Slusarz ([email protected])
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_armor array Strings in armor header lines used to distinguish between the different types of PGP decryption/encryption.

Public Methods

Method Description
parse ( mixed $text ) : array Parses a message into text and PGP components.
parseToPart ( mixed $text, $charset = 'UTF-8' ) : mixed Parses an armored message into a Horde_Mime_Part object.

Method Details

parse() public method

Parses a message into text and PGP components.
public parse ( mixed $text ) : array
$text mixed Either the text to parse or a Horde_Stream object.
return array An array with the parsed text, returned in blocks of text corresponding to their actual order. Keys:
  - data: (array) The data for each section. Each line has been
          stripped of EOL characters.
  - type: (integer) The type of data contained in block. Valid types
          are the class ARMOR_* constants.

parseToPart() public method

Parses an armored message into a Horde_Mime_Part object.
public parseToPart ( mixed $text, $charset = 'UTF-8' ) : mixed
$text mixed Either the text to parse or a Horde_Stream object.
return mixed Either null if no PGP data was found, or a Horde_Mime_Part object. For detached signature data: the full contents of the armored text (data + sig) is contained in the SIG_RAW metadata, and the charset is contained in the SIG_CHARSET metadata, within the application/pgp-signature part.

Property Details

$_armor protected property

Strings in armor header lines used to distinguish between the different types of PGP decryption/encryption.
protected array $_armor
return array