Inline Class Reference

Inheritance diagram for Inline:

Public Member Functions
	__construct (\Magento\Framework\App\ScopeResolverInterface $scopeResolver, \Magento\Framework\UrlInterface $url, \Magento\Framework\View\LayoutInterface $layout, \Magento\Framework\Translate\Inline\ConfigInterface $config, \Magento\Framework\Translate\Inline\ParserInterface $parser, \Magento\Framework\Translate\Inline\StateInterface $state, $templateFileName='', $translatorRoute='', $scope=null)
	isAllowed ()
	getParser ()
	processResponseBody (&$body, $isJson=false)
	getAdditionalHtmlAttribute ($tagName=null)

Protected Member Functions
	addInlineScript ()
	getAjaxUrl ()
	stripInlineTranslations (&$body)

Protected Attributes
	$isAllowed
	$parser
	$isScriptInserted = false
	$url
	$layout
	$config
	$scopeResolver
	$templateFileName
	$translatorRoute
	$scope
	$state

Detailed Description

Definition at line 11 of file Inline.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\UrlInterface	$url,
		\Magento\Framework\View\LayoutInterface	$layout,
		\Magento\Framework\Translate\Inline\ConfigInterface	$config,
		\Magento\Framework\Translate\Inline\ParserInterface	$parser,
		\Magento\Framework\Translate\Inline\StateInterface	$state,
			$templateFileName = '',
			$translatorRoute = '',
			$scope = null
	)

Initialize inline translation model

Parameters

\Magento\Framework\App\ScopeResolverInterface	$scopeResolver
\Magento\Framework\UrlInterface	$url
\Magento\Framework\View\LayoutInterface	$layout
Inline\ConfigInterface	$config
Inline\ParserInterface	$parser
Inline\StateInterface	$state
string	$templateFileName
string	$translatorRoute
null	$scope

Definition at line 85 of file Inline.php.

      {
        $this->scopeResolver = $scopeResolver;
        $this->url = $url;
        $this->layout = $layout;
        $this->config = $config;
        $this->parser = $parser;
        $this->state = $state;
        $this->templateFileName = $templateFileName;
        $this->translatorRoute = $translatorRoute;
        $this->scope = $scope;
    }

Member Function Documentation

addInlineScript()

addInlineScript ( )

protected

Add inline script code

Insert script and html with added inline translation content.

Returns

void

Definition at line 185 of file Inline.php.

    {
        $content = $this->getParser()->getContent();
        if (stripos($content, '</body>') === false) {
            return;
        }
        if (!$this->isScriptInserted) {
            $this->getParser()->setContent(str_ireplace('</body>', $this->getInlineScript() . '</body>', $content));
            $this->isScriptInserted = true;
        }
    }

getAdditionalHtmlAttribute()

getAdditionalHtmlAttribute

(

$tagName = null

)

Additional translation mode html attribute is not needed for base inline translation.

Parameters

mixed | string | null

$tagName

Returns

null @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements InlineInterface.

Definition at line 172 of file Inline.php.

    {
        return null;
    }

getAjaxUrl()

getAjaxUrl ( )

protected

Return URL for ajax requests

Returns

string

Definition at line 221 of file Inline.php.

    {
        return $this->url->getUrl(
            $this->translatorRoute,
            ['_secure' => $this->scopeResolver->getScope()->isCurrentlySecure()]
        );
    }

getParser()

getParser

(

)

Retrieve Inline Parser instance

Returns

Inline\ParserInterface

Implements InlineInterface.

Definition at line 129 of file Inline.php.

    {
        return $this->parser;
    }

isAllowed()

isAllowed

(

)

Check if Inline Translates is allowed

Returns

bool

Implements InlineInterface.

Definition at line 112 of file Inline.php.

    {
        if ($this->isAllowed === null) {
            if (!$this->scope instanceof \Magento\Framework\App\ScopeInterface) {
                $scope = $this->scopeResolver->getScope($this->scope);
            }
            $this->isAllowed = $this->config->isActive($scope)
                && $this->config->isDevAllowed($scope);
        }
        return $this->state->isEnabled() && $this->isAllowed;
    }

processResponseBody()

processResponseBody	(	&	$body,
			$isJson = false
	)

Replace translation templates with HTML fragments

Parameters

array | string	&$body
bool	$isJson

Returns

$this

Implements InlineInterface.

Definition at line 141 of file Inline.php.

    {
        if (!$this->isAllowed()) {
            $this->stripInlineTranslations($body);
            return $this;
        }

        $this->getParser()->setIsJson($isJson);

        if (is_array($body)) {
            foreach ($body as &$part) {
                $this->processResponseBody($part, $isJson);
            }
        } elseif (is_string($body)) {
            $this->getParser()->processResponseBodyString($body);
            $this->addInlineScript();
            $body = $this->getParser()->getContent();
        }

        $this->getParser()->setIsJson(false);

        return $this;
    }

stripInlineTranslations()

stripInlineTranslations ( &  $body )

protected

Strip inline translations from text

Parameters

array | string

&$body

Returns

$this

Definition at line 235 of file Inline.php.

    {
        if (is_array($body)) {
            foreach ($body as &$part) {
                $this->stripInlineTranslations($part);
            }
        } else {
            if (is_string($body)) {
                $body = preg_replace(
                    '#' . \Magento\Framework\Translate\Inline\ParserInterface::REGEXP_TOKEN . '#',
                    '$1',
                    $body
                );
            }
        }
        return $this;
    }

Field Documentation

$config

$config

protected

Definition at line 45 of file Inline.php.

$isAllowed

$isAllowed

protected

Definition at line 18 of file Inline.php.

$isScriptInserted

$isScriptInserted = false

protected

Definition at line 30 of file Inline.php.

$layout

$layout

protected

Definition at line 40 of file Inline.php.

$parser

$parser

protected

Definition at line 23 of file Inline.php.

$scope

$scope

protected

Definition at line 65 of file Inline.php.

$scopeResolver

$scopeResolver

protected

Definition at line 50 of file Inline.php.

$state

$state

protected

Definition at line 70 of file Inline.php.

$templateFileName

$templateFileName

protected

Definition at line 55 of file Inline.php.

$translatorRoute

$translatorRoute

protected

Definition at line 60 of file Inline.php.

$url

$url

protected

Definition at line 35 of file Inline.php.

---

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

• vendor/magento/framework/Translate/Inline.php