You are here

Home » API reference » Examples for Developers 3.x » RestExampleClientController.php

class RestExampleClientController in Examples for Developers 3.x

Controller routines for rest example routes.

Hierarchy

Expanded class hierarchy of RestExampleClientController

Related topics

Example: REST
This module will give you a brief demonstration of how the REST service works.

File

modules/rest_example/src/Controller/RestExampleClientController.php, line 15

Namespace

Drupal\rest_example\Controller
View source 
class RestExampleClientController extends ControllerBase {

  /**
   * RestExampleClientCalls object.
   *
   * @var \Drupal\rest_example\RestExampleClientCalls
   */
  private $restExampleClientCalls;

  /**
   * RestExampleClientController constructor.
   *
   * @param \Drupal\rest_example\RestExampleClientCalls $rest_example_client_calls
   *   RestExampleClientCalls service.
   */
  public function __construct(RestExampleClientCalls $rest_example_client_calls) {
    $this->restExampleClientCalls = $rest_example_client_calls;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('rest_example_client_calls'));
  }

  /**
   * Retrieve a list of all nodes available on the remote site.
   *
   * Building the list as a table by calling the RestExampleClientCalls::index()
   * and builds the list from the response of that.
   *
   * @throws \RuntimeException
   * @throws \GuzzleHttp\Exception\GuzzleException
   */
  public function indexAction() {
    if (NULL === $this->configFactory
      ->get('rest_example.settings')
      ->get('server_url')) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('The remote endpoint service address have not been set. Please go and provide the credentials and the endpoint address on the <a href="@url">config page</a>.', [
        '@url' => base_path() . 'examples/rest-client-settings',
      ]));
    }
    $build = [];
    $nodes = $this->restExampleClientCalls
      ->index();
    $build['intro'] = [
      '#markup' => $this
        ->t('This is a list of nodes, of type <em>Rest Example Test</em>, on the remote server. From here you can create new node, edit and delete existing ones.'),
    ];
    $build['node_table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Title'),
        $this
          ->t('Type'),
        $this
          ->t('Created'),
        $this
          ->t('Edit'),
        $this
          ->t('Delete'),
      ],
      '#empty' => t('There are no items on the remote system yet'),
    ];
    if (!empty($nodes)) {
      foreach ($nodes as $delta => $node) {
        $build['node_table'][$delta]['title']['#plain_text'] = $node['title'];
        $build['node_table'][$delta]['type']['#plain_text'] = $node['type'];
        $build['node_table'][$delta]['created']['#plain_text'] = $node['created'];
        $build['node_table'][$delta]['edit']['#plain_text'] = Link::createFromRoute($this
          ->t('Edit'), 'rest_example.client_actions_edit', [
          'id' => $node['nid'],
        ])
          ->toString();
        $build['node_table'][$delta]['delete']['#plain_tex'] = Link::createFromRoute($this
          ->t('Delete'), 'rest_example.client_actions_delete', [
          'id' => $node['nid'],
        ])
          ->toString();
      }
    }
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage 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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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.
RestExampleClientController::$restExampleClientCalls private property RestExampleClientCalls object.
RestExampleClientController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
RestExampleClientController::indexAction public function Retrieve a list of all nodes available on the remote site.
RestExampleClientController::__construct public function RestExampleClientController constructor.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.