TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport Class Reference

Inheritance diagram for TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport:

Public Member Functions
	main ()
	modMenu ()
Public Member Functions inherited from TYPO3\CMS\Backend\Module\AbstractFunctionModule
	init (&$pObj, $conf)
	handleExternalFunctionValue ()
	incLocalLang ()
	checkExtObj ()
	extObjContent ()
	modMenu ()

Public Attributes
	$doc
Public Attributes inherited from TYPO3\CMS\Backend\Module\AbstractFunctionModule
	$pObj
	$thisPath = ''
	$localLangFile = 'locallang.php'
	$extClassConf
	$function_key = ''

Protected Member Functions
	createTabs ()
	initialize ()
	updateBrokenLinks ()
	flush ($form=FALSE)
	getLevelSelector ()
	renderBrokenLinksTable ()
	startTable ()
	renderTableRow ($table, array $row, $brokenLinksItemTemplate)
	getCheckOptions (array $brokenLinkOverView, $prefix='')
	loadHeaderData ()
	getDocHeaderButtons ()
	getShortcutButton ()
	getTemplateMarkers ()
	getTemplateMarkersCheck ()
	isCurrentUserAdmin ()

Protected Attributes
	$relativePath
	$pageRecord = array()
	$isAccessibleForCurrentUser = FALSE
	$searchLevel
	$processor
	$modTS = array()
	$availableOptions = array()
	$checkOpt = array()
	$updateListHtml
	$refreshListHtml
	$checkOptHtml
	$checkOptHtmlCheck
	$content
	$pageRenderer
	$hookObjectsArr = array()
	$checkAllHtml = ''

Detailed Description

Module 'Linkvalidator' for the 'linkvalidator' extension

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 26 of file LinkValidatorReport.php.

Member Function Documentation

createTabs()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::createTabs ( )

protected

Create TabPanel to split the report and the checkLink functions

Returns

void

Definition at line 225 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\flush().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

flush()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::flush (   $form = FALSE )

protected

Flushes the rendered content to the browser

Parameters

boolean

$form

Returns

string $content

Definition at line 358 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$content, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getDocHeaderButtons(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getTemplateMarkers(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getTemplateMarkersCheck().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createTabs().

getCheckOptions()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getCheckOptions ( array  $brokenLinkOverView,   $prefix = ''  )

protected

Builds the checkboxes out of the hooks array

Parameters

array	$brokenLinkOverView	Array of broken links information
string	$prefix

Returns

string code content

Definition at line 580 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

getDocHeaderButtons()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getDocHeaderButtons ( )

protected

Gets the buttons that shall be rendered in the docHeader

Returns

array Available buttons for the docHeader

Definition at line 648 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\flush().

getLevelSelector()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getLevelSelector ( )

protected

Builds the selector for the level of pages to search

Returns

string Html code of that selector

Definition at line 372 of file LinkValidatorReport.php.

References $GLOBALS.

getShortcutButton()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getShortcutButton ( )

protected

Gets the button to set a new shortcut in the backend (if current user is allowed to).

Returns

string HTML representation of the shortcut button

Definition at line 662 of file LinkValidatorReport.php.

getTemplateMarkers()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getTemplateMarkers ( )

protected

Gets the filled markers that are used in the HTML template

Returns

array The filled marker array

Definition at line 675 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\flush().

getTemplateMarkersCheck()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getTemplateMarkersCheck ( )

protected

Gets the filled markers that are used in the HTML template

Returns

array The filled marker array

Definition at line 695 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\flush().

initialize()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::initialize ( )

protected

Initializes the Module

Returns

void

Definition at line 276 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\loadHeaderData(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Backend\Utility\BackendUtility\readPageAccess().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

isCurrentUserAdmin()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::isCurrentUserAdmin ( )

protected

Determines whether the current user is an admin

Returns

boolean Whether the current user is admin

Definition at line 715 of file LinkValidatorReport.php.

loadHeaderData()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::loadHeaderData ( )

protected

Loads data in the HTML head section (e.g. JavaScript or stylesheet information)

Returns

void

Definition at line 638 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize().

main()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::main

(

)

Main method of modfuncreport

Returns

string Module content

Definition at line 145 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$searchLevel, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createTabs(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getCheckOptions(), TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\updateBrokenLinks().

modMenu()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::modMenu

(

)

Initializes the menu array internally

Returns

array Module menu

Definition at line 259 of file LinkValidatorReport.php.

References $GLOBALS.

renderBrokenLinksTable()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::renderBrokenLinksTable ( )

protected

Displays the table of broken links or a note if there were no broken links

Returns

string Content of the table or of the note

Definition at line 394 of file LinkValidatorReport.php.

References $GLOBALS, and TYPO3\CMS\Core\Html\HtmlParser\getSubpart().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\updateBrokenLinks().

renderTableRow()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::renderTableRow (   $table, array  $row,   $brokenLinksItemTemplate  )

protected

Displays one line of the broken links table

Parameters

string	$table	Name of database table
array	$row	Record row to be processed
array	$brokenLinksItemTemplate	Markup of the template to be used

Returns

string HTML of the rendered row

Definition at line 499 of file LinkValidatorReport.php.

startTable()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::startTable ( )

protected

Displays the table header of the table with the broken links

Returns

string Code of content

Definition at line 472 of file LinkValidatorReport.php.

updateBrokenLinks()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::updateBrokenLinks ( )

protected

Updates the table of stored broken links

Returns

void

Definition at line 304 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderBrokenLinksTable(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

Member Data Documentation

$availableOptions

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$availableOptions = array()

protected

Definition at line 78 of file LinkValidatorReport.php.

$checkAllHtml

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkAllHtml = ''

protected

Definition at line 138 of file LinkValidatorReport.php.

$checkOpt

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkOpt = array()

protected

Definition at line 86 of file LinkValidatorReport.php.

$checkOptHtml

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkOptHtml

protected

Definition at line 108 of file LinkValidatorReport.php.

$checkOptHtmlCheck

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkOptHtmlCheck

protected

Definition at line 116 of file LinkValidatorReport.php.

$content

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$content

protected

Definition at line 123 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\flush().

$doc

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$doc

Definition at line 31 of file LinkValidatorReport.php.

$hookObjectsArr

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$hookObjectsArr = array()

protected

Definition at line 133 of file LinkValidatorReport.php.

$isAccessibleForCurrentUser

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$isAccessibleForCurrentUser = FALSE

protected

Definition at line 50 of file LinkValidatorReport.php.

$modTS

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$modTS = array()

protected

Definition at line 71 of file LinkValidatorReport.php.

$pageRecord

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pageRecord = array()

protected

Definition at line 43 of file LinkValidatorReport.php.

$pageRenderer

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pageRenderer

protected

Definition at line 128 of file LinkValidatorReport.php.

$processor

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$processor

protected

Definition at line 64 of file LinkValidatorReport.php.

$refreshListHtml

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$refreshListHtml

protected

Definition at line 100 of file LinkValidatorReport.php.

$relativePath

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$relativePath

protected

Definition at line 36 of file LinkValidatorReport.php.

$searchLevel

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$searchLevel

protected

Definition at line 57 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

$updateListHtml

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$updateListHtml

protected

Definition at line 93 of file LinkValidatorReport.php.