class ExampleController in HTTP Client Manager 8

Class ExampleController.

@package Drupal\http_client_manager_example\Controller

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\http_client_manager_example\Controller\ExampleController

File

modules/http_client_manager_example/src/Controller/ExampleController.php, line 17

Namespace

Drupal\http_client_manager_example\Controller

class ExampleController extends ControllerBase {

  /**
   * JsonPlaceholder Http Client.
   *
   * @var \Drupal\http_client_manager\HttpClientInterface
   */
  protected $httpClient;

  /**
   * {@inheritdoc}
   */
  public function __construct(HttpClientInterface $http_client) {
    $this->httpClient = $http_client;
  }

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

  /**
   * Get Client.
   *
   * @return \Drupal\http_client_manager\HttpClientInterface
   *   The Http Client instance.
   */
  public function getClient() {
    return $this->httpClient;
  }

  /**
   * Find posts.
   *
   * @param int|NULL $postId
   *   The post Id.
   *
   * @return string
   *   The service response.
   */
  public function findPosts($postId = NULL) {
    $client = $this
      ->getClient();

    /** @var FindPostsResponse $response */
    $response = $client
      ->findPosts([
      'postId' => $postId,
    ]);
    $post_link = TRUE;
    if (!empty($postId)) {
      $post_link = FALSE;
      $response = [
        $postId => $response,
      ];
    }
    $build = [];
    foreach ($response as $id => $post) {
      $build[$id] = $this
        ->buildPostResponse($post, $post_link);
    }
    return $build;
  }

  /**
   * Build Post response.
   *
   * @param \Drupal\http_client_manager_example\Response\FindPostsResponse $post
   *   The Post response object.
   * @param bool $post_link
   *   TRUE for a "Read more" link, otherwise "Back to list" link.
   *
   * @return array
   *   A render array of the post.
   */
  protected function buildPostResponse(FindPostsResponse $post, $post_link) {
    $route = 'http_client_manager_example.find_posts';
    $link_text = $post_link ? $this
      ->t('Read more') : $this
      ->t('Back to list');
    $route_params = $post_link ? [
      'postId' => $post
        ->getId(),
    ] : [];
    $output = [
      '#type' => 'fieldset',
      '#title' => $post
        ->getId() . ') ' . $post
        ->getTitle(),
      'body' => [
        '#markup' => '<p>' . $post
          ->getBody() . '</p>',
      ],
      'link' => [
        '#markup' => Link::createFromRoute($link_text, $route, $route_params)
          ->toString(),
      ],
    ];
    return $output;
  }

  /**
   * Create post.
   *
   * @return array
   *   The service response.
   */
  public function createPost() {
    if ($request = HttpConfigRequest::load('create_post')) {
      $response = '<pre>' . print_r($request
        ->execute(), TRUE) . '</pre>';
    }
    else {
      $response = $this
        ->t('Unable to load "create_post" configured request.');
    }
    return [
      '#type' => 'markup',
      '#markup' => $response,
    ];
  }

}

Members

Name	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::$entityManager	protected	property	The entity manager.
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::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
ExampleController::$httpClient	protected	property	JsonPlaceholder Http Client.
ExampleController::buildPostResponse	protected	function	Build Post response.
ExampleController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ExampleController::createPost	public	function	Create post.
ExampleController::findPosts	public	function	Find posts.
ExampleController::getClient	public	function	Get Client.
ExampleController::__construct	public	function
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.