diff options
Diffstat (limited to 'modules/xmlrpc/doc/sysmethodsig.html')
-rw-r--r-- | modules/xmlrpc/doc/sysmethodsig.html | 191 |
1 files changed, 191 insertions, 0 deletions
diff --git a/modules/xmlrpc/doc/sysmethodsig.html b/modules/xmlrpc/doc/sysmethodsig.html new file mode 100644 index 00000000..bb0bb7ca --- /dev/null +++ b/modules/xmlrpc/doc/sysmethodsig.html @@ -0,0 +1,191 @@ +<HTML +><HEAD +><TITLE +>system.methodSignature</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.77+"><LINK +REV="MADE" +HREF="edd@usefulinc.com"><LINK +REL="HOME" +TITLE="XML-RPC for PHP" +HREF="index.html"><LINK +REL="UP" +TITLE="Reserved methods" +HREF="reserved.html"><LINK +REL="PREVIOUS" +TITLE="Reserved methods" +HREF="reserved.html"><LINK +REL="NEXT" +TITLE="system.methodHelp" +HREF="sysmethhelp.html"></HEAD +><BODY +CLASS="SECT1" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>XML-RPC for PHP: version 1.1</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="reserved.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 7. Reserved methods</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="sysmethhelp.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="SECT1" +><H1 +CLASS="SECT1" +><A +NAME="SYSMETHODSIG" +></A +>system.methodSignature</H1 +><P +>This method takes one parameter, the name of a method + implemented by the XML-RPC server.</P +><P +>It returns an array of possible signatures for this + method. A signature is an array of types. The first of these + types is the return type of the method, the rest are parameters.</P +><P +>Multiple signatures (ie. overloading) are permitted: this is + the reason that an array of signatures are returned by this + method.</P +><P +>Signatures themselves are restricted to the top level + parameters expected by a method. For instance if a method + expects one array of structs as a parameter, and it returns a + string, its signature is simply "string, array". If it expects + three integers, its signature is "string, int, int, + int".</P +><P +> If no signature is defined for the method, a none-array value is + returned. Therefore this is the way to test for a non-signature, + if <TT +CLASS="PARAMETER" +><I +>$resp</I +></TT +> below is the response object + from a method call to <TT +CLASS="FUNCTION" +>system.methodSignature</TT +>: + </P +><PRE +CLASS="PROGRAMLISTING" +>$v=$resp->value(); +if ($v->kindOf()!="array") { + // then the method did not have a signature defined +} + </PRE +><P +> See the <TT +CLASS="FILENAME" +>introspect.php</TT +> demo included in + this distribution for an example of using this method. + </P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="reserved.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="sysmethhelp.html" +ACCESSKEY="N" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Reserved methods</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="reserved.html" +ACCESSKEY="U" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>system.methodHelp</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file |