Fossology\Lib\Data\Highlight Class Reference

Collaboration diagram for Fossology\Lib\Data\Highlight:

Public Member Functions
	__construct ($start, $end, $type, $refStart=-1, $refEnd=-1, $infoText="", $htmlElement=null)
	getStart ()
	getEnd ()
	getType ()
	setLicenseId ($licenseId)
	getLicenseId ()
	hasLicenseId ()
	isPersistent ()
	getRefStart ()
	getRefEnd ()
	getRefLength ()
	setInfoText ($infoText)
	getInfoText ()
	getHtmlElement ()
	getArray ()
	__toString ()

Public Attributes
const	MATCH = "M"
const	CHANGED = "MC"
const	ADDED = "MA"
const	DELETED = "MD"
const	SIGNATURE = "S"
const	KEYWORD = "K"
const	BULK = "B"
const	COPYRIGHT = "C"
const	URL = "U"
const	EMAIL = "E"
const	AUTHOR = "A"
const	IPRA = "I"
const	ECC = "X"
const	KEYWORDOTHERS = "KW"
const	UNDEFINED = "any"

Private Member Functions
	hasRef ()

Private Attributes
	$start
	$end
	$type
	$licenseId
	$refStart
	$refEnd
	$infoText
	$htmlElement

Detailed Description

Definition at line 13 of file Highlight.php.

Constructor & Destructor Documentation

__construct()

Fossology\Lib\Data\Highlight::__construct	(		$start,
			$end,
			$type,
			$refStart = -1,
			$refEnd = -1,
			$infoText = "",
			$htmlElement = null
	)

Parameters

int	$start
int	$end
string	$type
int	$refStart
int	$refEnd
string	$infoText
null | HtmlElement	$htmlElement

Definition at line 74 of file Highlight.php.

Member Function Documentation

getArray()

Fossology\Lib\Data\Highlight::getArray

(

)

Get Highlight element as associative array

Returns

array

Definition at line 202 of file Highlight.php.

getEnd()

Fossology\Lib\Data\Highlight::getEnd

(

)

Returns

int

Definition at line 98 of file Highlight.php.

getHtmlElement()

Fossology\Lib\Data\Highlight::getHtmlElement

(

)

Returns

null|HtmlElement

Definition at line 193 of file Highlight.php.

getInfoText()

Fossology\Lib\Data\Highlight::getInfoText

(

)

Returns

string

Definition at line 185 of file Highlight.php.

getLicenseId()

Fossology\Lib\Data\Highlight::getLicenseId

(

)

Returns

int

Definition at line 123 of file Highlight.php.

getRefEnd()

Fossology\Lib\Data\Highlight::getRefEnd

(

)

Returns

int

Definition at line 161 of file Highlight.php.

getRefLength()

Fossology\Lib\Data\Highlight::getRefLength

(

)

Returns

int

Definition at line 169 of file Highlight.php.

getRefStart()

Fossology\Lib\Data\Highlight::getRefStart

(

)

Returns

int

Definition at line 148 of file Highlight.php.

getStart()

Fossology\Lib\Data\Highlight::getStart

(

)

Returns

int

Definition at line 90 of file Highlight.php.

getType()

Fossology\Lib\Data\Highlight::getType

(

)

Returns

string

Definition at line 106 of file Highlight.php.

hasLicenseId()

Fossology\Lib\Data\Highlight::hasLicenseId

(

)

Returns

boolean

Definition at line 131 of file Highlight.php.

isPersistent()

Fossology\Lib\Data\Highlight::isPersistent

(

)

Returns

boolean

Definition at line 139 of file Highlight.php.

setInfoText()

Fossology\Lib\Data\Highlight::setInfoText

(

$infoText

)

Parameters

string

$infoText

Definition at line 177 of file Highlight.php.

setLicenseId()

Fossology\Lib\Data\Highlight::setLicenseId

(

$licenseId

)

Parameters

$licenseId

Returns

void

Definition at line 115 of file Highlight.php.

---

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

• src/lib/php/Data/Highlight.php