phpday 2025 - Call For Papers

xmlrpc_server_register_introspection_callback

(PHP 4 >= 4.1.0, PHP 5, PHP 7)

xmlrpc_server_register_introspection_callbackRegister a PHP function to generate documentation

Description

xmlrpc_server_register_introspection_callback(resource $server, string $function): bool
Warning

This function is EXPERIMENTAL. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk.

Warning

This function is currently not documented; only its argument list is available.

add a note

User Contributed Notes 2 notes

up
0
ronadaassoc at gmail dot com
2 years ago
<?xml version='1.0'?>
<introspection version='1.0'>
<methodList>
<methodDescription name='introspection.hello'>
<author>Dan Libby</author>
<purpose>greets the caller and demonstrates use of introspection mechanism</purpose>
<signatures>
<signature>
<params>
<value type='string' name='name'>name of the caller</value>
</params>
<returns>
<value type='string'>a greeting to the caller</value>
</returns>
</signature>
</signatures>
<see><item>system.listMethods</item></see>
<examples/>
<errors>
<item>returns fault code 1 if the caller's name is not specified</item>
</errors>
<notes>
<item>this is a lame example</item>
<item>example of multiple notes</item>
</notes>
<bugs/>
<todo/>
</methodDescription>
</methodList>
</introspection>
up
0
giunta dot gaetano at gmail dot com
3 years ago
The introspection callback function should return an XML string with the following format:

<?xml version='1.0'?>
<introspection version='1.0'>
<methodList>
<methodDescription name='introspection.hello'>
<author>Dan Libby</author>
<purpose>greets the caller and demonstrates use of introspection mechanism</purpose>
<signatures>
<signature>
<params>
<value type='string' name='name'>name of the caller</value>
</params>
<returns>
<value type='string'>a greeting to the caller</value>
</returns>
</signature>
</signatures>
<see><item>system.listMethods</item></see>
<examples/>
<errors>
<item>returns fault code 1 if the caller's name is not specified</item>
</errors>
<notes>
<item>this is a lame example</item>
<item>example of multiple notes</item>
</notes>
<bugs/>
<todo/>
</methodDescription>
</methodList>
</introspection>
To Top