Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, Filesystem $filesystem, \Magento\Captcha\Model\CaptchaFactory $factory)
	getCaptcha ($formId)
	getConfig ($key, $store=null)
	getFonts ()
	getImgDir ($website=null)
	getImgUrl ($website=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	INPUT_NAME_FIELD_VALUE = 'captcha'
const	MODE_ALWAYS = 'always'
const	MODE_AFTER_FAIL = 'after_fail'
const	XML_PATH_CAPTCHA_FONTS = 'captcha/fonts'
const	DEFAULT_CAPTCHA_TYPE = 'Zend'

Protected Member Functions
	_getWebsiteCode ($website=null)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_captcha = []
	$_filesystem
	$_storeManager
	$_factory
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Captcha image model

@api

Since

100.0.2

Definition at line 18 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		Filesystem	$filesystem,
		\Magento\Captcha\Model\CaptchaFactory	$factory
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
Filesystem	$filesystem
\Magento\Captcha\Model\CaptchaFactory	$factory

Definition at line 72 of file Data.php.

      {
        $this->_storeManager = $storeManager;
        $this->_filesystem = $filesystem;
        $this->_factory = $factory;
        parent::__construct($context);
    }

Member Function Documentation

_getWebsiteCode()

_getWebsiteCode (   $website = null )

protected

Get website code

Parameters

mixed

$website

Returns

string

Definition at line 165 of file Data.php.

    {
        return $this->_storeManager->getWebsite($website)->getCode();
    }

getCaptcha()

getCaptcha

(

$formId

)

Get Captcha

Parameters

string

$formId

Returns

\Magento\Captcha\Model\CaptchaInterface

Definition at line 90 of file Data.php.

    {
        if (!array_key_exists($formId, $this->_captcha)) {
            $captchaType = ucfirst($this->getConfig('type'));
            if (!$captchaType) {
                $captchaType = self::DEFAULT_CAPTCHA_TYPE;
            } elseif ($captchaType == 'Default') {
                $captchaType = $captchaType . 'Model';
            }

            $this->_captcha[$formId] = $this->_factory->create($captchaType, $formId);
        }
        return $this->_captcha[$formId];
    }

getConfig()

getConfig	(		$key,
			$store = null
	)

Returns config value

Parameters

string	$key	The last part of XML_PATH_$area_CAPTCHA_ constant (case insensitive)
\Magento\Store\Model\Store	$store

Returns

\Magento\Framework\App\Config\Element

Definition at line 112 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            'customer/captcha/' . $key,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getFonts()

getFonts

(

)

Get list of available fonts.

Return format: [['arial'] => ['label' => 'Arial', 'path' => '/www/magento/fonts/arial.ttf']]

Returns

array

Definition at line 129 of file Data.php.

    {
        $fontsConfig = $this->scopeConfig->getValue(\Magento\Captcha\Helper\Data::XML_PATH_CAPTCHA_FONTS, 'default');
        $fonts = [];
        if ($fontsConfig) {
            $libDir = $this->_filesystem->getDirectoryRead(DirectoryList::LIB_INTERNAL);
            foreach ($fontsConfig as $fontName => $fontConfig) {
                $fonts[$fontName] = [
                    'label' => $fontConfig['label'],
                    'path' => $libDir->getAbsolutePath($fontConfig['path']),
                ];
            }
        }
        return $fonts;
    }

getImgDir()

getImgDir

(

$website = null

)

Get captcha image directory

Parameters

mixed

$website

Returns

string

Definition at line 151 of file Data.php.

    {
        $mediaDir = $this->_filesystem->getDirectoryWrite(DirectoryList::MEDIA);
        $captchaDir = '/captcha/' . $this->_getWebsiteCode($website);
        $mediaDir->create($captchaDir);
        return $mediaDir->getAbsolutePath($captchaDir) . '/';
    }

getImgUrl()

getImgUrl

(

$website = null

)

Get captcha image base URL

Parameters

mixed

$website

Returns

string

Definition at line 176 of file Data.php.

    {
        return $this->_storeManager->getStore()->getBaseUrl(
            DirectoryList::MEDIA
        ) . 'captcha' . '/' . $this->_getWebsiteCode(
            $website
        ) . '/';
    }

Field Documentation

$_captcha

$_captcha = []

protected

Definition at line 49 of file Data.php.

$_factory

$_factory

protected

Definition at line 64 of file Data.php.

$_filesystem

$_filesystem

protected

Definition at line 54 of file Data.php.

$_storeManager

$_storeManager

protected

Definition at line 59 of file Data.php.

DEFAULT_CAPTCHA_TYPE

const DEFAULT_CAPTCHA_TYPE = 'Zend'

Default captcha type

Definition at line 43 of file Data.php.

INPUT_NAME_FIELD_VALUE

const INPUT_NAME_FIELD_VALUE = 'captcha'

Used for "name" attribute of captcha's input field

Definition at line 23 of file Data.php.

MODE_AFTER_FAIL

const MODE_AFTER_FAIL = 'after_fail'

Show captcha only after certain number of unsuccessful attempts

Definition at line 33 of file Data.php.

MODE_ALWAYS

const MODE_ALWAYS = 'always'

Always show captcha

Definition at line 28 of file Data.php.

XML_PATH_CAPTCHA_FONTS

const XML_PATH_CAPTCHA_FONTS = 'captcha/fonts'

Captcha fonts path

Definition at line 38 of file Data.php.

---

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

• vendor/magento/module-captcha/Helper/Data.php