W3cubDocs

/Symfony 4.1

ObjectRouteLoader

abstract class ObjectRouteLoader extends Loader

A route loader that calls a method on an object to load the routes.

Properties

protected $resolver from Loader

Methods

LoaderResolverInterface getResolver()

Gets the loader resolver.

from Loader
setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

from Loader
mixed import(mixed $resource, string|null $type = null)

Imports a resource.

from Loader
$this|LoaderInterface resolve(mixed $resource, string|null $type = null)

Finds a loader able to load an imported resource.

from Loader
object getServiceObject(string $id)

Returns the object that the method will be called on to load routes.

load(mixed $resource, string|null $type = null)

Calls the service that will load the routes.

bool supports(mixed $resource, string|null $type = null)

Returns whether this class supports the given resource.

Details

LoaderResolverInterface getResolver()

Gets the loader resolver.

Return Value

LoaderResolverInterface A LoaderResolverInterface instance

setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

Parameters

LoaderResolverInterface $resolver

mixed import(mixed $resource, string|null $type = null)

Imports a resource.

Parameters

mixed $resource A resource
string|null $type The resource type or null if unknown

Return Value

mixed

$this|LoaderInterface resolve(mixed $resource, string|null $type = null)

Finds a loader able to load an imported resource.

Parameters

mixed $resource A resource
string|null $type The resource type or null if unknown

Return Value

$this|LoaderInterface

Exceptions

FileLoaderLoadException If no loader is found

abstract protected object getServiceObject(string $id)

Returns the object that the method will be called on to load routes.

For example, if your application uses a service container, the $id may be a service id.

Parameters

string $id

Return Value

object

load(mixed $resource, string|null $type = null)

Calls the service that will load the routes.

Parameters

mixed $resource The resource
string|null $type The resource type or null if unknown

bool supports(mixed $resource, string|null $type = null)

Returns whether this class supports the given resource.

Parameters

mixed $resource A resource
string|null $type The resource type or null if unknown

Return Value

bool True if this class supports the given resource, false otherwise

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Routing/Loader/ObjectRouteLoader.html