diff --git a/index.html b/index.html index 7f62be7..5eafca8 100644 --- a/index.html +++ b/index.html @@ -84,17 +84,6 @@ - -
-
- -
-
- API Tools
- Build RESTful APIs in Minutes -
-
-
@@ -565,7 +554,7 @@
Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • @@ -661,6 +650,6 @@
    Search
    diff --git a/pages/404.html b/pages/404.html index 3b126f5..bbe174a 100644 --- a/pages/404.html +++ b/pages/404.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -324,7 +313,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/sitemap.xml b/sitemap.xml index eccba06..5ea455a 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,167 +2,134 @@ https://docs.mezzio.dev/mezzio-hal/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/doctrine/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/factories/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/hal/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/intro/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/links-and-resources/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/representations/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/resource-generator/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/cookbook/generating-custom-links-in-middleware/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/cookbook/generating-custom-resources/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/cookbook/path-segregated-uri-generation/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/doctrine/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/factories/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/hal/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/links-and-resources/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/representations/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/resource-generator/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/cookbook/generating-custom-links-in-middleware/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/cookbook/generating-custom-resources/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v1/cookbook/path-segregated-uri-generation/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/doctrine/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/factories/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/hal/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/installation/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/links-and-resources/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/migration/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/representations/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/resource-generator/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/cookbook/generating-custom-links-in-middleware/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/cookbook/generating-custom-resources/ - 2024-01-08 - daily + 2024-10-16 https://docs.mezzio.dev/mezzio-hal/v2/cookbook/path-segregated-uri-generation/ - 2024-01-08 - daily + 2024-10-16 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index e5dfc8f..a7cac80 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ diff --git a/v1/cookbook/generating-custom-links-in-middleware/index.html b/v1/cookbook/generating-custom-links-in-middleware/index.html index ff466a9..c7d1347 100644 --- a/v1/cookbook/generating-custom-links-in-middleware/index.html +++ b/v1/cookbook/generating-custom-links-in-middleware/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -633,7 +622,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/cookbook/generating-custom-resources/index.html b/v1/cookbook/generating-custom-resources/index.html index ec4a178..3604e99 100644 --- a/v1/cookbook/generating-custom-resources/index.html +++ b/v1/cookbook/generating-custom-resources/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -415,7 +404,7 @@

    Generating Custom Resources

    Mezzio\Hal\ResourceGenerator\ExtractCollectionTrait and Mezzio\Hal\ResourceGenerator\ExtractInstanceTrait; inspect these if you decide to write your own strategies.

    -

    In order for the MetadataMap to be able to use your CustomMetadata you need to register +

    In order for the MetadataMap to be able to use your CustomMetadata you need to register a factory (implementing Mezzio\Hal\Metadata\MetadataFactoryInterface) for it. You can register them via the configuration:

    return [
@@ -607,7 +596,7 @@ 
    Laminas
    
                     
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
    • 
                     
  • Laminas Components and MVC Components and MVC for enterprise applications
    • 
                     
  • Mezzio PSR-15 middleware in minutes
    • 
-                    
  • Laminas API Tools Build RESTful APIs in minutes
    • 
+                    
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    •
    diff --git a/v1/cookbook/path-segregated-uri-generation/index.html b/v1/cookbook/path-segregated-uri-generation/index.html index 2b7df82..42d6a8a 100644 --- a/v1/cookbook/path-segregated-uri-generation/index.html +++ b/v1/cookbook/path-segregated-uri-generation/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -795,7 +784,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/doctrine/index.html b/v1/doctrine/index.html index 185d76e..a113368 100644 --- a/v1/doctrine/index.html +++ b/v1/doctrine/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -944,7 +933,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/factories/index.html b/v1/factories/index.html index 2137ddb..f590ac6 100644 --- a/v1/factories/index.html +++ b/v1/factories/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -398,25 +387,29 @@

    Mezzio\Hal\HalResponseFactoryFactory

    Mezzio\Hal\LinkGeneratorFactory

    Since version 1.1.0, this factory allows an optional constructor argument, $urlGeneratorServiceName. It defaults to Mezzio\Hal\LinkGenerator\UrlGeneratorInterface, @@ -428,11 +421,13 @@

    Mezzio\Hal\LinkGenerato
    • Registered as service: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator
    • Generates instance of: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator
      • -
    • Depends on:
      • +
    • 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)
        • + 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 @@ -450,9 +445,11 @@

    Mezzio\Hal\Metadata\MetadataMapFact
    • Registered as service: Mezzio\Hal\Metadata\MetadataMap
    • Generates instance of: Mezzio\Hal\Metadata\MetadataMap
      • -
    • Depends on:
      • +
    • 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:

    @@ -462,56 +459,64 @@

    Mezzio\Hal\Metadata\MetadataMapFact ]

    The additional pairs are as follows:

    If you have created custom metadata types, you can extend this class to support them. Create create<type>(array $metadata) methods for each @@ -531,11 +536,13 @@

    Mezzio\Hal\ResourceGeneratorFactory
  • Registered as service: Mezzio\Hal\ResourceGenerator
  • Generates instance of: Mezzio\Hal\ResourceGenerator
    • -
  • Depends on:
    • +
  • 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.

    @@ -727,7 +734,7 @@

    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/hal/index.html b/v1/hal/index.html index f779349..89bcd92 100644 --- a/v1/hal/index.html +++ b/v1/hal/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -712,7 +701,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/index.html b/v1/index.html index bafce93..cb5dabb 100644 --- a/v1/index.html +++ b/v1/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -910,7 +899,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/links-and-resources/index.html b/v1/links-and-resources/index.html index c87d387..eec0600 100644 --- a/v1/links-and-resources/index.html +++ b/v1/links-and-resources/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -712,7 +701,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/representations/index.html b/v1/representations/index.html index 0deeffb..8197d6d 100644 --- a/v1/representations/index.html +++ b/v1/representations/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -709,7 +698,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v1/resource-generator/index.html b/v1/resource-generator/index.html index 36e3c81..4f54b60 100644 --- a/v1/resource-generator/index.html +++ b/v1/resource-generator/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -408,42 +397,50 @@

    Metadata

    The component also provides four concrete metadata types, requiring the following information:

    We aggregate metadata in a Mezzio\Hal\Metadata\MetadataMap instance:

    $bookMetadata = new RouteBasedResourceMetadata(
@@ -495,27 +492,35 @@ 
    Configuration-based metadata
    
 ];

    The rest of the parameters follow underscore delimiter naming convention:

    ResourceGenerator

    Once you have defined the metadata for the various objects you will represent in your API, you can start generating resources.

    @@ -719,7 +724,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/cookbook/generating-custom-links-in-middleware/index.html b/v2/cookbook/generating-custom-links-in-middleware/index.html index 906d440..09da7f3 100644 --- a/v2/cookbook/generating-custom-links-in-middleware/index.html +++ b/v2/cookbook/generating-custom-links-in-middleware/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -667,7 +656,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/cookbook/generating-custom-resources/index.html b/v2/cookbook/generating-custom-resources/index.html index 724302c..b84b8db 100644 --- a/v2/cookbook/generating-custom-resources/index.html +++ b/v2/cookbook/generating-custom-resources/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -429,7 +418,7 @@

    Generating Custom Resources

    Mezzio\Hal\ResourceGenerator\ExtractCollectionTrait and Mezzio\Hal\ResourceGenerator\ExtractInstanceTrait; inspect these if you decide to write your own strategies.

    -

    In order for the MetadataMap to be able to use your CustomMetadata you need to register +

    In order for the MetadataMap to be able to use your CustomMetadata you need to register a factory (implementing Mezzio\Hal\Metadata\MetadataFactoryInterface) for it. You can register them via the configuration:

    return [
@@ -642,7 +631,7 @@ 
    Laminas
    
                     
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
    • 
                     
  • Laminas Components and MVC Components and MVC for enterprise applications
    • 
                     
  • Mezzio PSR-15 middleware in minutes
    • 
-                    
  • Laminas API Tools Build RESTful APIs in minutes
    • 
+                    
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    •
    diff --git a/v2/cookbook/path-segregated-uri-generation/index.html b/v2/cookbook/path-segregated-uri-generation/index.html index d8cdd75..c435447 100644 --- a/v2/cookbook/path-segregated-uri-generation/index.html +++ b/v2/cookbook/path-segregated-uri-generation/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -830,7 +819,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/doctrine/index.html b/v2/doctrine/index.html index 0e647a2..89984f8 100644 --- a/v2/doctrine/index.html +++ b/v2/doctrine/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -973,7 +962,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/factories/index.html b/v2/factories/index.html index ec13762..25b8654 100644 --- a/v2/factories/index.html +++ b/v2/factories/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -411,16 +400,18 @@

    Mezzio\Hal\HalResponseFactoryFactory

    ResponseInterface vs ResponseFactoryInterface

    @@ -432,9 +423,11 @@

    Mezzio\Hal\LinkGeneratorFactory

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

    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 @@ -445,11 +438,13 @@

    Mezzio\Hal\LinkGenerato
    • Registered as service: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator
    • Generates instance of: Mezzio\Hal\LinkGenerator\MezzioUrlGenerator
      • -
    • Depends on:
      • +
    • 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)
        • + URIs will be generated without authority information) +
      +

    This factory allows an optional constructor argument, $urlHelperServiceName. It defaults to Mezzio\Helper\UrlHelper, but you may specify an @@ -467,9 +462,11 @@

    Mezzio\Hal\Metadata\MetadataMapFact
    • Registered as service: Mezzio\Hal\Metadata\MetadataMap
    • Generates instance of: Mezzio\Hal\Metadata\MetadataMap
      • -
    • Depends on:
      • +
    • 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:

    @@ -479,54 +476,62 @@

    Mezzio\Hal\Metadata\MetadataMapFact ]

    The additional pairs are as follows:

      -
    • For UrlBasedResourceMetadata:
      • +
    • For UrlBasedResourceMetadata:
      • resource_class: the resource class the metadata describes.
      • url: the URL to use when generating a self-relational link for the - resource.
        • + resource.
      • extractor: the extractor/hydrator service to use to extract resource - data.
        • -
      • For UrlBasedCollectionMetadata:
        • + data. +
      +
      • +
    • For UrlBasedCollectionMetadata:
      • collection_class: the collection class the metadata describes.
      • collection_relation: the embedded relation for the collection in the - generated resource.
        • + generated resource.
      • url: the URL to use when generating a self-relational link for the - collection resource.
        • + collection resource.
      • pagination_param: the name of the parameter indicating what page of data - is present. Defaults to "page".
        • + 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:
        • + 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.
        • + resource.
      • extractor: the extractor/hydrator service to use to extract resource - data.
        • + data.
      • resource_identifier: what property in the resource represents its - identifier; defaults to "id".
        • + identifier; defaults to "id".
      • route_params: an array of additional routing parameters to use when - generating the self relational link for the resource.
        • + 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)
      • max_depth: the number of nesting levels processed. Defaults to 10.
        • -
      • For RouteBasedCollectionMetadata:
        • +
      +
      • +
    • For RouteBasedCollectionMetadata:
      • collection_class: the collection class the metadata describes.
      • collection_relation: the embedded relation for the collection in the - generated resource.
        • + generated resource.
      • route: the route to use when generating a self relational link for the - collection resource.
        • + collection resource.
      • pagination_param: the name of the parameter indicating what page of data - is present. Defaults to "page".
        • + 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".
        • + 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.
        • + 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.
        • + 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 @@ -546,11 +551,13 @@

    Mezzio\Hal\ResourceGeneratorFactory
  • Registered as service: Mezzio\Hal\ResourceGenerator
  • Generates instance of: Mezzio\Hal\ResourceGenerator
    • -
  • Depends on:
    • +
  • 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.

    @@ -763,7 +770,7 @@

    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages

    • diff --git a/v2/hal/index.html b/v2/hal/index.html index 4d9f4d7..e7c08b6 100644 --- a/v2/hal/index.html +++ b/v2/hal/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -746,7 +735,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/index.html b/v2/index.html index bb60e34..2afc22d 100644 --- a/v2/index.html +++ b/v2/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -944,7 +933,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/installation/index.html b/v2/installation/index.html index b36309e..7b4b00e 100644 --- a/v2/installation/index.html +++ b/v2/installation/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -691,7 +680,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/links-and-resources/index.html b/v2/links-and-resources/index.html index 39d6c3b..6b5f1aa 100644 --- a/v2/links-and-resources/index.html +++ b/v2/links-and-resources/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -772,7 +761,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/migration/index.html b/v2/migration/index.html index af68075..8489dcc 100644 --- a/v2/migration/index.html +++ b/v2/migration/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -823,7 +812,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/representations/index.html b/v2/representations/index.html index e3fface..922657b 100644 --- a/v2/representations/index.html +++ b/v2/representations/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -743,7 +732,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages
    • diff --git a/v2/resource-generator/index.html b/v2/resource-generator/index.html index 2caf219..1ec5579 100644 --- a/v2/resource-generator/index.html +++ b/v2/resource-generator/index.html @@ -84,17 +84,6 @@ - -
    -
    - -
    -
    - API Tools
    - Build RESTful APIs in Minutes -
    -
    -
    @@ -421,40 +410,48 @@

    Metadata

    The component also provides four concrete metadata types, requiring the following information:

    We aggregate metadata in a Mezzio\Hal\Metadata\MetadataMap instance:

    $bookMetadata = new RouteBasedResourceMetadata(
@@ -506,27 +503,35 @@ 
    Configuration-based metadata
    
 ];

    The rest of the parameters follow underscore delimiter naming convention:

    ResourceGenerator

    Once you have defined the metadata for the various objects you will represent in your API, you can start generating resources.

    @@ -751,7 +756,7 @@
    Laminas
  • Laminas Project The new foundation for the community-supported, open source continuation of Zend Framework
  • Laminas Components and MVC Components and MVC for enterprise applications
  • Mezzio PSR-15 middleware in minutes
    • -
  • Laminas API Tools Build RESTful APIs in minutes
    • +
  • Maintenance Overview Current maintenance status of Laminas & Mezzio packages