class ExampleController in HTTP Client Manager 8.2

Same name and namespace in other branches

8 modules/http_client_manager_example/src/Controller/ExampleController.php \Drupal\http_client_manager_example\Controller\ExampleController

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

Expanded class hierarchy of ExampleController

File

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

Namespace

Drupal\http_client_manager_example\Controller

View source

class ExampleController extends ControllerBase {

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

  /**
   * The Posts Api Wrapper service.
   *
   * @var \Drupal\http_client_manager_example\Plugin\HttpServiceApiWrapper\HttpServiceApiWrapperPosts
   */
  protected $api;

  /**
   * The HTTP Service Api Wrapper Factory service.
   *
   * @var \Drupal\http_client_manager\HttpServiceApiWrapperFactoryInterface
   */
  protected $apiFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct(HttpClientInterface $http_client, HttpServiceApiWrapperInterface $api_wrapper, HttpServiceApiWrapperFactoryInterface $api_wrapper_factory) {
    $this->httpClient = $http_client;
    $this->api = $api_wrapper;
    $this->apiFactory = $api_wrapper_factory;
  }

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

  /**
   * 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 array
   *   The service response.
   */
  public function findPosts($postId = NULL) {
    $client = $this
      ->getClient();
    $post_link = TRUE;
    $command = 'FindPosts';
    $params = [];
    if (!empty($postId)) {
      $post_link = FALSE;
      $command = 'FindPost';
      $params = [
        'postId' => (int) $postId,
      ];
    }
    $response = $client
      ->call($command, $params);
    if (!empty($postId)) {
      $response = [
        $postId => $response
          ->toArray(),
      ];
    }
    $build = [];
    foreach ($response as $id => $post) {
      $build[$id] = $this
        ->buildPostResponse($post, $post_link);
    }
    return $build;
  }

  /**
   * Find posts - Advanced usage.
   *
   * @param int|null $postId
   *   The post Id.
   *
   * @return array
   *   The service response.
   */
  public function findPostsAdvanced($postId = NULL) {
    $post_link = empty($postId);
    $response = !empty($postId) ? $this->api
      ->findPost($postId) : $this->api
      ->findPosts();
    if (!empty($postId)) {
      $response = [
        $postId => $response,
      ];
    }
    $build = [];
    foreach ($response as $id => $post) {
      $build[$id] = $this
        ->buildPostResponse($post, $post_link, TRUE);
    }
    return $build;
  }

  /**
   * Build Post response.
   *
   * @param array $post
   *   The Post response item.
   * @param bool $post_link
   *   TRUE for a "Read more" link, otherwise "Back to list" link.
   * @param bool $advanced
   *   Boolean indicating if we are using the basic or advanced usage.
   *
   * @return array
   *   A render array of the post.
   */
  protected function buildPostResponse(array $post, $post_link, $advanced = FALSE) {
    $route = $advanced ? 'http_client_manager_example.find_posts.advanced' : '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['id'],
    ] : [];
    $output = [
      '#type' => 'fieldset',
      '#title' => $post['id'] . ') ' . $post['title'],
      'body' => [
        '#markup' => '<p>' . $post['body'] . '</p>',
      ],
      'link' => [
        '#markup' => Link::createFromRoute($link_text, $route, $route_params)
          ->toString(),
      ],
    ];
    return $output;
  }

  /**
   * Create post.
   *
   * @return array
   *   The service response.
   */
  public function createPost() {
    $this
      ->checkTokenModule();
    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,
    ];
  }

  /**
   * Create post - Advanced usage.
   *
   * @return array
   *   The service response.
   */
  public function createPostAdvanced() {
    $this
      ->checkTokenModule();

    // The whole HTTP Service Api Wrappers Factory is being used just to show
    // you an alternative way for accessing the api wrappers.
    $api = $this->apiFactory
      ->get('posts');

    // Here we are using an HTTP Config Request just for example purposes.
    $response = $api
      ->httpConfigRequest('create_post');
    return [
      '#type' => 'markup',
      '#markup' => '<pre>' . print_r($response, TRUE) . '</pre>',
    ];
  }

  /**
   * Check Token module.
   */
  protected function checkTokenModule() {
    if (!$this
      ->moduleHandler()
      ->moduleExists('token')) {
      $message = $this
        ->t('Install the Token module in order to use tokens inside your HTTP Config Requests.');
      \Drupal::messenger()
        ->addWarning($message);
    }
  }

}

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::$api	protected	property	The Posts Api Wrapper service.
ExampleController::$apiFactory	protected	property	The HTTP Service Api Wrapper Factory service.
ExampleController::$httpClient	protected	property	JsonPlaceholder Http Client.
ExampleController::buildPostResponse	protected	function	Build Post response.
ExampleController::checkTokenModule	protected	function	Check Token module.
ExampleController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ExampleController::createPost	public	function	Create post.
ExampleController::createPostAdvanced	public	function	Create post - Advanced usage.
ExampleController::findPosts	public	function	Find posts.
ExampleController::findPostsAdvanced	public	function	Find posts - Advanced usage.
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.

You are here

class ExampleController in HTTP Client Manager 8.2

Hierarchy

File

Namespace

Members

API Navigation