Computes a suggestion description.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The suggested entity for which to compute a description.

Return value

\Drupal\Core\StringTranslation\TranslatableMarkup|null A suggestion description.

File

core/modules/ckeditor5/src/Controller/EntityLinkSuggestionsController.php, line 252

Class

EntityLinkSuggestionsController

Returns responses for entity link suggestions autocomplete route.

Namespace

Drupal\ckeditor5\Controller

Code

protected function computeDescription(EntityInterface $entity) : ?TranslatableMarkup {
  $entity_type = $entity->getEntityType();
  $owner = $entity_type->hasKey('owner') && $entity->getOwner() ? $entity->getOwner()
    ->getDisplayName() : NULL;
  $creation_datetime = method_exists($entity, 'getCreatedTime') ? $this->dateFormatter
    ->format($entity->getCreatedTime(), 'medium') : NULL;
  $arg_owner = [
    '@owner' => $owner,
  ];
  $arg_creation_datetime = [
    '@creation-datetime' => $creation_datetime,
  ];
  if ($owner && $creation_datetime) {
    return $this->t('by @owner on @creation-datetime', $arg_owner + $arg_creation_datetime);
  }
  elseif ($owner) {
    return $this->t('by @owner', $arg_owner);
  }
  elseif ($creation_datetime) {
    return $this->t('on @creation-datetime', $arg_creation_datetime);
  }
  else {
    return NULL;
  }
}

---