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-seobase/Helper/ |
<?php
/**
* Copyright © MageWorx. All rights reserved.
* See LICENSE.txt for license details.
*/
namespace MageWorx\SeoBase\Helper;
use Magento\Store\Model\ScopeInterface;
use MageWorx\SeoAll\Model\Source\MetaRobots;
use MageWorx\SeoBase\Model\Source\CanonicalType;
/**
* SEO Base config data helper
*/
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
const XML_PATH_HOME_PAGE = 'web/default/cms_home_page';
/**
* XML config path canonical enabled
*/
const XML_PATH_CANONICAL_URL_ENABLED = 'mageworx_seo/base/canonical/use_canonical';
/**
* XML config path canonical enabled by robots
*/
const XML_PATH_DISABLE_CANONICAL_BY_ROBOTS = 'mageworx_seo/base/canonical/disable_by_robots';
/**
* XML config path canonical ignore pages
*/
const XML_PATH_CANONICAL_IGNORE_PAGES = 'mageworx_seo/base/canonical/canonical_ignore_pages';
/**
* XML config path trailing slash for home page URL
*/
const XML_PATH_TRAILING_SLASH_FOR_HOME = 'mageworx_seo/base/canonical/trailing_slash_home_page';
/**
* XML config path trailing slash for URL
*/
const XML_PATH_TRAILING_SLASH = 'mageworx_seo/base/canonical/trailing_slash';
/**
* XML config path use pager param in canonical URL
*/
const XML_PATH_USE_PAGER_FOR_CANONICAL = 'mageworx_seo/base/canonical/use_pager_in_canonical';
/**
* XML config path use canonical URL for layered navigation pages
*/
const XML_PATH_CANONICAL_FOR_LN = 'mageworx_seo/base/canonical/canonical_for_ln';
/**
* XML config path use canonical URL for layered navigation pages with multiple filters
*/
const XML_PATH_CANONICAL_FOR_LN_MULTIPLE = 'mageworx_seo/base/canonical/canonical_for_ln_multiple';
/**
* XML config path cross domain store for canonical URL
*/
const XML_PATH_CROSS_DOMAIN_STORE = 'mageworx_seo/base/canonical/cross_domain_store';
/**
* XML config path canonical cross domain URL
*/
const XML_PATH_CROSS_DOMAIN_URL = 'mageworx_seo/base/canonical/cross_domain_url';
/**
* XML config path product canonical types, such as short, long, etc.
*/
const XML_PATH_PRODUCT_CANONICAL_URL_TYPE = 'mageworx_seo/base/canonical/product_canonical_url_type';
/**
* XML config path use canonical for associated products
*/
const XML_PATH_ASSOCIATED_TYPES = 'mageworx_seo/base/canonical/associated_types';
/**
* XML config path https robots
*/
const XML_PATH_HTTPS_ROBOTS = 'mageworx_seo/base/robots/https_robots';
/**
* XML config path pages for noindex, follow robots
*/
const XML_PATH_NOINDEX_PAGES = 'mageworx_seo/base/robots/noindex_follow_pages';
/**
* XML config path user pages for noindex, follow robots
*/
const XML_PATH_NOINDEX_USER_PAGES = 'mageworx_seo/base/robots/noindex_follow_user_pages';
/**
* XML config path user pages for noindex, nofollow robots
*/
const XML_PATH_NOINDEX_NOFOLLOW_USER_PAGES = 'mageworx_seo/base/robots/noindex_nofollow_user_pages';
/**
* XML config path setting robots for layered navigation category pages
*/
const XML_PATH_CATEGORY_LN_ROBOTS = 'mageworx_seo/base/robots/category_ln_pages_robots';
/**
* XML config path layered navigation filters count for noindex, nofollow robots
*/
const XML_PATH_NOINDEX_FOR_LN_COUNT = 'mageworx_seo/base/robots/count_filters_for_noindex';
/**
* XML config path for noindex, follow if used category layered filter with multiple selection
*/
const XML_PATH_NOINDEX_FOLLOW_FOR_MULTIPLE_FILTER = 'mageworx_seo/base/robots/robots_for_ln_multiple';
/**
* XML config path for robots attribute settings
*/
const XML_PATH_ATTRIBUTE_SETTINGS = 'mageworx_seo/base/robots/attribute_settings';
/**
* XML config path "next" and "prev" link relations enabled
*/
const XML_PATH_USE_NEXT_PREV = 'mageworx_seo/base/use_next_prev';
/**
*
* @var \MageWorx\SeoAll\Model\Source\MetaRobots;
*/
public $robotsProvider;
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
/**
* @var \MageWorx\SeoBase\Model\ConfigDataLoader
*/
protected $configDataLoader;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $storeManager;
/**
* Data constructor.
*
* @param MetaRobots $robotsProvider
* @param \Magento\Framework\ObjectManagerInterface $objectManager
* @param \Magento\Framework\App\Helper\Context $context
* @param \MageWorx\SeoBase\Model\ConfigDataLoader $configDataLoader
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
*/
public function __construct(
MetaRobots $robotsProvider,
\Magento\Framework\ObjectManagerInterface $objectManager,
\Magento\Framework\App\Helper\Context $context,
\MageWorx\SeoBase\Model\ConfigDataLoader $configDataLoader,
\Magento\Store\Model\StoreManagerInterface $storeManager
) {
$this->objectManager = $objectManager;
$this->robotsProvider = $robotsProvider;
$this->configDataLoader = $configDataLoader;
$this->storeManager = $storeManager;
parent::__construct($context);
}
/**
* Check if canonical URL enabled
*
* @param int $storeId
* @return bool
*/
public function isCanonicalUrlEnabled($storeId = null)
{
return (bool)$this->scopeConfig->getValue(
self::XML_PATH_CANONICAL_URL_ENABLED,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* @param int|null $storeId
* @return bool
*/
public function useCategoriesPathInProductUrl($storeId = null): bool
{
if (isset($storeId) && $storeId != $this->storeManager->getStore()->getId()) {
$value = $this->configDataLoader->getConfigValue(
\Magento\Catalog\Helper\Product::XML_PATH_PRODUCT_URL_USE_CATEGORY,
(int)$storeId
);
}
return isset($value) ? (bool)$value : $this->scopeConfig->isSetFlag(
\Magento\Catalog\Helper\Product::XML_PATH_PRODUCT_URL_USE_CATEGORY,
\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* @param int|null $storeId
* @return mixed
*/
public function getProductCanonicalUrlType($storeId = null)
{
if (!$this->useCategoriesPathInProductUrl($storeId)) {
return CanonicalType::URL_TYPE_NO_CATEGORIES;
}
if (isset($storeId) && $storeId != $this->storeManager->getStore()->getId()) {
$value = $this->configDataLoader->getConfigValue(self::XML_PATH_PRODUCT_CANONICAL_URL_TYPE, (int)$storeId);
}
return isset($value) ? $value : (string)$this->scopeConfig->getValue(
self::XML_PATH_PRODUCT_CANONICAL_URL_TYPE,
\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve list of pages for noindex, follow robots
*
* @param int $storeId
* @return bool
*/
public function getCanonicalIgnorePages($storeId = null)
{
$ignorePagesString = (string)$this->scopeConfig->getValue(
self::XML_PATH_CANONICAL_IGNORE_PAGES,
ScopeInterface::SCOPE_STORE,
$storeId
);
$ignorePages = array_filter(preg_split('/\r?\n/', $ignorePagesString));
return array_map('trim', $ignorePages);
}
/**
* Checks if add or crop trailing slash for URL
*
* @param int $storeId
* @return int
*/
public function getTrailingSlash($storeId = null): int
{
if (isset($storeId) && $storeId != $this->storeManager->getStore()->getId()) {
$value = $this->configDataLoader->getConfigValue(self::XML_PATH_TRAILING_SLASH, (int)$storeId);
}
return isset($value) ? (int)$value : (int)$this->scopeConfig->getValue(
self::XML_PATH_TRAILING_SLASH,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Checks if add or crop trailing slash for home page URL
*
* @param int $storeId
* @return int
*/
public function getTrailingSlashForHomePage($storeId = null): int
{
if (isset($storeId) && $storeId != $this->storeManager->getStore()->getId()) {
$value = $this->configDataLoader->getConfigValue(self::XML_PATH_TRAILING_SLASH_FOR_HOME, (int)$storeId);
}
return isset($value) ? (int)$value : (int)$this->scopeConfig->getValue(
self::XML_PATH_TRAILING_SLASH_FOR_HOME,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Check if use pager for category canonical URL
*
* @param int $storeId
* @return bool
*/
public function usePagerForCanonical($storeId = null)
{
return (bool)$this->scopeConfig->getValue(
self::XML_PATH_USE_PAGER_FOR_CANONICAL,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve canonical type for category layered navigation pages
*
* @param int $storeId
* @return int
*/
public function getCanonicalTypeForLayeredPages($storeId = null)
{
return (int)$this->scopeConfig->getValue(
self::XML_PATH_CANONICAL_FOR_LN,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve canonical type for category layered navigation pages with filters with multiple select values
*
* @param int $storeId
* @return int
*/
public function getCanonicalTypeForLayeredPagesWithMultipleSelection($storeId = null)
{
return (int)$this->scopeConfig->getValue(
self::XML_PATH_CANONICAL_FOR_LN_MULTIPLE,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve cross domain store ID
*
* @param int $storeId
* @return int
*/
public function getCrossDomainStore($storeId = null)
{
return (int)$this->scopeConfig->getValue(
self::XML_PATH_CROSS_DOMAIN_STORE,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve cross domain URL
*
* @param int $storeId
* @return string
*/
public function getCrossDomainUrl($storeId = null)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_CROSS_DOMAIN_URL,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve comma-separated associated types for canonical URL
*
* @param int $storeId
* @return string
*/
public function getAssociatedProductTypes($storeId = null)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_ASSOCIATED_TYPES,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve list of associated types for canonical URL
*
* @param int $storeId
* @return array
*/
public function getAssociatedProductTypesAsArray($storeId = null)
{
$associatedProductTypes = explode(',', $this->getAssociatedProductTypes($storeId));
return array_filter($associatedProductTypes);
}
/**
* Retrieve robots for https protocol
*
* @param int $storeId
* @return string
* @deprecated will be removed
*/
public function getMetaRobotsForHttps($storeId = null)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_HTTPS_ROBOTS,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve list of pages for noindex, follow robots
*
* @param int $storeId
* @return array
*/
public function getNoindexPages($storeId = null)
{
$pagesString = (string)$this->scopeConfig->getValue(
self::XML_PATH_NOINDEX_PAGES,
ScopeInterface::SCOPE_STORE,
$storeId
);
$arrayRaw = array_map('trim', explode(',', $pagesString));
return array_filter($arrayRaw);
}
/**
* Retrieve list of user pages for noindex, follow robots
*
* @param int $storeId
* @return array
*/
public function getNoindexUserPages($storeId = null)
{
$pagesString = (string)$this->scopeConfig->getValue(
self::XML_PATH_NOINDEX_USER_PAGES,
ScopeInterface::SCOPE_STORE,
$storeId
);
$pagesArray = array_filter(preg_split('/\r?\n/', $pagesString));
$pagesArray = array_map('trim', $pagesArray);
return array_filter($pagesArray);
}
/**
* Retrieve list of pages for noindex, nofollow robots
*
* @param int $storeId
* @return array
*/
public function getNoindexNofollowUserPages($storeId = null)
{
$pagesString = (string)$this->scopeConfig->getValue(
self::XML_PATH_NOINDEX_NOFOLLOW_USER_PAGES,
ScopeInterface::SCOPE_STORE,
$storeId
);
$pagesArray = array_filter(preg_split('/\r?\n/', $pagesString));
$pagesArray = array_map('trim', $pagesArray);
return array_filter($pagesArray);
}
/**
* @param null|int $storeId
* @return string
*/
public function getCategoryLnRobots($storeId = null)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_CATEGORY_LN_ROBOTS,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve filter count for noindex pages
*
* @param int $storeId
* @return string
*/
public function getCountFiltersForNoindex($storeId = null)
{
return (string)$this->scopeConfig->getValue(
self::XML_PATH_NOINDEX_FOR_LN_COUNT,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve if set NOINDEX, FOLLOW if category filter has multiple selection
*
* @param int $storeId
* @return boolean
*/
public function isUseNoindexIfFilterMultipleValues($storeId = null)
{
return (bool)$this->scopeConfig->getValue(
self::XML_PATH_NOINDEX_FOLLOW_FOR_MULTIPLE_FILTER,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve CMS page home identifier code
*
* @param int|null $storeId
* @return string
*/
public function getHomeIdentifier($storeId = null)
{
return $this->scopeConfig->getValue(
\Magento\Cms\Helper\Page::XML_PATH_HOME_PAGE,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Check id "next" and "prev" link relations are enabled
*
* @param int $storeId
* @return bool
*/
public function useNextPrev($storeId = null)
{
return $this->scopeConfig->getValue(
self::XML_PATH_USE_NEXT_PREV,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Chech if disable canonical URL if meta robots contain "NOINDEX"
*
* @param int $storeId
* @return bool
*/
public function isDisableCanonicalByRobots($storeId = null)
{
return $this->scopeConfig->isSetFlag(
self::XML_PATH_DISABLE_CANONICAL_BY_ROBOTS,
ScopeInterface::SCOPE_STORE,
$storeId
);
}
/**
* Retrieve attribute meta robots settings as array 'attribute_combination' => 'meta_robots_value'
*
* @param null|int $storeId
* @return array
*/
public function getAttributeRobotsSettings($storeId = null)
{
$attributeSettingsAsString = (string)$this->scopeConfig->getValue(
self::XML_PATH_ATTRIBUTE_SETTINGS,
ScopeInterface::SCOPE_STORE,
$storeId
);
$attributeSettingsAsRawArray = array_filter(preg_split('/\r?\n/', $attributeSettingsAsString));
$attributeSettingsAsRawArray = array_map('trim', $attributeSettingsAsRawArray);
$attributeSettingsAsRawArray = array_map('strtolower', $attributeSettingsAsRawArray);
$attributeSettingArray = array();
foreach ($attributeSettingsAsRawArray as $settingLine) {
if (strpos($settingLine, ':') === false) {
continue;
}
$settingLine = str_replace(' ', '', $settingLine);
$conditionArray = explode(':', $settingLine);
if (count($conditionArray) != 2) {
continue;
}
$metaRobotsValue = $this->_formatMetaRobotsValue($conditionArray[0]);
if (!$this->isValidRobots($metaRobotsValue)) {
continue;
}
$attributesAsString = $conditionArray[1];
$attributesAsString = trim($attributesAsString, ',');
if (strpos($attributesAsString, ',') !== false) {
$attributeCombinations = explode(',', $attributesAsString);
$attributeCombinations = array_filter($attributeCombinations);
} else {
$attributeCombinations = array($attributesAsString);
}
if (!count($attributeCombinations)) {
continue;
}
foreach ($attributeCombinations as $attributeCombination) {
$attributeCombination = $this->_sortAttributeString($attributeCombination);
$attributeSettingArray[$attributeCombination] = $metaRobotsValue;
}
}
return $attributeSettingArray;
}
/**
* @param string $value
* @return string
*/
protected function _formatMetaRobotsValue($value)
{
$value = str_replace(' ', '', $value);
$value = str_replace(',', ', ', $value);
return strtoupper($value);
}
/**
* Check is valid meta robots value
*
* @param string $metaRobotsValue
* @return bool
*/
public function isValidRobots($metaRobotsValue)
{
/**
* @var MageWorx_SeoBase_Model_Catalog_Product_Attribute_Source_Meta_Robots $robotsProvider
*/
$robotsValidArray = $this->robotsProvider->getAllOptions();
foreach ($robotsValidArray as $robots) {
if ($robots['value'] == $metaRobotsValue) {
return true;
}
}
return false;
}
/**
* @param null|int $storeId
* @return bool
*/
public function isSeoUrlsEnable($storeId = null)
{
if ($this->isModuleOutputEnabled('MageWorx_SeoUrls')) {
/** @var \MageWorx\SeoUrls\Helper\Data $helperSeoUrls */
$helperSeoUrls = $this->objectManager->get('\MageWorx\SeoUrls\Helper\Data');
if ($helperSeoUrls->getIsSeoPagerEnable() || $helperSeoUrls->getIsSeoFiltersEnable()) {
return true;
}
}
return false;
}
/**
* @param string $attributeString
* @return string
*/
protected function _sortAttributeString($attributeString)
{
if (strpos($attributeString, '+') !== false) {
$attributes = explode('+', $attributeString);
$attributes = array_filter($attributes);
if (!count($attributes)) {
return $attributeString;
}
sort($attributes);
return implode('+', $attributes);
}
return $attributeString;
}
}