On this page

Provided Factories

This component provides a number of factories for use with PSR-11, in order to generate fully configured instances for your use.

Mezzio\Hal\HalResponseFactoryFactory

  • Registered as service: Mezzio\Hal\HalResponseFactory
  • Generates instance of: Mezzio\Hal\HalResponseFactory
  • Depends on:
    • Psr\Http\Message\ResponseInterface service. The service must resolve to a PHP callable capable of generating a PSR-7 ResponseInterface instance; it must not resolve to a ResponseInterface instance directly. This service is required, and must be supplied by the application. If you are using with mezzio v3 and above, the service will already be registered.
    • Mezzio\Hal\Renderer\JsonRenderer service. If the service is not present, it instantiates an instance itself.
    • Mezzio\Hal\Renderer\XmlRenderer service. If the service is not present, it instantiates an instance itself.

Mezzio\Hal\LinkGeneratorFactory

  • Registered as service: Mezzio\Hal\LinkGenerator
  • Generates instance of: Mezzio\Hal\LinkGenerator
  • Depends on:
    • Mezzio\Hal\LinkGenerator\UrlGeneratorInterface service

Since version 1.1.0, this factory allows an optional constructor argument, $urlGeneratorServiceName. It defaults to Mezzio\Hal\LinkGenerator\UrlGeneratorInterface, but you may specify an alternate service if desired. This may be useful, for instance, when using an alternate router in a path-segregated middleware pipeline, which would necessitate a different UrlHelper instance, and an alternate URL generator that consumes it.

Mezzio\Hal\LinkGenerator\MezzioUrlGeneratorFactory

  • Registered as service: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator
  • Generates instance of: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator
  • Depends on:
    • mezzio/mezzio-helpers package
    • Mezzio\Helper\UrlHelper service
    • Mezzio\Helper\ServerUrlHelper service (optional; if not provided, URIs will be generated without authority information)

Since version 1.1.0, this factory allows an optional constructor argument, $urlHelperServiceName. It defaults to Mezzio\Helper\UrlHelper, but you may specify an alternate service if desired. This may be useful, for instance, when using an alternate router in a path-segregated middleware pipeline, which would necessitate a different UrlHelper instance.

Mezzio\Hal\LinkGenerator\UrlGeneratorInterface

  • Registered as service: Mezzio\Hal\LinkGenerator\UrlGeneratorInterface
  • Aliased to service: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator

You can either define an alternate alias, or map the UrlGeneratorInterface service directly to a factory that will return a valid instance.

Mezzio\Hal\Metadata\MetadataMapFactory

  • Registered as service: Mezzio\Hal\Metadata\MetadataMap
  • Generates instance of: Mezzio\Hal\Metadata\MetadataMap
  • Depends on:
    • config service; if not present, will use an empty array

This service uses the Mezzio\Hal\Metadata\MetadataMap key of the config service in order to configure and return a Mezzio\Hal\Metadata\MetadataMap instance. It expects that value to be an array of elements, each with the following structure:

[
    '__class__' => 'Fully qualified class name of an AbstractMetadata type',
    // additional key/value pairs as required by the metadata type.
]

The additional pairs are as follows:

  • For UrlBasedResourceMetadata:
    • resource_class: the resource class the metadata describes.
    • url: the URL to use when generating a self-relational link for the resource.
    • extractor: the extractor/hydrator service to use to extract resource data.
  • For UrlBasedCollectionMetadata:
    • collection_class: the collection class the metadata describes.
    • collection_relation: the embedded relation for the collection in the generated resource.
    • url: the URL to use when generating a self-relational link for the collection resource.
    • pagination_param: the name of the parameter indicating what page of data is present. Defaults to "page".
    • pagination_param_type: whether the pagination parameter is a query string or path placeholder; use either AbstractCollectionMetadata::TYPE_QUERY ("query") or AbstractCollectionMetadata::TYPE_PLACEHOLDER ("placeholder"); default is "query".
  • For RouteBasedResourceMetadata:
    • resource_class: the resource class the metadata describes.
    • route: the route to use when generating a self relational link for the resource.
    • extractor: the extractor/hydrator service to use to extract resource data.
    • resource_identifier: what property in the resource represents its identifier; defaults to "id".
    • route_identifier_placeholder: what placeholder in the route string represents the resource identifier; defaults to "id". Deprecated since 1.4.0; use the identifiers_to_placeholders_mapping setting instead.
    • route_params: an array of additional routing parameters to use when generating the self relational link for the resource.
    • identifiers_to_placeholders_mapping (associative array mapping resource properties to routing parameters, for use when generating the URI; since 1.4.0)
  • For RouteBasedCollectionMetadata:
    • collection_class: the collection class the metadata describes.
    • collection_relation: the embedded relation for the collection in the generated resource.
    • route: the route to use when generating a self relational link for the collection resource.
    • pagination_param: the name of the parameter indicating what page of data is present. Defaults to "page".
    • pagination_param_type: whether the pagination parameter is a query string or path placeholder; use either AbstractCollectionMetadata::TYPE_QUERY ("query") or AbstractCollectionMetadata::TYPE_PLACEHOLDER ("placeholder"); default is "query".
    • route_params: an array of additional routing parameters to use when generating the self relational link for the collection resource. Defaults to an empty array.
    • query_string_arguments: an array of query string parameters to include when generating the self relational link for the collection resource. Defaults to an empty array.

If you have created custom metadata types, you can extend this class to support them. Create create<type>(array $metadata) methods for each type you wish to support, where <type> is your custom class name, minus the namespace.

Limitation

There is a known limitation with laminas-router when using routes with optional parameters (e.g., /books[/:id], where :id is optional). In such cases, if no matching parameter is provided (such as when generating a URI without an :id), the router will raise an exception due to the missing parameter.

If you encounter this issue, create separate routing entries for each optional parameter. See the issue for a comprehensive example.

Mezzio\Hal\ResourceGeneratorFactory

  • Registered as service: Mezzio\Hal\ResourceGenerator
  • Generates instance of: Mezzio\Hal\ResourceGenerator
  • Depends on:
    • Mezzio\Hal\Metadata\MetadataMap service
    • Laminas\Hydrator\HydratorPluginManager service
    • Mezzio\Hal\LinkGenerator service

If you wish to use a container implementation other than the Laminas\Hydrator\HydratorPluginManager, either register it under that service name, or create an alternate factory.

Since version 1.1.0, this factory allows an optional constructor argument, $linkGeneratorServiceName. It defaults to Mezzio\Hal\LinkGenerator, but you may specify an alternate service if desired. This may be useful, for instance, when using an alternate router in a path-segregated middleware pipeline, which would necessitate a different UrlHelper instance, an alternate URL generator that consumes it, and an alternate LinkGenerator consuming the URL generator.