class DeveloperAppListBuilderForDeveloper in Apigee Edge 8

Lists developer apps of a developer on the UI.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
  - class \Drupal\apigee_edge\Entity\ListBuilder\EdgeEntityListBuilder
    class \Drupal\apigee_edge\Entity\ListBuilder\AppListBuilder
    class \Drupal\apigee_edge\Entity\ListBuilder\DeveloperAppListBuilderForDeveloper implements ContainerInjectionInterface

Expanded class hierarchy of DeveloperAppListBuilderForDeveloper

1 file declares its use of DeveloperAppListBuilderForDeveloper

DeveloperAppRouteProvider.php in src/Entity/DeveloperAppRouteProvider.php

File

src/Entity/ListBuilder/DeveloperAppListBuilderForDeveloper.php, line 46

Namespace

Drupal\apigee_edge\Entity\ListBuilder

View source

class DeveloperAppListBuilderForDeveloper extends AppListBuilder implements ContainerInjectionInterface {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

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

  /**
   * Associative array that contains generated CSS entity ids for apps by name.
   *
   * @var array
   */
  private $appNameCssIdCache = [];

  /**
   * DeveloperAppListBuilderForDeveloper 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\Session\AccountInterface $current_user
   *   Currently logged-in user.
   * @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, AccountInterface $current_user, 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->currentUser = $current_user;
    $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_user'), $container
      ->get('current_route_match'), $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   *
   * Because we use the _controller directive in the route we had to implement
   * the ContainerInjectionInterface interface.
   */
  public static function create(ContainerInterface $container) {
    return static::createInstance($container, $container
      ->get('entity_type.manager')
      ->getDefinition('developer_app'));
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityIdQuery() : QueryInterface {
    $query = parent::buildEntityIdQuery();
    $user = $this->routeMatch
      ->getParameter('user');
    $developer_id = $user
      ->get('apigee_edge_developer_id')->value;

    // If developer id can not be retrieved for a Drupal user it means that
    // either there is connection error or the site is out of sync with
    // Apigee Edge.
    if ($developer_id === NULL) {
      throw new DeveloperDoesNotExistException($user
        ->getEmail());
    }
    $query
      ->condition('developerId', $developer_id);
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    foreach ($operations as $operation => $parameters) {
      if ($entity
        ->hasLinkTemplate("{$operation}-for-developer")) {
        $operations[$operation]['url'] = $entity
          ->toUrl("{$operation}-for-developer");
      }
      if ($entity
        ->hasLinkTemplate("{$operation}-form-for-developer")) {
        $operations[$operation]['url'] = $this
          ->ensureDestination($entity
          ->toUrl("{$operation}-form-for-developer"));
      }
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  protected function generateCssIdForApp(AppInterface $app) : string {

    // If we are listing the apps of a developer then developer app name is also
    // unique. But this method must return the same CSS id for an app within
    // the same page request.
    if (!array_key_exists($app
      ->getName(), $this->appNameCssIdCache)) {
      $this->appNameCssIdCache[$app
        ->getName()] = Html::getUniqueId($app
        ->getName());
    }
    return $this->appNameCssIdCache[$app
      ->getName()];
  }

  /**
   * {@inheritdoc}
   */
  protected function renderAppName(AppInterface $app) : array {
    if ($app
      ->access('view')) {
      return $app
        ->toLink(NULL, 'canonical-by-developer')
        ->toRenderable();
    }
    return parent::renderAppName($app);
  }

  /**
   * Redirects users to their Apps page.
   *
   * This controller assumes that it is only invoked for authenticated users.
   * This is enforced for the 'apigee_edge.user.apps' route with the
   * '_user_is_logged_in' requirement.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Returns a redirect to the Apps of the currently logged in user.
   */
  public function appsPage() : RedirectResponse {
    $options['absolute'] = TRUE;
    $url = Url::fromRoute('entity.developer_app.collection_by_developer', [
      'user' => $this->currentUser
        ->id(),
    ], $options);
    return new RedirectResponse($url
      ->toString(), 302);
  }

  /**
   * Returns the title of the "developer app list by user" page.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The title of the page.
   */
  public function pageTitle() : TranslatableMarkup {

    /** @var \Drupal\user\UserInterface $account */
    $account = $this->routeMatch
      ->getParameter('user');
    if ($account && $account
      ->id() != $this->currentUser
      ->id()) {
      $args['@user'] = Markup::create($account
        ->label());
      $title = $this
        ->t('Apps of @user', $args);
    }
    else {
      $title = apigee_edge_app_listing_page_title();
    }
    return $title;
  }

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

}

Members

Name	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::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::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EdgeEntityListBuilder::render	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
DeveloperAppListBuilderForDeveloper::$appNameCssIdCache	private	property	Associative array that contains generated CSS entity ids for apps by name.
DeveloperAppListBuilderForDeveloper::$currentUser	protected	property	The current user.
DeveloperAppListBuilderForDeveloper::$routeMatch	protected	property	Route match object.
DeveloperAppListBuilderForDeveloper::appsPage	public	function	Redirects users to their Apps page.
DeveloperAppListBuilderForDeveloper::buildEntityIdQuery	protected	function	Builds an entity query used by entity listing. Overrides EdgeEntityListBuilder::buildEntityIdQuery
DeveloperAppListBuilderForDeveloper::create	public static	function	Because we use the _controller directive in the route we had to implement the ContainerInjectionInterface interface. Overrides ContainerInjectionInterface::create
DeveloperAppListBuilderForDeveloper::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides AppListBuilder::createInstance
DeveloperAppListBuilderForDeveloper::generateCssIdForApp	protected	function	Generates a unique CSS id for an app. Overrides AppListBuilder::generateCssIdForApp
DeveloperAppListBuilderForDeveloper::getCacheMaxAge	protected	function	Returns the cache max age. Overrides EdgeEntityListBuilder::getCacheMaxAge
DeveloperAppListBuilderForDeveloper::getDefaultOperations	protected	function	Gets this list's default operations. Overrides AppListBuilder::getDefaultOperations
DeveloperAppListBuilderForDeveloper::pageTitle	public	function	Returns the title of the "developer app list by user" page.
DeveloperAppListBuilderForDeveloper::renderAppName	protected	function	Renders the name of an app for the entity list. Overrides AppListBuilder::renderAppName
DeveloperAppListBuilderForDeveloper::__construct	public	function	DeveloperAppListBuilderForDeveloper constructor. Overrides AppListBuilder::__construct
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.

You are here

class DeveloperAppListBuilderForDeveloper in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation