‪TYPO3CMS  10.4
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration Class Reference

Public Member Functions

 __construct (FileLocation $fileLocation, string $fileName, bool $fail=false)
 
 buildContent ()
 
 matches (ResponseInterface $response)
 
StatusMessage[] getMismatches (ResponseInterface $response)
 
 withExpectedContentType (string $contentType)
 
 withUnexpectedContentType (string $contentType)
 
 withExpectedContent (string $content)
 
 withUnexpectedContent (string $content)
 
 withHandler (\Closure $handler)
 
 withBuildFlags (int $buildFlags)
 
FileLocation getFileLocation ()
 
string getFileName ()
 
string getUrl ()
 
bool shallFail ()
 
string null getExpectedContentType ()
 
string null getUnexpectedContentType ()
 
string null getExpectedContent ()
 
string null getUnexpectedContent ()
 

Public Attributes

const FLAG_BUILD_HTML = 1
 
const FLAG_BUILD_PHP = 2
 
const FLAG_BUILD_SVG = 4
 
const FLAG_BUILD_HTML_DOCUMENT = 64
 
const FLAG_BUILD_SVG_DOCUMENT = 128
 

Protected Attributes

FileLocation $fileLocation
 
string $fileName
 
bool $fail
 
string null $expectedContentType
 
string null $unexpectedContentType
 
string null $expectedContent
 
string null $unexpectedContent
 
Closure $handler
 
int $buildFlags = self::FLAG_BUILD_HTML | self::FLAG_BUILD_HTML_DOCUMENT
 

Detailed Description

Declares contents on server response expectations on a static file.

should only be used from within TYPO3 Core

Definition at line 27 of file FileDeclaration.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::__construct ( FileLocation  $fileLocation,
string  $fileName,
bool  $fail = false 
)

Definition at line 71 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fail, TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fileLocation, and TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fileName.

Member Function Documentation

◆ buildContent()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::buildContent ( )

Definition at line 78 of file FileDeclaration.php.

◆ getExpectedContent()

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getExpectedContent ( )
Returns
‪string|null

Definition at line 251 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$expectedContent.

◆ getExpectedContentType()

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getExpectedContentType ( )
Returns
‪string|null

Definition at line 235 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$expectedContentType.

◆ getFileLocation()

FileLocation TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getFileLocation ( )
Returns
‪FileLocation

Definition at line 203 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fileLocation.

◆ getFileName()

string TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getFileName ( )
Returns
‪string

Definition at line 211 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fileName.

◆ getMismatches()

StatusMessage [] TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getMismatches ( ResponseInterface  $response)
Parameters
ResponseInterface$response
Returns
‪StatusMessage[]

Definition at line 112 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\ServerResponseCheck\createMismatchMessage(), and TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\matches().

◆ getUnexpectedContent()

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getUnexpectedContent ( )
Returns
‪string|null

Definition at line 259 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$unexpectedContent.

◆ getUnexpectedContentType()

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getUnexpectedContentType ( )
Returns
‪string|null

Definition at line 243 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$unexpectedContentType.

◆ getUrl()

string TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::getUrl ( )
Returns
‪string

Definition at line 219 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fileName.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\ServerResponseCheck\createMismatchMessage().

◆ matches()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::matches ( ResponseInterface  $response)

Definition at line 103 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getMismatches().

◆ shallFail()

bool TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::shallFail ( )
Returns
‪bool

Definition at line 227 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$fail.

◆ withBuildFlags()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::withBuildFlags ( int  $buildFlags)

Definition at line 193 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$buildFlags.

◆ withExpectedContent()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::withExpectedContent ( string  $content)

Definition at line 172 of file FileDeclaration.php.

◆ withExpectedContentType()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::withExpectedContentType ( string  $contentType)

Definition at line 158 of file FileDeclaration.php.

◆ withHandler()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::withHandler ( \Closure  $handler)

Definition at line 186 of file FileDeclaration.php.

References TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\$handler.

◆ withUnexpectedContent()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::withUnexpectedContent ( string  $content)

Definition at line 179 of file FileDeclaration.php.

◆ withUnexpectedContentType()

TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::withUnexpectedContentType ( string  $contentType)

Definition at line 165 of file FileDeclaration.php.

Member Data Documentation

◆ $buildFlags

int TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$buildFlags = self::FLAG_BUILD_HTML | self::FLAG_BUILD_HTML_DOCUMENT
protected

Definition at line 69 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\withBuildFlags().

◆ $expectedContent

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$expectedContent
protected

Definition at line 57 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getExpectedContent().

◆ $expectedContentType

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$expectedContentType
protected

Definition at line 49 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getExpectedContentType().

◆ $fail

bool TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$fail
protected

Definition at line 45 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\__construct(), and TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\shallFail().

◆ $fileLocation

FileLocation TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$fileLocation
protected

Definition at line 37 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\__construct(), and TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getFileLocation().

◆ $fileName

string TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$fileName
protected

Definition at line 41 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\__construct(), TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getFileName(), and TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getUrl().

◆ $handler

Closure TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$handler
protected

Definition at line 65 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\withHandler().

◆ $unexpectedContent

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$unexpectedContent
protected

Definition at line 61 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getUnexpectedContent().

◆ $unexpectedContentType

string null TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::$unexpectedContentType
protected

Definition at line 53 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration\getUnexpectedContentType().

◆ FLAG_BUILD_HTML

const TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::FLAG_BUILD_HTML = 1

Definition at line 29 of file FileDeclaration.php.

◆ FLAG_BUILD_HTML_DOCUMENT

const TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::FLAG_BUILD_HTML_DOCUMENT = 64

Definition at line 32 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\ServerResponseCheck\initializeFileDeclarations().

◆ FLAG_BUILD_PHP

const TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::FLAG_BUILD_PHP = 2

Definition at line 30 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\ServerResponseCheck\initializeFileDeclarations().

◆ FLAG_BUILD_SVG

const TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::FLAG_BUILD_SVG = 4

Definition at line 31 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\ServerResponseCheck\initializeFileDeclarations().

◆ FLAG_BUILD_SVG_DOCUMENT

const TYPO3\CMS\Install\SystemEnvironment\ServerResponse\FileDeclaration::FLAG_BUILD_SVG_DOCUMENT = 128

Definition at line 33 of file FileDeclaration.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\ServerResponse\ServerResponseCheck\initializeFileDeclarations().