annotate core/modules/comment/src/CommentLinkBuilderInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\comment;
Chris@0 4
Chris@0 5 use Drupal\Core\Entity\FieldableEntityInterface;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Defines an interface for building comment links on a commented entity.
Chris@0 9 *
Chris@0 10 * Comment links include 'log in to post new comment', 'add new comment' etc.
Chris@0 11 */
Chris@0 12 interface CommentLinkBuilderInterface {
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Builds links for the given entity.
Chris@0 16 *
Chris@0 17 * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
Chris@0 18 * Entity for which the links are being built.
Chris@0 19 * @param array $context
Chris@0 20 * Array of context passed from the entity view builder.
Chris@0 21 *
Chris@0 22 * @return array
Chris@0 23 * Array of entity links.
Chris@0 24 */
Chris@0 25 public function buildCommentedEntityLinks(FieldableEntityInterface $entity, array &$context);
Chris@0 26
Chris@0 27 }