MultiStatusStatusProvider

Since v1.0.0

Description

MultiStatusStatusProvider is a trait. It adds a getHttpStatus() method to your entity, value object or exception. This method returns a HttpStatus value object that represents the status HTTP 207 Multi-Status.

MultiStatusStatusProvider satisfies the HttpStatusProvider and HttpException interfaces.

Public Interface

MultiStatusStatusProvider has the following public interface:

// MultiStatusStatusProvider lives in this namespace
namespace GanbaroDigital\HttpStatus\StatusProviders\Successful;

// our return types
use GanbaroDigital\HttpStatus\StatusValues\Successful\MultiStatusStatus;

trait MultiStatusStatusProvider
{
    /**
     * returns the HTTP status code that best represents this object
     *
     * @return MultiStatusStatus
     */
    public function getHttpStatus();
}

How To Use

In Value Objects and Entities

Use this trait in any value object or entity that maps onto the HTTP 207 status.

use GanbaroDigital\HttpStatus\Interfaces\HttpStatusProvider;
use GanbaroDigital\HttpStatus\StatusProviders\Successful\MultiStatusStatusProvider;

class MyValueObject implements HttpStatusProvider
{
    // adds getHttpStatus()
    use MultiStatusStatusProvider;
}

PHP does not let traits implement interfaces. Your value object or entity will need to implement the HttpStatusProvider interface explicitly.

In Exceptions

Use this trait in any exception that maps onto the HTTP 207 status.

use GanbaroDigital\HttpStatus\Interfaces\HttpSuccessfulException;
use GanbaroDigital\HttpStatus\StatusProviders\Successful\MultiStatusStatusProvider;

class MyException implements HttpSuccessfulException
{
    // adds getHttpStatus()
    use MultiStatusStatusProvider;
}

PHP does not let traits implement interfaces. Your value object or entity will need to implement the HttpSuccessfulException interface explicitly.

In practice, it would be very unusual to use an exception to represent a HTTP 2xx status code.

Class Contract

Here is the contract for this class:

GanbaroDigital\HttpStatus\StatusProviders\Successful\MultiStatusStatusProvider
 [x] Can instantiate class that uses this trait
 [x] Returns multi status status

Class contracts are built from this class's unit tests.

Future releases of this class will not break this contract.

Future releases of this class may add to this contract. New additions may include:

  • clarifying existing behaviour (e.g. stricter contract around input or return types)
  • add new behaviours (e.g. extra class methods)

When you use this class, you can only rely on the behaviours documented by this contract.

If you:

  • find other ways to use this class,
  • or depend on behaviours that are not covered by a unit test,
  • or depend on undocumented internal states of this class,

... your code may not work in the future.

Notes

See Also