eZNamePatternResolver Class Reference

List of all members.

Public Member Functions
	__construct ($namePattern, eZContentObject $contentObject, $contentVersion=false, $contentTranslation=false)
	Constructs a object to resolve $namePattern.
	resolveNamePattern ($limit=0, $sequence= '')
	Return the real name for an object name pattern.
Private Member Functions
	extractTokens ($namePattern)
	Extract all tokens from $namePattern.
	fetchContentAttributes ()
	Fetches the list of available class-identifiers in the token, and it will only fetch the attributes which appear amongst the identifiers found in tokens.
	filterNamePattern ($namePattern)
	Builds a lookup / translation table for groups in the $namePattern.
	getIdentifiers ($patternString)
	Returns all identifiers from all tokens in the name pattern.
	isTokenGroup ($identifier)
	Checks whether $identifier is a placeholder for a token group.
	resolveToken ($token)
	Looks up the value $token should be replaced with and returns this as a string.
	tokenParts ($token)
	Return the different constituents of $token in an array.
	translatePattern ()
	Replaces tokens in the name pattern with their resolved values.
Private Attributes
	$attributeArray
	$contentObject
	$groupLookupTable
	$metaString = 'EZMETAGROUP_'
	$namePattern
	$origNamePattern
	$translation
	$version

---

Detailed Description

Definition at line 38 of file eznamepatternresolver.php.

---

Constructor & Destructor Documentation

eZNamePatternResolver::__construct	(	$	namePattern,
		eZContentObject $	contentObject,
		$	contentVersion = false,
		$	contentTranslation = false
	)

Constructs a object to resolve $namePattern.

$contentVersion and $contentTranslation specify which version and translation respectively of the content object to use.

Parameters:

string	$namePattern
eZContentObject	$contentObject
int | false	$contentVersion
string | false	$contentTranslation

Definition at line 108 of file eznamepatternresolver.php.

---

Member Function Documentation

eZNamePatternResolver::extractTokens

(

$

namePattern

)

[private]

Extract all tokens from $namePattern.

Example: Text <token> more text ==> <token>

Parameters:

string

$namePattern

Returns:

array

Definition at line 205 of file eznamepatternresolver.php.

Referenced by resolveToken(), and translatePattern().

eZNamePatternResolver::fetchContentAttributes

(

)

[private]

Fetches the list of available class-identifiers in the token, and it will only fetch the attributes which appear amongst the identifiers found in tokens.

Returns:

void

Definition at line 151 of file eznamepatternresolver.php.

Referenced by resolveNamePattern().

eZNamePatternResolver::filterNamePattern

(

$

namePattern

)

[private]

Builds a lookup / translation table for groups in the $namePattern.

The groups are referenced with a generated meta-token in the original name pattern.

Returns intermediate name pattern where groups are replaced with meta- tokens.

Parameters:

string

$namePattern

Returns:

string

Definition at line 302 of file eznamepatternresolver.php.

Referenced by __construct().

eZNamePatternResolver::getIdentifiers

(

$

patternString

)

[private]

Returns all identifiers from all tokens in the name pattern.

Parameters:

string

$patternString

Returns:

array

Definition at line 336 of file eznamepatternresolver.php.

Referenced by fetchContentAttributes().

eZNamePatternResolver::isTokenGroup

(

$

identifier

)

[private]

Checks whether $identifier is a placeholder for a token group.

Parameters:

string

$identifier

Returns:

void

Definition at line 263 of file eznamepatternresolver.php.

Referenced by resolveToken().

eZNamePatternResolver::resolveNamePattern	(	$	limit = 0,
		$	sequence = ''
	)

Return the real name for an object name pattern.

Parameters:

int	$limit	The limit on the string length, by defaul 0 aka none
string	$sequence	End sequence applied to string if limit has been reached

Returns:

string

Definition at line 125 of file eznamepatternresolver.php.

eZNamePatternResolver::resolveToken

(

$

token

)

[private]

Looks up the value $token should be replaced with and returns this as a string.

Meta strings denothing token groups are automatically inferred.

Parameters:

string

$token

Returns:

string

Definition at line 221 of file eznamepatternresolver.php.

Referenced by translatePattern().

eZNamePatternResolver::tokenParts

(

$

token

)

[private]

Return the different constituents of $token in an array.

The normal case here is that the different identifiers within one token will be tokenized and returned.

Example: "<title|text>" ==> array( 'title', 'text' )

Parameters:

string

$token

Returns:

array

Definition at line 285 of file eznamepatternresolver.php.

Referenced by resolveToken().

eZNamePatternResolver::translatePattern

(

)

[private]

Replaces tokens in the name pattern with their resolved values.

Returns:

string

Definition at line 180 of file eznamepatternresolver.php.

Referenced by resolveNamePattern().

---

Member Data Documentation

eZNamePatternResolver::$attributeArray [private]

Definition at line 88 of file eznamepatternresolver.php.

eZNamePatternResolver::$contentObject [private]

Definition at line 67 of file eznamepatternresolver.php.

Referenced by __construct().

eZNamePatternResolver::$groupLookupTable [private]

Definition at line 45 of file eznamepatternresolver.php.

eZNamePatternResolver::$metaString = 'EZMETAGROUP_' [private]

Definition at line 96 of file eznamepatternresolver.php.

eZNamePatternResolver::$namePattern [private]

Definition at line 60 of file eznamepatternresolver.php.

Referenced by __construct(), extractTokens(), and filterNamePattern().

eZNamePatternResolver::$origNamePattern [private]

Definition at line 52 of file eznamepatternresolver.php.

eZNamePatternResolver::$translation [private]

Definition at line 81 of file eznamepatternresolver.php.

eZNamePatternResolver::$version [private]

Definition at line 74 of file eznamepatternresolver.php.

---

The documentation for this class was generated from the following file:

• eznamepatternresolver.php