You are here

Home » API reference » xmlrpc 8 » XmlRpcExampleClientForm.php

class XmlRpcExampleClientForm in xmlrpc 8

Form demonstrating XML-RPC client.

This is the client part of the module. If defines a form with two input fields to call xmlrpc_example.add or xmlrpc_example.subtract methods on this host. Please note that having a user interface to query an XML-RPC service is not required. A method can be requested to a server using the xmlrpc() function directly. We have included an user interface to make the testing easier.

Presents a two arguments form and makes a call to an XML-RPC server using these arguments as input, showing the result in a message.

Hierarchy

Expanded class hierarchy of XmlRpcExampleClientForm

1 string reference to 'XmlRpcExampleClientForm'
xmlrpc_example.routing.yml in xmlrpc_example/xmlrpc_example.routing.yml
xmlrpc_example/xmlrpc_example.routing.yml

File

xmlrpc_example/src/Form/XmlRpcExampleClientForm.php, line 23

Namespace

Drupal\xmlrpc_example\Form
View source 
class XmlRpcExampleClientForm extends FormBase {
  use XmlRpcTrait;

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'xmlrpc_example_client';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('xmlrpc_example.server');
    $form['explanation'] = [
      '#markup' => '<div>' . $this
        ->t('This example demonstrates how to make XML-RPC calls with Drupal. <br />The "Request methods" button makes a request to the server and asks for the available list of methods, as a service discovery request. <br/>The "Add integers" and "Subtract integers" use the xmlrpc() function to act as a client, calling the XML-RPC server defined in this same example for some defined methods.<br />An XML-RPC error will result if the result in the addition or subtraction requested is out of bounds defined by the server. These error numbers are defined by the server. <br />The "Add and Subtract" button performs a multicall operation on the XML-RPC server: several requests in a single XML-RPC call.<br />') . '</div>',
    ];

    // We are going to call add and subtract methods, and
    // they work with integer values.
    $form['num1'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Enter an integer'),
      '#default_value' => 2,
      '#size' => 5,
      '#required' => TRUE,
    ];
    $form['num2'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Enter a second integer'),
      '#default_value' => 2,
      '#size' => 5,
      '#required' => TRUE,
    ];

    // Include several buttons, each of them calling a different method.
    // This button submits a XML-RPC call to the system.listMethods method.
    $form['information'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Request methods'),
      '#submit' => [
        [
          $this,
          'submitInformation',
        ],
      ],
    ];

    // This button submits a XML-RPC call to the xmlrpc_example.add method.
    $form['add'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add the integers'),
      '#submit' => [
        [
          $this,
          'submitAdd',
        ],
      ],
    ];

    // This button submits a XML-RPC call to the xmlrpc_example.subtract method.
    $form['subtract'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Subtract the integers'),
      '#submit' => [
        [
          $this,
          'submitSubtract',
        ],
      ],
    ];

    // This button submits a XML-RPC call to the system.multicall method.
    $form['add_subtract'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add and Subtract'),
      '#submit' => [
        [
          $this,
          'submitAddSubtract',
        ],
      ],
    ];
    if ($config
      ->get('alter_enabled')) {
      $form['overridden'] = [
        '#type' => 'markup',
        '#markup' => '<div><strong>' . $this
          ->t('Just a note of warning: The <a href=":url">alter form</a> has been used to disable the limits, so you may want to turn that off if you do not want it.', [
          ':url' => Url::fromRoute('xmlrpc_example.alter')
            ->toString(),
        ]) . '</strong></div>',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * Submit handler to query system.listMethods.
   *
   * Submit: query the XML-RPC endpoint for the method system.listMethods
   * and report the result as a Drupal message. The result is a list of the
   * available methods in this XML-RPC server.
   *
   * Important note: Not all XML-RPC servers implement this method. Drupal's
   * built-in XML-RPC server implements this method by default.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form_state object.
   *
   * @see xmlrpc()
   * @see xmlrpc_errno()
   * @see xmlrpc_error_msg()
   */
  public function submitInformation(array &$form, FormStateInterface $form_state) {

    // First define the endpoint of the XML-RPC service, in this case this is
    // our own server.
    $server = $this
      ->getEndpoint();

    // Then we should define the method to call. xmlrpc() requires that all the
    // information related to the called method be passed as an array in the
    // form of 'method_name' => arguments_array.
    $options = [
      'system.listMethods' => [],
    ];

    // Make the xmlrpc request and process the results.
    $result = xmlrpc($server, $options);
    if ($result === FALSE) {
      $this
        ->messenger()
        ->addError($this
        ->t('Error return from xmlrpc(): Error: @errno, Message: @message', [
        '@errno' => xmlrpc_errno(),
        '@message' => xmlrpc_error_msg(),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The XML-RPC server returned this response: <pre>@response</pre>', [
        '@response' => print_r($result, TRUE),
      ]));
    }
  }

  /**
   * Submit handler to query xmlrpc_example.add.
   *
   * Submit: query the XML-RPC endpoint for the method xmlrpc_example.add
   * and report the result as a Drupal message.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form_state object.
   *
   * @see xmlrpc()
   * @see xmlrpc_errno()
   * @see xmlrpc_error_msg()
   */
  public function submitAdd(array &$form, FormStateInterface $form_state) {

    // First define the endpoint of the XML-RPC service. In this case this is
    // our own server.
    $server = $this
      ->getEndpoint();

    // Then we should define the method to call. xmlrpc() requires that all the
    // information related to the called method is passed as an array in the
    // form of 'method_name' => arguments_array.
    $options = [
      'xmlrpc_example.add' => [
        (int) $form_state
          ->getValue('num1'),
        (int) $form_state
          ->getValue('num2'),
      ],
    ];

    // Make the xmlrpc request and process the results.
    $result = xmlrpc($server, $options);
    if ($result === FALSE) {
      $this
        ->messenger()
        ->addError($this
        ->t('Error return from xmlrpc(): Error: @errno, Message: @message', [
        '@errno' => xmlrpc_errno(),
        '@message' => xmlrpc_error_msg(),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The XML-RPC server returned this response: @response', [
        '@response' => print_r($result, TRUE),
      ]));
    }
  }

  /**
   * Submit handler to query xmlrpc_example.subtract.
   *
   * Submit: query the XML-RPC endpoint for the method xmlrpc_example.subtract
   * and report the result as a Drupal message.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form_state object.
   *
   * @see xmlrpc()
   * @see xmlrpc_errno()
   * @see xmlrpc_error_msg()
   * @see xmlrpc_example_client_add_submit()
   */
  public function submitSubtract(array &$form, FormStateInterface $form_state) {
    $server = $this
      ->getEndpoint();
    $options = [
      'xmlrpc_example.subtract' => [
        (int) $form_state
          ->getValue('num1'),
        (int) $form_state
          ->getValue('num2'),
      ],
    ];

    // Make the xmlrpc request and process the results.
    $result = xmlrpc($server, $options);
    if ($result === FALSE) {
      $this
        ->messenger()
        ->addError($this
        ->t('Error return from xmlrpc(): Error: @errno, Message: @message', [
        '@errno' => xmlrpc_errno(),
        '@message' => xmlrpc_error_msg(),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The XML-RPC server returned this response: @response', [
        '@response' => print_r($result, TRUE),
      ]));
    }
  }

  /**
   * Submit a multicall request.
   *
   * Submit a multicall request: query the XML-RPC endpoint for the methods
   * xmlrpc_example.add and xmlrpc_example.subtract and report the result as a
   * Drupal message. Drupal's XML-RPC client builds the system.multicall request
   * automatically when there is more than one method to call.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form_state object.
   *
   * @see xmlrpc()
   * @see xmlrpc_errno()
   * @see xmlrpc_error_msg()
   * @see xmlrpc_example_client_multicall_submit()
   */
  public function submitAddSubtract(array &$form, FormStateInterface $form_state) {
    $server = $this
      ->getEndpoint();

    /*
     * The XML-RPC server built in the xmlrpc module supports system.multicall.
     *
     * To make a multicall request, the main invoked method should be the
     * function 'system.multicall', and the arguments to make this call must be
     * defined as an array of single method calls, being the array keys the
     * service methods to be called, and the array elements being the method
     * arguments.
     *
     * See the code below this comment as example.
     */

    // Build an array of several calls, The built-in XML-RPC support will
    // construct the correct system.multicall request for the server.
    $options = [
      'xmlrpc_example.add' => [
        (int) $form_state
          ->getValue('num1'),
        (int) $form_state
          ->getValue('num2'),
      ],
      'xmlrpc_example.subtract' => [
        (int) $form_state
          ->getValue('num1'),
        (int) $form_state
          ->getValue('num2'),
      ],
    ];

    // Make the XML-RPC request and process the results.
    $result = xmlrpc($server, $options);
    if ($result === FALSE) {
      $this
        ->messenger()
        ->addError($this
        ->t('Error return from xmlrpc(): Error: @errno, Message: @message', [
        '@errno' => xmlrpc_errno(),
        '@message' => xmlrpc_error_msg(),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The XML-RPC server returned this response: <pre>@response</pre>', [
        '@response' => print_r($result, TRUE),
      ]));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
XmlRpcExampleClientForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
XmlRpcExampleClientForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
XmlRpcExampleClientForm::submitAdd public function Submit handler to query xmlrpc_example.add.
XmlRpcExampleClientForm::submitAddSubtract public function Submit a multicall request.
XmlRpcExampleClientForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
XmlRpcExampleClientForm::submitInformation public function Submit handler to query system.listMethods.
XmlRpcExampleClientForm::submitSubtract public function Submit handler to query xmlrpc_example.subtract.
XmlRpcTrait::$endPoint protected property The XML-RPC server endpoint.
XmlRpcTrait::getEndpoint public function Returns the URI of the server XML-RPC endpoint.