g2-8.x-1.x-dev/src/ParamConverter/NodeMatch.php

<?php

declare(strict_types=1);

namespace Drupal\g2\ParamConverter;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\ParamConverter\ParamConverterInterface;
use Drupal\Core\Session\AccountProxy;
use Drupal\g2\G2;
use Drupal\node\Entity\Node;
use Symfony\Component\Routing\Route;

/**
 * Class NodeMatch is a flexible ParamConverter.
 *
 * Depending on its use configuration, it will match:
 * - matches at beginning, matches anywhere in title, or only full matches.
 * - returning a configurable number of results.
 */
class NodeMatch implements ParamConverterInterface {

  /**
   * The current_user service.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $currentUser;

  /**
   * The entity_type.manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $etm;

  /**
   * NodeMatch constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $etm
   *   The entity_type.manager service.
   * @param \Drupal\Core\Session\AccountProxy $current_user
   *   The current_user service.
   */
  public function __construct(
    EntityTypeManagerInterface $etm,
    AccountProxy $current_user,
  ) {
    $this->currentUser = $current_user;
    $this->etm = $etm;
  }

  /**
   * Converts the raw value to an array of nodes.
   *
   * Only returns unpublished nodes to users with "administer g2 entries".
   *
   * @param mixed $value
   *   The raw value.
   * @param mixed $definition
   *   The parameter definition provided in the route options.
   * @param string $name
   *   The name of the parameter.
   * @param array<string,mixed> $defaults
   *   The route defaults array.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]|mixed|null
   *   A possibly empty array of nodes.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function convert($value, $definition, $name, array $defaults): mixed {
    // XXX earlier versions used "administer nodes". Which one is better ?
    $hasAdmin = $this->currentUser->hasPermission(G2::PERM_ADMIN);
    $min_status = $hasAdmin
      ? Node::NOT_PUBLISHED
      : Node::PUBLISHED;

    // @todo Match on LOWER(title), not title: MySQL does not need it, but other
    // engines might.
    $query = $this->etm
      ->getStorage(G2::TYPE)
      ->getQuery()
      ->accessCheck(!$hasAdmin)
      ->condition('type', G2::BUNDLE)
      ->condition('status', $min_status, '>=')
      ->condition('title', $value . '%', 'LIKE')
      ->sort('sticky', 'desc')
      ->sort('title');

    $ids = $query->execute();
    $nodes = $this->etm
      ->getStorage(G2::TYPE)
      ->loadMultiple($ids);

    return $nodes;
  }

  /**
   * {@inheritdoc}
   */
  public function applies($definition, $name, Route $route) {
    assert(is_array($definition));
    $result = !empty($definition['type']) && $definition['type'] == 'g2:node:title';
    return $result;
  }

}