Docs For Class Crypt_GPG

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 ]

parse [line 274]

Crypt_GPG_UserId parse(
string
$string)

Parses a user id object from a user id string

A user id string is of the form:

name (comment) &lt;email-address&gt;

with the comment and email-address being optional.

Return: the user id object parsed from the string.
Access: public

Parameters:

string $string — the user id string to parse.

[ 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
$isRevoked)

Sets whether or not this user id is revoked

Access: public

Parameters:

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

[ Top ]

setValid [line 255]

void setValid(
boolean
$isValid)

Sets whether or not this user id is valid

Access: public

Parameters:

boolean $isValid — 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 ]

Class: Crypt_GPG_UserId

Class Overview

Author(s):

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

getComment [line 112]

getEmail [line 125]

getName [line 99]

isRevoked [line 138]

isValid [line 151]

parse [line 274]

Parameters:

setComment [line 210]

Parameters:

setEmail [line 225]

Parameters:

setName [line 195]

Parameters:

setRevoked [line 240]

Parameters:

setValid [line 255]

Parameters:

__toString [line 166]