interface/modules/zend_modules/library/Zend/XmlRpc/Client/ServerIntrospection.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\XmlRpc\Client;
  11
  12 use Zend\XmlRpc\Client as XMLRPCClient;
  13
  14 /**
  15  * Wraps the XML-RPC system.* introspection methods
  16  */
  17 class ServerIntrospection
  18 {
  19     /**
  20      * @var \Zend\XmlRpc\Client\ServerProxy
  21      */
  22     private $system = null;
  23
  24     /**
  25      * @param \Zend\XmlRpc\Client $client
  26      */
  27     public function __construct(XMLRPCClient $client)
  28     {
  29         $this->system = $client->getProxy('system');
  30     }
  31
  32     /**
  33      * Returns the signature for each method on the server,
  34      * autodetecting whether system.multicall() is supported and
  35      * using it if so.
  36      *
  37      * @return array
  38      */
  39     public function getSignatureForEachMethod()
  40     {
  41         $methods = $this->listMethods();
  42
  43         try {
  44             $signatures = $this->getSignatureForEachMethodByMulticall($methods);
  45         } catch (Exception\FaultException $e) {
  46             // degrade to looping
  47         }
  48
  49         if (empty($signatures)) {
  50             $signatures = $this->getSignatureForEachMethodByLooping($methods);
  51         }
  52
  53         return $signatures;
  54     }
  55
  56     /**
  57      * Attempt to get the method signatures in one request via system.multicall().
  58      * This is a boxcar feature of XML-RPC and is found on fewer servers.  However,
  59      * can significantly improve performance if present.
  60      *
  61      * @param  array $methods
  62      * @throws Exception\IntrospectException
  63      * @return array array(array(return, param, param, param...))
  64      */
  65     public function getSignatureForEachMethodByMulticall($methods = null)
  66     {
  67         if ($methods === null) {
  68             $methods = $this->listMethods();
  69         }
  70
  71         $multicallParams = array();
  72         foreach ($methods as $method) {
  73             $multicallParams[] = array('methodName' => 'system.methodSignature',
  74                                        'params'     => array($method));
  75         }
  76
  77         $serverSignatures = $this->system->multicall($multicallParams);
  78
  79         if (! is_array($serverSignatures)) {
  80             $type = gettype($serverSignatures);
  81             $error = "Multicall return is malformed.  Expected array, got $type";
  82             throw new Exception\IntrospectException($error);
  83         }
  84
  85         if (count($serverSignatures) != count($methods)) {
  86             $error = 'Bad number of signatures received from multicall';
  87             throw new Exception\IntrospectException($error);
  88         }
  89
  90         // Create a new signatures array with the methods name as keys and the signature as value
  91         $signatures = array();
  92         foreach ($serverSignatures as $i => $signature) {
  93             $signatures[$methods[$i]] = $signature;
  94         }
  95
  96         return $signatures;
  97     }
  98
  99     /**
 100      * Get the method signatures for every method by
 101      * successively calling system.methodSignature
 102      *
 103      * @param array $methods
 104      * @return array
 105      */
 106     public function getSignatureForEachMethodByLooping($methods = null)
 107     {
 108         if ($methods === null) {
 109             $methods = $this->listMethods();
 110         }
 111
 112         $signatures = array();
 113         foreach ($methods as $method) {
 114             $signatures[$method] = $this->getMethodSignature($method);
 115         }
 116
 117         return $signatures;
 118     }
 119
 120     /**
 121      * Call system.methodSignature() for the given method
 122      *
 123      * @param  array  $method
 124      * @throws Exception\IntrospectException
 125      * @return array  array(array(return, param, param, param...))
 126      */
 127     public function getMethodSignature($method)
 128     {
 129         $signature = $this->system->methodSignature($method);
 130         if (!is_array($signature)) {
 131             $error = 'Invalid signature for method "' . $method . '"';
 132             throw new Exception\IntrospectException($error);
 133         }
 134         return $signature;
 135     }
 136
 137     /**
 138      * Call system.listMethods()
 139      *
 140      * @return array  array(method, method, method...)
 141      */
 142     public function listMethods()
 143     {
 144         return $this->system->listMethods();
 145     }
 146 }