TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Linkvalidator\Task\ValidatorTask Class Reference
Inheritance diagram for TYPO3\CMS\Linkvalidator\Task\ValidatorTask:
TYPO3\CMS\Scheduler\Task\AbstractTask

Public Member Functions

 getEmail ()
 
 setEmail ($email)
 
 getEmailOnBrokenLinkOnly ()
 
 setEmailOnBrokenLinkOnly ($emailOnBrokenLinkOnly)
 
 getPage ()
 
 setPage ($page)
 
 getDepth ()
 
 setDepth ($depth)
 
 getEmailTemplateFile ()
 
 setEmailTemplateFile ($emailTemplateFile)
 
 getConfiguration ()
 
 setConfiguration ($configuration)
 
 execute ()
 
 getAdditionalInformation ()
 
- Public Member Functions inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
 __construct ()
 
 execute ()
 
 getAdditionalInformation ()
 
 setTaskUid ($id)
 
 getTaskUid ()
 
 getTaskTitle ()
 
 getTaskDescription ()
 
 getTaskClassName ()
 
 isDisabled ()
 
 setDisabled ($flag)
 
 setExecutionTime ($timestamp)
 
 getTaskGroup ()
 
 setTaskGroup ($taskGroup)
 
 getExecutionTime ()
 
 setDescription ($description)
 
 getDescription ()
 
 setScheduler ()
 
 unsetScheduler ()
 
 setExecution (\TYPO3\CMS\Scheduler\Execution $execution)
 
 getExecution ()
 
 getNextDueExecution ()
 
 areMultipleExecutionsAllowed ()
 
 isExecutionRunning ()
 
 markExecution ()
 
 unmarkExecution ($executionID, \Exception $failure=null)
 
 unmarkAllExecutions ()
 
 save ()
 
 stop ()
 
 remove ()
 
 getType ()
 

Protected Member Functions

 loadModTsConfig ($page)
 
 getSearchField (array $modTS)
 
 getLinkTypes (array $modTS)
 
 buildMail ($curPage, $pageList, array $markerArray, array $oldBrokenLink)
 
 setCliArguments ()
 
 getLanguageService ()
 
 getDatabaseConnection ()
 

Protected Attributes

 $sleepTime
 
 $sleepAfterFinish
 
 $countInARun
 
 $totalBrokenLink = 0
 
 $oldTotalBrokenLink = 0
 
 $templateMail
 
 $configuration = []
 
 $isDifferentToLastRun
 
 $emailTemplateFile
 
 $depth
 
 $page
 
 $email
 
 $emailOnBrokenLinkOnly
 
 $templateService
 
- Protected Attributes inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
 $scheduler
 
 $taskUid
 
 $disabled = false
 
 $execution
 
 $executionTime = 0
 
 $description = ''
 
 $taskGroup
 

Additional Inherited Members

- Public Attributes inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
const TYPE_SINGLE = 1
 
const TYPE_RECURRING = 2
 

Detailed Description

This class provides Scheduler plugin implementation

Definition at line 30 of file ValidatorTask.php.

Member Function Documentation

◆ buildMail()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::buildMail (   $curPage,
  $pageList,
array  $markerArray,
array  $oldBrokenLink 
)
protected

Build the mail content

Parameters
int$curPageId of the current page
string$pageListList of pages id
array$markerArrayArray of markers
array$oldBrokenLinkMarker array with the number of link found
Returns
string Content of the mail

Definition at line 509 of file ValidatorTask.php.

References $GLOBALS, $params, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle().

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute().

◆ execute()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::execute ( )

Function execute from the Scheduler

Returns
bool TRUE on successful execution, FALSE on error
Exceptions

Definition at line 254 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$page, TYPO3\CMS\Linkvalidator\Task\ValidatorTask\buildMail(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLanguageService(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getSearchField(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\loadModTsConfig(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Scheduler\Task\AbstractTask\save(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setCliArguments(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ getAdditionalInformation()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getAdditionalInformation ( )

Returns the most important properties of the link validator task as a comma separated string that will be displayed in the scheduler module.

Returns
string

Definition at line 557 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$depth, TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$page, TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getDepth(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getEmail(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLanguageService(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getPage(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle().

◆ getConfiguration()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getConfiguration ( )

Get the value of the protected property configuration

Returns
array specific TSconfig for this task

Definition at line 232 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$configuration.

◆ getDatabaseConnection()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getDatabaseConnection ( )
protected
Returns

Definition at line 613 of file ValidatorTask.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute().

◆ getDepth()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getDepth ( )

Get the value of the protected property depth

Returns
int Level of pages the task should check

Definition at line 190 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$depth.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getAdditionalInformation().

◆ getEmail()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getEmail ( )

Get the value of the protected property email

Returns
string Email address to which an email report is sent

Definition at line 127 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$email.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getAdditionalInformation().

◆ getEmailOnBrokenLinkOnly()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getEmailOnBrokenLinkOnly ( )

Get the value of the protected property emailOnBrokenLinkOnly

Returns
bool Whether to send an email, if new broken links were found

Definition at line 148 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$emailOnBrokenLinkOnly.

◆ getEmailTemplateFile()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getEmailTemplateFile ( )

Get the value of the protected property emailTemplateFile

Returns
string Template to be used for the email

Definition at line 211 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$emailTemplateFile.

◆ getLanguageService()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getLanguageService ( )
protected
Returns
LanguageService

Definition at line 605 of file ValidatorTask.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getAdditionalInformation(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\loadModTsConfig().

◆ getLinkTypes()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getLinkTypes ( array  $modTS)
protected

Get the list of linkTypes to parse in modTSconfig

Parameters
array$modTSmod.linkvalidator TSconfig array
Returns
array $linkTypes list of link types

Definition at line 399 of file ValidatorTask.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$oldTotalBrokenLink, $params, TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$totalBrokenLink, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLanguageService(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFromAddress(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFromName(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Scheduler\Task\AbstractTask\save(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\validEmail().

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute().

◆ getPage()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getPage ( )

Get the value of the protected property page

Returns
int UID of the start page for this task

Definition at line 169 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$page.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getAdditionalInformation().

◆ getSearchField()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::getSearchField ( array  $modTS)
protected

Get the list of fields to parse in modTSconfig

Parameters
array$modTSmod.linkvalidator TSconfig array
Returns
array $searchFields List of fields

Definition at line 381 of file ValidatorTask.php.

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

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute().

◆ loadModTsConfig()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::loadModTsConfig (   $page)
protected

Get the linkvalidator modTSconfig for a page

Parameters
int$pageUid of the page
Returns
array $modTsConfig mod.linkvalidator TSconfig array
Exceptions

Definition at line 348 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$page, TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute().

◆ setCliArguments()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setCliArguments ( )
protected

Simulate cli call with setting the required options to the $_SERVER['argv']

Returns
void

Definition at line 586 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$countInARun, TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$sleepAfterFinish, and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$sleepTime.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute().

◆ setConfiguration()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setConfiguration (   $configuration)

Set the value of the private property configuration

Parameters
array$configurationspecific TSconfig for this task
Returns
void

Definition at line 243 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$configuration.

◆ setDepth()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setDepth (   $depth)

Set the value of the private property depth

Parameters
int$depthLevel of pages the task should check
Returns
void

Definition at line 201 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$depth.

◆ setEmail()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setEmail (   $email)

Set the value of the private property email.

Parameters
string$emailEmail address to which an email report is sent
Returns
void

Definition at line 138 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$email.

◆ setEmailOnBrokenLinkOnly()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setEmailOnBrokenLinkOnly (   $emailOnBrokenLinkOnly)

Set the value of the private property emailOnBrokenLinkOnly

Parameters
bool$emailOnBrokenLinkOnlyOnly send an email, if new broken links were found
Returns
void

Definition at line 159 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$emailOnBrokenLinkOnly.

◆ setEmailTemplateFile()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setEmailTemplateFile (   $emailTemplateFile)

Set the value of the private property emailTemplateFile

Parameters
string$emailTemplateFileTemplate to be used for the email
Returns
void

Definition at line 222 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$emailTemplateFile.

◆ setPage()

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::setPage (   $page)

Set the value of the private property page

Parameters
int$pageUID of the start page for this task.
Returns
void

Definition at line 180 of file ValidatorTask.php.

References TYPO3\CMS\Linkvalidator\Task\ValidatorTask\$page.

Member Data Documentation

◆ $configuration

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$configuration = []
protected

Definition at line 73 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getConfiguration(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setConfiguration().

◆ $countInARun

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$countInARun
protected

Definition at line 45 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setCliArguments().

◆ $depth

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$depth
protected

Definition at line 94 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getAdditionalInformation(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getDepth(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setDepth().

◆ $email

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$email
protected

Definition at line 108 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getEmail(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setEmail().

◆ $emailOnBrokenLinkOnly

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$emailOnBrokenLinkOnly
protected

Definition at line 115 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getEmailOnBrokenLinkOnly(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setEmailOnBrokenLinkOnly().

◆ $emailTemplateFile

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$emailTemplateFile
protected

Definition at line 87 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getEmailTemplateFile(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setEmailTemplateFile().

◆ $isDifferentToLastRun

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$isDifferentToLastRun
protected

Definition at line 80 of file ValidatorTask.php.

◆ $oldTotalBrokenLink

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$oldTotalBrokenLink = 0
protected

Definition at line 59 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes().

◆ $page

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$page
protected

Definition at line 101 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getAdditionalInformation(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getPage(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\loadModTsConfig(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setPage().

◆ $sleepAfterFinish

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$sleepAfterFinish
protected

Definition at line 40 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setCliArguments().

◆ $sleepTime

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$sleepTime
protected

Definition at line 35 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\setCliArguments().

◆ $templateMail

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$templateMail
protected

Definition at line 66 of file ValidatorTask.php.

◆ $templateService

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$templateService
protected

Definition at line 120 of file ValidatorTask.php.

◆ $totalBrokenLink

TYPO3\CMS\Linkvalidator\Task\ValidatorTask::$totalBrokenLink = 0
protected

Definition at line 52 of file ValidatorTask.php.

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes().