Inheritance diagram for DefaultModel:

Public Member Functions
	__construct (\Magento\Framework\Session\SessionManagerInterface $session, \Magento\Captcha\Helper\Data $captchaData, \Magento\Captcha\Model\ResourceModel\LogFactory $resLogFactory, $formId)

	getBlockName ()

	isRequired ($login=null)

	isShownToLoggedInUser ()

	isCaseSensitive ()

	getFont ()

	getExpiration ()

	getTimeout ()

	getImgDir ()

	getImgUrl ()

	isCorrect ($word)

	getImgSrc ()

	logAttempt ($login)

	setShowCaptchaInSession ($value=true)

	getWordLen ()

	getWord ()

Public Member Functions inherited from CaptchaInterface
	generate ()

Data Fields
const	SESSION_WORD = 'word'

const	DEFAULT_WORD_LENGTH_FROM = 3

const	DEFAULT_WORD_LENGTH_TO = 5

Protected Member Functions
	generateWord ()

	setWord ($word)

	randomSize ()

	gc ()

Protected Attributes
	$captchaData

	$expiration

	$fsize = 22

	$formId

	$resLogFactory

	$keepSession = true

	$session

Detailed Description

Implementation of \Zend\Captcha\Image

@api

Since: 100.0.2

Definition at line 16 of file DefaultModel.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Session\SessionManagerInterface	$session,
		\Magento\Captcha\Helper\Data	$captchaData,
		\Magento\Captcha\Model\ResourceModel\LogFactory	$resLogFactory,
			$formId
	)

Parameters

\Magento\Framework\Session\SessionManagerInterface	$session
\Magento\Captcha\Helper\Data	$captchaData
ResourceModel\LogFactory	$resLogFactory
string	$formId

Exceptions

Definition at line 88 of file DefaultModel.php.

       {
         parent::__construct();
         $this->session = $session;
         $this->captchaData = $captchaData;
         $this->resLogFactory = $resLogFactory;
         $this->formId = $formId;
     }

Member Function Documentation

◆ gc()

gc ( )

protected

Overlap of the parent method

Returns: void

Now deleting old captcha images make crontab script

See also: \Magento\Captcha\Cron\DeleteExpiredImages::execute

Added SuppressWarnings since this method is declared in parent class and we can not use other method name. @SuppressWarnings(PHPMD.ShortMethodName)

Since: 100.2.0

Definition at line 546 of file DefaultModel.php.

     {
         //do nothing
     }

◆ generateWord()

generateWord ( )

protected

Generate word used for captcha render

Returns: string

Exceptions

Definition at line 378 of file DefaultModel.php.

     {
         $word = '';
         $symbols = $this->getSymbols();
         $wordLen = $this->getWordLen();
         for ($i = 0; $i < $wordLen; $i++) {
             $word .= $symbols[array_rand($symbols)];
         }
         return $word;
     }

◆ getBlockName()

getBlockName ( )

Get Block Name

Returns: string

Implements CaptchaInterface.

Definition at line 117 of file DefaultModel.php.

     {
         return \Magento\Captcha\Block\Captcha\DefaultCaptcha::class;
     }

◆ getExpiration()

getExpiration ( )

After this time isCorrect() is going to return FALSE even if word was guessed correctly

Returns: int

as "timeout" configuration parameter specifies timeout in minutes - we multiply it on 60 to set expiration in seconds

Definition at line 264 of file DefaultModel.php.

     {
         if (!$this->expiration) {
             $this->expiration = (int)$this->captchaData->getConfig('timeout') * 60;
         }
         return $this->expiration;
     }

◆ getFont()

getFont ( )

Get font to use when generating captcha

Returns: string

Definition at line 244 of file DefaultModel.php.

     {
         $font = (string)$this->captchaData->getConfig('font');
         $fonts = $this->captchaData->getFonts();
 
         if (isset($fonts[$font])) {
             $fontPath = $fonts[$font]['path'];
         } else {
             $fontData = array_shift($fonts);
             $fontPath = $fontData['path'];
         }
 
         return $fontPath;
     }

◆ getImgDir()

getImgDir ( )

Get captcha image directory

Returns: string

Definition at line 291 of file DefaultModel.php.

     {
         return $this->captchaData->getImgDir();
     }

◆ getImgSrc()

getImgSrc ( )

Return full URL to captcha image

Returns: string

Definition at line 333 of file DefaultModel.php.

     {
         return $this->getImgUrl() . $this->getId() . $this->getSuffix();
     }

◆ getImgUrl()

getImgUrl ( )

Get captcha image base URL

Returns: string

Definition at line 301 of file DefaultModel.php.

     {
         return $this->captchaData->getImgUrl();
     }

◆ getTimeout()

getTimeout ( )

Get timeout for session token

Returns: int

Definition at line 281 of file DefaultModel.php.

     {
         return $this->getExpiration();
     }

◆ getWord()

getWord ( )

Get captcha word

Returns: string

Definition at line 486 of file DefaultModel.php.

     {
         $sessionData = $this->session->getData($this->getFormIdKey(self::SESSION_WORD));
         return time() < $sessionData['expires'] ? $sessionData['data'] : null;
     }

◆ getWordLen()

getWordLen ( )

Returns length for generating captcha word. This value may be dynamic.

Returns: int

Exceptions

Definition at line 406 of file DefaultModel.php.

     {
         $from = 0;
         $to = 0;
         $length = (string)$this->captchaData->getConfig('length');
         if (!is_numeric($length)) {
             if (preg_match('/(\d+)-(\d+)/', $length, $matches)) {
                 $from = (int)$matches[1];
                 $to = (int)$matches[2];
             }
         } else {
             $from = (int)$length;
             $to = (int)$length;
         }
 
         if ($to < $from || $from < 1 || $to < 1) {
             $from = self::DEFAULT_WORD_LENGTH_FROM;
             $to = self::DEFAULT_WORD_LENGTH_TO;
         }
 
         return \Magento\Framework\Math\Random::getRandomNumber($from, $to);
     }

◆ isCaseSensitive()

isCaseSensitive ( )

Whether to respect case while checking the answer

Returns: bool

Definition at line 234 of file DefaultModel.php.

     {
         return (string)$this->captchaData->getConfig('case_sensitive');
     }

◆ isCorrect()

isCorrect ( $word )

Checks whether captcha was guessed correctly by user

Parameters

string $word

Returns: bool

Implements CaptchaInterface.

Definition at line 312 of file DefaultModel.php.

     {
         $storedWord = $this->getWord();
         $this->clearWord();
 
         if (!$word || !$storedWord) {
             return false;
         }
 
         if (!$this->isCaseSensitive()) {
             $storedWord = strtolower($storedWord);
             $word = strtolower($word);
         }
         return $word === $storedWord;
     }

◆ isRequired()

isRequired ( $login = null )

Whether captcha is required to be inserted to this form

Parameters

null | string $login

Returns: bool

Definition at line 128 of file DefaultModel.php.

     {
         if (($this->isUserAuth()
                 && !$this->isShownToLoggedInUser())
             || !$this->isEnabled()
             || !in_array(
                 $this->formId,
                 $this->getTargetForms()
             )
         ) {
             return false;
         }
 
         return $this->isShowAlways()
             || $this->isOverLimitAttempts($login)
             || $this->session->getData($this->getFormIdKey('show_captcha'));
     }

◆ isShownToLoggedInUser()

isShownToLoggedInUser ( )

Check if CAPTCHA has to be shown to logged in user on this form

Returns: bool

Definition at line 151 of file DefaultModel.php.

     {
         $forms = (array)$this->captchaData->getConfig('shown_to_logged_in_user');
         foreach ($forms as $formId => $isShownToLoggedIn) {
             if ($isShownToLoggedIn && $this->formId == $formId) {
                 return true;
             }
         }
         return false;
     }

◆ logAttempt()

logAttempt ( $login )

Log attempt

Parameters

string $login

Returns: $this

Definition at line 344 of file DefaultModel.php.

     {
         if ($this->isEnabled() && in_array($this->formId, $this->getTargetForms())) {
             $this->getResourceModel()->logAttempt($login);
             if ($this->isOverLimitLoginAttempts($login)) {
                 $this->setShowCaptchaInSession(true);
             }
         }
         return $this;
     }

◆ randomSize()

randomSize ( )

protected

Override function to generate less curly captcha that will not cut off

See also: \Zend\Captcha\Image::_randomSize()

Returns: int

Exceptions

Definition at line 529 of file DefaultModel.php.

     {
         return \Magento\Framework\Math\Random::getRandomNumber(280, 300) / 100;
     }

◆ setShowCaptchaInSession()

setShowCaptchaInSession ( $value = true )

Set show_captcha flag in session

Parameters

bool $value

Returns: void

Since: 100.1.0

Definition at line 362 of file DefaultModel.php.

     {
         if ($value !== true) {
             $value = false;
         }
 
         $this->session->setData($this->getFormIdKey('show_captcha'), $value);
     }

◆ setWord()

setWord ( $word )

protected

Set captcha word

Parameters

string $word

Returns: $this

Since: 100.2.0

Definition at line 499 of file DefaultModel.php.

     {
         $this->session->setData(
             $this->getFormIdKey(self::SESSION_WORD),
             ['data' => $word, 'expires' => time() + $this->getTimeout()]
         );
         $this->word = $word;
         return $this;
     }

Field Documentation

◆ $captchaData

$captchaData

protected

Definition at line 37 of file DefaultModel.php.

◆ $expiration

$expiration

protected

Definition at line 44 of file DefaultModel.php.

◆ $formId

$formId

protected

Definition at line 59 of file DefaultModel.php.

◆ $fsize

$fsize = 22

protected

Definition at line 52 of file DefaultModel.php.

◆ $keepSession

$keepSession = true

protected

Definition at line 73 of file DefaultModel.php.

◆ $resLogFactory

$resLogFactory

protected

Definition at line 65 of file DefaultModel.php.

◆ $session

$session

protected

Definition at line 79 of file DefaultModel.php.

◆ DEFAULT_WORD_LENGTH_FROM

const DEFAULT_WORD_LENGTH_FROM = 3

Min captcha lengths default value

Definition at line 26 of file DefaultModel.php.

◆ DEFAULT_WORD_LENGTH_TO

const DEFAULT_WORD_LENGTH_TO = 5

Max captcha lengths default value

Definition at line 31 of file DefaultModel.php.

◆ SESSION_WORD

const SESSION_WORD = 'word'

Key in session for captcha code

Definition at line 21 of file DefaultModel.php.

The documentation for this class was generated from the following file:

vendor/magento/module-captcha/Model/DefaultModel.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ gc()

◆ generateWord()

◆ getBlockName()

◆ getExpiration()

◆ getFont()

◆ getImgDir()

◆ getImgSrc()

◆ getImgUrl()

◆ getTimeout()

◆ getWord()

◆ getWordLen()

◆ isCaseSensitive()

◆ isCorrect()

◆ isRequired()

◆ isShownToLoggedInUser()

◆ logAttempt()

◆ randomSize()

◆ setShowCaptchaInSession()

◆ setWord()

Field Documentation

◆ $captchaData

◆ $expiration

◆ $formId

◆ $fsize

◆ $keepSession

◆ $resLogFactory

◆ $session

◆ DEFAULT_WORD_LENGTH_FROM

◆ DEFAULT_WORD_LENGTH_TO

◆ SESSION_WORD