ForwardLinkGeneratorInterface.php in Forward 4.x

Namespace

Drupal\forward\Services

File

src/Services/ForwardLinkGeneratorInterface.php

<?php

namespace Drupal\forward\Services;

use Drupal\Core\Entity\EntityInterface;

/**
 * Defines an interface for generating a Forward link on an entity.
 */
interface ForwardLinkGeneratorInterface {

  /**
   * Generate a Forward link for a given entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Entity for which the link is being generated.
   * @param array $settings
   *   Array with these keys:
   *     title - the link title, with tokens allowed
   *     style - 0, 1, or 2 (text only, icon only, text and icon)
   *     icon - optional path to custom icon, or a blank string
   *     nofollow - true if a nofollow tag should be included
   *
   * @return array
   *   A render array containing the generated link.
   *
   * @see the ForwardLinkFormatter for example usage.
   */
  public function generate(EntityInterface $entity, array $settings);

}

Interfaces

Name	Description
ForwardLinkGeneratorInterface	Defines an interface for generating a Forward link on an entity.