IP.Board  3.3.0
xmlrpc_server Class Reference

Public Member Functions

 __construct (ipsRegistry $registry)
 __construct (ipsRegistry $registry)
 addModlog ($mod_title)
 blogPings ($entry_id, $entry)
 blogTracker ($entry_id="", $entry_name="", $entry="")
 deletePost ($appkey, $postid, $username, $password, $publish)
 editPost ($postid, $username, $password, $content, $publish)
 editPost ($appkey, $postid, $username, $password, $content, $publish)
 getCategories ($blogid, $username, $password)
 getPost ($postid, $username, $password)
 getRecentPosts ($blogid, $username, $password, $numberOfPosts)
 getUserInfo ($appkey, $username, $password)
 getUsersBlogs ($appkey, $username, $password)
 newMediaObject ($blogid, $username, $password, $file)
 newPost ($blogid, $username, $password, $content, $publish)
 newPost ($appkey, $blogid, $username, $password, $content, $publish)
 pfCleanTopicTitle ($title="")

Data Fields

 $__dispatch_map = array()
 $classApiServer
 $error = ""

Protected Member Functions

 _authenticate ($username, $password)
 _authenticate ($username, $password)
 _compilePost (&$content, $publish)
 _compilePost ($content, $publish)

Protected Attributes

 $registry

Constructor & Destructor Documentation

__construct ( ipsRegistry registry)

CONSTRUCTOR

public

Parameters:
objectipsRegistry reference
Returns:
void
__construct ( ipsRegistry registry)

CONSTRUCTOR

public

Parameters:
objectipsRegistry reference
Returns:
void

Member Function Documentation

_authenticate ( username,
password 
) [protected]

_authenticate()

Authenticates the username and password

This will return

  • false (Failed)
  • true (Succes)

protected

Parameters:
string$usernameUsername
string$passwordPassword
Returns:
boolean
_authenticate ( username,
password 
) [protected]

_authenticate()

Authenticates the username and password

This will return

  • false (Failed)
  • true (Succes)

protected

Parameters:
string$usernameUsername
string$passwordPassword
Returns:
boolean
_compilePost ( content,
publish 
) [protected]

_compilePost()

Compiles a blog entry for inserting to the database

protected

Parameters:
array$content
bool$password
Returns:
bool
blogPings ( entry_id,
entry 
)

Ping-e-dee-doo

Parameters:
integer$entry_id
array$entry
Returns:
void
blogTracker ( entry_id = "",
entry_name = "",
entry = "" 
)

Blog tracker

Parameters:
integer$entry_id
string$entry_name
string$entry
Returns:
bool
deletePost ( appkey,
postid,
username,
password,
publish 
)

XMLRPC_server::deletePost()

Deletes a Blog entry.

public

Parameters:
string$appkeyAppkey (ignored)
int$postidEntry ID
string$usernameUsername
string$passwordPassword
bool$publishPublish (ignored)
Returns:
string xml
editPost ( postid,
username,
password,
content,
publish 
)

XMLRPC_server::editPost()

Edit the entry.

public

Parameters:
int$postidEntry ID
string$usernameUsername
string$passwordPassword
string$contentPost content
bool$publishPublish?
Returns:
string xml
editPost ( appkey,
postid,
username,
password,
content,
publish 
)

XMLRPC_server::editPost()

Edit the entry.

public

Parameters:
string$appkeyAppkey (ignored)
int$postidEntry ID
string$usernameUsername
string$passwordPassword
string$contentPost content
bool$publishPublish?
Returns:
string xml
getCategories ( blogid,
username,
password 
)

XMLRPC_server::getCategories()

Returns a list of the Blogs categories.

public

Parameters:
string$blogidApplication key
string$usernameUsername
string$passwordPassword
Returns:
string xml document
getPost ( postid,
username,
password 
)

XMLRPC_server::getPost()

Get an entry.

public

Parameters:
int$postidEntry ID
string$usernameUsername
string$passwordPassword
Returns:
string xml
getRecentPosts ( blogid,
username,
password,
numberOfPosts 
)

XMLRPC_server::getRecentPosts()

Returns a list of the Blogs categories.

public

Parameters:
int$blogidBlog ID
string$usernameUsername
string$passwordPassword
int$numberOfPostsNumber of posts
Returns:
string xml
getUserInfo ( appkey,
username,
password 
)

XMLRPC_server::getUserInfo()

Retrieve user info

This will return a param "response" with either

  • FAILED (Unknown failure)
  • SUCCESS (Added OK)

public

Parameters:
string$appkeyAppkey (ignored)
string$usernameUsername
string$passwordPassword
Returns:
string xml
getUsersBlogs ( appkey,
username,
password 
)

XMLRPC_server::getUsersBlogs()

Retrieves a user's blog entries

This will return a param "response" with either

  • FAILED (Unknown failure)
  • SUCCESS (Added OK)

public

Parameters:
string$appkeyApplication key
string$usernameUsername
string$passwordPassword
Returns:
string xml document
newMediaObject ( blogid,
username,
password,
file 
)

XMLRPC_server::newMediaObject()

Post a new entry.

public

Parameters:
int$blogidBlog ID
string$usernameUsername
string$passwordPassword
array$fileUploaded file details
Returns:
string xml
newPost ( blogid,
username,
password,
content,
publish 
)

XMLRPC_server::newPost()

Post a new entry.

public

Parameters:
int$blogidBlog ID
string$usernameUsername
string$passwordPassword
array$contentPost content
bool$publishPublish?
Returns:
string xml
newPost ( appkey,
blogid,
username,
password,
content,
publish 
)

XMLRPC_server::newPost()

Adds a new post to the Blog.

public

Parameters:
string$appkeyAppkey (ignored)
int$blogidBlog ID
string$usernameUsername
string$passwordPassword
string$contentdContent
bool$publishPublish (ignored)
Returns:
string xml
pfCleanTopicTitle ( title = "")

Clean topic title

Parameters:
string$title
Returns:
string

The documentation for this class was generated from the following files:
 All Data Structures Functions Variables