[naruto] element index

Package indexes

All elements
a b c d e g h i m n p r s t v
a
top
addForumTopic
Phpbb3Naruto::addForumTopic() in phpbb3Naruto.php
Creates a new topic in a Forum.
addForumTopic
MockNaruto::addForumTopic() in mockNaruto.php
Creates a new topic in a Forum.
addForumTopic
Creates a new topic in a Forum.
addForumTopic
RestNaruto::addForumTopic() in restNaruto.php
Creates a new topic in a Forum.
addTopicPost
RestNaruto::addTopicPost() in restNaruto.php
Creates a new post in a topic.
addTopicPost
Creates a new post in a topic.
addTopicPost
MockNaruto::addTopicPost() in mockNaruto.php
Creates a new post in a topic.
addTopicPost
Phpbb3Naruto::addTopicPost() in phpbb3Naruto.php
Creates a new post in a topic.
b
top
buildQueryString
Builds a query string from an map of parameters.
c
top
clearAttributes
Removes all attributes.
clearOptions
NarutoOptions::clearOptions() in narutoOptions.php
Removes all options.
d
top
DEFAULT_TOPIC_LIMIT
The default number of topics to return in a list.
e
top
exportAuthToken
NarutoCredentials::exportAuthToken() in narutoCredentials.php
This method converts the credentials into a single token for
E_AUTH
NarutoConstants::E_AUTH in narutoConstants.php
Error: Caller authentication problem falure
E_COMM
NarutoConstants::E_COMM in narutoConstants.php
Error: Connection problem
E_DB
NarutoConstants::E_DB in narutoConstants.php
Error: Database error.
E_NOSUP
NarutoConstants::E_NOSUP in narutoConstants.php
Error: Method being called is not supported.
E_NOUSER
NarutoConstants::E_NOUSER in narutoConstants.php
Error: User was not found.
E_PERM
NarutoConstants::E_PERM in narutoConstants.php
Error: Caller does not have permission to execute method.
E_PROTO
NarutoConstants::E_PROTO in narutoConstants.php
Error: Unexpected client/server protocol error
g
top
generateSalt
RestNarutoUtils::generateSalt() in restNarutoUtils.php
This method generates a request-unique sting by combining the path_info and request paramters.
getAttribute
NarutoDO::getAttribute() in narutoDO.php
Returns the value of a attribute. The value will be a string or numeric.
getAttributes
Returns all of the attributes.
getEmail
NarutoUser::getEmail() in narutoUser.php
Get the email.
getForumId
NarutoTopic::getForumId() in narutoTopic.php
Get the forum id.
getForumList
This method retrieves an a list of forums.
getForumList
RestNaruto::getForumList() in restNaruto.php
This method retrieves an a list of forums.
getForumList
MockNaruto::getForumList() in mockNaruto.php
This method retrieves an a list of forums.
getForumList
Phpbb3Naruto::getForumList() in phpbb3Naruto.php
This method retrieves an a list of forums.
getId
NarutoDO::getId() in narutoDO.php
Get the id.
getLastUpdated
Get the elapsed time since last updated.
getLastUpdated
Get the elapsed time since last updated.
getName
NarutoDO::getName() in narutoDO.php
Get the id.
getOption
NarutoOptions::getOption() in narutoOptions.php
Returns the value of a option. The value will be a string or numeric.
getOptions
NarutoOptions::getOptions() in narutoOptions.php
Returns all of the options.
getParentId
NarutoForum::getParentId() in narutoForum.php
Get the parent id.
getPostCount
NarutoTopic::getPostCount() in narutoTopic.php
Get the post count.
getRecentTopics
Returns a list of topics across all forums in order of most recent posts.
getRecentTopics
Returns a list of topics across all forums in order of most recent posts.
getRecentTopics
Returns a list of topics across all forums in order of most recent posts.
getRecentTopics
Returns a list of topics across all forums in order of most recent posts.
getSecondaryCode
Gets the code from the secondary source of the exception.
getSecondaryMessage
Gets the message from the secondary source of the exception.
getSecondarySource
Gets the secondary source of the exception.
getTopic
Phpbb3Naruto::getTopic() in phpbb3Naruto.php
Returns information about set of topics.
getTopic
RestNaruto::getTopic() in restNaruto.php
Returns information about set of topics.
getTopic
Naruto::getTopic() in naruto.php
Returns information about set of topics.
getTopic
MockNaruto::getTopic() in mockNaruto.php
Returns information about set of topics.
getTopicCount
NarutoForum::getTopicCount() in narutoForum.php
Get the topic count.
getTopicList
MockNaruto::getTopicList() in mockNaruto.php
Returns a list of Topics in a forum.
getTopicList
Phpbb3Naruto::getTopicList() in phpbb3Naruto.php
Returns a list of Topics in a forum.
getTopicList
RestNaruto::getTopicList() in restNaruto.php
Returns a list of Topics in a forum.
getTopicList
Returns a list of Topics in a forum.
getUnreadPrivateMessageCount
Gets a count of the number of unread messages.
getUnreadPrivateMessageCount
Gets a count of the number of unread messages.
getUnreadPrivateMessageCount
Gets a count of the number of unread messages.
getUnreadPrivateMessageCount
Gets a count of the number of unread messages.
getUrl
NarutoDO::getUrl() in narutoDO.php
Get the url.
getUser
RestNaruto::getUser() in restNaruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUser
MockNaruto::getUser() in mockNaruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUser
Phpbb3Naruto::getUser() in phpbb3Naruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUser
Naruto::getUser() in naruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserByName
Phpbb3Naruto::getUserByName() in phpbb3Naruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserByName
RestNaruto::getUserByName() in restNaruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserByName
MockNaruto::getUserByName() in mockNaruto.php
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserByName
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserBySession
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserBySession
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserBySession
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserbySession
Returns a user's information. Look for user attribute "ban" for indication of banned users.
getUserName
NarutoCredentials::getUserName() in narutoCredentials.php
Gets the user name.
h
top
HDR_AUTHTOKEN
NarutoConstants::HDR_AUTHTOKEN in narutoConstants.php
The HTTP header for sharing the authorization token
HDR_VERSION
NarutoConstants::HDR_VERSION in narutoConstants.php
The HTTP header indicating the client's version
i
top
importAuthToken
NarutoCredentials::importAuthToken() in narutoCredentials.php
Imports a previously exported authorization token. This call allows for user validation. This is called by the server-side.
m
top
mockNaruto.php
mockNaruto.php in mockNaruto.php
mergeTopics
Naruto::mergeTopics() in naruto.php
Merges two topics
mergeTopics
MockNaruto::mergeTopics() in mockNaruto.php
Merges two topics
mergeTopics
RestNaruto::mergeTopics() in restNaruto.php
Merges two topics
mergeTopics
Phpbb3Naruto::mergeTopics() in phpbb3Naruto.php
Merges two topics
METHOD_ADDFORUMTOPIC
METHOD_ADDTOPICPOST
METHOD_GETFORUMLIST
METHOD_GETRECENTTOPICS
METHOD_GETTOPIC
NarutoConstants::METHOD_GETTOPIC in narutoConstants.php
METHOD_GETTOPICLIST
METHOD_GETUNREADPRIVATEMESSAGECOUNT
METHOD_GETUSER
NarutoConstants::METHOD_GETUSER in narutoConstants.php
METHOD_GETUSERBYNAME
METHOD_GETUSERBYSESSION
METHOD_MERGETOPICS
MockNaruto
MockNaruto in mockNaruto.php
This class implements a test Naruto interface for simulating message baord activity.
MockNaruto
MockNaruto::MockNaruto() in mockNaruto.php
Constructor.
n
top
naruto.php
naruto.php in naruto.php
narutoCategory.php
narutoCategory.php in narutoCategory.php
narutoConstants.php
narutoConstants.php in narutoConstants.php
narutoCredentials.php
narutoCredentials.php in narutoCredentials.php
narutoDO.php
narutoDO.php in narutoDO.php
narutoException.php
narutoException.php in narutoException.php
narutoForum.php
narutoForum.php in narutoForum.php
narutoOptions.php
narutoOptions.php in narutoOptions.php
narutoService.php
narutoService.php in narutoService.php
narutoTopic.php
narutoTopic.php in narutoTopic.php
narutoUser.php
narutoUser.php in narutoUser.php
Naruto
Naruto in naruto.php
This class defines the main client interface to message boards.
NarutoCategory
NarutoCategory::NarutoCategory() in narutoCategory.php
Contructor.
NarutoCategory
NarutoCategory in narutoCategory.php
This class encapulates a Category data object. A category is a special type of Forum that only contains sub-forums.
NarutoConstants
NarutoConstants in narutoConstants.php
This class defines the common constants used in the application.
NarutoCredentials
NarutoCredentials in narutoCredentials.php
This class defines the authentication framework for the API.
NarutoDO
NarutoDO in narutoDO.php
This is a base class for data objects including Forum, Topic and User.
NarutoDO
NarutoDO::NarutoDO() in narutoDO.php
Contructor.
NarutoException
NarutoException::NarutoException() in narutoException.php
Contructor.
NarutoException
NarutoException in narutoException.php
This class defines the base execption for the API.
NarutoForum
NarutoForum in narutoForum.php
This class encapulates a Forum data object.
NarutoForum
NarutoForum::NarutoForum() in narutoForum.php
Contructor.
NarutoOptions
NarutoOptions in narutoOptions.php
This class stores a options array in an object. This is used to pass this sata between methods.
NarutoOptions
NarutoOptions::NarutoOptions() in narutoOptions.php
Constructor
NarutoService
NarutoService in narutoService.php
This interface defines methods needed for the server-side requests handler.
NarutoTopic
NarutoTopic in narutoTopic.php
This class defined the topic object.
NarutoTopic
NarutoTopic::NarutoTopic() in narutoTopic.php
Contructor.
NarutoUser
NarutoUser::NarutoUser() in narutoUser.php
Contructor.
NarutoUser
NarutoUser in narutoUser.php
This class defines the forum user object.
netQuery
RestNaruto::netQuery() in restNaruto.php
netQuery - makes a HTTP request.
p
top
phpbb3Naruto.php
phpbb3Naruto.php in phpbb3Naruto.php
Phpbb3Naruto
Phpbb3Naruto in phpbb3Naruto.php
This class defines the PhpBB3 message board implementation.
r
top
restNaruto.php
restNaruto.php in restNaruto.php
restNarutoService.php
restNarutoService.php in restNarutoService.php
restNarutoUtils.php
restNarutoUtils.php in restNarutoUtils.php
recode
RestNarutoUtils::recode() in restNarutoUtils.php
Encodes and decodes special content sent over the network.
RestNaruto
RestNaruto in restNaruto.php
This class defines the REST client implementation.
RestNaruto
RestNaruto::RestNaruto() in restNaruto.php
Constructor.
RestNarutoService
Constructor.
RestNarutoService
RestNarutoService in restNarutoService.php
This class defines the REST server implementation.
RestNarutoUtils
RestNarutoUtils in restNarutoUtils.php
This class defines the tools used by the REST client and server implementations.
s
top
setAttribute
NarutoDO::setAttribute() in narutoDO.php
Adds or updates a attribute. The value has to be a string or numeric.
setAttributes
Sets all of the attributes at once removing all existing attributes.
setCredentials
NarutoCredentials::setCredentials() in narutoCredentials.php
This method specifies the credentials to use for message board authorizations.
setEmail
NarutoUser::setEmail() in narutoUser.php
Set the email.
setForumId
NarutoTopic::setForumId() in narutoTopic.php
Set the forum id.
setId
NarutoDO::setId() in narutoDO.php
Set the id.
setLastUpdated
Set the elapsed time since last updated.
setLastUpdated
Set the elapsed time since last updated.
setName
NarutoDO::setName() in narutoDO.php
Set the name.
setOption
NarutoOptions::setOption() in narutoOptions.php
Adds or updates a option. The value has to be a string or numeric.
setOptions
NarutoOptions::setOptions() in narutoOptions.php
Sets all of the options at once removing all existing options.
setParentId
NarutoForum::setParentId() in narutoForum.php
Set the parent id.
setPostCount
NarutoTopic::setPostCount() in narutoTopic.php
Set the post count.
setSecondaryCode
Sets the code from the secondary source of the exception.
setSecondaryMessage
Sets the message from the secondary source of the exception.
setSecondarySource
Sets the secondary source of the exception.
setTopicCount
NarutoForum::setTopicCount() in narutoForum.php
Set the topic count.
setTransactionLog
This method sets the location of the transaction log. By default there is no log, but by setting this logging will be enabled.
setTransactionLog
This method sets the location of the transaction log. By default there is no log, but by setting this logging will be enabled.
setUrl
NarutoDO::setUrl() in narutoDO.php
Set the url.
startService
NarutoService::startService() in narutoService.php
This method is run per server-side service request. It processes a service request from the server variables.
startService
RestNarutoService::startService() in restNarutoService.php
This method is run per server-side service request. It processes a service request from the server variables.
sxeAck
RestNarutoUtils::sxeAck() in restNarutoUtils.php
Adds the ack element to a SimpleXMLElement.
sxeAddAttributes
Adds the attributes element to a SimpleXMLElement.
sxeAddException
RestNarutoUtils::sxeAddException() in restNarutoUtils.php
Adds the exception element to a SimpleXMLElement.
sxeAddForum
RestNarutoUtils::sxeAddForum() in restNarutoUtils.php
Adds the forum element to a SimpleXMLElement.
sxeAddForums
RestNarutoUtils::sxeAddForums() in restNarutoUtils.php
Adds the forums element to a SimpleXMLElement.
sxeAddTopic
RestNarutoUtils::sxeAddTopic() in restNarutoUtils.php
Adds the topic element to a SimpleXMLElement.
sxeAddTopics
RestNarutoUtils::sxeAddTopics() in restNarutoUtils.php
Adds the topics element to a SimpleXMLElement.
sxeAddUser
RestNarutoUtils::sxeAddUser() in restNarutoUtils.php
Adds the user element to a SimpleXMLElement.
sxeDecimal
RestNarutoUtils::sxeDecimal() in restNarutoUtils.php
Adds the Decimal element to a SimpleXMLElement.
sxeExtractAttributes
Converts a SimpleXMLElement to a map of Attributes.
sxeExtractException
Converts a SimpleXMLElement to a map of Attributes.
sxeExtractForum
RestNarutoUtils::sxeExtractForum() in restNarutoUtils.php
Converts a SimpleXMLElement to a NarutoForum object.
sxeExtractForums
Converts a SimpleXMLElement to a list of NarutoForum's.
sxeExtractTopic
RestNarutoUtils::sxeExtractTopic() in restNarutoUtils.php
Converts a SimpleXMLElement to a NarutoTopic object.
sxeExtractTopics
Converts a SimpleXMLElement to a list of NarutoTopic's.
sxeExtractUser
RestNarutoUtils::sxeExtractUser() in restNarutoUtils.php
Converts a SimpleXMLElement to a NarutoUser object.
sxeGetResponse
RestNarutoUtils::sxeGetResponse() in restNarutoUtils.php
Adds the main response element to a SimpleXMLElement. The response element includes the version and seq attributes and is named $method + 'Response'.
sxeGetRoot
RestNarutoUtils::sxeGetRoot() in restNarutoUtils.php
Returns the root element for the XML response.
sxeId
RestNarutoUtils::sxeId() in restNarutoUtils.php
Adds the Id element to a SimpleXMLElement.
sxeNak
RestNarutoUtils::sxeNak() in restNarutoUtils.php
Adds the nak element to a SimpleXMLElement.
t
top
toString
NarutoException::toString() in narutoException.php
Returns information about the execptions.
v
top
validateUser
NarutoCredentials::validateUser() in narutoCredentials.php
Valitates a user's password. This should be called by the message board.
VERSION
NarutoConstants::VERSION in narutoConstants.php
The current Naruto API version
a b c d e g h i m n p r s t v