‪TYPO3CMS  9.5
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
 
bool $isError
 
string $baseDir = 'typo3/sysext/core/Documentation/Changelog'
 

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 49 of file validateRstFiles.php.

References $dir.

Member Function Documentation

◆ clearMessages()

validateRstFiles::clearMessages ( )
protected

Definition at line 115 of file validateRstFiles.php.

Referenced by validate().

◆ findFiles()

validateRstFiles::findFiles ( )

Definition at line 102 of file validateRstFiles.php.

References $finder.

Referenced by validate().

◆ validate()

validateRstFiles::validate ( )

◆ validateContent()

validateRstFiles::validateContent ( string  $fileContent)
protected

Definition at line 135 of file validateRstFiles.php.

Referenced by validate().

◆ validateLastLine()

validateRstFiles::validateLastLine ( string  $line)
protected

Definition at line 161 of file validateRstFiles.php.

Referenced by validate().

◆ validateLastLineByFilename()

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

Definition at line 181 of file validateRstFiles.php.

Referenced by validate().

Member Data Documentation

◆ $baseDir

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

Definition at line 47 of file validateRstFiles.php.

◆ $isError

bool validateRstFiles::$isError
protected

Definition at line 43 of file validateRstFiles.php.

◆ $messages

array validateRstFiles::$messages
protected

Definition at line 39 of file validateRstFiles.php.