class InstagramAccountListBuilder in Instagram Feeds 8

Lists instagram_account entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\instagram_feeds\InstagramAccountListBuilder

File

src/InstagramAccountListBuilder.php, line 13

Namespace

Drupal\instagram_feeds

class InstagramAccountListBuilder extends EntityListBuilder {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatterService;

  /**
   * Get the list of columns to render.
   *
   * @return array
   *   The list of columns, where keys are field names and values are headers.
   */
  protected function getColumns() {
    return [
      'iid' => $this
        ->t('Instagram User ID'),
      'account' => $this
        ->t('Instagram Username'),
      'cron_import_limit' => $this
        ->t('Cron Import Limit'),
      'media_bundle' => $this
        ->t('Media Type'),
      'status' => $this
        ->t('Status'),
      'token_expiration' => $this
        ->t('Token Expiry'),
      'uid' => $this
        ->t('Author'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [];
    foreach ($this
      ->getColumns() as $field => $label) {
      $header[$field] = [
        'data' => $label,
        'field' => $field,
        'specifier' => $field,
      ];
    }
    $header['iid']['class'] = [
      RESPONSIVE_PRIORITY_LOW,
    ];
    $header['media_bundle']['class'] = [
      RESPONSIVE_PRIORITY_LOW,
    ];
    $header['cron_import_limit']['class'] = [
      RESPONSIVE_PRIORITY_LOW,
    ];
    $header['token_expiration']['sort'] = 'desc';
    return $header + parent::buildHeader();
  }

  /**
   * Gets date formatter service.
   *
   * @return \Drupal\Core\Datetime\DateFormatterInterface
   *   The date formatter service.
   */
  protected function dateFormatter() : DateFormatterInterface {
    if (!isset($this->dateFormatterService)) {
      $this->dateFormatterService = \Drupal::service('date.formatter');
    }
    return $this->dateFormatterService;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\instagram_feeds\Entity\InstagramAccountInterface $entity */
    $row = [];
    foreach (array_keys($this
      ->getColumns()) as $field) {
      $value = $entity
        ->get($field)
        ->first()
        ->getValue();
      $row[$field]['data']['#markup'] = reset($value);
    }
    $row['uid']['data'] = [
      '#theme' => 'username',
      '#account' => $entity
        ->getOwner(),
    ];
    $row['account'] = $entity
      ->toLink();
    $row['status'] = empty($row['status']) ? $this
      ->t('Disabled') : $this
      ->t('Enabled');
    $row['token_expiration']['data'] = $this
      ->dateFormatter()
      ->format($entity
      ->getTokenExpirationTime(), 'short');
    return $row + parent::buildRow($entity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations	protected	function	Gets this list's default operations.	2
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
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::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
InstagramAccountListBuilder::$dateFormatterService	protected	property	The date formatter service.
InstagramAccountListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
InstagramAccountListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
InstagramAccountListBuilder::dateFormatter	protected	function	Gets date formatter service.
InstagramAccountListBuilder::getColumns	protected	function	Get the list of columns to render.
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.