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

Class: Crypt_GPG_UserId

Source Location: /Crypt_GPG-0.6.0/GPG/UserId.php

Class Overview


A class for GPG user id information


Author(s):

Copyright:

  • 2008 silverorange

Methods


Inherited Variables

Inherited Methods


Class Details

[line 52]
A class for GPG user id information

This class is used to store the results of the Crypt_GPG::getKeys() method. User id objects are members of a Crypt_GPG_Key object.



[ Top ]


Method Detail

getComment   [line 112]

string getComment( )

Gets the comments field of this user id
  • Return: the comments field of this user id.
  • Access: public

[ Top ]

getEmail   [line 125]

string getEmail( )

Gets the email field of this user id
  • Return: the email field of this user id.
  • Access: public

[ Top ]

getName   [line 99]

string getName( )

Gets the name field of this user id
  • Return: the name field of this user id.
  • Access: public

[ Top ]

isRevoked   [line 138]

boolean isRevoked( )

Gets whether or not this user id is revoked
  • Return: true if this user id is revoked and false if it is not.
  • Access: public

[ Top ]

isValid   [line 151]

boolean isValid( )

Gets whether or not this user id is valid
  • Return: true if this user id is valid and false if it is not.
  • Access: public

[ Top ]

setComment   [line 210]

void setComment( string $comment)

Sets the comment field of this user id
  • Access: public

Parameters:

string   $comment   —  the comment field of this user id.

[ Top ]

setEmail   [line 225]

void setEmail( string $email)

Sets the email field of this user id
  • Access: public

Parameters:

string   $email   —  the email field of this user id.

[ Top ]

setName   [line 195]

void setName( string $name)

Sets the name field of this user id
  • Access: public

Parameters:

string   $name   —  the name field of this user id.

[ Top ]

setRevoked   [line 240]

void setRevoked( boolean $is_revoked)

Sets whether or not this user id is revoked
  • Access: public

Parameters:

boolean   $is_revoked   —  whether or not this user id is revoked.

[ Top ]

setValid   [line 255]

void setValid( boolean $is_valid)

Sets whether or not this user id is valid
  • Access: public

Parameters:

boolean   $is_valid   —  whether or not this user id is valid.

[ Top ]

__toString   [line 166]

string __toString( )

Gets a string representation of this user id

The string is formatted as: 'name (comment) <email>'.

  • Return: a string representation of this user id.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:19:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.