BadRequirementArgs

Description

BadRequirementArgs is an exception. It is thrown when data passed into RequireAllOf or RequireAnyOneOf isn't an array.

Public Interface

BadRequirementArgs has the following public interface:

// BadRequirementArgs lives in this namespace
namespace GanbaroDigital\Defensive\V1\Exceptions;

// our base class and interface(s)
use GanbaroDigital\ExceptionHelpers\V1\BaseExceptions\ParameterisedException;
use GanbaroDigital\HttpStatus\Interfaces\HttpRequestErrorException;

// return types from our method(s)
use GanbaroDigital\HttpStatus\StatusValues\RequestError\UnprocessableEntityStatus;

class BadRequirementArgs
  extends ParameterisedException
  implements DefensiveException, HttpRequestErrorException
{
    // we map onto HTTP 422
    use UnprocessableEntityStatusProvider;

    /**
     * creates a new exception about data we could not use as input parameters
     * for a single Requirement object
     *
     * @param  mixed $fieldOrVar
     *         the value that you're throwing an exception about
     * @param  string $fieldOrVarName
     *         the name of the value in your code
     * @param  array $extraData
     *         extra data that you want to include in your exception
     * @param  int|null $typeFlags
     *         do we want any extra type information in the final
     *         exception message?
     * @param  array $callStackFilter
     *         are there any namespaces we want to filter out of
     *         the call stack?
     * @return BadRequirementArgs
     *         an fully-built exception for you to throw
     */
    public static function newFromVar(
        $fieldOrVar,
        $fieldOrVarName,
        array $extraData = [],
        $typeFlags = null,
        array $callStackFilter = []
    );

    /**
     * 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 UnprocessableEntityStatus
     */
    public function getHttpStatus();
}

How To Use

Creating Exceptions To Throw

Call BadRequirementArgs::newFromVar() to create a new throwable exception:

// how to import
use GanbaroDigital\Defensive\V1\Exceptions\BadRequirementArgs;

throw BadRequirementArgs::newFromVar([], '$data');

Catching The Exception

BadRequirementArgs extends or implements a rich set of classes and interfaces. You can use any of these to catch thrown exceptions.

// example 1: we catch only BadRequirementArgs exceptions
use GanbaroDigital\Defensive\V1\Exceptions\BadRequirementArgs;

try {
    throw BadRequirementArgs::newFromVar([], '$data');
}
catch(BadRequirementArgs $e) {
    // ...
}

// example 2: catch all exceptions thrown by the Defensive Library
use GanbaroDigital\Defensive\V1\Exceptions\BadRequirementArgs;
use GanbaroDigital\Defensive\V1\Exceptions\DefensiveException;

try {
    throw BadRequirementArgs::newFromVar([], '$data');
}
catch(DefensiveException $e) {
    // ...
}

// example 3: catch all exceptions where there was a problem with the
// parameter(s) passed into the method
use GanbaroDigital\Defensive\V1\Exceptions\BadRequirementArgs;
use GanbaroDigital\HttpStatus\Interfaces\HttpRequestErrorException;

try {
    throw BadRequirementArgs::newFromVar([], '$data');
}
catch(HttpRequestErrorException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

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

try {
    throw BadRequirementArgs::newFromVar([], '$data');
}
catch(HttpException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

// example 5: catch all runtime exceptions
use GanbaroDigital\Defensive\V1\Exceptions\BadRequirementArgs;
use RuntimeException;

try {
    throw BadRequirementArgs::newFromVar([], '$data');
}
catch(RuntimeException $e) {
    // ...
}

Class Contract

Here is the contract for this class:

GanbaroDigital\Defensive\V1\Exceptions\BadRequirementArgs
 [x] Can instantiate
 [x] is DefensiveException
 [x] is RuntimeException
 [x] is HttpStatusProvider
 [x] maps to UnprocessableEntity
 [x] Can create from bad requirement args

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

Notes

None at this time.

See Also

• ParameterisedException class
• mapping exceptions onto HTTP status codes