Constructor.
MockNaruto
MockNaruto
(array $config)
-
array
$config: the moc configuration data that it will use to return predictable results.
Creates a new topic in a Forum.
-
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.
Implementation of:
- Naruto::addForumTopic()
- Creates a new topic in a Forum.
Creates a new post in a topic.
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.
Implementation of:
- Naruto::addTopicPost()
- Creates a new post in a topic.
This method retrieves an a list of forums.
-
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.
Implementation of:
- Naruto::getForumList()
- This method retrieves an a list of forums.
Returns a list of topics across all forums in order of most recent posts.
-
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.
Implementation of:
- Naruto::getRecentTopics()
- Returns a list of topics across all forums in order of most recent posts.
Returns information about set of topics.
-
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.
Implementation of:
- Naruto::getTopic()
- Returns information about set of topics.
Returns a list of Topics in a forum.
-
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.
Implementation of:
- Naruto::getTopicList()
- Returns a list of Topics in a forum.
Gets a count of the number of unread messages.
-
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.
Implementation of:
- Naruto::getUnreadPrivateMessageCount()
- Gets a count of the number of unread messages.
Returns a user's information. Look for user attribute "ban" for indication of banned users.
-
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.
Implementation of:
- Naruto::getUser()
- Returns a user's information. Look for user attribute "ban" for indication of banned users.
Returns a user's information. Look for user attribute "ban" for indication of banned users.
-
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
Implementation of:
- Naruto::getUserByName()
- Returns a user's information. Look for user attribute "ban" for indication of banned users.
Returns a user's information. Look for user attribute "ban" for indication of banned users.
-
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.
Merges two topics
-
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
Implementation of:
- Naruto::mergeTopics()
- Merges two topics