Spatie\SlashCommand\Handlers\BaseHandler

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	canHandle()	0	1	?
	handle()	0	1	?
A	__construct()	0	4	1
A	respondToSlack()	0	4	1
A	dispatch()	0	6	1
A	abort()	0	4	1
A	getRequest()	0	4	1

<?php

namespace Spatie\SlashCommand\Handlers;

use Illuminate\Contracts\Bus\Dispatcher;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Spatie\SlashCommand\Exceptions\SlackSlashCommandException;
use Spatie\SlashCommand\HandlesSlashCommand;
use Spatie\SlashCommand\Jobs\SlashCommandResponseJob;
use Spatie\SlashCommand\Request;
use Spatie\SlashCommand\Response;

abstract class BaseHandler implements HandlesSlashCommand
{
    use DispatchesJobs;

    /** @var \Spatie\SlashCommand\Request */
    protected $request;

    public function __construct(Request $request)
    {
        $this->request = $request;
    }

    public function respondToSlack(string $text = ''): Response
    {
        return Response::create($this->request)->withText($text);
    }

    protected function dispatch(SlashCommandResponseJob $job)
    {
        $job->setRequest($this->request);

        return app(Dispatcher::class)->dispatch($job);
    }

    protected function abort($response)
    {
        throw new SlackSlashCommandException($response);
    }

    public function getRequest(): Request
    {
        return $this->request;
    }

    /**
     * If this function returns true, the handle method will get called.
     *
     * @param \Spatie\SlashCommand\Request $request
     *
     * @return bool
     */
    abstract public function canHandle(Request $request): bool;

    /**
     * Handle the given request. Remember that Slack expects a response
     * within three seconds after the slash command was issued. If
     * there is more time needed, dispatch a job.
     *
     * @param \Spatie\SlashCommand\Request $request
     *
     * @return \Spatie\SlashCommand\Response
     */
    abstract public function handle(Request $request): Response;
}