Crypt_GPG
[ class tree: Crypt_GPG ] [ index: Crypt_GPG ] [ all elements ]

Class: Crypt_GPG_Key

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

Class Overview


A data class for GPG key information


Author(s):

Copyright:

  • 2008-2010 silverorange

Methods


Inherited Variables

Inherited Methods


Class Details

[line 61]
A data class for GPG key information

This class is used to store the results of the Crypt_GPG::getKeys() method.



[ Top ]


Method Detail

addSubKey   [line 196]

Crypt_GPG_Key addSubKey( Crypt_GPG_SubKey $subKey)

Adds a sub-key to this key

The first added sub-key will be the primary key of this key.

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

Parameters:

Crypt_GPG_SubKey   $subKey     the sub-key to add.

[ Top ]

addUserId   [line 212]

Crypt_GPG_Key addUserId( Crypt_GPG_UserId $userId)

Adds a user id to this key
  • Return: the current object, for fluent interface.
  • Access: public

Parameters:

Crypt_GPG_UserId   $userId     the user id to add.

[ Top ]

canEncrypt   [line 172]

boolean canEncrypt( )

Gets whether or not this key can encrypt data

This key can encrypt data if any sub-key of this key can encrypt data.

  • Return: true if this key can encrypt data and false if this key cannot encrypt data.
  • Access: public

[ Top ]

canSign   [line 149]

boolean canSign( )

Gets whether or not this key can sign data

This key can sign data if any sub-key of this key can sign data.

  • Return: true if this key can sign data and false if this key cannot sign data.
  • Access: public

[ Top ]

getPrimaryKey   [line 129]

Crypt_GPG_SubKey getPrimaryKey( )

Gets the primary sub-key of this key

The primary key is the first added sub-key.

  • Return: the primary sub-key of this key.
  • Access: public

[ Top ]

getSubKeys   [line 99]

array getSubKeys( )

Gets the sub-keys of this key

[ Top ]

getUserIds   [line 114]

array getUserIds( )

Gets the user ids of this key

[ Top ]


Documentation generated on Wed, 13 Mar 2013 18:30:09 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.