TYPO3\CMS\Core\Domain\ConsumableString Class Reference

Inheritance diagram for TYPO3\CMS\Core\Domain\ConsumableString:

Public Member Functions
	__construct (string $value)
	__toString ()
	count ()
	consume ()

Public Attributes
readonly string	$value

Private Attributes
int	$counter = 0

Detailed Description

String wrapper that keeps track of how often the value was consumed. This can be used to make decisions during runtime, depending on whether a provided value actually has been used (e.g. in rendered content).

Definition at line 25 of file ConsumableString.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Domain\ConsumableString::__construct

(

string

$value

)

Reimplemented in TYPO3\CMS\Core\Security\ContentSecurityPolicy\ConsumableNonce.

Definition at line 33 of file ConsumableString.php.

References TYPO3\CMS\Core\Domain\ConsumableString\$value.

Member Function Documentation

__toString()

TYPO3\CMS\Core\Domain\ConsumableString::__toString

(

)

Definition at line 38 of file ConsumableString.php.

References TYPO3\CMS\Core\Domain\ConsumableString\consume().

consume()

TYPO3\CMS\Core\Domain\ConsumableString::consume

(

)

Definition at line 48 of file ConsumableString.php.

References TYPO3\CMS\Core\Domain\ConsumableString\$value.

Referenced by TYPO3\CMS\Core\Domain\ConsumableString\__toString(), and TYPO3\CMS\Adminpanel\Utility\HtmlDumper\setNonce().

count()

TYPO3\CMS\Core\Domain\ConsumableString::count

(

)

Definition at line 43 of file ConsumableString.php.

References TYPO3\CMS\Core\Domain\ConsumableString\$counter.

Member Data Documentation

$counter

int TYPO3\CMS\Core\Domain\ConsumableString::$counter = 0

private

Definition at line 31 of file ConsumableString.php.

Referenced by TYPO3\CMS\Core\Domain\ConsumableString\count().

$value

readonly string TYPO3\CMS\Core\Domain\ConsumableString::$value

use the consume() method instead

Definition at line 30 of file ConsumableString.php.

Referenced by TYPO3\CMS\Core\Domain\ConsumableString\__construct(), and TYPO3\CMS\Core\Domain\ConsumableString\consume().