FOSSology  3.2.0rc1
Open Source License Compliance by Open Source Software
Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Fossology\Lib\View\HighlightProcessor Class Reference
Collaboration diagram for Fossology\Lib\View\HighlightProcessor:
Collaboration graph

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 27 of file HighlightProcessor.php.

Member Function Documentation

Fossology\Lib\View\HighlightProcessor::addAllSplitPositions ( &  $splitPositions,
  $level,
  $highlightEntry 
)
private
Parameters
$splitPositions
$level
Highlight$highlightEntry
Returns
mixed

Definition at line 187 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::addHighlightingLayer ( &  $highlightEntries,
&  $splitPositions,
  $level 
)
private
Parameters
Highlight[]$highlightEntries
$splitPositions
$level
Returns
array

Definition at line 162 of file HighlightProcessor.php.

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

Definition at line 209 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::calculateSplitPositions (   $highlights)
Parameters
Highlight[]$highlights
Returns
array

Definition at line 84 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::flattenHighlights ( &  $highlights,
  $excludedTypes = array() 
)
Parameters
Highlight[]$highlights
string[]$excludedTypes

Highlight[] $highlights

Definition at line 104 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::getReferenceText ( License  $license,
Highlight  $highlight 
)
protected
Parameters
License$license
Highlight$highlight
Returns
string

Definition at line 73 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::getSplitPositions (   $highlightInfos)
private
Parameters
$highlightInfos
Returns
mixed

Definition at line 145 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::sortHighlights ( &  $highlights)
Parameters
$highlights

Definition at line 134 of file HighlightProcessor.php.

Fossology\Lib\View\HighlightProcessor::sortSplitPositionEntries ( &  $splitPositions)
private
Parameters
$splitPositions
Returns
void

Definition at line 285 of file HighlightProcessor.php.

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

/brief user defined auxilary function for sorting

Definition at line 223 of file HighlightProcessor.php.

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