MethodIsNotStatic

Description

MethodIsNotStatic is an exception thrown when an attempt is made to access a method statically, but that method is not a static method.

Public Interface

MethodIsNotStatic has the following public interface:

// our base class and interface(s)
use GanbaroDigital\ExceptionHelpers\V1\BaseExceptions\ParameterisedException;
use GanbaroDigital\HttpStatus\Interfaces\HttpRuntimeErrorException;
use GanbaroDigital\UnitTestHelpers\V1\Exceptions\UnitTestHelpersException;

// return types from our method(s)
use GanbaroDigital\HttpStatus\StatusValues\RuntimeError\UnexpectedErrorStatusProvider;

// how to import
use GanbaroDigital\UnitTestHelpers\V1\Exceptions\MethodIsNotStatic;

// our public interface
class MethodIsNotStatic
  extends ParameterisedException
  implements UnitTestHelpersException, HttpRuntimeErrorException
{
    /**
     * create a throwable exception
     *
     * @param  string $className
     *         the class we were asked to invoke
     * @param  string $methodName
     *         the method on $className that was not static
     * @return MethodIsNotStatic
     */
    public static function newFromClassAndMethod($className, $methodName);

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

How To Use

Creating Exceptions To Throw

Call MethodIsNotStatic::newFromClassAndMethod() to create a throwable exception:

throw MethodIsNotStatic::newFromClassAndMethod(MyClass::class, 'unhappyMethod');

Catching The Exception

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

// example 1: we catch only MethodIsNotStatic exceptions
use GanbaroDigital\UnitTestHelpers\V1\Exceptions\MethodIsNotStatic;

try {
    throw MethodIsNotStatic::newFromClassAndMethod(MyClass::class, 'unhappyMethod');
}
catch(MethodIsNotStatic $e) {
    // ...
}

// example 2: catch all exceptions thrown by the Unit Test Helpers library
use GanbaroDigital\UnitTestHelpers\V1\Exceptions\MethodIsNotStatic;
use GanbaroDigital\UnitTestHelpers\V1\Exceptions\UnitTestHelpersException;

try {
    throw MethodIsNotStatic::newFromClassAndMethod(MyClass::class, 'unhappyMethod');
}
catch(UnitTestHelpersException $e) {
    // ...
}

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

try {
    throw MethodIsNotStatic::newFromClassAndMethod(MyClass::class, 'unhappyMethod');
}
catch(HttpRuntimeErrorException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

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

try {
    throw MethodIsNotStatic::newFromClassAndMethod(MyClass::class, 'unhappyMethod');
}
catch(HttpException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

// example 5: catch all runtime exceptions
use GanbaroDigital\UnitTestHelpers\V1\Exceptions\MethodIsNotStatic;
use RuntimeException;

try {
    throw MethodIsNotStatic::newFromClassAndMethod(MyClass::class, 'unhappyMethod');
}
catch(RuntimeException $e) {
    // ...
}

Notes

None at this time.

See Also

• HttpRuntimeErrorException interface