Each component should contain a description of how it can be used in an application

[froschdesign]

Problem

At the moment, most components only describe basic usage without integration and use within an application. This ends up in recurring questions from users how a component can be used in a zend-mvc-based or zend-expressive application.

Examples

• zend-barcode
• zend-cache
• zend-filter (usage of FilterPluginManager is missing)
• zend-form (usage of FormElementManager is missing)
• zend-hydrator (usage of HydratorPluginManager is missing)
• zend-inputfilter (usage of InputFilterManager is missing)
• zend-validator (usage of ValidatorPluginManager is missing)
• etc.

Suggestion

We should add for each component a description of how the component can be used in an application. It would be advantageous if we add descriptions for:

• zend-mvc applications
• zend-expressive applications
• a stand-alone usage
• and other frameworks, libraries etc.

The description should covered only a basic example how a component can be integrated in an application. For examples that illustrate full functionality, the tutorials should be used. The descriptions for application integrations should only be bundles of individual descriptions, which should already exist in the components. Therefore links must be set for all steps.

Requirements

• the descriptions for Mezzio must use mezzio-tooling
• the descriptions for laminas-mvc must use laminas-cli; if corresponding commands are available
• links must be added which describe the individual steps in detail

Examples

An example can be found at zend-navigation:

Usage in a zend-mvc-based application

The fastest way to get up and running with zend-navigation is:

• Register zend-navigation as module.
• Define navigation container configuration under the top-level navigation key in your application configuration.
• Render your container using a navigation view helper within your view scripts.

…

https://docs.zendframework.com/zend-navigation/quick-start/#usage-in-a-zend-mvc-based-application

Another example can be found at zend-i18n (WIP):

Usage in a Slim Application

The following examples show two options for using the Translator of zend-i18n in the micro framework Slim.

…

https://froschdesign.github.io/zend-documentation-showcase/application-integration/slim/

Already present

For laminas-mvc based applications

• laminas-form
• laminas-inputfilter
• laminas-session

See also: https://docs.laminas.dev/tutorials/#application-integrations

For Mezzio based applications

• laminas-inputfilter

Project

There is a project that tracks progress on this topic: https://github.com/orgs/laminas/projects/3

[settermjd]

As zend-mvc and zend-expressive build on these components and people will logically want to use them together, this makes a lot of sense.