validateRstFiles Class Reference

Public Member Functions
	__construct (string $dir='')
	validate ()
	findFiles ()

Protected Member Functions
	clearMessages ()
	validateContent (string $fileContent)
	validateLastLine (string $line)
	validateLastLineByFilename (string $path, string $lastLine)

Protected Attributes
array	$messages
array	$linkTargets = []
bool	$isError
string	$baseDir = 'typo3/sysext/core/Documentation/Changelog'

Private Member Functions
	setError (array $config)
	validateLinkTarget (string $fileContent)

Detailed Description

Check ReST files for integrity. If errors are found, they will be output on stdout and the program will exit with exit code 1.

Optional arguments: -d <directory>

By default, the standard path is used. You can override this for testing purposes.

Definition at line 35 of file validateRstFiles.php.

Constructor & Destructor Documentation

__construct()

validateRstFiles::__construct

(

string

$dir = ''

)

Definition at line 51 of file validateRstFiles.php.

References $dir.

Member Function Documentation

clearMessages()

validateRstFiles::clearMessages ( )

protected

Definition at line 113 of file validateRstFiles.php.

Referenced by validate().

findFiles()

validateRstFiles::findFiles

(

)

Definition at line 100 of file validateRstFiles.php.

References $finder.

Referenced by validate().

setError()

validateRstFiles::setError ( array  $config )

private

Definition at line 171 of file validateRstFiles.php.

Referenced by validateContent(), and validateLinkTarget().

validate()

validateRstFiles::validate

(

)

Definition at line 58 of file validateRstFiles.php.

References $finder, clearMessages(), findFiles(), validateContent(), validateLastLine(), and validateLastLineByFilename().

validateContent()

validateRstFiles::validateContent ( string  $fileContent )

protected

Definition at line 133 of file validateRstFiles.php.

References setError(), and validateLinkTarget().

Referenced by validate().

validateLastLine()

validateRstFiles::validateLastLine ( string  $line )

protected

Definition at line 205 of file validateRstFiles.php.

Referenced by validate().

validateLastLineByFilename()

validateRstFiles::validateLastLineByFilename ( string  $path, string  $lastLine  )

protected

Definition at line 225 of file validateRstFiles.php.

Referenced by validate().

validateLinkTarget()

validateRstFiles::validateLinkTarget ( string  $fileContent )

private

Definition at line 178 of file validateRstFiles.php.

References setError().

Referenced by validateContent().

Member Data Documentation

$baseDir

string validateRstFiles::$baseDir = 'typo3/sysext/core/Documentation/Changelog'

protected

Definition at line 49 of file validateRstFiles.php.

$isError

bool validateRstFiles::$isError

protected

Definition at line 45 of file validateRstFiles.php.

$linkTargets

array validateRstFiles::$linkTargets = []

protected

Definition at line 41 of file validateRstFiles.php.

$messages

array validateRstFiles::$messages

protected

Definition at line 39 of file validateRstFiles.php.