You are here

class ItemListController in Feeds 8.3

Lists the feed items belonging to a feed.

Hierarchy

Expanded class hierarchy of ItemListController

File

src/Controller/ItemListController.php, line 19

Namespace

Drupal\feeds\Controller
View source
class ItemListController extends ControllerBase {

  /**
   * Provides a object for obtaining system time.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Provides a service to handle various date related functionality.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The constructor.
   *
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The object for obtaining system time.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The services of date.
   */
  public function __construct(TimeInterface $time, DateFormatterInterface $date_formatter) {
    $this->time = $time;
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('datetime.time'), $container
      ->get('date.formatter'));
  }

  /**
   * Lists the feed items belonging to a feed.
   */
  public function listItems(FeedInterface $feeds_feed, Request $request) {
    $processor = $feeds_feed
      ->getType()
      ->getProcessor();
    $header = [
      'id' => $this
        ->t('ID'),
      'title' => $this
        ->t('Label'),
      'imported' => $this
        ->t('Imported'),
      'guid' => [
        'data' => $this
          ->t('GUID'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'url' => [
        'data' => $this
          ->t('URL'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
    ];
    $build = [];
    $build['table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => [],
      '#empty' => $this
        ->t('There are no items yet.'),
    ];

    // @todo Allow processors to create their own entity listings.
    if (!$processor instanceof EntityProcessorInterface) {
      return $build;
    }
    $entity_ids = $this
      ->entityTypeManager()
      ->getStorage($processor
      ->entityType())
      ->getQuery()
      ->condition('feeds_item.target_id', $feeds_feed
      ->id())
      ->pager(50)
      ->sort('feeds_item.imported', 'DESC')
      ->execute();
    $storage = $this
      ->entityTypeManager()
      ->getStorage($processor
      ->entityType());
    foreach ($storage
      ->loadMultiple($entity_ids) as $entity) {
      $ago = $this->dateFormatter
        ->formatInterval($this->time
        ->getRequestTime() - $entity
        ->get('feeds_item')->imported);
      $row = [];

      // Entity ID.
      $row[] = $entity
        ->id();

      // Entity link.
      try {
        $row[] = [
          'data' => $entity
            ->toLink(Unicode::truncate($entity
            ->label(), 75, TRUE, TRUE)),
          'title' => $entity
            ->label(),
        ];
      } catch (UndefinedLinkTemplateException $e) {
        $row[] = $entity
          ->label();
      }

      // Imported ago.
      $row[] = $this
        ->t('@time ago', [
        '@time' => $ago,
      ]);

      // Item GUID.
      $row[] = [
        'data' => Html::escape(Unicode::truncate($entity
          ->get('feeds_item')->guid, 30, FALSE, TRUE)),
        'title' => $entity
          ->get('feeds_item')->guid,
      ];

      // Item URL.
      $row[] = [
        'data' => Html::escape(Unicode::truncate($entity
          ->get('feeds_item')->url, 30, FALSE, TRUE)),
        'title' => $entity
          ->get('feeds_item')->url,
      ];
      $build['table']['#rows'][] = $row;
    }
    $build['pager'] = [
      '#type' => 'pager',
    ];
    $build['#title'] = $this
      ->t('%title items', [
      '%title' => $feeds_feed
        ->label(),
    ]);
    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::$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.
ItemListController::$dateFormatter protected property Provides a service to handle various date related functionality.
ItemListController::$time protected property Provides a object for obtaining system time.
ItemListController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ItemListController::listItems public function Lists the feed items belonging to a feed.
ItemListController::__construct public function The constructor.
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.