TYPO3\CMS\Frontend\Page\CacheHashConfiguration Class Reference

Public Member Functions
	__construct (array $configuration=null)
	shallExcludeAllEmptyParameters ()
	applies (string $aspect, string $value)
	equals (string $aspect, string $value)
	startsWith (string $aspect, string $value)
	contains (string $aspect, string $value)
	hasData (string $aspect)

Static Public Member Functions
static	with (CacheHashConfiguration $other)

Public Attributes
const	ASPECT_CACHED_PARAMETERS_WHITELIST = 'cachedParametersWhiteList'
const	ASPECT_EXCLUDED_PARAMETERS = 'excludedParameters'
const	ASPECT_EXCLUDED_PARAMETERS_IF_EMPTY = 'excludedParametersIfEmpty'
const	ASPECT_REQUIRED_CACHE_HASH_PRESENCE_PARAMETERS = 'requireCacheHashPresenceParameters'

Protected Member Functions
	getData (string $aspect, string $indicator)
	defineData (string $aspect)
	processConfiguration ()
	isAllowedProperty (string $propertyName)

Protected Attributes
const	PROPERTY_EXCLUDE_ALL_EMPTY_PARAMETERS = 'excludeAllEmptyParameters'
const	INDICATOR_STARTS_WITH = '^'
const	INDICATOR_CONTAINS = '~'
const	INDICATOR_EQUALS = '='
const	ALLOWED_INDICATORS
const	ALLOWED_PROPERTY_NAMES
array	$configuration
array	$data = array( )

Detailed Description

Model for configuration properties in $GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash'].

URL parameter names are prefixed with the following indicators:

• ‪= (equals): exact match, default behavior if not given
• ‪+ ^ (startsWith): matching the beginning of a parameter name
• ‪~ (contains): matching any inline occurrence in a parameter name

Example: $configuration = new CacheHashConfiguration([ 'excludedParameters' => ['utm_source', '^tx_my_plugin[aspects]', '~[temporary]'], ... ]);

Definition at line 34 of file CacheHashConfiguration.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::__construct

(

array

$configuration = null

)

Definition at line 68 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\$configuration, $GLOBALS, and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\processConfiguration().

Member Function Documentation

applies()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::applies	(	string	$aspect,
		string	$value
	)

Definition at line 99 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\contains(), TYPO3\CMS\Frontend\Page\CacheHashConfiguration\equals(), and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\startsWith().

contains()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::contains	(	string	$aspect,
		string	$value
	)

Definition at line 126 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\$data, and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\getData().

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\applies().

defineData()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::defineData ( string  $aspect )

protected

Definition at line 150 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\$data, and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\INDICATOR_EQUALS.

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\processConfiguration().

equals()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::equals	(	string	$aspect,
		string	$value
	)

Definition at line 106 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\$data, and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\getData().

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\applies().

getData()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::getData ( string  $aspect, string  $indicator  )

protected

Definition at line 145 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\contains(), TYPO3\CMS\Frontend\Page\CacheHashConfiguration\equals(), and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\startsWith().

hasData()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::hasData

(

string

$aspect

)

Definition at line 140 of file CacheHashConfiguration.php.

isAllowedProperty()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::isAllowedProperty ( string  $propertyName )

protected

Definition at line 200 of file CacheHashConfiguration.php.

processConfiguration()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::processConfiguration ( )

protected

Definition at line 191 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\defineData().

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\__construct().

shallExcludeAllEmptyParameters()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::shallExcludeAllEmptyParameters

(

)

Definition at line 94 of file CacheHashConfiguration.php.

startsWith()

TYPO3\CMS\Frontend\Page\CacheHashConfiguration::startsWith	(	string	$aspect,
		string	$value
	)

Definition at line 112 of file CacheHashConfiguration.php.

References TYPO3\CMS\Frontend\Page\CacheHashConfiguration\$data, and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\getData().

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\applies().

with()

static TYPO3\CMS\Frontend\Page\CacheHashConfiguration::with ( CacheHashConfiguration  $other )

static

Merges other configuration property names with current configuration (extends current configuration).

Example: $configuration = (new CacheHashConfiguration(['cachedParametersWhiteList' => [...]]) ->with(new CacheHashConfiguration(['excludedParameters' => [...]])); results in an instance having both aspects 'cachedParametersWhiteList' and 'excludedParameters' defined.

Parameters

CacheHashConfiguration

$other

Returns

‪static

Definition at line 86 of file CacheHashConfiguration.php.

Member Data Documentation

$configuration

array TYPO3\CMS\Frontend\Page\CacheHashConfiguration::$configuration

protected

Definition at line 62 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\__construct().

$data

array TYPO3\CMS\Frontend\Page\CacheHashConfiguration::$data = array( )

protected

Definition at line 66 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\contains(), TYPO3\CMS\Frontend\Page\CacheHashConfiguration\defineData(), TYPO3\CMS\Frontend\Page\CacheHashConfiguration\equals(), and TYPO3\CMS\Frontend\Page\CacheHashConfiguration\startsWith().

ALLOWED_INDICATORS

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::ALLOWED_INDICATORS

protected

Initial value:

= [
        ‪self::INDICATOR_STARTS_WITH,
        ‪self::INDICATOR_CONTAINS,
        ‪self::INDICATOR_EQUALS,
    ]

Definition at line 46 of file CacheHashConfiguration.php.

ALLOWED_PROPERTY_NAMES

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::ALLOWED_PROPERTY_NAMES

protected

Initial value:

= [
        ‪self::PROPERTY_EXCLUDE_ALL_EMPTY_PARAMETERS,
        ‪self::ASPECT_CACHED_PARAMETERS_WHITELIST,
        ‪self::ASPECT_EXCLUDED_PARAMETERS,
        ‪self::ASPECT_EXCLUDED_PARAMETERS_IF_EMPTY,
        ‪self::ASPECT_REQUIRED_CACHE_HASH_PRESENCE_PARAMETERS,
    ]

Definition at line 52 of file CacheHashConfiguration.php.

ASPECT_CACHED_PARAMETERS_WHITELIST

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::ASPECT_CACHED_PARAMETERS_WHITELIST = 'cachedParametersWhiteList'

Definition at line 36 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\containsResolvesParameterValueDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\emptyIndicatedValueThrowsExceptionDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\equalsResolvesParameterValueDataProvider(), TYPO3\CMS\Frontend\Page\CacheHashCalculator\hasCachedParametersWhiteList(), TYPO3\CMS\Frontend\Page\CacheHashCalculator\isInCachedParametersWhiteList(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\nonArrayValueThrowsExceptionDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\nonScalarValueThrowsExceptionDataProvider(), and TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\startsWithResolvesParameterValueDataProvider().

ASPECT_EXCLUDED_PARAMETERS

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::ASPECT_EXCLUDED_PARAMETERS = 'excludedParameters'

Definition at line 37 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\containsResolvesParameterValueDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\emptyIndicatedValueThrowsExceptionDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\equalsResolvesParameterValueDataProvider(), TYPO3\CMS\Frontend\Page\CacheHashCalculator\isExcludedParameter(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\nonArrayValueThrowsExceptionDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\nonScalarValueThrowsExceptionDataProvider(), and TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\startsWithResolvesParameterValueDataProvider().

ASPECT_EXCLUDED_PARAMETERS_IF_EMPTY

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::ASPECT_EXCLUDED_PARAMETERS_IF_EMPTY = 'excludedParametersIfEmpty'

Definition at line 38 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Page\CacheHashCalculator\isAllowedWithEmptyValue().

ASPECT_REQUIRED_CACHE_HASH_PRESENCE_PARAMETERS

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::ASPECT_REQUIRED_CACHE_HASH_PRESENCE_PARAMETERS = 'requireCacheHashPresenceParameters'

Definition at line 39 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\containsResolvesParameterValueDataProvider(), TYPO3\CMS\Frontend\Page\CacheHashCalculator\doParametersRequireCacheHash(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\emptyIndicatedValueThrowsExceptionDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\equalsResolvesParameterValueDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\nonArrayValueThrowsExceptionDataProvider(), TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\nonScalarValueThrowsExceptionDataProvider(), and TYPO3\CMS\Frontend\Tests\Unit\Page\CacheHashConfigurationTest\startsWithResolvesParameterValueDataProvider().

INDICATOR_CONTAINS

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::INDICATOR_CONTAINS = '~'

protected

Definition at line 43 of file CacheHashConfiguration.php.

INDICATOR_EQUALS

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::INDICATOR_EQUALS = '='

protected

Definition at line 44 of file CacheHashConfiguration.php.

Referenced by TYPO3\CMS\Frontend\Page\CacheHashConfiguration\defineData().

INDICATOR_STARTS_WITH

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::INDICATOR_STARTS_WITH = '^'

protected

Definition at line 42 of file CacheHashConfiguration.php.

PROPERTY_EXCLUDE_ALL_EMPTY_PARAMETERS

const TYPO3\CMS\Frontend\Page\CacheHashConfiguration::PROPERTY_EXCLUDE_ALL_EMPTY_PARAMETERS = 'excludeAllEmptyParameters'

protected

Definition at line 41 of file CacheHashConfiguration.php.