You are here

Home » API reference » Apigee Edge 8 » TeamAppListByTeam.php

class TeamAppListByTeam in Apigee Edge 8

Lists team apps of a team on the UI.

Hierarchy

Expanded class hierarchy of TeamAppListByTeam

1 file declares its use of TeamAppListByTeam
TeamAppRouteProvider.php in modules/apigee_edge_teams/src/Entity/TeamAppRouteProvider.php

File

modules/apigee_edge_teams/src/Entity/ListBuilder/TeamAppListByTeam.php, line 39

Namespace

Drupal\apigee_edge_teams\Entity\ListBuilder
View source 
class TeamAppListByTeam extends AppListBuilder implements ContainerInjectionInterface {

  /**
   * Route match object.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * TeamAppListByTeam constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Render\RendererInterface $render
   *   The render.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack object.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match object.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, RendererInterface $render, RequestStack $request_stack, TimeInterface $time, RouteMatchInterface $route_match, ConfigFactoryInterface $config_factory = NULL) {
    if (!$config_factory) {
      $config_factory = \Drupal::service('config.factory');
    }
    parent::__construct($entity_type, $entity_type_manager, $render, $request_stack, $time, $config_factory);
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'), $container
      ->get('renderer'), $container
      ->get('request_stack'), $container
      ->get('datetime.time'), $container
      ->get('current_route_match'), $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return static::createInstance($container, $container
      ->get('entity_type.manager')
      ->getDefinition('team_app'));
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityIdQuery() : QueryInterface {
    $query = parent::buildEntityIdQuery();
    $team = $this->routeMatch
      ->getParameter('team');
    $query
      ->condition('companyName', $team
      ->id());
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();

    // Update the empty text for table views.
    if (!empty($build['table'])) {
      $build['table']['#empty'] = t('There are no @label yet.', [
        '@label' => $this->entityType
          ->getPluralLabel(),
      ]);
    }
    return $build;
  }

  /**
   * Returns the title of the "team app list by team" page.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The title of the page.
   */
  public function pageTitle() : TranslatableMarkup {
    return $this
      ->t('@team_apps', [
      '@team_apps' => $this->entityType
        ->getCollectionLabel(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getCacheMaxAge() {
    return $this->configFactory
      ->get('apigee_edge_teams.team_app_settings')
      ->get('cache_expiration');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AppListBuilder::$appWarningsChecker protected property The app warnings checker.
AppListBuilder::$configFactory protected property The config factory. Overrides EdgeEntityListBuilder::$configFactory
AppListBuilder::$renderer protected property The renderer service.
AppListBuilder::$requestStack protected property The request stack.
AppListBuilder::$time protected property The time service.
AppListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader 1
AppListBuilder::buildInfoRow protected function Builds an info row for an app in the entity listing. 1
AppListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
AppListBuilder::buildWarningRow protected function Builds a warning row for an app in the entity listing.
AppListBuilder::checkAppCredentialWarnings protected function Checks credentials of an app and returns warnings about them.
AppListBuilder::generateCssIdForApp protected function Generates a unique CSS id for an app. 1
AppListBuilder::getCssIdForInfoRow final protected function Returns the CSS ID of the app info row.
AppListBuilder::getCssIdForWarningRow final protected function Returns the CSS ID of the app warning row.
AppListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 1
AppListBuilder::renderAppName protected function Renders the name of an app for the entity list. 1
AppListBuilder::renderAppStatus protected function Renders the status of an app for the entity list.
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
EdgeEntityListBuilder::$entityTypeManager protected property The entity type manager service.
EdgeEntityListBuilder::DEFAULT_DISPLAY_TYPE constant The default display type.
EdgeEntityListBuilder::getDisplaySettings protected function Returns the display settings.
EdgeEntityListBuilder::getEntityIds final protected function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
EdgeEntityListBuilder::renderUsingViewMode protected function Renders a list of entities using the provided view mode.
EdgeEntityListBuilder::usingDisplayType protected function Returns TRUE if entity type is configure to use provided display type.
EdgeEntityListBuilder::VIEW_MODE_DISPLAY_TYPE constant The view mode display type.
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::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
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.
TeamAppListByTeam::$routeMatch protected property Route match object.
TeamAppListByTeam::buildEntityIdQuery protected function Builds an entity query used by entity listing. Overrides EdgeEntityListBuilder::buildEntityIdQuery
TeamAppListByTeam::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
TeamAppListByTeam::createInstance public static function Instantiates a new instance of this entity handler. Overrides AppListBuilder::createInstance
TeamAppListByTeam::getCacheMaxAge protected function Returns the cache max age. Overrides EdgeEntityListBuilder::getCacheMaxAge
TeamAppListByTeam::pageTitle public function Returns the title of the "team app list by team" page.
TeamAppListByTeam::render public function Builds the entity listing as renderable array for table.html.twig. Overrides AppListBuilder::render
TeamAppListByTeam::__construct public function TeamAppListByTeam constructor. Overrides AppListBuilder::__construct