WorkerLinkChecker class - Documentation for SproutCMS

Info Page:

Page options:

class WorkerLinkChecker

Name	Visibility	Description
`$job_name`
`$metric_names`

Name	Visibility	Description
__construct	public	Constructor
buildCsv	private	Return a CSV for the specified errors
checkPage	private	Checks a single page
checkUrl	public	Returns TRUE if the given URL is found, a string of the error message if the URL was not found.
getMetricNames	public	Gets the job name
getName	public	Gets the job name
run	public	Do stuff

void $WorkerBase->__construct ( );

Constructor

Manually checks if the method 'run' exists,
because it's a varags,
so can't use the normal abstract function approach

unknown $WorkerLinkChecker->buildCsv ( mixed &$errs );

Return a CSV for the specified errors

unknown $WorkerLinkChecker->checkPage ( mixed &$row , mixed &$errs );

Checks a single page

unknown $WorkerLinkChecker->checkUrl ( mixed $href [, mixed $subsite_id ] );

Returns TRUE if the given URL is found, a string of the error message if the URL was not found.

unknown $WorkerBase->getMetricNames ( );

Gets the job name

unknown $WorkerBase->getName ( );

Gets the job name

void $WorkerLinkChecker->run ( [ mixed $email_address ] );

Do stuff