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: LogoutCommand

Source Location: /commands/intrinsic/LogoutCommand.php

Class Overview

De-authorises the current connection. Any command marked as `requiresAuthentication` will fail until this connection is re-authenticated.

Implements interfaces:

Command

Methods

Class Details

[line 10]
De-authorises the current connection. Any command marked as `requiresAuthentication` will fail until this connection is re-authenticated.

This should be called at the end of your FastVision API session. Reseller web hosting control panels should call this command after the user logs-out to prevent unauthorised use of the users FastVision web hosting account.

[ Top ]

Class Methods

method commandName [line 12]

void commandName(
)

Tags:

access:

public

Implementation of:

Command::commandName(): Name of the command

[ Top ]

method parseRequest [line 22]

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 27]

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 17]

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