class EasyBreadcrumbStructuredDataJsonLd in Easy Breadcrumb 2.x

Class EasyBreadcrumbStructuredDataJsonLd.

@package Drupal\easy_breadcrumb

Hierarchy

• class \Drupal\easy_breadcrumb\EasyBreadcrumbStructuredDataJsonLd implements ContainerInjectionInterface

1 string reference to 'EasyBreadcrumbStructuredDataJsonLd'

easy_breadcrumb.services.yml in ./easy_breadcrumb.services.yml

easy_breadcrumb.services.yml

1 service uses EasyBreadcrumbStructuredDataJsonLd

easy_breadcrumb.structured_data_json_ld in ./easy_breadcrumb.services.yml

Drupal\easy_breadcrumb\EasyBreadcrumbStructuredDataJsonLd

File

src/EasyBreadcrumbStructuredDataJsonLd.php, line 15

Namespace

Drupal\easy_breadcrumb

class EasyBreadcrumbStructuredDataJsonLd implements ContainerInjectionInterface {

  /**
   * The Easy Breadcrumb builder.
   *
   * @var \Drupal\easy_breadcrumb\EasyBreadcrumbBuilder
   */
  protected $easyBreadcrumbBuilder;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

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

  /**
   * EasyBreadcrumbStructuredDataJsonLd constructor.
   *
   * @param \Drupal\easy_breadcrumb\EasyBreadcrumbBuilder $easy_breadcrumb_builder
   *   The Easy Breadcrumb builder.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   */
  public function __construct(EasyBreadcrumbBuilder $easy_breadcrumb_builder, ConfigFactoryInterface $config_factory, RouteMatchInterface $route_match) {
    $this->easyBreadcrumbBuilder = $easy_breadcrumb_builder;
    $this->configFactory = $config_factory;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('easy_breadcrumb.breadcrumb'), $container
      ->get('config.factory'), $container
      ->get('current_route_match'));
  }

  /**
   * Build JSON-LD value.
   */
  public function value() {
    $value = FALSE;
    $config = $this->configFactory
      ->get(EasyBreadcrumbConstants::MODULE_SETTINGS);
    if ($config
      ->get(EasyBreadcrumbConstants::ADD_STRUCTURED_DATA_JSON_LD)) {

      /** @var \Drupal\Core\Breadcrumb\Breadcrumb $breadcrumb */
      $breadcrumb = $this->easyBreadcrumbBuilder
        ->build($this->routeMatch);
      $links = $breadcrumb
        ->getLinks();

      // Only fire if at least one link present.
      if (count($links) > 0) {

        // Open JSON.
        $value = '{
          "@context": "https://schema.org",
          "@type": "BreadcrumbList",
          "itemListElement": [';
        $position = 1;

        /** @var \Drupal\Core\Link $link */
        foreach ($links as $link) {
          $name = $link
            ->getText();
          $item = $link
            ->getUrl()
            ->setAbsolute(TRUE)
            ->toString();

          // Escape " to produce valid json for titles with "" in them.
          $name = str_replace('"', '\\"', $name);
          $item = str_replace('"', '\\"', $item);

          // Add a comma before each item except the first.
          if ($position > 1) {
            $value .= ',';
          }

          // Only add item if link's not empty.
          if (!empty($item)) {
            $value .= '{
            "@type": "ListItem",
            "position": "' . $position . '",
            "name": "' . $name . '",
            "item": "' . $item . '"
          }';
          }
          else {
            $value .= '{
              "@type": "ListItem",
              "position": "' . $position . '",
              "name": "' . $name . '"
            }';
          }

          // Increment position for next run.
          $position++;
        }

        // Close JSON.
        $value .= ']}';
      }
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EasyBreadcrumbStructuredDataJsonLd::$configFactory	protected	property	The config factory.
EasyBreadcrumbStructuredDataJsonLd::$easyBreadcrumbBuilder	protected	property	The Easy Breadcrumb builder.
EasyBreadcrumbStructuredDataJsonLd::$routeMatch	protected	property	The route match.
EasyBreadcrumbStructuredDataJsonLd::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
EasyBreadcrumbStructuredDataJsonLd::value	public	function	Build JSON-LD value.
EasyBreadcrumbStructuredDataJsonLd::__construct	public	function	EasyBreadcrumbStructuredDataJsonLd constructor.