CMS MADE SIMPLE FORGE

CMS Made Simple Core

 

[#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: None
State: Open
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