How is Magento\Framework\View\Page\Title::set() implemented and used?

dmitrii_fediuk · May 7, 2017, 2:22pm

Implementation

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Page/Title.php#L48-L58


/**
 * Set page title
 *
 * @param string $title
 * @return $this
 */
public function set($title)
{
    $this->textValue = $title;
    return $this;
}

Usage examples

1. Magento\Framework\View\Page\Config\Generator\Head::processTitle()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Page/Config/Generator/Head.php#L143-L155


/**
 * Process title
 *
 * @param \Magento\Framework\View\Page\Config\Structure $pageStructure
 * @return $this
 */
protected function processTitle(Structure $pageStructure)
{
    if ($pageStructure->getTitle()) {
        $this->pageConfig->getTitle()->set($pageStructure->getTitle());
    }
    return $this;
}

2. Magento\Cms\Block\Page::_prepareLayout()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Cms/Block/Page.php#L94-L116


/**
 * Prepare global layout
 *
 * @return $this
 */
protected function _prepareLayout()
{
    $page = $this->getPage();
    $this->_addBreadcrumbs($page);
    $this->pageConfig->addBodyClass('cms-' . $page->getIdentifier());
    $metaTitle = $page->getMetaTitle();
    $this->pageConfig->getTitle()->set($metaTitle ? $metaTitle : $page->getTitle());
    $this->pageConfig->setKeywords($page->getMetaKeywords());
    $this->pageConfig->setDescription($page->getMetaDescription());


    $pageMainTitle = $this->getLayout()->getBlock('page.main.title');
    if ($pageMainTitle) {
        // Setting empty page title if content heading is absent
        $cmsTitle = $page->getContentHeading() ?: ' ';
        $pageMainTitle->setPageTitle($this->escapeHtml($cmsTitle));
    }
    return parent::_prepareLayout();
}

3. Magento\Catalog\Block\Product\View::_prepareLayout()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Catalog/Block/Product/View.php#L120-L163


/**
 * Add meta information from product to head block
 *
 * @return \Magento\Catalog\Block\Product\View
 */
protected function _prepareLayout()
{
    $this->getLayout()->createBlock('Magento\Catalog\Block\Breadcrumbs');
    $product = $this->getProduct();
    if (!$product) {
        return parent::_prepareLayout();
    }


    $title = $product->getMetaTitle();
    if ($title) {
        $this->pageConfig->getTitle()->set($title);
    }
    $keyword = $product->getMetaKeyword();
    $currentCategory = $this->_coreRegistry->registry('current_category');
    if ($keyword) {
        $this->pageConfig->setKeywords($keyword);
    } elseif ($currentCategory) {
        $this->pageConfig->setKeywords($product->getName());
    }
    $description = $product->getMetaDescription();
    if ($description) {
        $this->pageConfig->setDescription($description);
    } else {
        $this->pageConfig->setDescription($this->string->substr($product->getDescription(), 0, 255));
    }
    if ($this->_productHelper->canUseCanonicalTag()) {
        $this->pageConfig->addRemotePageAsset(
            $product->getUrlModel()->getUrl($product, ['_ignore_category' => true]),
            'canonical',
            ['attributes' => ['rel' => 'canonical']]
        );
    }


    $pageMainTitle = $this->getLayout()->getBlock('page.main.title');
    if ($pageMainTitle) {
        $pageMainTitle->setPageTitle($product->getName());
    }
    return parent::_prepareLayout();
}