Docs For Class Naruto

Interface Naruto

Description

This class defines the main client interface to message boards.

Located in /classes/naruto.php (line 20)

Method Summary

string addForumTopic (NarutoCredentials $credentials, string $forumId, string $topic, string $body, [NarutoOptions $options = null])

boolean addTopicPost (NarutoCredentials $credentials, string $forumId, string $topicId, string $subject, string $body, [NarutoOptions $options = null])

array getForumList (NarutoCredentials $credentials, [NarutoOptions $options = null])

array getRecentTopics (NarutoCredentials $credentials, [NarutoOptions $options = null], string $forumId)

NarutoTopic getTopic (NarutoCredentials $credentials, array $forumId, array $topicId, [NarutoOptions $options = null])

array getTopicList (NarutoCredentials $credentials, string $forumId, [NarutoOptions $options = null])

int getUnreadPrivateMessageCount (NarutoCredentials $credentials, [NarutoOptions $options = null])

NarutoUser getUser (NarutoCredentials $credentials, string $userId, [NarutoOptions $options = null])

NarutoUser getUserByName (NarutoCredentials $credentials, $userName, [NarutoOptions $options = null], string $userId)

NarutoUser getUserbySession (NarutoCredentials $credentials, string $sessionId, [NarutoOptions $options = null])

boolean mergeTopics (NarutoCredentials $credentials, string $forumId, string $topicId, string $intoTopicId, [NarutoOptions $options = null])

Methods

addForumTopic (line 104)

Creates a new topic in a Forum.

return: id of new topic.
exception: NarutoException on error.
access: public

string addForumTopic (NarutoCredentials $credentials, string $forumId, string $topic, string $body, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
string $forumId: The ID of the forum the topic goes in.
string $topic: The title of the topic.
string $body: the message content for the topic post.
NarutoOptions $options
: the allowed options if any
- userName : The name of the user making the post. This should only work if the calling user has admin rights. Default value is the name of the calling user.

addTopicPost (line 121)

Creates a new post in a topic.

return: true
exception: NarutoException on error.
access: public

boolean addTopicPost (NarutoCredentials $credentials, string $forumId, string $topicId, string $subject, string $body, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
string $forumId: The ID of the forum where the topics exist
string $topicId: The ID of the topic where the topics exist
string $subject: the message subject for the topic post.
string $body: the message content for the topic post.
NarutoOptions $options
: the allowed options if any
- userName : The name of the user making the post. This should only work if the calling user has admin rights. Default value is the name of the calling user.

getForumList (line 37)

This method retrieves an a list of forums.

return: list of NarutoForum objects. An empty array is returned if there are no forums.
exception: NarutoException on error.
access: public

array getForumList (NarutoCredentials $credentials, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
NarutoOptions $options
: the allowed options if any
- string parentId : The id of the parent forum. If not specified then all the forums are returned.
- string userName : Return list on the authority level of userName. This option should only be authorized for the credentials of administrators.

getRecentTopics (line 88)

Returns a list of topics across all forums in order of most recent posts.

return: list of NarutoTopic objects. An empty array is returned if there are no topics.
exception: NarutoException on error.
access: public

array getRecentTopics (NarutoCredentials $credentials, [NarutoOptions $options = null], string $forumId)

NarutoCredentials $credentials: the callers credentials.
string $forumId: The ID of the forum where the topics exist
NarutoOptions $options
: the allowed options if any
- integer limit The maximum number of objects to return.
- integer maxAge The maximum object age.
- string userName : Return list on the authority level of userName. This option should only be authorized for the credentials of administrators.

getTopic (line 70)

Returns information about set of topics.

return: a topic. or null.
exception: NarutoException on error.
access: public

NarutoTopic getTopic (NarutoCredentials $credentials, array $forumId, array $topicId, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
array $forumId: the forum id.
array $topicId: the topic id.
NarutoOptions $options
: the allowed options if any
- string userName : Return list on the authority level of userName. This option should only be authorized for the credentials of administrators.

getTopicList (line 55)

Returns a list of Topics in a forum.

return: list of NarutoTopics objects. An empty array is returned if there are no topics.
exception: NarutoException on error.
access: public

array getTopicList (NarutoCredentials $credentials, string $forumId, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
string $forumId: The ID of the forum where the topics exist
NarutoOptions $options
: the allowed options if any
- integer limit The maximum number of objects to return.
- integer offset The starting object index.
- integer maxAge The maximum object age.
- string userName : Return list on the authority level of userName. This option should only be authorized for the credentials of administrators.

getUnreadPrivateMessageCount (line 147)

Gets a count of the number of unread messages.

return: number of unread messages.
exception: NarutoException on error.
access: public

int getUnreadPrivateMessageCount (NarutoCredentials $credentials, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
NarutoOptions $options
: the allowed options if any
- userName : The name of the user being checked. This should only work if the calling user has admin rights. Default value is the name of the calling user.

getUser (line 162)

Returns a user's information. Look for user attribute "ban" for indication of banned users.

return: a user. or null.
exception: NarutoException on error.
access: public

NarutoUser getUser (NarutoCredentials $credentials, string $userId, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
string $userId: the user's id.
NarutoOptions $options
: the allowed options if any
- boolean email : true if email should be included in return information. This should only work if the calling user has admin rights.

getUserByName (line 177)

Returns a user's information. Look for user attribute "ban" for indication of banned users.

return: a user. or null.
exception: NarutoException on error.
access: public

NarutoUser getUserByName (NarutoCredentials $credentials, $userName, [NarutoOptions $options = null], string $userId)

NarutoCredentials $credentials: the callers credentials.
string $userId: the user's id.
NarutoOptions $options
: the allowed options if any
- boolean email : true if email should be included in return information. This should only work if the calling user has admin rights.
$userName

getUserbySession (line 192)

Returns a user's information. Look for user attribute "ban" for indication of banned users.

return: a user. or null. Anonymous users are null.
exception: NarutoException on error.
access: public

NarutoUser getUserbySession (NarutoCredentials $credentials, string $sessionId, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
string $sessionId: the user's session id.
NarutoOptions $options
: the allowed options if any
- boolean email : true if email should be included in return information. This should only work if the calling user has admin rights.

mergeTopics (line 134)

Merges two topics

return: true or false
exception: NarutoException on error.
access: public

boolean mergeTopics (NarutoCredentials $credentials, string $forumId, string $topicId, string $intoTopicId, [NarutoOptions $options = null])

NarutoCredentials $credentials: the callers credentials.
string $forumId: The ID of the forum where the topics exist
string $topicId: The ID of the topic being merged
string $intoTopicId: the destination topic ID.
NarutoOptions $options: the allowed options if any

Documentation generated on Sun, 26 Oct 2008 16:41:07 -0400 by phpDocumentor 1.4.2