‪TYPO3CMS  9.5
TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport Class Reference
Inheritance diagram for TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport:
TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait

Public Member Functions

 init ($pObj)
 
string main ()
 
 checkExtObj ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool __isset (string $propertyName)
 
mixed __get (string $propertyName)
 
 __set (string $propertyName, $propertyValue)
 
 __unset (string $propertyName)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed __call (string $methodName, array $arguments)
 

Protected Member Functions

string createTabs ()
 
 initialize ()
 
 updateBrokenLinks ()
 
 render ()
 
string flush ($form=false)
 
string getLevelSelector ($prefix='report')
 
string renderBrokenLinksTable ()
 
array getPageList ()
 
Statement getLinkValidatorBrokenLinks (array $pageList, array $linkTypes)
 
array getNoBrokenLinkMessage (array $brokenLinksMarker)
 
array startTable ()
 
string renderTableRow ($table, array $row, $brokenLinksItemTemplate)
 
string getCheckOptions (array $brokenLinkOverView, $prefix='report')
 
array getDocHeaderButtons ()
 
string getShortcutButton ()
 
array getTemplateMarkers ()
 
array getTemplateMarkersCheck ()
 
bool isCurrentUserAdmin ()
 
 extObjContent ()
 
LanguageService getLanguageService ()
 
BackendUserAuthentication getBackendUser ()
 
PageRenderer getPageRenderer ()
 
string addPageTranslationsToPageList (string $theList, string $permsClause)
 

Protected Attributes

DocumentTemplate $doc
 
array $pageRecord = array( )
 
bool $isAccessibleForCurrentUser = false
 
LinkAnalyzer $linkAnalyzer
 
array $modTS = array( )
 
array $availableOptions = array( )
 
array $searchLevel = array( 'report' => 0, 'check' => 0 )
 
array $checkOpt = array( 'report' => [], 'check' => [] )
 
array $checkOptionsHtml = array( 'report' => [], 'check' => [] )
 
string $content
 
TYPO3 CMS Linkvalidator Linktype LinktypeInterface[] $hookObjectsArr = array( )
 
string $updateListHtml = ''
 
string $refreshListHtml = ''
 
MarkerBasedTemplateService $templateService
 
IconFactory $iconFactory
 
 $id
 
InfoModuleController $pObj
 
 $extObj
 
string $localLangFile = ''
 
array $extClassConf
 
 $function_key = ''
 

Private Attributes

array $deprecatedPublicProperties
 
array $deprecatedPublicMethods
 

Detailed Description

Module 'Link validator' as sub module of Web -> Info

This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.

Definition at line 44 of file LinkValidatorReport.php.

Member Function Documentation

◆ addPageTranslationsToPageList()

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::addPageTranslationsToPageList ( string  $theList,
string  $permsClause 
)
protected

◆ checkExtObj()

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

Called from InfoModuleController until deprecation removal in TYPO3 v10.0

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 891 of file LinkValidatorReport.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getModuleData().

◆ createTabs()

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

Create tabs to split the report and the checkLink functions

Returns
‪string

Definition at line 304 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\flush(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService().

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

◆ extObjContent()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::extObjContent ( )
protected

Calls the main function inside ANOTHER sub-submodule which might exist.

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 906 of file LinkValidatorReport.php.

◆ flush()

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::flush (   $form = false)
protected

◆ getBackendUser()

◆ getCheckOptions()

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

Builds the checkboxes out of the hooks array

Parameters
array$brokenLinkOverView‪Array of broken links information
string$prefix‪"report" or "check" for "Report" and "Check links" tab
Returns
‪string code content

Definition at line 738 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

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

◆ getDocHeaderButtons()

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

References TYPO3\CMS\Backend\Utility\BackendUtility\cshItem(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getShortcutButton().

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

◆ getLanguageService()

◆ getLevelSelector()

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getLevelSelector (   $prefix = 'report')
protected

Builds the selector for the level of pages to search

Parameters
string$prefix‪Indicating if the selector is build for the "report" or "check" tab
Returns
‪string Html code of that selector

Definition at line 441 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$availableOptions, and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getTemplateMarkers(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getTemplateMarkersCheck().

◆ getLinkValidatorBrokenLinks()

Statement TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getLinkValidatorBrokenLinks ( array  $pageList,
array  $linkTypes 
)
protected

Prepare database query with pageList and keyOpt data.

Parameters
int[]$pageList‪Pages to check for broken links
string[]$linkTypes‪Link types to validate
Returns
‪Statement

Definition at line 553 of file LinkValidatorReport.php.

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

◆ getNoBrokenLinkMessage()

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getNoBrokenLinkMessage ( array  $brokenLinksMarker)
protected

Replace $brokenLinksMarker['NO_BROKEN_LINKS] with localized flashmessage

Parameters
array$brokenLinksMarker
Returns
‪array $brokenLinksMarker['NO_BROKEN_LINKS] replaced with flashmessage

Definition at line 599 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Core\Messaging\AbstractMessage\OK.

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

◆ getPageList()

◆ getPageRenderer()

PageRenderer TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getPageRenderer ( )
protected

◆ getShortcutButton()

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

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

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

◆ getTemplateMarkers()

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

◆ getTemplateMarkersCheck()

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

Gets the filled markers that are used in the HTML template Check Links tab

Returns
‪array The filled marker array

Definition at line 857 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLevelSelector().

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

◆ init()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::init (   $pObj)

Init, called from parent object

Parameters
InfoModuleController$pObj‪A reference to the parent (calling) object

Definition at line 187 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$pObj, and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService().

◆ initialize()

◆ isCurrentUserAdmin()

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

Determines whether the current user is an admin

Returns
‪bool Whether the current user is admin

Definition at line 881 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getBackendUser(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin().

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

◆ main()

◆ render()

◆ renderBrokenLinksTable()

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

◆ renderTableRow()

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

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordPath(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ startTable()

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

Displays the table header of the table with the broken links

Returns
‪array Code of content

Definition at line 623 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

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

◆ updateBrokenLinks()

Member Data Documentation

◆ $availableOptions

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

List of available link types to check defined in the TSconfig

Definition at line 96 of file LinkValidatorReport.php.

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

◆ $checkOpt

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkOpt = array( 'report' => [], 'check' => [] )
protected

List of link types currently chosen in the statistics table Used to show broken links of these types only For "Report" and "Check link" tab

Definition at line 111 of file LinkValidatorReport.php.

◆ $checkOptionsHtml

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkOptionsHtml = array( 'report' => [], 'check' => [] )
protected

Html for the statistics table with the checkboxes of the link types and the numbers of broken links For "Report" and "Check link" tab

Definition at line 119 of file LinkValidatorReport.php.

◆ $content

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

Complete content (html) to be displayed

Definition at line 125 of file LinkValidatorReport.php.

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

◆ $deprecatedPublicMethods

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$deprecatedPublicMethods
private
Initial value:
= array(
'extObjContent' => 'Using LinkValidatorReport::extObjContent() is deprecated, method will be removed in TYPO3 v10.0.',
)

Definition at line 60 of file LinkValidatorReport.php.

◆ $deprecatedPublicProperties

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$deprecatedPublicProperties
private
Initial value:
= array(
'pObj' => 'Using LinkValidatorReport::$pObj is deprecated and will not be possible anymore in TYPO3 v10.0.',
'doc' => 'Using LinkValidatorReport::$doc is deprecated and will not be possible anymore in TYPO3 v10.0.',
'function_key' => 'Using LinkValidatorReport::$function_key is deprecated, property will be removed in TYPO3 v10.0.',
'extClassConf' => 'Using LinkValidatorReport::$extClassConf is deprecated, property will be removed in TYPO3 v10.0.',
'localLangFile' => 'Using LinkValidatorReport::$localLangFile is deprecated, property will be removed in TYPO3 v10.0.',
'extObj' => 'Using LinkValidatorReport::$extObj is deprecated, property will be removed in TYPO3 v10.0.',
)

Definition at line 49 of file LinkValidatorReport.php.

◆ $doc

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

Definition at line 66 of file LinkValidatorReport.php.

◆ $extClassConf

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$extClassConf
protected

Contains module configuration parts from TBE_MODULES_EXT if found

See also
‪handleExternalFunctionValue()
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 175 of file LinkValidatorReport.php.

◆ $extObj

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$extObj
protected
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 159 of file LinkValidatorReport.php.

◆ $function_key

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$function_key = ''
protected
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 180 of file LinkValidatorReport.php.

◆ $hookObjectsArr

TYPO3 CMS Linkvalidator Linktype LinktypeInterface [] TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$hookObjectsArr = array( )
protected

Definition at line 129 of file LinkValidatorReport.php.

◆ $iconFactory

IconFactory TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$iconFactory
protected

Definition at line 145 of file LinkValidatorReport.php.

◆ $id

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$id
protected

◆ $isAccessibleForCurrentUser

bool TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$isAccessibleForCurrentUser = false
protected

Information, if the module is accessible for the current user or not

Definition at line 78 of file LinkValidatorReport.php.

◆ $linkAnalyzer

LinkAnalyzer TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$linkAnalyzer
protected

Link validation class

Definition at line 84 of file LinkValidatorReport.php.

◆ $localLangFile

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$localLangFile = ''
protected

Can be hardcoded to the name of a locallang.xlf file (from the same directory as the class file) to use/load and is included / added to $GLOBALS['LOCAL_LANG']

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 167 of file LinkValidatorReport.php.

◆ $modTS

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

TSconfig of the current module

Definition at line 90 of file LinkValidatorReport.php.

◆ $pageRecord

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

Information about the current page record

Definition at line 72 of file LinkValidatorReport.php.

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

◆ $pObj

InfoModuleController TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pObj
protected

Contains a reference to the parent calling object

Definition at line 154 of file LinkValidatorReport.php.

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

◆ $refreshListHtml

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$refreshListHtml = ''
protected

Definition at line 137 of file LinkValidatorReport.php.

◆ $searchLevel

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$searchLevel = array( 'report' => 0, 'check' => 0 )
protected

Depth for the recursive traversal of pages for the link validation For "Report" and "Check link" tab.

Definition at line 103 of file LinkValidatorReport.php.

◆ $templateService

MarkerBasedTemplateService TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$templateService
protected

Definition at line 141 of file LinkValidatorReport.php.

◆ $updateListHtml

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$updateListHtml = ''
protected

Definition at line 133 of file LinkValidatorReport.php.