HighlightState.php

<?php
/*
Copyright (C) 2014-2015, Siemens AG
Author: Andreas Würl

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

namespace Fossology\Lib\View;


use Fossology\Lib\Data\Highlight;
use Fossology\Lib\Data\SplitPosition;

class HighlightState
{
  const PLACEHOLDER = " # ";

  private $elementStack;
  private $highlightRenderer;
  private $anchorDrawn;
  private $insertBacklink;

  public function __construct(HighlightRenderer $highlightRenderer, $insertBacklink = false)
  {
    $this->highlightRenderer = $highlightRenderer;
    $this->insertBacklink = $insertBacklink;
    $this->elementStack = array();
  }

  public function push(SplitPosition $splitPosition)
  {
    array_push($this->elementStack, $splitPosition);
  }

  public function pop()
  {
    return array_pop($this->elementStack);
  }

  public function getElementStack()
  {
    return $this->elementStack;
  }

  public function processSplitEntries($entries)
  {
    foreach ($entries as $entry) {
      switch ($entry->getAction()) {
        case SplitPosition::START:
          $this->push($entry);
          $this->checkForAnchor($entry);
          break;
        case SplitPosition::END:
          $this->pop();
          break;
      }
    }
  }

  public function insertElements($entries, PagedResult $result)
  {
    foreach ($entries as $entry) {
      switch ($entry->getAction()) {
        case SplitPosition::START:
          $this->push($entry);
          $result->appendMetaText($this->startSpan($entry));
          break;
        case SplitPosition::ATOM:
          $result->appendMetaText($this->startSpan($entry));
          $result->appendMetaText(
            self::PLACEHOLDER . $this->highlightRenderer->createSpanEnd($entry));
          break;

        case SplitPosition::END:
          $this->pop();
          $result->appendMetaText(
            $this->highlightRenderer->createSpanEnd($entry));
          break;
      }
    }
  }

  public function closeOpenElements(PagedResult $result)
  {
    foreach ($this->elementStack as $splitPosition) {
      $result->appendMetaText(
        $this->highlightRenderer->createSpanEnd($splitPosition));
    }
  }

  public function openExistingElements(PagedResult $result)
  {
    foreach ($this->elementStack as $entry) {
      $result->appendMetaText($this->highlightRenderer->createSpanStart($entry));
    }
  }

  protected function startSpan(SplitPosition $entry)
  {
    $anchorText = $this->checkForAnchor($entry)
        ? "<a id=\"highlight\"" . ($this->insertBacklink ? " href=\"#top\">&nbsp;&#8593;&nbsp;" : ">") . "</a>"
        : "";

    return $anchorText . $this->highlightRenderer->createSpanStart($entry);
  }

  protected function checkForAnchor(SplitPosition $entry)
  {
    $shouldShowAnchor = !$this->anchorDrawn && $entry->getHighlight()->getType() != Highlight::KEYWORD;
    if ($shouldShowAnchor) {
      $this->anchorDrawn = true;
    }
    return $shouldShowAnchor;
  }
}