'

Peter Downies forumControl

Soap Functions

Soap Tester

Server:

http://soap.peterdownie.com/webServices/forumControl/server.php

Generator

: http://soap.peterdownie.com/webServices/forumControl/petersWebServiceClassGenerator.php

PDF Auto Documentation

:http://soap.peterdownie.com/webServices/forumControl/documentation_maker.php

Software Version

: 2.41g

Greater Code Name(GCN)

: Atomic

Lesser Code Name(LCN)

: Proton

Service Version

: 1.01
forumControl is a forum system. It does not inclu-de users, usesrControl was made for that and in the "
future there will be tripCodeControl. 
Very happy to release this as BETA 1.01!
March 15 2017 Update
I will be updating this to have sub forums or threads or such.
This will have a discussion about other web services in the future
as well as allowing talking about chess which was its original purpose.



__construct

( #0 host , #1 user , #2 password , #3 database , #4 prePend , #5 projectIdentification )
Construct a new object
   Required ParametersOptional Values as cookies

createForum

( #0 userID , #1 username , #2 forumName , #3 forumIntroText )
allows the creation of a forum, you will need to make sure that you already have a primary keyfunction, or database with that value.
This is split to reduce complexity and ease intergration with other systems. ConnectionID is for making sure that the database is paired properly
   Usage: UserID, username and project_identifcation ID all come from the user control table(or other system with the same idea). The rest does not need explaining. This function will generate a bunch of different status(an possibly severity, see class technical specifications) and output. red outputs are when status is ERROR, green outputs are returned on status of NOMINAL
output

deleteAForum

( #0 forumID )
deletes a forum but makes sure that checks are made before deleting the data. You can use
the deleteAForum_NonSAFE if you wish to delete without these checks.
   Usage
Returns output as well as status(and possibly severity). red outputs are when status is ERROR, green outputs are returned on status of NOMINAL
Output values

commentOnForum

( #0 userID , #1 forumID , #2 comment )
Add a comment to a forum.
   Usage
As with most of my functions the mainoutput is ['output'], status and possibly serverity. and depending on the outputed value there can be other array elements returned.red outputs are when status is ERROR, green outputs are returned on status of NOMINAL
Possible Output ValuesData returned when output is COMMENT_SUCCESSFULLY_INSERTED and/or status is NOMINAL

deleteAcommentOnAForum

( #0 postID )
This  version Allow you to have comments deleted. Deleting comments may cause problems.
   Usage
['output'] is the controlling output in this function and depending on its value there can be other array elements. This function also has status and on status ERROR has severity.red outputs are when status is ERROR, green outputs are returned on status of NOMINAL
Possible Output Values

hideAComment

( #0 postID )
Hides a comment from view in a forum. This is a better idea than deleting posts as deleting them may cause problems.
   Usage
Again this is controlled by ["output"] and depending on the value than other arrays may be returned. This function also has status and on status ERROR has severity.red outputs are when status is ERROR green outputs are returned on status of NOMINAL
Possible Output values

getPost

( #0 postID )
Get a post within a specific project.
   The return is controlled by an ['output'] and status, with the possibility of severity if status is ERROR(Red outputs are on ERROR), green outputs are on NOMINAL status.
Possible output valuesWhen Output is POST_FOUND_SUCCESSFULLY

getAllPostOnForum

( #0 forumID )
This will ge all of the posts on a forum. You can also specify which posts you want
to get in the function called getSomePostsOnForum(). This function is not controlled by ['output']
Instead it will return all rows for a forumID. Each post will be pushed onto an output array
   This function outputs an output variable and status(and severity if statuse is ERROR), Green items are NOMINAL status and Red items are ERROR status.
Possible Output DataWhen output is OUTPUTTING_FEED
If table has been modified and this has not been updated than. Will return multiple rows.

getSomePostsOnForum

( #0 forumID , #1 entryMin , #2 entryMax )
This will allow yout to get some posts from a forum. It returns all data in the database"
for the forum between the entries. It does use output as a controlling array type.
   This function is controlled by output, if output is not outputed than it will start feeding out rows of data. Red Values are whene status is ERROR
Possible output valuesWhen output is OUTPUTTING_FEED
If table has been modified and this has not been updated than. Will return multiple rows.

getSomePostsOnForum_ActivePostsOnly

( #0 forumID , #1 startEntry , #2 MaxCount )
gets an array of active post, you can count these and if the count is maxCount there
are likely more results, if there are less than there likely are no results or no results at this time.
   This gets the active posts. It is controlled by a array eleement called output. If output is not set than it dumps out the post data. It returns output and status. It also returns severity if status is ERROR. RED outputs are on erroand green outputs are on NOMINAL
Possible output valuesIf output is OUTPUTTING_FEED will return one or more rows.

unHideComment

( #0 postID )
Changes a comment status from DISABLED to ACTIVE. Makes getSomePostsOnForum_ActivePostsOnly see the comment again.
   Unhide a comment changes the comments status from DISABLED to ACTIVE. It returns an output variable that tells you what has happend.
Possible Output Values

getForumOwnerData

( #0 forumID )
Get the user_ID to connect to a remote database and the username of that user. The username is only the last used and may not be the current
username.
   getForumOwnerData is controlled by a array element called output. If output is not set than it is retrieving data.
Possibke output valeusIf output is EVERYTHING_OKAY than these are also returned.

getAllForumsOwnedByUser

( #0 userID )
Gets all of the forumIDs created by a user ID. UserID should be linked to a external control.
   This function is controlled by an output variable. Green items are when status is NOMINAL and Red items are when status is ERROR
Possible output valuesWhen output is OUTPUTTING_FEED than will return feed of below.

getAllForumsCommentedOnByUser

( #0 userID )
gets All of the forums that a user has commented on.
   If there is an error, output is returned. Otherwise forums in the project are returned.
Possible output valuesOther data will come in feed[var] when status[output] is OUTPUTTING_FEED

get_X_MostRecentForums

( #0 count )
gets the most recently created Forums.
   If output is set it is NO_ROWS_RETURNED and no items will be returned. Otherwise returns an array of most recent forums created by date.
Data will be output in feed when [output] variable is OUTPUTTING_FEED

updateUsername

( #0 userID , #1 new_username )
Change the stored username of a forum. The username is for temp use, not for exact data.
   updateUsername is controlled by a array element called output.GREEN items are when status is NOMINAL and RED items are when the status is ERROR
output values

getForumsBelowMax

( #0 maximum_exclusive , #1 count )
Gets count Items below the maximuim exclusive values(Exclusive means it does not include maximium).
   This function is controlled by a variable called status.
Possible output valuesWhen output is OUTPUTTING_FEEDWhen Nominal it will feed out rows of data, of the following structure in the next query.Every return has an output which gives you additional information about what is going on in the database. RED items are returned WHEN status is ERROR. GreenItems are returned when status is NOMINAL

getForumsAboveMin

( #0 minimum_exclusive , #1 count )
This gets X amount of forums about minimum exclusive, you can feed the returned number back into this function recursively. If you want to start at the first one use 0.
   This function is modeled after the function getForumsBelowMaxThis function is controlled by a variable called status.
Possible output valesWhen status is output is OUTPUTTING_FEEDWhen Nominal it will feed out rows of data, of the following structure in the next query.Every return has an output which gives you additional information about what is going on in the database. RED items are returned WHEN status is ERROR. GreenItems are returned when status is NOMINAL

getCurrentMaxForumValueInProject

( )
This will get the amx value of the forums for use in the function getForumsBelowMax

searchForums

( #0 searchQuery )
Searchs through all of the forums name, introduction and psot data. This uses reguluar expressions which is both powerful and more complicated I would like. This
returns up to 4 queries. See tech for more details.
   search forms is controlled by a status variable. If Error there is only one query. If Nominal there is 4.When status is ERRORPossible outputs
GREEN when status is NOMINALRED when STATUS is ERRORForum Data: When the status is NOMINAL, the 2nd and 3rd returned queries will be this with 0 or more rows.Forum Post: When the status is NOMINAL, the 4th return is 0 or more rows