Public Member Functions
	__construct (string $tableName, string $fieldName, array $configuration, int $workspaceId=0)

	sanitize (string $slug)

	extract (string $slug)

	generate (array $recordData, int $pid)

	isUniqueInPid (string $slug, RecordState $state)

	isUniqueInSite (string $slug, RecordState $state)

	isUniqueInTable (string $slug, RecordState $state)

	buildSlugForUniqueInSite (string $slug, RecordState $state)

	buildSlugForUniqueInPid (string $slug, RecordState $state)

	buildSlugForUniqueInTable (string $slug, RecordState $state)

Protected Member Functions
	flushRootLineCaches ()

	buildSlug (string $slug, RecordState $state, callable $isUnique)

	createPreparedQueryBuilder ()

	applyWorkspaceConstraint (QueryBuilder $queryBuilder, RecordState $state)

	applyLanguageConstraint (QueryBuilder $queryBuilder, int $languageId)

	applySlugConstraint (QueryBuilder $queryBuilder, string $slug)

	applyPageIdConstraint (QueryBuilder $queryBuilder, int $pageId)

	applyRecordConstraint (QueryBuilder $queryBuilder, $recordId)

	resolveVersionOverlays (array $records)

	resolveParentPageRecord (int $pid, int $languageId)

Protected Attributes
string	$tableName

string	$fieldName

int	$workspaceId

array	$configuration = array( )

bool	$workspaceEnabled

bool	$prependSlashInSlug

Detailed Description

Generates, sanitizes and validates slugs for a TCA field

Definition at line 42 of file SlugHelper.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\DataHandling\SlugHelper::__construct	(	string	$tableName,
		string	$fieldName,
		array	$configuration,
		int	$workspaceId = `0`
	)

Slug constructor.

Parameters

string	$tableName	‪TCA table
string	$fieldName	‪TCA field
array	$configuration	‪TCA configuration of the field
int	$workspaceId	‪the workspace ID to be working on.

Definition at line 80 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\$configuration, TYPO3\CMS\Core\DataHandling\SlugHelper\$fieldName, TYPO3\CMS\Core\DataHandling\SlugHelper\$tableName, and TYPO3\CMS\Core\DataHandling\SlugHelper\$workspaceId.

Member Function Documentation

◆ applyLanguageConstraint()

TYPO3\CMS\Core\DataHandling\SlugHelper::applyLanguageConstraint	(	QueryBuilder	$queryBuilder,
		int	$languageId
	)

protected

Apply constraint to fetch records with same language (Slug / language should be unique). If language is -1 (all languages), there should not be any other records with the same slug of any language (or -1).

Definition at line 458 of file SlugHelper.php.

References $GLOBALS, TYPO3\CMS\Core\DataHandling\SlugHelper\$tableName, and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

◆ applyPageIdConstraint()

TYPO3\CMS\Core\DataHandling\SlugHelper::applyPageIdConstraint	(	QueryBuilder	$queryBuilder,
		int	$pageId
	)

protected

Definition at line 495 of file SlugHelper.php.

References TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid().

◆ applyRecordConstraint()

TYPO3\CMS\Core\DataHandling\SlugHelper::applyRecordConstraint	(	QueryBuilder	$queryBuilder,
			$recordId
	)

protected

Parameters

string | int $recordId

Definition at line 518 of file SlugHelper.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

◆ applySlugConstraint()

TYPO3\CMS\Core\DataHandling\SlugHelper::applySlugConstraint	(	QueryBuilder	$queryBuilder,
		string	$slug
	)

protected

Definition at line 485 of file SlugHelper.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

◆ applyWorkspaceConstraint()

TYPO3\CMS\Core\DataHandling\SlugHelper::applyWorkspaceConstraint	(	QueryBuilder	$queryBuilder,
		RecordState	$state
	)

protected

Definition at line 435 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\Model\EntityPointerLink\getSubject(), and TYPO3\CMS\Core\DataHandling\Model\RecordState\getVersionLink().

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

◆ buildSlug()

TYPO3\CMS\Core\DataHandling\SlugHelper::buildSlug	(	string	$slug,
		RecordState	$state,
		callable	$isUnique
	)

protected

Generate a slug with a suffix "/mytitle-1" if that is in use already.

Parameters

string	$slug	‪proposed slug
callable	$isUnique	‪Callback to check for uniqueness

Exceptions

SiteNotFoundException

Definition at line 358 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\extract(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), and TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize().

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlugForUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlugForUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlugForUniqueInTable().

◆ buildSlugForUniqueInPid()

TYPO3\CMS\Core\DataHandling\SlugHelper::buildSlugForUniqueInPid	(	string	$slug,
		RecordState	$state
	)

Generate a slug with a suffix "/mytitle-1" if the suggested slug is in use already.

Parameters

string $slug ‪proposed slug

Definition at line 393 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlug().

◆ buildSlugForUniqueInSite()

TYPO3\CMS\Core\DataHandling\SlugHelper::buildSlugForUniqueInSite	(	string	$slug,
		RecordState	$state
	)

Generate a slug with a suffix "/mytitle-1" if that is in use already.

Parameters

string $slug ‪proposed slug

Exceptions

SiteNotFoundException

Definition at line 383 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlug().

◆ buildSlugForUniqueInTable()

TYPO3\CMS\Core\DataHandling\SlugHelper::buildSlugForUniqueInTable	(	string	$slug,
		RecordState	$state
	)

Generate a slug with a suffix "/mytitle-1" if that is in use already.

Parameters

string $slug ‪proposed slug

Exceptions

SiteNotFoundException

Definition at line 404 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlug().

◆ createPreparedQueryBuilder()

TYPO3\CMS\Core\DataHandling\SlugHelper::createPreparedQueryBuilder ( )

protected

Definition at line 409 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\$fieldName, $GLOBALS, and TYPO3\CMS\Core\DataHandling\SlugHelper\$tableName.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

◆ extract()

TYPO3\CMS\Core\DataHandling\SlugHelper::extract ( string $slug )

Extracts payload of slug and removes wrapping delimiters, e.g. /hello/world/ will become hello/world.

Definition at line 142 of file SlugHelper.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlug(), and TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize().

◆ flushRootLineCaches()

TYPO3\CMS\Core\DataHandling\SlugHelper::flushRootLineCaches ( )

protected

Ensure root line caches are flushed to avoid any issue regarding moving of pages or dynamically creating sites while managing slugs at the same request

Definition at line 344 of file SlugHelper.php.

References TYPO3\CMS\Core\Utility\RootlineUtility\RUNTIME_CACHE_TAG.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite().

◆ generate()

TYPO3\CMS\Core\DataHandling\SlugHelper::generate	(	array	$recordData,
		int	$pid
	)

Used when no slug exists for a record

Parameters

int $pid ‪The uid of the page to generate the slug for

Definition at line 154 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\$configuration, TYPO3\CMS\Core\DataHandling\SlugHelper\$fieldName, $GLOBALS, TYPO3\CMS\Core\DataHandling\SlugHelper\$tableName, TYPO3\CMS\Core\DataHandling\SlugHelper\$workspaceId, TYPO3\CMS\Core\DataHandling\SlugHelper\resolveParentPageRecord(), TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ isUniqueInPid()

TYPO3\CMS\Core\DataHandling\SlugHelper::isUniqueInPid	(	string	$slug,
		RecordState	$state
	)

Checks if there are other records with the same slug that are located on the same PID.

Definition at line 232 of file SlugHelper.php.

◆ isUniqueInSite()

TYPO3\CMS\Core\DataHandling\SlugHelper::isUniqueInSite	(	string	$slug,
		RecordState	$state
	)

Check if there are other records with the same slug that are located on the same site.

Exceptions

Definition at line 257 of file SlugHelper.php.

◆ isUniqueInTable()

TYPO3\CMS\Core\DataHandling\SlugHelper::isUniqueInTable	(	string	$slug,
		RecordState	$state
	)

Check if there are other records with the same slug.

Exceptions

Definition at line 321 of file SlugHelper.php.

◆ resolveParentPageRecord()

TYPO3\CMS\Core\DataHandling\SlugHelper::resolveParentPageRecord	(	int	$pid,
		int	$languageId
	)

protected

Fetch a parent page, but exclude spacers and sys-folders

Definition at line 565 of file SlugHelper.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SPACER, and TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SYSFOLDER.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\generate().

◆ resolveVersionOverlays()

TYPO3\CMS\Core\DataHandling\SlugHelper::resolveVersionOverlays ( array $records )

protected

Definition at line 536 of file SlugHelper.php.

References TYPO3\CMS\Webhooks\Message\$record.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

◆ sanitize()

TYPO3\CMS\Core\DataHandling\SlugHelper::sanitize ( string $slug )

Cleans a slug value so it is used directly in the path segment of a URL.

Definition at line 99 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\extract().

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\buildSlug(), and TYPO3\CMS\Core\DataHandling\SlugHelper\generate().

Member Data Documentation

◆ $configuration

array TYPO3\CMS\Core\DataHandling\SlugHelper::$configuration = array( )

protected

Definition at line 58 of file SlugHelper.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\__construct(), and TYPO3\CMS\Core\DataHandling\SlugHelper\generate().

◆ $fieldName

string TYPO3\CMS\Core\DataHandling\SlugHelper::$fieldName

protected

Definition at line 50 of file SlugHelper.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\__construct(), TYPO3\CMS\Core\DataHandling\SlugHelper\createPreparedQueryBuilder(), and TYPO3\CMS\Core\DataHandling\SlugHelper\generate().

◆ $prependSlashInSlug

bool TYPO3\CMS\Core\DataHandling\SlugHelper::$prependSlashInSlug

protected

Defines whether the slug field should start with "/". For pages (due to rootline functionality), this is a must have, otherwise the root level page would have an empty value.

Definition at line 70 of file SlugHelper.php.

◆ $tableName

string TYPO3\CMS\Core\DataHandling\SlugHelper::$tableName

protected

Definition at line 46 of file SlugHelper.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\__construct(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\createPreparedQueryBuilder(), and TYPO3\CMS\Core\DataHandling\SlugHelper\generate().

◆ $workspaceEnabled

bool TYPO3\CMS\Core\DataHandling\SlugHelper::$workspaceEnabled

protected

Definition at line 62 of file SlugHelper.php.

◆ $workspaceId

int TYPO3\CMS\Core\DataHandling\SlugHelper::$workspaceId

protected

Definition at line 54 of file SlugHelper.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\__construct(), and TYPO3\CMS\Core\DataHandling\SlugHelper\generate().

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyLanguageConstraint()

◆ applyPageIdConstraint()

◆ applyRecordConstraint()

◆ applySlugConstraint()

◆ applyWorkspaceConstraint()

◆ buildSlug()

◆ buildSlugForUniqueInPid()

◆ buildSlugForUniqueInSite()

◆ buildSlugForUniqueInTable()

◆ createPreparedQueryBuilder()

◆ extract()

◆ flushRootLineCaches()

◆ generate()

◆ isUniqueInPid()

◆ isUniqueInSite()

◆ isUniqueInTable()

◆ resolveParentPageRecord()

◆ resolveVersionOverlays()

◆ sanitize()

Member Data Documentation

◆ $configuration

◆ $fieldName

◆ $prependSlashInSlug

◆ $tableName

◆ $workspaceEnabled

◆ $workspaceId