ContainerIsReadOnly

Description

ContainerIsReadOnly is an exception. It is thrown when you attempt to change the contents of a dependency-injection container without first putting it into read-write mode.

Public Interface

ContainerIsReadOnly has the following public interface:

// ContainerIsReadOnly lives in this namespace
namespace GanbaroDigital\DIContainers\V1\Exceptions;

// our base classes and interfaces
use GanbaroDigital\DIContainers\V1\Exceptions\DIContainersException;
use GanbaroDigital\ExceptionHelpers\V1\BaseExceptions\ParameterisedException;
use GanbaroDigital\HttpStatus\Interfaces\HttpRuntimeErrorException;

// return type(s) for our methods
use GanbaroDigital\HttpStatus\StatusValues\RuntimeError\UnexpectedErrorStatus;

class ContainerIsReadOnly
  extends ParameterisedException
  implements DIContainersException, HttpRuntimeErrorException
{
    // adds 'getHttpStatus()' that returns a HTTP 500 status value object
    use UnexpectedErrorStatusProvider;

    /**
     * create a new exception
     *
     * @param  mixed $container
     *         the container that is read-only
     * @param  int|null $typeFlags
     *         do we want any extra type information in the final exception message?
     * @param  array $callerFilter
     *         are there any namespaces we want to filter out of the call stack?
     * @return ContainerIsReadOnly
     *         an fully-built exception for you to throw
     */
    public static function newFromContainer(
        $container,
        $typeFlags = null,
        array $callerFilter = []
    )

    /**
     * what was the data that we used to create the printable message?
     *
     * @return array
     */
    public function getMessageData();

    /**
     * what was the format string we used to create the printable message?
     *
     * @return string
     */
    public function getMessageFormat();

    /**
     * which HTTP status code do we map onto?
     *
     * @return UnexpectedErrorStatus
     */
    public function getHttpStatus();
}

How To Use

Creating Exceptions To Throw

Call ContainerIsReadOnly::newFromContainer() to create a new exception that you can throw:

use GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly;

throw ContainerIsReadOnly::newFromContainer($container);

Catching The Exception

ContainerIsReadOnly implements a rich set of classes and interfaces. You can use any of these to catch this exception.

// example 1: we catch only ContainerIsReadOnly exceptions
use GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly;

try {
    throw ContainerIsReadOnly::newFromContainer($container);
}
catch(ContainerIsReadOnly $e) {
    // ...
}

// example 2: catch all exceptions thrown by the DIContainers Library
use GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly;
use GanbaroDigital\DIContainers\V1\Exceptions\DIContainersException;

try {
    throw ContainerIsReadOnly::newFromContainer($container);
}
catch(DIContainersException $e) {
    // ...
}

// example 3: catch all exceptions where something went wrong that
// should never happen
use GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly;
use GanbaroDigital\HttpStatus\Interfaces\HttpRuntimeErrorException;

try {
    throw ContainerIsReadOnly::newFromContainer($container);
}
catch(HttpRuntimeErrorException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

// example 4: catch all exceptions that map onto a HTTP status
use GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly;
use GanbaroDigital\HttpStatus\Interfaces\HttpException;

try {
    throw ContainerIsReadOnly::newFromContainer($container);
}
catch(HttpException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

// example 5: catch all runtime exceptions
use GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly;
use RuntimeException;

try {
    throw ContainerIsReadOnly::newFromContainer($container);
}
catch(RuntimeException $e) {
    // ...
}

Class Contract

Here is the contract for this class:

GanbaroDigital\DIContainers\V1\Exceptions\ContainerIsReadOnly
 [x] Can instantiate
 [x] Is d i containers exception
 [x] Is parameterised exception
 [x] Is runtime exception
 [x] Is http runtime error exception
 [x] Maps to unexpected error status
 [x] Can build from container
 [x] Exception message contains caller
 [x] Exception message contains type of container

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

Notes

None at this time.

Changelog

v1.2016060601

• $callerFilter signature changed

  The $callerFilter parameter is now type-hinted as an array, and can no longer be NULL.

  If no $callerFilter parameter is provided, it now defaults to an empty list. It no longer defaults to FilterCodeCaller::$DEFAULT_PARTIALS; that list no longer exists.

  These changes were made to make this class compatible with the latest Exception Helpers Library.

See Also

• FactoryListContainer - dependency-injection container for factories