TYPO3\CMS\Linkvalidator\LinkAnalyzer Class Reference

Inheritance diagram for TYPO3\CMS\Linkvalidator\LinkAnalyzer:

Public Member Functions
	__construct ()
	init (array $searchField, $pid)
	getLinkStatistics ($checkOptions=array(), $considerHidden=FALSE)
	getLinkCounts ($curPage)
	extGetTreeList ($id, $depth, $begin=0, $permsClause, $considerHidden=FALSE)
	getRootLineIsHidden (array $pageInfo)

Protected Attributes
	$searchFields = array()
	$pidList = ''
	$linkCounts = array()
	$brokenLinkCounts = array()
	$recordsWithBrokenLinks = array()
	$hookObjectsArr = array()
	$extPageInTreeInfo = array()
	$recordReference = ''
	$pageWithAnchor = ''

Detailed Description

This class provides Processing plugin implementation

Author

Michael Miousse micha.nosp@m.el.m.nosp@m.iouss.nosp@m.e@in.nosp@m.foglo.nosp@m.be.c.nosp@m.a

Jochen Rieger j.rie.nosp@m.ger@.nosp@m.conne.nosp@m.cta..nosp@m.ag

Definition at line 25 of file LinkAnalyzer.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::__construct

(

)

Fill hookObjectsArr with different link types and possible XClasses.

Definition at line 93 of file LinkAnalyzer.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Member Function Documentation

extGetTreeList()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::extGetTreeList	(		$id,
			$depth,
			$begin = 0,
			$permsClause,
			$considerHidden = FALSE
	)

Calls TYPO3::extGetTreeList. Although this duplicates the function TYPO3::extGetTreeList this is necessary to create the object that is used recursively by the original function.

Generates a list of page uids from $id. List does not include $id itself. The only pages excluded from the list are deleted pages.

Parameters

integer	$id	Start page id
integer	$depth	Depth to traverse down the page tree.
integer	$begin	is an optional integer that determines at which
string	$permsClause	Perms clause
boolean	$considerHidden	Whether to consider hidden pages or not

Returns

string Returns the list with a comma in the end (if any pages selected!)

Definition at line 390 of file LinkAnalyzer.php.

References $GLOBALS.

getLinkCounts()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getLinkCounts

(

$curPage

)

Fill a marker array with the number of links found in a list of pages

Parameters

string

$curPage

Comma separated list of page uids

Returns

array Marker array with the number of links found

Definition at line 355 of file LinkAnalyzer.php.

References $GLOBALS.

getLinkStatistics()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getLinkStatistics	(		$checkOptions = array(),
			$considerHidden = FALSE
	)

Find all supported broken links and store them in tx_linkvalidator_link

Parameters

array	$checkOptions	List of hook object to activate
boolean	$considerHidden	Defines whether to look into hidden fields

Returns

void

Definition at line 122 of file LinkAnalyzer.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\LinkAnalyzer\$pageWithAnchor, TYPO3\CMS\Linkvalidator\LinkAnalyzer\$pidList, TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\explodeSoftRefParserList(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Backend\Utility\BackendUtility\softRefParserObj().

getRootLineIsHidden()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getRootLineIsHidden

(

array

$pageInfo

)

Check if rootline contains a hidden page

Parameters

array

$pageInfo

Array with uid, title, hidden, extendToSubpages from pages table

Returns

boolean TRUE if rootline contains a hidden page, FALSE if not

Definition at line 420 of file LinkAnalyzer.php.

References $GLOBALS.

init()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::init	(	array	$searchField,
			$pid
	)

Store all the needed configuration values in class variables

Parameters

array	$searchField	List of fields in which to search for links
string	$pid	List of comma separated page uids in which to search for links

Returns

void

Definition at line 110 of file LinkAnalyzer.php.

Member Data Documentation

$brokenLinkCounts

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$brokenLinkCounts = array()

protected

Definition at line 53 of file LinkAnalyzer.php.

$extPageInTreeInfo

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$extPageInTreeInfo = array()

protected

Definition at line 74 of file LinkAnalyzer.php.

$hookObjectsArr

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$hookObjectsArr = array()

protected

Definition at line 67 of file LinkAnalyzer.php.

$linkCounts

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$linkCounts = array()

protected

Definition at line 46 of file LinkAnalyzer.php.

$pageWithAnchor

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$pageWithAnchor = ''

protected

Definition at line 88 of file LinkAnalyzer.php.

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\getLinkStatistics().

$pidList

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$pidList = ''

protected

Definition at line 39 of file LinkAnalyzer.php.

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\getLinkStatistics().

$recordReference

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$recordReference = ''

protected

Definition at line 81 of file LinkAnalyzer.php.

$recordsWithBrokenLinks

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$recordsWithBrokenLinks = array()

protected

Definition at line 60 of file LinkAnalyzer.php.

$searchFields

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$searchFields = array()

protected

Definition at line 32 of file LinkAnalyzer.php.