Title Class Reference

Public Member Functions
	__construct (App\Config\ScopeConfigInterface $scopeConfig)
	set ($title)
	get ()
	getShort ()
	getShortHeading ()
	getDefault ()
	append ($suffix)
	prepend ($prefix)
	unsetValue ()

Data Fields
const	TITLE_GLUE = ' / '

Protected Member Functions
	build ($withConfigValues=true)
	addConfigValues ($title)

Detailed Description

Page title

@api

Since

100.0.2

Definition at line 17 of file Title.php.

Constructor & Destructor Documentation

__construct()

__construct

(

App\Config\ScopeConfigInterface

$scopeConfig

)

Parameters

App\Config\ScopeConfigInterface

$scopeConfig

Definition at line 47 of file Title.php.

      {
        $this->scopeConfig = $scopeConfig;
    }

Member Function Documentation

addConfigValues()

addConfigValues (   $title )

protected

Parameters

string

$title

Returns

string

Definition at line 113 of file Title.php.

    {
        $preparedTitle = $this->scopeConfig->getValue(
            'design/head/title_prefix',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        ) . ' ' . $title . ' ' . $this->scopeConfig->getValue(
            'design/head/title_suffix',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        return trim($preparedTitle);
    }

append()

append

(

$suffix

)

Parameters

string

$suffix

Returns

void

Definition at line 143 of file Title.php.

    {
        $this->appendedValues[] = $suffix;
    }

build()

build (   $withConfigValues = true )

protected

Parameters

bool

$withConfigValues

Returns

array

Definition at line 100 of file Title.php.

    {
        return array_merge(
            $this->prependedValues,
            [$withConfigValues ? $this->addConfigValues($this->textValue) : $this->textValue],
            $this->appendedValues
        );
    }

get()

get

(

)

Retrieve title element text (encoded)

Returns

string

Definition at line 70 of file Title.php.

    {
        return join(self::TITLE_GLUE, $this->build());
    }

getDefault()

getDefault

(

)

Retrieve default title text

Returns

string

Definition at line 130 of file Title.php.

    {
        $defaultTitle = $this->scopeConfig->getValue(
            'design/head/default_title',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        return $this->addConfigValues($defaultTitle);
    }

getShort()

getShort

(

)

Same as getTitle(), but return only first item from chunk

Returns

mixed

Definition at line 80 of file Title.php.

    {
        $title = $this->build();
        return reset($title);
    }

getShortHeading()

getShortHeading

(

)

Same as getShort(), but return title without prefix and suffix

Returns

mixed

Definition at line 90 of file Title.php.

    {
        $title = $this->build(false);
        return reset($title);
    }

prepend()

prepend

(

$prefix

)

Parameters

string

$prefix

Returns

void

Definition at line 152 of file Title.php.

    {
        array_unshift($this->prependedValues, $prefix);
    }

set()

set

(

$title

)

Set page title

Parameters

string

$title

Returns

$this

Definition at line 59 of file Title.php.

    {
        $this->textValue = $title;
        return $this;
    }

unsetValue()

unsetValue

(

)

Unset title

Returns

void

Definition at line 162 of file Title.php.

    {
        $this->textValue = null;
    }

Field Documentation

TITLE_GLUE

const TITLE_GLUE = ' / '

Default title glue

Definition at line 22 of file Title.php.

---

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

• vendor/magento/framework/View/Page/Title.php