CMS MADE SIMPLE FORGE

CMS Made Simple Core

 
Back Back to List

[#11553] Documentation issue for UserTagOperations function "CallUserTag"

avatar
Created By: Ryan Foster (RytoEX)
Date Submitted: Wed Aug 30 05:30:01 -0400 2017

Assigned To:
Version: 2.2.3.1
CMSMS Version: 2.2.3.1
Severity: Trivial
Resolution: Fixed
State: Closed
Summary:
Documentation issue for UserTagOperations function "CallUserTag"
Detailed Description:
The function "CallUserTag" from the class "UserTagOperations" lists possible
return values of "string|false"[1][2].  However, the PHP function it uses,
"call_user_func_array"[3], states that it "[returns] the return value of the
callback, or FALSE on error."  It is possible for UDTs to return non-string
results, so the documentation should probably specify that "CallUserTag" returns
"mixed|false"[4] since it's impossible to know at compile time what user
specified functions would return.


[1]:
https://apidoc.cmsmadesimple.org/classes/UserTagOperations.html#method_CallUserTag
[2]:
http://viewsvn.cmsmadesimple.org/filedetails.php?repname=cmsmadesimple&path=%2Ftrunk%2Flib%2Fclasses%2Fclass.usertagoperations.inc.php&rev=11078&peg=11078
[3]: http://php.net/manual/en/function.call-user-func-array.php
[4]: https://docs.phpdoc.org/references/phpdoc/types.html


History

Comments
avatar 
Date: 2017-10-01 13:25
Posted By: Robert Campbell (calguy1000)

fixed in svn
avatar 
Date: 2017-10-03 17:53
Posted By: Ryan Foster (RytoEX)

Thanks for that fix in commit 11506[1].  The APIDoc page[2] still shows a
response of "string|false".  Is there some additional step to refresh that?  Is
that only done during version releases?

[1]: 
http://viewsvn.cmsmadesimple.org/revision.php?repname=cmsmadesimple&path=%2F&rev=11506&peg=11506
[2]: 
https://apidoc.cmsmadesimple.org/classes/UserTagOperations.html#method_CallUserTag
avatar 
Date: 2018-03-10 09:58
Posted By: Ryan Foster (RytoEX)

The APIDoc web page still shows "string|false" for me instead of "mixed|false". 
Is there some documentation update script that has to be run to get the web
APIdocs to reflect the code/comment/doc changes?
Updates

Updated: 2018-03-10 09:48
state: Open => Closed

Updated: 2017-10-01 13:25
resolution_id: => 7