FV_API

[ ] [ ] [ ]

Packages:
FV_API

Files:

ApiConnector.php
ApiIncludes.php
ChangePasswordCommand.php
Command.php
Configuration.php
DeleteDnsRecordCommand.php
DeleteForwarderCommand.php
DeleteMailboxCommand.php
DisableAutoresponderCommand.php
DisplayIdentityCommand.php
EnableAutoresponderCommand.php
ListDnsRecordsCommand.php
ListDomainsCommand.php
ListForwardersCommand.php
ListFtpUsersCommand.php
ListMailboxesCommand.php
LoginCommand.php
LoginSwitchUserCommand.php
LogoutCommand.php
LookupDomainWhoisCommand.php
NewForwarderCommand.php
NewMailboxCommand.php
ResetDomainNameserversCommand.php
SetDomainNameserversCommand.php
SetDomainRegistrantDetailsCommand.php
SetForwarderDestinationCommand.php
SetMailboxPasswordCommand.php
ShowDomainCommand.php
ShowDomainMailPolicyCommand.php
ShowDomainNameserversCommand.php
ShowDomainRegistrantDetailsCommand.php
ShowForwarderCommand.php
ShowMailboxCommand.php

Interfaces:

Command

Classes:

AccessDeniedException
AddressRecord
CanonicalNameRecord
ChangePasswordCommand
ConnectionException
DeleteDnsRecordCommand
DeleteForwarderCommand
DeleteMailboxCommand
DisableAutoresponderCommand
DisplayIdentityCommand
DomainAttribute
DomainPolicyForward
DomainPolicyRefuse
DomainPolicyRewrite
DomainPolicySmtpRoute
EnableAutoresponderCommand
InternalErrorException
InvalidRequestException
ListDnsRecordsCommand
ListDomainsCommand
ListForwardersCommand
ListFtpUsersCommand
ListMailboxesCommand
LoginCommand
LoginRequiredException
LoginSwitchUserCommand
LogoutCommand
LookupDomainWhoisCommand
MailExchangeRecord
MalformedRequestException
Nameserver
NameserverRecord
NewForwarderCommand
NewMailboxCommand
Record
RequestGenerator
ResetDomainNameserversCommand
SetDomainNameserversCommand
SetDomainRegistrantDetailsCommand
SetForwarderDestinationCommand
SetMailboxPasswordCommand
ShowDomainCommand
ShowDomainMailPolicyCommand
ShowDomainNameserversCommand
ShowDomainRegistrantDetailsCommand
ShowForwarderCommand
ShowMailboxCommand
SSLRequiredException
TextRecord
UnexpectedStatusException

Class: LoginCommand

Source Location: /commands/intrinsic/LoginCommand.php

Class Overview

Authenticates a new connection to the FastVision reseller API system.

Implements interfaces:

Command

Methods

Class Details

[line 9]
Authenticates a new connection to the FastVision reseller API system.

This will be typically be the first command issued in any session.

[ Top ]

Class Methods

constructor __construct [line 32]

LoginCommand __construct(

$account_name, 
$email_address, 
$password)

Tags:

access:

public

Parameters:

	$account_name
	$email_address
	$password

[ Top ]

method commandName [line 39]

void commandName(
)

Tags:

access:

public

Implementation of:

Command::commandName(): Name of the command

[ Top ]

method getEmailAddress [line 84]

void getEmailAddress(
)

Tags:

access:

public

[ Top ]

method getFID [line 69]

void getFID(
)

Tags:

access:

public

[ Top ]

method getFVN [line 74]

void getFVN(
)

Tags:

access:

public

[ Top ]

method getName [line 79]

void getName(
)

Tags:

access:

public

[ Top ]

method getToken [line 64]

void getToken(
)

Tags:

access:

public

[ Top ]

method parseRequest [line 49]

void parseRequest(
RequestGenerator
$req)

Tags:

access:

public

Implementation of:

Command::parseRequest(): Used to convert the command into a request we can issue to the FastVision API reseller servers.

Parameters:

RequestGenerator

$req

[ Top ]

method parseResponse [line 56]

void parseResponse(

$xml)

Tags:

access:

public

Implementation of:

Command::parseResponse(): Used to convert the response command into a request we can issue to the FastVision API reseller servers.

Parameters:

SimpleXMLElement

$xml

[ Top ]

method requiresAuthentication [line 44]

void requiresAuthentication(
)

Tags:

access:

public

Implementation of:

Command::requiresAuthentication(): Does the connection need to be authenticated prior to issuing this command? (Boolean)

[ Top ]

Documentation generated on Mon, 30 Mar 2009 16:34:37 +0100 by phpDocumentor 1.4.1