makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 06:08:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/11663] Add the doc block about the return value.

Browse source 
generate_text_for_storage does not return anything, all returned values are outputted using the parameters so this uses the returned value with the same idea as many C language functions where the returned value is if all went well or not and if it didn't what went wrong.

PHPBB3-11663
This commit is contained in:
brunoais 2013-08-14 10:44:45 +01:00
parent b6d6938b9f
commit 53888ec540
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
phpBB/includes/functions_content.php
View file

@ -481,6 +481,8 @@ function generate_text_for_display($text, $uid, $bitfield, $flags, $censor_text
* For parsing custom parsed text to be stored within the database. * For parsing custom parsed text to be stored within the database.
* This function additionally returns the uid and bitfield that needs to be stored. * This function additionally returns the uid and bitfield that needs to be stored.
* Expects $text to be the value directly from request_var() and in it's non-parsed form * Expects $text to be the value directly from request_var() and in it's non-parsed form
*
* @return array An array of string with the errors that occurred while parsing
*/ */
function generate_text_for_storage(&$text, &$uid, &$bitfield, &$flags, $allow_bbcode = false, $allow_urls = false, $allow_smilies = false) function generate_text_for_storage(&$text, &$uid, &$bitfield, &$flags, $allow_bbcode = false, $allow_urls = false, $allow_smilies = false)
{ {