modResource.cleanAlias

modResource::cleanAlias¶

Filters a string into something that can be used as a URL path segment. The config of the Resource's context is merged under $options. Then filterPathSegment() of the Resource class applies HTML stripping, transliteration, character restrictions, lowercasing, trimming and the length limit.

The behavior is driven by the friendly_alias_* system settings, and $options overrides any of them for this call. set() uses the method whenever the alias field is assigned.

Syntax¶

string cleanAlias ($alias [, array $options = array()])

• $alias (string) string to filter
• $options (array) filter options merged over the context config, by default array()

Example¶

$resource = $modx->getObject('modResource', array('id' => 5));
$alias = $resource->cleanAlias('Hello World');

See Also¶

• modResource
• modResource.set
• modResource.getAliasPath