Shieldon\Firewall\Kernel\CaptchaTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setCaptcha()	0	4	1
A	captchaResponse()	0	18	4

<?php
/*
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <contact@terryl.in>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Kernel;

use Shieldon\Firewall\Captcha\CaptchaInterface;

/*
 * Captcha Trait is loaded in Kernel instance only.
 */
trait CaptchaTrait
{
    /**
     * Container for captcha addons.
     * The collection of \Shieldon\Firewall\Captcha\CaptchaInterface
     *
     * @var array
     */
    public $captcha = [];

    /**
     * Set a captcha.
     *
     * @param CaptchaInterface $instance
     *
     * @return void
     */
    public function setCaptcha(CaptchaInterface $instance): void
    {
        $class = $this->getClassName($instance);

It seems like getClassName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->captcha[$class] = $instance;
    }

    /**
     * Return the result from Captchas.
     *
     * @return bool
     */
    public function captchaResponse(): bool
    {
        foreach ($this->captcha as $captcha) {
            
            if (!$captcha->response()) {
                return false;
            }
        }

        /**
         * $sessionLimit @ SessionTrait
         * sessionHandler() @ SessionTrait
         */
        if (!empty($this->sessionLimit['count'])) {
            $this->result = $this->sessionHandler(self::RESPONSE_ALLOW);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

The constant Shieldon\Firewall\Kernel\CaptchaTrait::RESPONSE_ALLOW was not found. Maybe you did not declare it correctly or list all dependencies?

It seems like sessionHandler() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return true;
    }
}