class TestableContentAwareGenerator in Zircon Profile 8

Overwrite doGenerate to reduce amount of mocking needed

Hierarchy

• class \Symfony\Component\Routing\Generator\UrlGenerator implements ConfigurableRequirementsInterface, UrlGeneratorInterface
  • class \Symfony\Cmf\Component\Routing\ProviderBasedGenerator implements VersatileGeneratorInterface
    • class \Symfony\Cmf\Component\Routing\ContentAwareGenerator
      • class \Symfony\Cmf\Component\Routing\Tests\Routing\TestableContentAwareGenerator

File

vendor/symfony-cmf/routing/Tests/Routing/ContentAwareGeneratorTest.php, line 437

Namespace

Symfony\Cmf\Component\Routing\Tests\Routing

class TestableContentAwareGenerator extends ContentAwareGenerator {
  protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens, array $requiredSchemes = array()) {
    return 'result_url';
  }

  // expose as public
  public function getLocale($parameters) {
    return parent::getLocale($parameters);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentAwareGenerator::$contentRepository	protected	property	The content repository used to find content by it's id This can be used to specify a parameter content_id when generating urls
ContentAwareGenerator::$defaultLocale	protected	property	The locale to use when neither the parameters nor the request context indicate the locale to use.
ContentAwareGenerator::checkLocaleRequirement	private	function
ContentAwareGenerator::generate	public	function	Overrides ProviderBasedGenerator::generate
ContentAwareGenerator::getBestLocaleRoute	protected	function	Determine if there is a route with matching locale associated with the given route via associated content.
ContentAwareGenerator::getRouteByContent	protected	function	Get the route based on the $name that is an object implementing RouteReferrersReadInterface or a content found in the content repository with the content_id specified in parameters that is an instance of RouteReferrersReadInterface.
ContentAwareGenerator::getRouteByLocale	protected	function
ContentAwareGenerator::getRouteByName	protected	function	Get the route by a string name
ContentAwareGenerator::getRouteDebugMessage	public	function	Convert a route identifier (name, content object etc) into a string usable for logging and other debug/error messages Overrides ProviderBasedGenerator::getRouteDebugMessage
ContentAwareGenerator::setContentRepository	public	function	Set an optional content repository to find content by ids
ContentAwareGenerator::setDefaultLocale	public	function	Overwrite the locale to be used by default if there is neither one in the parameters when building the route nor a request available (i.e. CLI).
ContentAwareGenerator::supports	public	function	We additionally support empty name and data in parameters and RouteAware content Overrides ProviderBasedGenerator::supports
ContentAwareGenerator::unsetLocaleIfNotNeeded	protected	function	If the _locale parameter is allowed by the requirements of the route and it is the default locale, remove it from the parameters so that we do not get an unneeded ?_locale= query string.
ProviderBasedGenerator::$provider	protected	property	The route provider for this generator.
ProviderBasedGenerator::__construct	public	function	Overrides UrlGenerator::__construct
TestableContentAwareGenerator::doGenerate	protected	function	Overrides UrlGenerator::doGenerate
TestableContentAwareGenerator::getLocale	public	function	Determine the locale to be used with this request Overrides ContentAwareGenerator::getLocale
UrlGenerator::$context	protected	property
UrlGenerator::$decodedChars	protected	property	This array defines the characters (besides alphanumeric ones) that will not be percent-encoded in the path segment of the generated URL.
UrlGenerator::$logger	protected	property
UrlGenerator::$routes	protected	property
UrlGenerator::$strictRequirements	protected	property
UrlGenerator::getContext	public	function	Gets the request context. Overrides RequestContextAwareInterface::getContext
UrlGenerator::getRelativePath	public static	function	Returns the target path as relative reference from the base path.
UrlGenerator::isStrictRequirements	public	function	Returns whether to throw an exception on incorrect parameters. Null means the requirements check is deactivated completely. Overrides ConfigurableRequirementsInterface::isStrictRequirements
UrlGenerator::setContext	public	function	Sets the request context. Overrides RequestContextAwareInterface::setContext
UrlGenerator::setStrictRequirements	public	function	Enables or disables the exception on incorrect parameters. Passing null will deactivate the requirements check completely. Overrides ConfigurableRequirementsInterface::setStrictRequirements
UrlGeneratorInterface::ABSOLUTE_PATH		constant	Generates an absolute path, e.g. "/dir/file".
UrlGeneratorInterface::ABSOLUTE_URL		constant	Generates an absolute URL, e.g. "http://example.com/dir/file".
UrlGeneratorInterface::NETWORK_PATH		constant	Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host.
UrlGeneratorInterface::RELATIVE_PATH		constant	Generates a relative path based on the current request path, e.g. "../parent-file".