TYPO3\CMS\Core\DataHandling\SlugHelper Class Reference

Public Member Functions
	__construct (string $tableName, string $fieldName, array $configuration, int $workspaceId=0)
string	sanitize (string $slug)
string	extract (string $slug)
string	generate (array $recordData, int $pid)
bool	isUniqueInPid (string $slug, RecordState $state)
bool	isUniqueInSite (string $slug, RecordState $state)
bool	isUniqueInTable (string $slug, RecordState $state)
string	buildSlugForUniqueInSite (string $slug, RecordState $state)
string	buildSlugForUniqueInPid (string $slug, RecordState $state)
string	buildSlugForUniqueInTable (string $slug, RecordState $state)

Protected Member Functions
QueryBuilder	createPreparedQueryBuilder ()
	applyWorkspaceConstraint (QueryBuilder $queryBuilder)
	applyLanguageConstraint (QueryBuilder $queryBuilder, int $languageId)
	applySlugConstraint (QueryBuilder $queryBuilder, string $slug)
	applyPageIdConstraint (QueryBuilder $queryBuilder, int $pageId)
	applyRecordConstraint (QueryBuilder $queryBuilder, $recordId)
int	resolveLivePageId ($recordId)
array	resolveVersionOverlays (array $records)
array null	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 35 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 73 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\$configuration, TYPO3\CMS\Core\DataHandling\SlugHelper\$fieldName, TYPO3\CMS\Core\DataHandling\SlugHelper\$tableName, TYPO3\CMS\Core\DataHandling\SlugHelper\$workspaceId, and TYPO3\CMS\Backend\Utility\BackendUtility\isTableWorkspaceEnabled().

Member Function Documentation

applyLanguageConstraint()

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

protected

Parameters

QueryBuilder	$queryBuilder
int	$languageId

Definition at line 488 of file SlugHelper.php.

References $GLOBALS, TYPO3\CMS\Core\DataHandling\SlugHelper\$tableName, TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere(), TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\eq(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\expr().

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

Parameters

QueryBuilder	$queryBuilder
int	$pageId

Definition at line 522 of file SlugHelper.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere(), TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\eq(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\expr().

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

applyRecordConstraint()

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

protected

Parameters

QueryBuilder	$queryBuilder
string | int	$recordId

Definition at line 546 of file SlugHelper.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere(), TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), TYPO3\CMS\Backend\Utility\BackendUtility\getLiveVersionIdOfRecord(), and TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\neq().

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

Parameters

QueryBuilder	$queryBuilder
string	$slug

Definition at line 508 of file SlugHelper.php.

References TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\eq(), TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), and TYPO3\CMS\Core\Database\Query\QueryBuilder\where().

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 )

protected

Parameters

QueryBuilder

$queryBuilder

Definition at line 462 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\$workspaceId, TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere(), TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\in(), and TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\neq().

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

buildSlugForUniqueInPid()

string 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
RecordState	$state

Returns

‪string

Definition at line 385 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\extract(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), and TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize().

buildSlugForUniqueInSite()

string 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
RecordState	$state

Returns

‪string

Exceptions

Definition at line 359 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\extract(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize().

buildSlugForUniqueInTable()

string 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
RecordState	$state

Returns

‪string

Exceptions

Definition at line 412 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\extract(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable(), and TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize().

createPreparedQueryBuilder()

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

protected

Returns

‪QueryBuilder

Definition at line 434 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()

string TYPO3\CMS\Core\DataHandling\SlugHelper::extract

(

string

$slug

)

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

Parameters

string

$slug

Returns

‪string

Definition at line 137 of file SlugHelper.php.

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

generate()

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

Used when no slug exists for a record

Parameters

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

Returns

‪string

Definition at line 151 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(), and TYPO3\CMS\Core\DataHandling\SlugHelper\sanitize().

isUniqueInPid()

bool 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.

Parameters

string	$slug
RecordState	$state

Returns

‪bool

Definition at line 233 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyPageIdConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyRecordConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applySlugConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\createPreparedQueryBuilder(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getContext(), TYPO3\CMS\Core\DataHandling\Model\EntityUidPointer\getIdentifier(), TYPO3\CMS\Core\DataHandling\Model\EntityContext\getLanguageId(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getSubject(), TYPO3\CMS\Core\DataHandling\SlugHelper\resolveLivePageId(), TYPO3\CMS\Core\DataHandling\Model\RecordState\resolveNodeIdentifier(), and TYPO3\CMS\Core\DataHandling\SlugHelper\resolveVersionOverlays().

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

isUniqueInSite()

bool 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.

Parameters

string	$slug
RecordState	$state

Returns

‪bool

Exceptions

Definition at line 265 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyRecordConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applySlugConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint(), TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\DataHandling\SlugHelper\createPreparedQueryBuilder(), TYPO3\CMS\Core\DataHandling\Model\RecordStateFactory\forName(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getContext(), TYPO3\CMS\Core\DataHandling\Model\EntityPointer\getIdentifier(), TYPO3\CMS\Core\DataHandling\Model\EntityUidPointer\getIdentifier(), TYPO3\CMS\Core\DataHandling\Model\EntityContext\getLanguageId(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getNode(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getSubject(), TYPO3\CMS\Core\DataHandling\SlugHelper\resolveLivePageId(), TYPO3\CMS\Core\DataHandling\Model\RecordState\resolveNodeAggregateIdentifier(), and TYPO3\CMS\Core\DataHandling\SlugHelper\resolveVersionOverlays().

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

isUniqueInTable()

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

Check if there are other records with the same slug.

Parameters

string	$slug
RecordState	$state

Returns

‪bool

Exceptions

Definition at line 332 of file SlugHelper.php.

References TYPO3\CMS\Core\DataHandling\SlugHelper\applyLanguageConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyRecordConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applySlugConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint(), TYPO3\CMS\Core\DataHandling\SlugHelper\createPreparedQueryBuilder(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getContext(), TYPO3\CMS\Core\DataHandling\Model\EntityUidPointer\getIdentifier(), TYPO3\CMS\Core\DataHandling\Model\EntityContext\getLanguageId(), TYPO3\CMS\Core\DataHandling\Model\RecordState\getSubject(), and TYPO3\CMS\Core\DataHandling\SlugHelper\resolveVersionOverlays().

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

resolveLivePageId()

int TYPO3\CMS\Core\DataHandling\SlugHelper::resolveLivePageId (   $recordId )

protected

Parameters

int

$recordId

Returns

‪int

Exceptions

Definition at line 569 of file SlugHelper.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Backend\Utility\BackendUtility\getLiveVersionOfRecord().

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

resolveParentPageRecord()

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

protected

Fetch a parent page, but exclude spacers, recyclers and sys-folders and all doktypes > 200

Parameters

int	$pid
int	$languageId

Returns

‪array|null

Definition at line 637 of file SlugHelper.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordLocalization().

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

resolveVersionOverlays()

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

protected

Parameters

array

$records

Returns

‪array

Definition at line 605 of file SlugHelper.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

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

sanitize()

string TYPO3\CMS\Core\DataHandling\SlugHelper::sanitize

(

string

$slug

)

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

Parameters

string

$slug

Returns

‪string

Definition at line 95 of file SlugHelper.php.

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

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

Member Data Documentation

$configuration

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

protected

Definition at line 51 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 43 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 63 of file SlugHelper.php.

$tableName

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

protected

Definition at line 39 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 55 of file SlugHelper.php.

$workspaceId

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

protected

Definition at line 47 of file SlugHelper.php.

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