Commit 445c1149 by pupi1985

PHPDoc update in app/captcha, app/events, app/post-create and app/post-update

parent 25fed1ea
......@@ -38,8 +38,8 @@ function qa_captcha_available()
/**
* Return an HTML string explaining $captchareason (from qa_user_captcha_reason()) to the user about why they are seeing a captcha
* @param $captchareason
* @return mixed|null|string
* @param string $captchareason
* @return string|null
*/
function qa_captcha_reason_note($captchareason)
{
......@@ -66,10 +66,10 @@ function qa_captcha_reason_note($captchareason)
/**
* Prepare $qa_content for showing a captcha, adding the element to $fields, given previous $errors, and a $note to display.
* Returns JavaScript required to load CAPTCHA when field is shown by user (e.g. clicking comment button).
* @param $qa_content
* @param $fields
* @param $errors
* @param $note
* @param array $qa_content
* @param array $fields
* @param array $errors
* @param string $note
* @return string
*/
function qa_set_up_captcha_field(&$qa_content, &$fields, $errors, $note = null)
......@@ -105,7 +105,7 @@ function qa_set_up_captcha_field(&$qa_content, &$fields, $errors, $note = null)
/**
* Check if captcha is submitted correctly, and if not, set $errors['captcha'] to a descriptive string.
* @param $errors
* @param array $errors
* @return bool
*/
function qa_captcha_validate_post(&$errors)
......
......@@ -33,12 +33,12 @@ require_once QA_INCLUDE_DIR . 'app/updates.php';
* to $lastpostid whose antecedent question is $questionid, and was caused by $lastuserid. Pass a unix $timestamp for
* the event time or leave as null to use now. This will add an event to $questionid's and $lastuserid's streams. If
* $otheruserid is set, it will also add an notification-style event for that user, unless they are the one who did it.
* @param $questionid
* @param $lastpostid
* @param $updatetype
* @param $lastuserid
* @param $otheruserid
* @param $timestamp
* @param int $questionid
* @param int $lastpostid
* @param string $updatetype
* @param mixed $lastuserid
* @param mixed|null $otheruserid
* @param int|null $timestamp
*/
function qa_create_event_for_q_user($questionid, $lastpostid, $updatetype, $lastuserid, $otheruserid = null, $timestamp = null)
{
......@@ -57,11 +57,11 @@ function qa_create_event_for_q_user($questionid, $lastpostid, $updatetype, $last
* being created with those tags or having one of those tags added afterwards). The event of type $updatetype relates
* to the question $questionid, and was caused by $lastuserid. Pass a unix $timestamp for the event time or leave as
* null to use now.
* @param $tagstring
* @param $questionid
* @param $updatetype
* @param $lastuserid
* @param $timestamp
* @param string $tagstring
* @param int $questionid
* @param string $updatetype
* @param mixed $lastuserid
* @param int $timestamp
*/
function qa_create_event_for_tags($tagstring, $questionid, $updatetype, $lastuserid, $timestamp = null)
{
......@@ -80,11 +80,11 @@ function qa_create_event_for_tags($tagstring, $questionid, $updatetype, $lastuse
* that category or being moved to it later on), along with all of its ancestor categories. The event of type
* $updatetype relates to the question $questionid, and was caused by $lastuserid. Pass a unix $timestamp for the event
* time or leave as null to use now.
* @param $categoryid
* @param $questionid
* @param $updatetype
* @param $lastuserid
* @param $timestamp
* @param int|null $categoryid
* @param int $questionid
* @param string $updatetype
* @param mixed $lastuserid
* @param int|null $timestamp
*/
function qa_create_event_for_category($categoryid, $questionid, $updatetype, $lastuserid, $timestamp = null)
{
......
......@@ -33,10 +33,10 @@ require_once QA_INCLUDE_DIR . 'util/string.php';
/**
* Return value to store in database combining $notify and $email values entered by user $userid (or null for anonymous)
* @param $userid
* @param $notify
* @param $email
* @return null|string
* @param mixed $userid
* @param bool $notify
* @param string $email
* @return string|null
*/
function qa_combine_notify_email($userid, $notify, $email)
{
......@@ -48,22 +48,22 @@ function qa_combine_notify_email($userid, $notify, $email)
* Add a question (application level) - create record, update appropriate counts, index it, send notifications.
* If question is follow-on from an answer, $followanswer should contain answer database record, otherwise null.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $followanswer
* @param $userid
* @param $handle
* @param $cookieid
* @param $title
* @param $content
* @param $format
* @param $text
* @param $tagstring
* @param $notify
* @param $email
* @param $categoryid
* @param $extravalue
* @param array $followanswer
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param string $title
* @param string $content
* @param string $format
* @param string $text
* @param string $tagstring
* @param bool $notify
* @param string $email
* @param int|null $categoryid
* @param string|null $extravalue
* @param bool $queued
* @param $name
* @return mixed
* @param string|null $name
* @return int
*/
function qa_question_create($followanswer, $userid, $handle, $cookieid, $title, $content, $format, $text, $tagstring, $notify, $email,
$categoryid = null, $extravalue = null, $queued = false, $name = null)
......@@ -113,7 +113,7 @@ function qa_question_create($followanswer, $userid, $handle, $cookieid, $title,
/**
* Perform various common cached count updating operations to reflect changes in the question whose id is $postid
* @param $postid
* @param int|null $postid
*/
function qa_update_counts_for_q($postid)
{
......@@ -130,8 +130,8 @@ function qa_update_counts_for_q($postid)
/**
* Return an array containing the elements of $inarray whose key is in $keys
* @param $inarray
* @param $keys
* @param array $inarray
* @param array $keys
* @return array
*/
function qa_array_filter_by_keys($inarray, $keys)
......@@ -163,16 +163,16 @@ function qa_suspend_post_indexing($suspend = true)
/**
* Add post $postid (which comes under $questionid) of $type (Q/A/C) to the database index, with $title, $text,
* $tagstring and $categoryid. Calls through to all installed search modules.
* @param $postid
* @param $type
* @param $questionid
* @param $parentid
* @param $title
* @param $content
* @param $format
* @param $text
* @param $tagstring
* @param $categoryid
* @param int $postid
* @param string $type
* @param int $questionid
* @param int $parentid
* @param string $title
* @param string $content
* @param string $format
* @param string $text
* @param string $tagstring
* @param int $categoryid
*/
function qa_post_index($postid, $type, $questionid, $parentid, $title, $content, $format, $text, $tagstring, $categoryid)
{
......@@ -193,18 +193,18 @@ function qa_post_index($postid, $type, $questionid, $parentid, $title, $content,
* Add an answer (application level) - create record, update appropriate counts, index it, send notifications.
* $question should contain database record for the question this is an answer to.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $userid
* @param $handle
* @param $cookieid
* @param $content
* @param $format
* @param $text
* @param $notify
* @param $email
* @param $question
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param string $content
* @param string $format
* @param string $text
* @param bool $notify
* @param string $email
* @param array $question
* @param bool $queued
* @param $name
* @return mixed
* @param string|null $name
* @return int
*/
function qa_answer_create($userid, $handle, $cookieid, $content, $format, $text, $notify, $email, $question, $queued = false, $name = null)
{
......@@ -244,7 +244,7 @@ function qa_answer_create($userid, $handle, $cookieid, $content, $format, $text,
/**
* Perform various common cached count updating operations to reflect changes in an answer of question $questionid
* @param $questionid
* @param int $questionid
*/
function qa_update_q_counts_for_a($questionid)
{
......@@ -263,20 +263,20 @@ function qa_update_q_counts_for_a($questionid)
* $commentsfollows should contain database records for all previous comments on the same question or answer,
* but it can also contain other records that are ignored.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $userid
* @param $handle
* @param $cookieid
* @param $content
* @param $format
* @param $text
* @param $notify
* @param $email
* @param $question
* @param $parent
* @param $commentsfollows
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param string $content
* @param string $format
* @param string $text
* @param bool $notify
* @param string $email
* @param array $question
* @param array $parent
* @param array $commentsfollows
* @param bool $queued
* @param $name
* @return mixed
* @param string|null $name
* @return int
*/
function qa_comment_create($userid, $handle, $cookieid, $content, $format, $text, $notify, $email, $question, $parent, $commentsfollows, $queued = false, $name = null)
{
......
......@@ -44,18 +44,18 @@ define('QA_POST_STATUS_QUEUED', 2);
* $userid, $handle and $cookieid. Set $remoderate to true if the question should be requeued for moderation if
* modified. Set $silent to true to not mark the question as edited. Reports event as appropriate. See /qa-include/app/posts.php
* for a higher-level function which is easier to use.
* @param $oldquestion
* @param $title
* @param $content
* @param $format
* @param $text
* @param $tagstring
* @param $notify
* @param $userid
* @param $handle
* @param $cookieid
* @param $extravalue
* @param $name
* @param array $oldquestion
* @param string $title
* @param string $content
* @param string $format
* @param string $text
* @param string $tagstring
* @param bool $notify
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param string|null $extravalue
* @param string|null $name
* @param bool $remoderate
* @param bool $silent
*/
......@@ -144,12 +144,12 @@ function qa_question_set_content($oldquestion, $title, $content, $format, $text,
* in $userid, $handle and $cookieid, and the database records for the selected and deselected answers in $answers.
* Handles user points values and notifications.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $userid
* @param $handle
* @param $cookieid
* @param $oldquestion
* @param $selchildid
* @param $answers
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $oldquestion
* @param int|null $selchildid
* @param array $answers
*/
function qa_question_set_selchildid($userid, $handle, $cookieid, $oldquestion, $selchildid, $answers)
{
......@@ -209,11 +209,11 @@ function qa_question_set_selchildid($userid, $handle, $cookieid, $oldquestion, $
* Reopen $oldquestion if it was closed. Pass details of the user doing this in $userid, $handle and $cookieid, and the
* $oldclosepost (to match $oldquestion['closedbyid']) if any.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldquestion
* @param $oldclosepost
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldquestion
* @param array|null $oldclosepost
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_question_close_clear($oldquestion, $oldclosepost, $userid, $handle, $cookieid)
{
......@@ -237,12 +237,12 @@ function qa_question_close_clear($oldquestion, $oldclosepost, $userid, $handle,
* Close $oldquestion as a duplicate of the question with id $originalpostid. Pass details of the user doing this in
* $userid, $handle and $cookieid, and the $oldclosepost (to match $oldquestion['closedbyid']) if any. See
* /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldquestion
* @param $oldclosepost
* @param $originalpostid
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldquestion
* @param array $oldclosepost
* @param int $originalpostid
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_question_close_duplicate($oldquestion, $oldclosepost, $originalpostid, $userid, $handle, $cookieid)
{
......@@ -263,12 +263,12 @@ function qa_question_close_duplicate($oldquestion, $oldclosepost, $originalposti
* Close $oldquestion with the reason given in $note. Pass details of the user doing this in $userid, $handle and
* $cookieid, and the $oldclosepost (to match $oldquestion['closedbyid']) if any.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldquestion
* @param $oldclosepost
* @param $note
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldquestion
* @param array $oldclosepost
* @param string $note
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_question_close_other($oldquestion, $oldclosepost, $note, $userid, $handle, $cookieid)
{
......@@ -294,16 +294,17 @@ function qa_question_close_other($oldquestion, $oldclosepost, $note, $userid, $h
/**
* Set $oldquestion to hidden if $hidden is true, visible/normal if otherwise. All other parameters are as for qa_question_set_status(...)
* Set $oldquestion to hidden if $hidden is true, visible/normal if otherwise. All other parameters are as for
* qa_question_set_status(...)
* @deprecated Replaced by qa_question_set_status.
* @param $oldquestion
* @param $hidden
* @param $userid
* @param $handle
* @param $cookieid
* @param $answers
* @param $commentsfollows
* @param $closepost
* @param array $oldquestion
* @param bool $hidden
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $answers
* @param array $commentsfollows
* @param int|null $closepost
*/
function qa_question_set_hidden($oldquestion, $hidden, $userid, $handle, $cookieid, $answers, $commentsfollows, $closepost = null)
{
......@@ -318,14 +319,14 @@ function qa_question_set_hidden($oldquestion, $hidden, $userid, $handle, $cookie
* $commentsfollows ($commentsfollows can also contain records for follow-on questions which are ignored), and
* $closepost to match $oldquestion['closedbyid'] (if any). Handles indexing, user points, cached counts and event
* reports. See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldquestion
* @param $status
* @param $userid
* @param $handle
* @param $cookieid
* @param $answers
* @param $commentsfollows
* @param $closepost
* @param array $oldquestion
* @param int $status
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $answers
* @param array $commentsfollows
* @param int $closepost
*/
function qa_question_set_status($oldquestion, $status, $userid, $handle, $cookieid, $answers, $commentsfollows, $closepost = null)
{
......@@ -472,14 +473,14 @@ function qa_question_set_status($oldquestion, $status, $userid, $handle, $cookie
* contain records for follow-on questions which are ignored), and $closepost to match $oldquestion['closedbyid'] (if any).
* Set $silent to true to not mark the question as edited. Handles cached counts and event reports and will reset category
* IDs and paths for all answers and comments. See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldquestion
* @param $categoryid
* @param $userid
* @param $handle
* @param $cookieid
* @param $answers
* @param $commentsfollows
* @param $closepost
* @param array $oldquestion
* @param int $categoryid
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $answers
* @param array $commentsfollows
* @param int|null $closepost
* @param bool $silent
*/
function qa_question_set_category($oldquestion, $categoryid, $userid, $handle, $cookieid, $answers, $commentsfollows, $closepost = null, $silent = false)
......@@ -531,11 +532,11 @@ function qa_question_set_category($oldquestion, $categoryid, $userid, $handle, $
* comments on it. Pass details of the user doing this in $userid, $handle and $cookieid, and $closepost to match
* $oldquestion['closedbyid'] (if any). Handles unindexing, votes, points, cached counts and event reports.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldquestion
* @param $userid
* @param $handle
* @param $cookieid
* @param $oldclosepost
* @param array $oldquestion
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array|null $oldclosepost
*/
function qa_question_delete($oldquestion, $userid, $handle, $cookieid, $oldclosepost = null)
{
......@@ -579,10 +580,10 @@ function qa_question_delete($oldquestion, $userid, $handle, $cookieid, $oldclose
/**
* Set the author (application level) of $oldquestion to $userid and also pass $handle and $cookieid
* of user. Updates points and reports events as appropriate.
* @param $oldquestion
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldquestion
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_question_set_userid($oldquestion, $userid, $handle, $cookieid)
{
......@@ -606,7 +607,7 @@ function qa_question_set_userid($oldquestion, $userid, $handle, $cookieid)
/**
* Remove post $postid from our index and update appropriate word counts. Calls through to all search modules.
* @param $postid
* @param int $postid
*/
function qa_post_unindex($postid)
{
......@@ -643,16 +644,16 @@ function qa_question_uncache($questionId)
* $handle and $cookieid. Set $remoderate to true if the question should be requeued for moderation if modified. Set
* $silent to true to not mark the question as edited. Handle indexing and event reports as appropriate. See
* /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldanswer
* @param $content
* @param $format
* @param $text
* @param $notify
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $name
* @param array $oldanswer
* @param string $content
* @param string $format
* @param string $text
* @param bool $notify
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param string|null $name
* @param bool $remoderate
* @param bool $silent
*/
......@@ -715,13 +716,13 @@ function qa_answer_set_content($oldanswer, $content, $format, $text, $notify, $u
/**
* Set $oldanswer to hidden if $hidden is true, visible/normal if otherwise. All other parameters are as for qa_answer_set_status(...)
* @deprecated Replaced by qa_answer_set_status.
* @param $oldanswer
* @param $hidden
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $commentsfollows
* @param array $oldanswer
* @param bool $hidden
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param array $commentsfollows
*/
function qa_answer_set_hidden($oldanswer, $hidden, $userid, $handle, $cookieid, $question, $commentsfollows)
{
......@@ -735,13 +736,13 @@ function qa_answer_set_hidden($oldanswer, $hidden, $userid, $handle, $cookieid,
* and the database records for all comments on the answer in $commentsfollows ($commentsfollows can also contain other
* records which are ignored). Handles indexing, user points, cached counts and event reports. See /qa-include/app/posts.php for
* a higher-level function which is easier to use.
* @param $oldanswer
* @param $status
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $commentsfollows
* @param array $oldanswer
* @param int $status
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param array $commentsfollows
*/
function qa_answer_set_status($oldanswer, $status, $userid, $handle, $cookieid, $question, $commentsfollows)
{
......@@ -860,11 +861,11 @@ function qa_answer_set_status($oldanswer, $status, $userid, $handle, $cookieid,
* follow-on questions. Pass the database record for the question in $question and details of the user doing this
* in $userid, $handle and $cookieid. Handles unindexing, votes, points, cached counts and event reports.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldanswer
* @param $question
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldanswer
* @param array $question
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_answer_delete($oldanswer, $question, $userid, $handle, $cookieid)
{
......@@ -908,10 +909,10 @@ function qa_answer_delete($oldanswer, $question, $userid, $handle, $cookieid)
/**
* Set the author (application level) of $oldanswer to $userid and also pass $handle and $cookieid
* of user. Updates points and reports events as appropriate.
* @param $oldanswer
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldanswer
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_answer_set_userid($oldanswer, $userid, $handle, $cookieid)
{
......@@ -942,17 +943,17 @@ function qa_answer_set_userid($oldanswer, $userid, $handle, $cookieid)
* otherwise null. Set $remoderate to true if the question should be requeued for moderation if modified. Set $silent
* to true to not mark the question as edited. Handles unindexing and event reports. See /qa-include/app/posts.php for a
* higher-level function which is easier to use.
* @param $oldcomment
* @param $content
* @param $format
* @param $text
* @param $notify
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $parent
* @param $name
* @param array $oldcomment
* @param string $content
* @param string $format
* @param string $text
* @param bool $notify
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param array $parent
* @param string|null $name
* @param bool $remoderate
* @param bool $silent
*/
......@@ -1018,19 +1019,19 @@ function qa_comment_set_content($oldcomment, $content, $format, $text, $notify,
* $commentsfollows ($commentsfollows can also contain other records which are ignored). Set $remoderate to true if the
* question should be requeued for moderation if modified. Set $silent to true to not mark the question as edited.
* Handles indexing (based on $text), user points, cached counts and event reports.
* @param $oldanswer
* @param $parentid
* @param $content
* @param $format
* @param $text
* @param $notify
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $answers
* @param $commentsfollows
* @param $name
* @param array $oldanswer
* @param int $parentid
* @param string $content
* @param string $format
* @param string $text
* @param bool $notify
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param array $answers
* @param array $commentsfollows
* @param string|null $name
* @param bool $remoderate
* @param bool $silent
*/
......@@ -1116,13 +1117,13 @@ function qa_answer_to_comment($oldanswer, $parentid, $content, $format, $text, $
/**
* Set $oldcomment to hidden if $hidden is true, visible/normal if otherwise. All other parameters are as for qa_comment_set_status(...)
* @deprecated Replaced by qa_comment_set_status.
* @param $oldcomment
* @param $hidden
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $parent
* @param array $oldcomment
* @param bool $hidden
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param array $parent
*/
function qa_comment_set_hidden($oldcomment, $hidden, $userid, $handle, $cookieid, $question, $parent)
{
......@@ -1135,13 +1136,13 @@ function qa_comment_set_hidden($oldcomment, $hidden, $userid, $handle, $cookieid
* antecedent question's record in $question, details of the user doing this in $userid, $handle and $cookieid, and the
* answer's database record in $answer if this is a comment on an answer, otherwise null. Handles indexing, user
* points, cached counts and event reports. See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldcomment
* @param $status
* @param $userid
* @param $handle
* @param $cookieid
* @param $question
* @param $parent
* @param array $oldcomment
* @param int $status
* @param mixed $userid
* @param string $handle
* @param string $cookieid
* @param array $question
* @param array $parent
*/
function qa_comment_set_status($oldcomment, $status, $userid, $handle, $cookieid, $question, $parent)
{
......@@ -1261,12 +1262,12 @@ function qa_comment_set_status($oldcomment, $status, $userid, $handle, $cookieid
* and the answer's database record in $answer if this is a comment on an answer, otherwise null. Pass details of the user
* doing this in $userid, $handle and $cookieid. Handles unindexing, points, cached counts and event reports.
* See /qa-include/app/posts.php for a higher-level function which is easier to use.
* @param $oldcomment
* @param $question
* @param $parent
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldcomment
* @param array $question
* @param array $parent
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_comment_delete($oldcomment, $question, $parent, $userid, $handle, $cookieid)
{
......@@ -1299,10 +1300,10 @@ function qa_comment_delete($oldcomment, $question, $parent, $userid, $handle, $c
/**
* Set the author (application level) of $oldcomment to $userid and also pass $handle and $cookieid
* of user. Updates points and reports events as appropriate.
* @param $oldcomment
* @param $userid
* @param $handle
* @param $cookieid
* @param array $oldcomment
* @param mixed $userid
* @param string $handle
* @param string $cookieid
*/
function qa_comment_set_userid($oldcomment, $userid, $handle, $cookieid)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment