Cubiche\Core\Bus\Exception\NotFoundException

Complexity

Total Complexity

9

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	notFound()	0	8	2
A	nameOfMessage()	0	4	1
A	nameOfCommand()	0	4	1
A	handlerMethodNameForObject()	0	4	1
A	nameOfQuery()	0	4	1
A	handlerFor()	0	7	1
A	middlewareOfType()	0	7	1
A	methodForObject()	0	4	1

<?php
/**
 * This file is part of the Cubiche package.
 *
 * Copyright (c) Cubiche
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cubiche\Core\Bus\Exception;

use RuntimeException;
use Exception;

/**
 * NotFoundException class.
 *
 * @author Ivannis Suárez Jerez <ivannis.suarez@gmail.com>
 */
class NotFoundException extends RuntimeException
{
    /**
     * Creates an exception for a not found message name, method name or handler for a given message.
     *
     * @param string         $type
     * @param mixed          $message
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    protected static function notFound($type, $message, Exception $cause = null)
    {
        return new static(sprintf(
            'Not found a %s for a given object of type %s',
            $type,
            is_object($message) ? get_class($message) : gettype($message)
        ), 0, $cause);
    }

    /**
     * @param mixed          $object
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function nameOfMessage($object, Exception $cause = null)
    {
        return self::notFound('name of message', $object, $cause);
    }

    /**
     * @param mixed          $object
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function nameOfCommand($object, Exception $cause = null)
    {
        return self::notFound('name of command', $object, $cause);
    }

    /**
     * @param mixed          $object
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function handlerMethodNameForObject($object, Exception $cause = null)
    {
        return self::notFound('handler method name', $object, $cause);
    }

    /**
     * @param mixed          $object
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function nameOfQuery($object, Exception $cause = null)
    {
        return self::notFound('name of query', $object, $cause);
    }

    /**
     * @param string         $messageName
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function handlerFor($messageName, Exception $cause = null)
    {
        return new static(sprintf(
            'Not found a handler for a given message named %s',
            $messageName
        ), 0, $cause);
    }

    /**
     * Creates an exception for a not found middleware.
     *
     * @param string         $type
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function middlewareOfType($type, Exception $cause = null)
    {
        return new static(sprintf(
            'Not found a middleware of type %s',
            $type
        ), 0, $cause);
    }

    /**
     * @param mixed          $object
     * @param string         $method
     * @param Exception|null $cause
     *
     * @return NotFoundException
     */
    public static function methodForObject($object, $method, Exception $cause = null)
    {
        return self::notFound('method with name `'.$method.'`', $object, $cause);
    }
}