Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/old/vendor/mageworx/module-seoxtemplates/Helper/Comment/Category/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

<?php
/**
 * Copyright © MageWorx. All rights reserved.
 * See LICENSE.txt for license details.
 */
namespace MageWorx\SeoXTemplates\Helper\Comment\Category;

class Source extends \Magento\Framework\App\Helper\AbstractHelper
{
    /**
     * Return Static Variable header
     *
     * @return string
     */
    public function getStaticVariableHeader(): string
    {
        return '<p><p><b><u>' . __('Static Template variables:') . '</u></b>' . ' ' .
            __('their values are written in product/category attributes in the backend.') . ' ' .
            __('The values of randomizer feature will also be written in the attributes.');
    }

    /**
     * Return Dynamic Variable header
     *
     * @return string
     */
    public function getDynamicVariableHeader(): string
    {
        return '<br><p><p><b><u>' . __('Dynamic Template variables:') . '</u></b>' .
            ' <font color = "#ea7601">' . __('their values will only be seen on the frontend. In the backend you’ll see the variables themselves.') . '</font>' .
            ' ' . __('Here randomizer values will change with every page refresh.');
    }

    /**
     * Return comment for Category
     *
     * @return string
     */
    public function getCategoryComment(): string
    {
        return '<b>[category]</b> - ' . __('output a current category name') . ';';
    }

    /**
     * Return comment for Categories
     *
     * @return string
     */
    public function getCategoriesComment(): string
    {
        return '<b>[categories]</b> - ' . __('output a current categories chain starting from the first parent category and ending a current category') . ';';
    }

    /**
     * Return comment for Parent Category
     *
     * @return string
     */
    public function getParentCategoryComment(): string
    {
        return '<b>[parent_category]</b> - ' . __('output a parent category name') . ';';
    }

    /**
     * Return comment for Parent Category by level
     *
     * @return string
     */
    public function getParentCategoryByLevelComment(): string
    {
        $html = '<b>[parent_category_1]</b> - ' . __('outputs the 1st parent category name. It equals to [parent_category]') . ';';
        $html .= '<br>' . '<b>[parent_category_2]</b> - ' . __('outputs the 2st parent category name') . ';';
        $html .= '<br>&nbsp;&nbsp;&nbsp;&nbsp;' . __('etc.');
        $html .= '<br>&nbsp;&nbsp;&nbsp;&nbsp;' . __('The orders of the parent categories is as follows: <br>&nbsp;&nbsp;&nbsp;&nbsp; yoursite/parent_category_3/parent_category_2/parent_category_1/category.html') . ';';
        return $html;
    }

    /**
     * Return comment for Subcategories
     *
     * @return string
     */
    public function getSubcategoriesComment(): string
    {
        return '<b>[subcategories]</b> - ' . __('output a list of subcategories for a current category') . ';';
    }

    /**
     * Return comment for Website Name
     *
     * @return string
     */
    public function getWebsiteNameComment(): string
    {
        return '<b>[website_name]</b> - ' . __('output a current website name') . ';';
    }

    /**
     * Return comment for Store Name
     *
     * @return string
     */
    public function getStoreNameComment(): string
    {
        return '<b>[store_name]</b> - ' . __('output a current store name') . ';';
    }

    /**
     * Return comment for Store View Name
     *
     * @return string
     */
    public function getStoreViewNameComment(): string
    {
        return '<b>[store_view_name]</b> - ' . __('output a current store view name') . ';';
    }

    /**
     * Return comment for filter_all
     *
     * @return string
     */
    public function getLnAllFiltersComment(): string
    {
        $string = '<b>[filter_all]</b> - ' . __('inserts all chosen attributes of LN on the category page.');
        $string .= "<br>&nbsp;&nbsp;&nbsp;&nbsp;" . __('Example:') . " <b>" . '[category][ – parameters: {filter_all}]' . "</b>";
        $string .= " - " . __('If "color", "occasion", and "shoe size" attributes are chosen, on the frontend you will see:');
        $string .= "<br>&nbsp;&nbsp;&nbsp;&nbsp;" . __('"Shoes – parameters: Color Red, Occasion Casual, Shoe Size 6.5"');
        $string .= " - " . __('If no attributes are chosen, you will see: "Shoes".');

        return $string;
    }

    /**
     * Return comment for personal filters
     *
     * @return string
     */
    public function getLnPersonalFiltersComment(): string
    {
        $string = '<b>[filter_<i>attribute_code</i>]</b> - ' . __('insert attribute value if exists.');
        $string .= "<br>&nbsp;&nbsp;&nbsp;&nbsp;" . __('Example:') . ' <b>[category][ in {filter_color}]</b>';
        $string .= "<br>&nbsp;&nbsp;&nbsp;&nbsp;" . __('Will translate to "Shoes in Color Red" on the frontend.');

        $string .= '<br><b>[filter_<i>attribute_code</i>_label]</b> - ' . __('inserts mentioned product attribute label on the category LN page.');
        $string .= '<br><b>[filter_<i>attribute_code</i>_value]</b> - ' . __('inserts mentioned product attribute value on the category LN page.');

        return $string;
    }

    /**
     * Return comment for randomizer
     *
     * @return string
     */
    public function getRandomizeComment(): string
    {
        return '<p>'. __('Randomizer feature is available. The construction like [Buy||Order||Purchase] will use a randomly picked word.').'<br>'.__('
        Also randomizers can be used within other template variables, ex: [-parameters:||-filters: {filter_all}]. Number of randomizers blocks is not limited within the template.').'<br>';
    }
}