pmjones/adr

An alternative to MVC for server-side applications.

Maintainers

Details

github.com/pmjones/adr-example

Homepage

Source

Issues

Installs: 9

Dependents: 0

Suggesters: 0

Security: 0

Stars: 66

Watchers: 8

Forks: 9

Open Issues: 2

dev-master 2018-01-19 17:43 UTC

Requires

Requires (Dev)

MIT 3d3bd4a6b63af90bb635f7681d27d62c6a8a0148

  • Paul M. Jones <pmjones.woop@pmjones.io>

This package is auto-updated.

Last update: 2024-11-11 04:59:22 UTC

README

This example shows an Action Domain Responder user interface subsystem, with the corresponding domain logic and data source elements, for a naive blogging system.

This is not a running example, in the sense that it cannot be dropped onto a web server and begin operating properly.

However, there is a full test suite in the tests/ directory. (These are more properly considred integration rather than unit tests, but they will do for the purpose of this example.) Issue composer install followed by ./vendor/bin/phpunit to run the tests.

There is no authentication, authorization, or session mechanism included. While necessary in a real system, they would increase the complexity of the example and make it more difficult to discern the separation of concerns.

Action

The Action classes depend on 3rd-party HTTP Request and Response interfaces.

Each Action picks apart the incoming request to pass individual typehinted Domain method arguments. A differently-constructed Domain might require a different input signature, such as a data transfer object or a catch-all array of all possible request values.

Domain

The base ApplicationService class protects all the "real" service methods behind the magic __call() method. This allows the service to implement some functionality common to all the service methods, such as exception handling, though it does get in the way of IDE auto-completion.

The BlogService methods return a domain Payload that wraps the domain results and includes a status indicator. This standardizes the domain return signature, makes the BlogResponder work much more readable.

The domain logic uses a Data Mapper for data source interactions (BlogMapper et al.).

Responder

Each Responder calls a method corresponding to the domain Payload status to build the HTTP Response.

The base Responder class depends on a 3rd-party HTTP Request interface and Response object.

The base BlogResponder class depends on a 3rd-party PHP-based Template View system. The templates are located in resources/templates/blog/.