class DefaultPageLocator implements IPageLocator (View source)

Class to return fully qualified class names by its name.

Properties

protected array $namespacePrefixes Prefix for page classes.

Methods

__construct(array $namespace_prefixes)

Creates the DefaultPageLocator.

string
normalize(string $namespace)

Normalizes passed namespace.

string
resolvePage(string $name)

Returns the fully qualified class name of a page by its name.

array
buildPossiblePages(string $name)

Builds all possible page classes from passed name and current prefixes.

string
buildClassNameFromName(string $name)

Builds the class name from a given name by uppercasing the first letter of each word and removing the spaces.

string
getExistingPageClass(array $possible_pages)

Returns first existing class passed in array.

Expectation
shouldReceive(string $name)

No description

Details

__construct(array $namespace_prefixes)

Creates the DefaultPageLocator.

Parameters

array $namespace_prefixes The page namespace prefixes.

Exceptions

PageFactoryException When no prefixes are given.

protected string normalize(string $namespace)

Normalizes passed namespace.

Parameters

string $namespace Namespace.

Return Value

string

string resolvePage(string $name)

Returns the fully qualified class name of a page by its name.

Parameters

string $name The name of the page.

Return Value

string

Exceptions

PageFactoryException When no name is given.

protected array buildPossiblePages(string $name)

Builds all possible page classes from passed name and current prefixes.

Parameters

string $name Page name.

Return Value

array

protected string buildClassNameFromName(string $name)

Builds the class name from a given name by uppercasing the first letter of each word and removing the spaces.

Parameters

string $name The class name.

Return Value

string

protected string getExistingPageClass(array $possible_pages)

Returns first existing class passed in array.

Parameters

array $possible_pages Possible page classes.

Return Value

string

Exceptions

PageFactoryException When page class is not found.

Expectation shouldReceive(string $name)

Parameters

string $name

Return Value

Expectation