Captcha.php

Go to the documentation of this file.

<?php

 
namespace Depage\HtmlForm\Elements;
 
use Gregwar\Captcha\CaptchaBuilder;
use Gregwar\Captcha\PhraseBuilder;

class Captcha extends Text
{
    protected $captcha = null;

    protected $sessionSlot = null;
 
    protected $textColor = false;
    protected $backgroundColor = false;
    protected $width = 250;
    protected $height = 100;

    protected function setDefaults(): void
    {
        parent::setDefaults();
        $this->defaults['defaultValue'] = false;
        $this->defaults['errorMessage'] = _('Please fill in the correct phrase.');
        $this->defaults['textColor'] = false;
        $this->defaults['backgroundColor'] = false;
        $this->defaults['width'] = 250;
        $this->defaults['height'] = 100;
    }

    public function __construct(string $name, array $parameters, object $form)
    {
        $this->captcha = new CaptchaBuilder();
 
        parent::__construct($name, $parameters, $form);
 
        if (is_array($this->textColor)) {
            $this->captcha->setTextColor($this->textColor[0], $this->textColor[1], $this->textColor[2]);
        }
        if (is_array($this->backgroundColor)) {
            $this->captcha->setBackgroundColor($this->backgroundColor[0], $this->backgroundColor[1], $this->backgroundColor[2]);
        }
    }

    public function setValue(mixed $newValue): mixed
    {
        if (is_bool($newValue)) {
            $this->value = $newValue;
        } else {
            $this->value = $newValue;
        }
 
        return $this->value;
    }

    public function setSessionSlot(&$sessionSlot): void
    {
        $this->sessionSlot = &$sessionSlot;
 
    }

    public function validate(): bool
    {
        if (!$this->validated) {
            $this->validated = true;
 
            $this->valid = $this->value === true || $this->testPhrase($this->value);
        }
 
        return $this->valid;
    }

    protected function testPhrase(mixed $value): bool
    {
        $this->captcha->setPhrase($this->sessionSlot['formCaptcha'] ?? "");
 
        if (!$this->captcha->testPhrase($value)) {
            $this->getNewPhrase();
 
            return false;
        }
 
        return true;
    }

    protected function getNewPhrase(): void
    {
        $phraseBuilder = new PhraseBuilder();
        $phrase = $phraseBuilder->build();
 
        $this->captcha->setPhrase($phrase);
        $this->sessionSlot['formCaptcha'] = $phrase;
    }

    public function __toString(): string
    {
        $value              = $this->htmlValue();
        $type               = strtolower($this->type);
        $inputAttributes    = $this->htmlInputAttributes();
        $marker             = $this->htmlMarker();
        $label              = $this->htmlLabel();
        $list               = $this->htmlList();
        $wrapperAttributes  = $this->htmlWrapperAttributes();
        $errorMessage       = $this->htmlErrorMessage();
        $helpMessage        = $this->htmlHelpMessage();
 
        if (empty($this->sessionSlot['formCaptcha'])) {
            $this->getNewPhrase();
        }
 
        $this->captcha->build($this->width, $this->height);
 
        return "<p {$wrapperAttributes}>"
            . "<label>"
                . "<span class=\"depage-label\">{$label}{$marker}</span>"
                . "<span class=\"captcha-img\">"
                    . "<img src=\"" . $this->captcha->inline() . "\" />"
                . "</span>"
                . "<input name=\"{$this->name}\" type=\"{$type}\"{$inputAttributes} value=\"$value\">"
                . $list
            . "</label>"
            . $errorMessage
            . $helpMessage
        . "</p>\n";
    }
}
 
// vim:set ft=php sw=4 sts=4 fdm=marker et :