Class: skyrock

Source Location: /plugins/skyrock.plg.php

Class Overview

openinviter_base
   |
   --skyrock

Skyrock Plugin

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 23]
Skyrock Plugin

Imports user's contacts from Skyrock and send messages using Skyrock's internal system

Tags:

author:	OpenInviter
version:	1.0.0

[ Top ]

Class Methods

method getMyContacts [line 97]

mixed getMyContacts(
)

Get the current user's contacts

Makes all the necesarry requests to import the current user's contacts

Tags:

return:

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

[ Top ]

method login [line 48]

bool login(
string
$user, string
$pass)

Makes all the necessary requests to authenticate the current user to the server.

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

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 ]

method sendMessage [line 145]

mixed sendMessage(
string
$session_id, string
$message, array
$contacts)

Send message to contacts

Sends a message to the contacts using the service's inernal messaging system

Tags:

return:

FALSE on failure.

Parameters:

string	$session_id	The OpenInviter user's session ID
string	$message	The message being sent to your contacts
array	$contacts	An array of the contacts that will receive the message

[ Top ]

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