Class: _hosted

Source Location: /plugins/_hosted.plg.php

Class Overview

openinviter_base
   |
   --_hosted

OpenInviter Hosted Solution

Author(s):

OpenInviter

Version:

1.0.0

Methods

Inherited Methods

Class: openinviter_base

openinviter_base::buildDebugHuman(): Transform the debug buffer in a human readable form
openinviter_base::buildDebugXML(): Transform the debug buffer to an XML
openinviter_base::checkResponse(): Check a request's response
openinviter_base::checkSession(): Check for an active session
openinviter_base::debugRequest(): Execute the debugger
openinviter_base::endSession()
openinviter_base::followLocation(): Extract Location: header
openinviter_base::get(): Execute a GET request
openinviter_base::getCookiePath(): Get the cookies file path
openinviter_base::getElementDOM(): Execute an XPath query
openinviter_base::getElementString(): Extract a substring from a string
openinviter_base::getHiddenElements(): Extracts hidden elements from a HTML bulk
openinviter_base::getLogoutPath(): Get the logout file path
openinviter_base::getProxy()
openinviter_base::getSessionID(): Get the OpenInviter session ID
openinviter_base::init(): Intialize transport
openinviter_base::isEmail(): Validate an email
openinviter_base::localDebug(): Write debug information
openinviter_base::logAction(): Write an action to the log
openinviter_base::login()
openinviter_base::parseCSV(): Parse a CSV string into an array
openinviter_base::post(): Execute a POST request
openinviter_base::remoteDebug(): Send debug information to server
openinviter_base::resetDebugger(): Reset the debugger
openinviter_base::returnContacts()
openinviter_base::startSession()
openinviter_base::stopPlugin(): Stops the internal plugin
openinviter_base::updateDebugBuffer(): Update the internal debug buffer

Class Details

[line 21]
OpenInviter Hosted Solution

Imports user's contacts using OpenInviter's Hosted Solution

Tags:

author:	OpenInviter
version:	1.0.0

[ Top ]

Class Methods

constructor __construct [line 31]

_hosted __construct(
[
$service = '_hosted'])

Parameters:

$service

[ Top ]

method getHostedServices [line 36]

void getHostedServices(
)

[ Top ]

method getMyContacts [line 94]

mixed getMyContacts(
)

Get the current user's contacts

Returns the contacts array that was previously imported.

Tags:

return:

The array if contacts if importing was successful, FALSE otherwise.

[ Top ]

method login [line 63]

bool login(
string
$user, string
$pass)

Requests the OpenInviter Server to import the contacts for a certain service and user. Parses the response and stores the contacts in the designated variable.

Tags:

return:

TRUE if the current user was authenticated successfully, FALSE otherwise.

Overrides openinviter_base::login() (parent method not documented)

Parameters:

string	$user	The current user.
string	$pass	The password for the current user.

[ Top ]

method logout [line 109]

bool logout(
)

Terminate session

Terminates the current user's session, debugs the request and reset's the internal debudder.

Tags:

return:

TRUE if the session was terminated successfully, FALSE otherwise.

[ Top ]

Documentation generated on Tue, 23 Feb 2010 02:00:41 +0200 by phpDocumentor 1.4.1