Fossology\Lib\View\HighlightProcessor Class Reference

Collaboration diagram for Fossology\Lib\View\HighlightProcessor:

Public Member Functions
	__construct (LicenseDao $licenseDao)
	calculateSplitPositions ($highlights)
	flattenHighlights (&$highlights, $excludedTypes=array())
	sortHighlights (&$highlights)

Public Attributes
const	LEVEL = 'level'
const	ACTION = 'action'
const	ENTRY = 'entry'
const	REF_TEXT_MAX_LENGTH = 100

Protected Member Functions
	getReferenceText (License $license, Highlight $highlight)

Private Member Functions
	getSplitPositions ($highlightInfos)
	addHighlightingLayer (&$highlightEntries, &$splitPositions, $level)
	addAllSplitPositions (&$splitPositions, $level, $highlightEntry)
	addSingleSectionSplitPositions (&$splitPositions, $start, $end, $level, $highlightEntry)
	startAndLengthFirstSorter (Highlight $a, Highlight $b)
	splitPositionEntrySorter (SplitPosition $a, SplitPosition $b)
	compare ($a, $b)
	sortSplitPositionEntries (&$splitPositions)

Private Attributes
	$licenseDao

Detailed Description

Definition at line 16 of file HighlightProcessor.php.

Member Function Documentation

addAllSplitPositions()

Fossology\Lib\View\HighlightProcessor::addAllSplitPositions ( &  $splitPositions,   $level,   $highlightEntry  )

private

Parameters

	$splitPositions
	$level
Highlight	$highlightEntry

Returns

mixed

Definition at line 176 of file HighlightProcessor.php.

addHighlightingLayer()

Fossology\Lib\View\HighlightProcessor::addHighlightingLayer ( &  $highlightEntries, &  $splitPositions,   $level  )

private

Parameters

Highlight[]	$highlightEntries
	$splitPositions
	$level

Returns

array

Definition at line 151 of file HighlightProcessor.php.

addSingleSectionSplitPositions()

Fossology\Lib\View\HighlightProcessor::addSingleSectionSplitPositions ( &  $splitPositions,   $start,   $end,   $level,   $highlightEntry  )

private

Parameters

$splitPositions
$start
$end
$level
$highlightEntry

Definition at line 198 of file HighlightProcessor.php.

calculateSplitPositions()

Fossology\Lib\View\HighlightProcessor::calculateSplitPositions

(

$highlights

)

Parameters

Highlight[]

$highlights

Returns

array

Definition at line 73 of file HighlightProcessor.php.

flattenHighlights()

Fossology\Lib\View\HighlightProcessor::flattenHighlights	(	&	$highlights,
			$excludedTypes = array()
	)

Parameters

Highlight[]	$highlights
string[]	$excludedTypes

Highlight[] $highlights

Definition at line 93 of file HighlightProcessor.php.

getReferenceText()

Fossology\Lib\View\HighlightProcessor::getReferenceText ( License  $license, Highlight  $highlight  )

protected

Parameters

License	$license
Highlight	$highlight

Returns

string

Definition at line 62 of file HighlightProcessor.php.

getSplitPositions()

Fossology\Lib\View\HighlightProcessor::getSplitPositions (   $highlightInfos )

private

Parameters

$highlightInfos

Returns

mixed

Definition at line 134 of file HighlightProcessor.php.

sortHighlights()

Fossology\Lib\View\HighlightProcessor::sortHighlights

(

&

$highlights

)

Parameters

$highlights

Definition at line 123 of file HighlightProcessor.php.

sortSplitPositionEntries()

Fossology\Lib\View\HighlightProcessor::sortSplitPositionEntries ( &  $splitPositions )

private

Parameters

$splitPositions

Returns

void

Definition at line 274 of file HighlightProcessor.php.

startAndLengthFirstSorter()

Fossology\Lib\View\HighlightProcessor::startAndLengthFirstSorter ( Highlight  $a, Highlight  $b  )

private

/brief user defined auxilary function for sorting

Definition at line 212 of file HighlightProcessor.php.

---

The documentation for this class was generated from the following file:

• src/lib/php/View/HighlightProcessor.php