class HttpConfigRequestListBuilder in HTTP Client Manager 8

Provides a listing of Http Config Request entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
      • class \Drupal\http_client_manager\HttpConfigRequestListBuilder

File

src/HttpConfigRequestListBuilder.php, line 16

Namespace

Drupal\http_client_manager

class HttpConfigRequestListBuilder extends ConfigEntityListBuilder {

  /**
   * Current Request.
   *
   * @var null|\Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, RequestStack $request_stack) {
    parent::__construct($entity_type, $storage);
    $this->request = $request_stack
      ->getCurrentRequest();
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('request_stack'));
  }

  /**
   * Loads entity IDs using a pager sorted by the entity id.
   *
   * @return array
   *   An array of entity IDs.
   */
  protected function getEntityIds() {
    $query = $this
      ->getStorage()
      ->getQuery()
      ->condition('service_api', $this->request
      ->get('serviceApi'))
      ->condition('command_name', $this->request
      ->get('commandName'))
      ->sort($this->entityType
      ->getKey('id'));

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Http Config Request');
    $header['id'] = $this
      ->t('Machine name');
    $header['params'] = $this
      ->t('Parameters');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->label();
    $row['id'] = $entity
      ->id();
    $params = [];
    foreach ($entity
      ->getParameters() as $key => $value) {
      $params[$key] = $this
        ->t('@key: @value', [
        '@key' => $key,
        '@value' => is_array($value) ? json_encode($value, JSON_PRETTY_PRINT) : $value,
      ]);
    }
    $row['params']['data'] = [
      '#theme' => 'item_list',
      '#items' => $params,
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if ($entity
      ->access('execute') && $entity
      ->hasLinkTemplate('execute')) {
      $operations['execute'] = array(
        'title' => $this
          ->t('Execute'),
        'weight' => 101,
        'url' => Url::fromRoute('entity.http_config_request.execute', [
          'http_config_request' => $entity
            ->id(),
          'serviceApi' => $entity
            ->get('service_api'),
          'commandName' => $entity
            ->get('command_name'),
        ]),
      );
    }
    return $operations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
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
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
HttpConfigRequestListBuilder::$request	protected	property	Current Request.
HttpConfigRequestListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
HttpConfigRequestListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
HttpConfigRequestListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
HttpConfigRequestListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
HttpConfigRequestListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
HttpConfigRequestListBuilder::__construct	public	function	Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
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.