TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Linkvalidator\LinkAnalyzer Class Reference

Public Member Functions

 __construct ()
 
 init (array $searchField, $pid, $tsConfig)
 
 getLinkStatistics ($checkOptions=[], $considerHidden=false)
 
 getTSConfig ()
 
 getLinkCounts ($curPage)
 
 extGetTreeList ($id, $depth, $begin=0, $permsClause, $considerHidden=false)
 
 getRootLineIsHidden (array $pageInfo)
 

Protected Member Functions

 emitBeforeAnalyzeRecordSignal ($results, $record, $table, $fields)
 
 getSignalSlotDispatcher ()
 
 getObjectManager ()
 
 getDatabaseConnection ()
 
 getLanguageService ()
 

Protected Attributes

 $searchFields = []
 
 $pidList = ''
 
 $linkCounts = []
 
 $brokenLinkCounts = []
 
 $recordsWithBrokenLinks = []
 
 $hookObjectsArr = []
 
 $extPageInTreeInfo = []
 
 $recordReference = ''
 
 $pageWithAnchor = ''
 
 $tsConfig = []
 

Detailed Description

This class provides Processing plugin implementation

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 100 of file LinkAnalyzer.php.

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

Member Function Documentation

◆ emitBeforeAnalyzeRecordSignal()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::emitBeforeAnalyzeRecordSignal (   $results,
  $record,
  $table,
  $fields 
)
protected

Emits a signal before the record is analyzed

Parameters
array$resultsArray of broken links
array$recordRecord to analyse
string$tableTable name of the record
array$fieldsArray of fields to analyze
Returns
array

Definition at line 489 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\getSignalSlotDispatcher().

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

◆ 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
int$idStart page id
int$depthDepth to traverse down the page tree.
int$beginis an optional integer that determines at which
string$permsClausePerms clause
bool$considerHiddenWhether to consider hidden pages or not
Returns
string Returns the list with a comma in the end (if any pages selected!)

Definition at line 425 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\getDatabaseConnection().

◆ getDatabaseConnection()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getDatabaseConnection ( )
protected
Returns

Definition at line 517 of file LinkAnalyzer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\extGetTreeList(), TYPO3\CMS\Linkvalidator\LinkAnalyzer\getLinkCounts(), TYPO3\CMS\Linkvalidator\LinkAnalyzer\getLinkStatistics(), and TYPO3\CMS\Linkvalidator\LinkAnalyzer\getRootLineIsHidden().

◆ getLanguageService()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getLanguageService ( )
protected
Returns
LanguageService

Definition at line 525 of file LinkAnalyzer.php.

References $GLOBALS.

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

◆ getLinkCounts()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getLinkCounts (   $curPage)

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

Parameters
string$curPageComma separated list of page uids
Returns
array Marker array with the number of links found

Definition at line 387 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\getDatabaseConnection().

◆ getLinkStatistics()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getLinkStatistics (   $checkOptions = [],
  $considerHidden = false 
)

Find all supported broken links and store them in tx_linkvalidator_link

Parameters
array$checkOptionsList of hook object to activate
bool$considerHiddenDefines whether to look into hidden fields
Returns
void

Definition at line 133 of file LinkAnalyzer.php.

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

◆ getObjectManager()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getObjectManager ( )
protected
Returns

Definition at line 509 of file LinkAnalyzer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ getRootLineIsHidden()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getRootLineIsHidden ( array  $pageInfo)

Check if rootline contains a hidden page

Parameters
array$pageInfoArray with uid, title, hidden, extendToSubpages from pages table
Returns
bool TRUE if rootline contains a hidden page, FALSE if not

Definition at line 458 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\getDatabaseConnection().

◆ getSignalSlotDispatcher()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getSignalSlotDispatcher ( )
protected
Returns

Definition at line 501 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\getObjectManager().

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

◆ getTSConfig()

TYPO3\CMS\Linkvalidator\LinkAnalyzer::getTSConfig ( )

Returns the TSConfig that was passed to the init() method.

This can be used by link checkers that get a reference of this object passed to the checkLink() method.

Returns
array

Definition at line 280 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\$tsConfig.

◆ init()

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

Store all the needed configuration values in class variables

Parameters
array$searchFieldList of fields in which to search for links
string$pidList of comma separated page uids in which to search for links
array$tsConfigThe currently active TSConfig.
Returns
void

Definition at line 119 of file LinkAnalyzer.php.

References TYPO3\CMS\Linkvalidator\LinkAnalyzer\$tsConfig.

Member Data Documentation

◆ $brokenLinkCounts

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$brokenLinkCounts = []
protected

Definition at line 53 of file LinkAnalyzer.php.

◆ $extPageInTreeInfo

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$extPageInTreeInfo = []
protected

Definition at line 74 of file LinkAnalyzer.php.

◆ $hookObjectsArr

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$hookObjectsArr = []
protected

Definition at line 67 of file LinkAnalyzer.php.

◆ $linkCounts

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$linkCounts = []
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 = []
protected

Definition at line 60 of file LinkAnalyzer.php.

◆ $searchFields

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$searchFields = []
protected

Definition at line 32 of file LinkAnalyzer.php.

◆ $tsConfig

TYPO3\CMS\Linkvalidator\LinkAnalyzer::$tsConfig = []
protected

Definition at line 95 of file LinkAnalyzer.php.

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\getTSConfig(), and TYPO3\CMS\Linkvalidator\LinkAnalyzer\init().