You are here

Home » API reference » Album Photos 8.4 » PhotosUserAlbumsController.php

class PhotosUserAlbumsController in Album Photos 8.4

Display user albums.

Hierarchy

Expanded class hierarchy of PhotosUserAlbumsController

File

src/Controller/PhotosUserAlbumsController.php, line 20

Namespace

Drupal\photos\Controller
View source 
class PhotosUserAlbumsController extends ControllerBase {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The entity manager service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   */
  public function __construct(Connection $connection, EntityTypeManagerInterface $entity_manager, RendererInterface $renderer, RouteMatchInterface $route_match) {
    $this->connection = $connection;
    $this->entityTypeManager = $entity_manager;
    $this->renderer = $renderer;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'), $container
      ->get('entity_type.manager'), $container
      ->get('renderer'), $container
      ->get('current_route_match'));
  }

  /**
   * A custom access check.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Run access checks for this account.
   */
  public function access(AccountInterface $account) {

    // Check if user can view account photos.
    $uid = $this->routeMatch
      ->getParameter('user');
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->load($uid);
    if (!$account || _photos_access('viewUser', $account)) {
      return AccessResult::allowed();
    }
    else {
      return AccessResult::forbidden();
    }
  }

  /**
   * Photos page title.
   */
  public function title() {

    // Generate title.
    $user = $this
      ->currentUser();
    $uid = $this->routeMatch
      ->getParameter('user');
    if ($uid != $user
      ->id()) {
      $account = $this->entityTypeManager
        ->getStorage('user')
        ->load($uid);
      return $this
        ->t("@name's albums", [
        '@name' => $account
          ->getDisplayName(),
      ]);
    }
    else {
      return $this
        ->t('My Albums');
    }
  }

  /**
   * Returns content for user albums.
   *
   * @return array
   *   An array of markup for user album content.
   */
  public function contentOverview() {

    // Get current user and account.
    // @todo a lot of duplicate code can be consolidated in these controllers.
    $user = $this
      ->currentUser();
    $uid = $this->routeMatch
      ->getParameter('user');
    $account = FALSE;
    if ($uid && is_numeric($uid)) {
      $account = $this->entityTypeManager
        ->getStorage('user')
        ->load($uid);
    }
    if (!$account) {
      throw new NotFoundHttpException();
    }
    $output = '';
    $build = [];
    $cache_tags = [
      'user:' . $uid,
    ];
    if ($account
      ->id() && $account
      ->id() != 0) {
      if ($user
        ->id() == $account
        ->id()) {
        $output = Link::fromTextAndUrl($this
          ->t('Rearrange albums'), Url::fromRoute('photos.album.rearrange', [
          'user' => $account
            ->id(),
        ]))
          ->toString();
      }
      $query = $this->connection
        ->select('node_field_data', 'n')
        ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender');
      $query
        ->join('photos_album', 'p', 'p.pid = n.nid');
      $query
        ->fields('n', [
        'nid',
      ]);
      $query
        ->condition('n.uid', $account
        ->id());
      $query
        ->orderBy('p.wid', 'ASC');
      $query
        ->orderBy('n.nid', 'DESC');
      $query
        ->limit(10);
      $query
        ->addTag('node_access');
      $results = $query
        ->execute();
    }
    else {
      $query = $this->connection
        ->select('node', 'n')
        ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender');
      $query
        ->join('photos_album', 'p', 'p.pid = n.nid');
      $query
        ->fields('n', [
        'nid',
      ]);
      $query
        ->orderBy('n.nid', 'DESC');
      $query
        ->limit(10);
      $query
        ->addTag('node_access');
      $results = $query
        ->execute();
    }
    foreach ($results as $result) {
      $nid = $result->nid;
      $cache_tags[] = 'node:' . $nid;
      $cache_tags[] = 'photos:album:' . $nid;
      $node = $this->entityTypeManager
        ->getStorage('node')
        ->load($result->nid);
      $node_view = $this->entityTypeManager
        ->getViewBuilder('node')
        ->view($node, 'full');
      $output .= $this->renderer
        ->render($node_view);
    }
    if ($output) {
      $pager = [
        '#type' => 'pager',
      ];
      $output .= $this->renderer
        ->render($pager);
    }
    else {
      if ($account != FALSE) {
        $output .= $this
          ->t('@name has not created an album yet.', [
          '@name' => $account
            ->getDisplayName(),
        ]);
      }
      else {
        $output .= $this
          ->t('No albums have been created yet.');
      }
    }
    $build['#markup'] = $output;
    $build['#cache'] = [
      'tags' => $cache_tags,
    ];
    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::$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.
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.
PhotosUserAlbumsController::$connection protected property The database connection.
PhotosUserAlbumsController::$entityTypeManager protected property The entity manager. Overrides ControllerBase::$entityTypeManager
PhotosUserAlbumsController::$renderer protected property The renderer.
PhotosUserAlbumsController::$routeMatch protected property The current route match.
PhotosUserAlbumsController::access public function A custom access check.
PhotosUserAlbumsController::contentOverview public function Returns content for user albums.
PhotosUserAlbumsController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
PhotosUserAlbumsController::title public function Photos page title.
PhotosUserAlbumsController::__construct public function Constructor.
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.