classes/XLite/Model/Language.php line 29

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2011-present Qualiteam software Ltd. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XLite\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  11. use Includes\Utils\Module\Module;
  12. use XCart\Domain\ModuleManagerDomain;
  14. /**
  15.  * Language
  16.  *
  17.  * @ORM\Entity
  18.  * @ORM\Table (name="languages",
  19.  *      uniqueConstraints={
  20.  *          @ORM\UniqueConstraint (name="code3", columns={"code3"}),
  21.  *          @ORM\UniqueConstraint (name="code2", columns={"code"})
  22.  *      },
  23.  *      indexes={
  24.  *          @ORM\Index (name="added", columns={"added"}),
  25.  *          @ORM\Index (name="enabled", columns={"enabled"})
  26.  *      }
  27.  * )
  28.  */
  29. class Language extends \XLite\Model\Base\I18n
  30. {
  31.     /**
  32.      * Unique id
  33.      *
  34.      * @var integer
  35.      *
  36.      * @ORM\Id
  37.      * @ORM\GeneratedValue (strategy="AUTO")
  38.      * @ORM\Column (type="integer", unique=true)
  39.      */
  40.     protected $lng_id;
  42.     /**
  43.      * Language alpha-2 code (ISO 639-2)
  44.      *
  45.      * @var string
  46.      *
  47.      * @ORM\Column (type="string", options={ "fixed": true }, length=2, unique=true)
  48.      */
  49.     protected $code;
  51.     /**
  52.      * Language alpha-3 code (ISO 639-3)
  53.      *
  54.      * @var string
  55.      *
  56.      * @ORM\Column (type="string", options={ "fixed": true }, length=3, unique=true)
  57.      */
  58.     protected $code3 = '';
  60.     /**
  61.      * Right-to-left flag
  62.      *
  63.      * @var boolean
  64.      *
  65.      * @ORM\Column (type="boolean")
  66.      */
  67.     protected $r2l = false;
  69.     /**
  70.      * Language status (added/not added)
  71.      *
  72.      * @var integer
  73.      *
  74.      * @ORM\Column (type="boolean")
  75.      */
  76.     protected $added = false;
  78.     /**
  79.      * Language state (enabled/disabled)
  80.      *
  81.      * @var integer
  82.      *
  83.      * @ORM\Column (type="boolean")
  84.      */
  85.     protected $enabled = false;
  87.     /**
  88.      * Related module (Author\Name)
  89.      *
  90.      * @var string
  91.      *
  92.      * @ORM\Column (type="string", nullable=true)
  93.      */
  94.     protected $module;
  96.     /**
  97.      * Countries
  98.      *
  99.      * @var \XLite\Model\Country[]
  100.      *
  101.      * @ORM\OneToMany (targetEntity="XLite\Model\Country", mappedBy="language")
  102.      */
  103.     protected $countries;
  105.     /**
  106.      * @var \Doctrine\Common\Collections\Collection
  107.      *
  108.      * @ORM\OneToMany (targetEntity="XLite\Model\LanguageTranslation", mappedBy="owner", cascade={"all"})
  109.      */
  110.     protected $translations;
  112.     /**
  113.      * Get module
  114.      *
  115.      * @return string
  116.      */
  117.     public function getValidModule()
  118.     {
  119.         /** @var ModuleManagerDomain $moduleManagerDomain */
  120.         $moduleManagerDomain = \XCart\Container::getContainer()?->get(ModuleManagerDomain::class);
  122.         if ($module = $this->getModule()) {
  123.             [$author, $name] = Module::explodeModuleId($module);
  125.             return $moduleManagerDomain->isEnabled("{$author}-{$name}") ? $module : '';
  126.         }
  128.         return '';
  129.     }
  131.     /**
  132.      * Return true if current language is set as a default for customer interface
  133.      *
  134.      * @return boolean
  135.      */
  136.     public function getDefaultCustomer()
  137.     {
  138.         return $this->getCode() == \XLite\Core\Config::getInstance()->General->default_language;
  139.     }
  141.     /**
  142.      * Return true if current language is set as a default for admin interface
  143.      *
  144.      * @return boolean
  145.      */
  146.     public function getDefaultAdmin()
  147.     {
  148.         return $this->getCode() == \XLite\Core\Config::getInstance()->General->default_admin_language;
  149.     }
  151.     /**
  152.      * Return true if current language is set as a default for customer interface
  153.      *
  154.      * @return boolean
  155.      */
  156.     public function getDefaultAuth()
  157.     {
  158.         return (!\XLite\Core\Auth::getInstance()->isAdmin() && $this->getDefaultCustomer())
  159.         || (\XLite\Core\Auth::getInstance()->isAdmin() && $this->getDefaultAdmin());
  160.     }
  162.     /**
  163.      * Get flag URL
  164.      *
  165.      * @return string
  166.      */
  167.     public function getFlagURL()
  168.     {
  169.         return \XLite\Core\Layout::getInstance()->getResourceWebPath(
  170.             $this->getFlagFile(),
  171.             \XLite\Core\Layout::WEB_PATH_OUTPUT_URL,
  172.             \XLite::INTERFACE_WEB,
  173.             \XLite::ZONE_CUSTOMER
  174.         );
  175.     }
  177.     /**
  178.      * Get flag URL
  179.      *
  180.      * @return string
  181.      */
  182.     public function getFlagFile()
  183.     {
  184.         $code = $this->getLanguageToFlagCodeMapping()[$this->getCode()] ?? $this->getCode();
  186.         $file = "images/flags_svg/{$code}.svg";
  187.         $path = \XLite\Core\Layout::getInstance()->getResourceFullPath(
  188.             $file,
  189.             \XLite::INTERFACE_WEB,
  190.             \XLite::ZONE_COMMON
  191.         );
  193.         return $path
  194.             ? $file
  195.             : 'images/flags_svg/__.svg';
  196.     }
  198.     /**
  199.      * @return array
  200.      */
  201.     protected function getLanguageToFlagCodeMapping()
  202.     {
  203.         return [
  204.             'be' => 'by',
  205.             'ja' => 'jp',
  206.             'ko' => 'kr',
  207.             'hy' => 'am',
  208.             'ar' => 'sa',
  209.             'el' => 'gr',
  210.             'he' => 'il',
  211.             'kr' => 'ng',
  212.             'sv' => 'se',
  213.             'sl' => 'si',
  214.             'si' => 'lk',
  215.             'et' => 'ee',
  216.             'ee' => 'gh',
  217.             'aa' => 'et',
  218.             'km' => 'kh',
  219.             'ms' => 'my',
  220.             'my' => 'mm',
  221.         ];
  222.     }
  224.     /**
  225.      * Remove all label translations to the language
  226.      * Return true on success
  227.      *
  228.      * @return boolean
  229.      */
  230.     public function removeTranslations()
  231.     {
  232.         return \XLite\Core\Database::getRepo('XLite\Model\LanguageLabel')->deleteTranslations($this->getCode());
  233.     }
  235.     /**
  236.      * Get default language code
  237.      *
  238.      * @return string
  239.      */
  240.     protected function getSessionLanguageCode()
  241.     {
  242.         return $this->getCode();
  243.     }
  245.     /**
  246.      * Get lng_id
  247.      *
  248.      * @return integer
  249.      */
  250.     public function getLngId()
  251.     {
  252.         return $this->lng_id;
  253.     }
  255.     /**
  256.      * Set code
  257.      *
  258.      * @param string $code
  259.      * @return Language
  260.      */
  261.     public function setCode($code)
  262.     {
  263.         $this->code = $code;
  265.         return $this;
  266.     }
  268.     /**
  269.      * Get code
  270.      *
  271.      * @return string
  272.      */
  273.     public function getCode()
  274.     {
  275.         return $this->code;
  276.     }
  278.     /**
  279.      * Set code3
  280.      *
  281.      * @param string $code3
  282.      * @return Language
  283.      */
  284.     public function setCode3($code3)
  285.     {
  286.         $this->code3 = $code3;
  288.         return $this;
  289.     }
  291.     /**
  292.      * Get code3
  293.      *
  294.      * @return string
  295.      */
  296.     public function getCode3()
  297.     {
  298.         return $this->code3;
  299.     }
  301.     /**
  302.      * Set r2l
  303.      *
  304.      * @param boolean $r2l
  305.      * @return Language
  306.      */
  307.     public function setR2l($r2l)
  308.     {
  309.         $this->r2l = $r2l;
  311.         return $this;
  312.     }
  314.     /**
  315.      * Get r2l
  316.      *
  317.      * @return boolean
  318.      */
  319.     public function getR2l()
  320.     {
  321.         return $this->r2l;
  322.     }
  324.     /**
  325.      * Set added
  326.      *
  327.      * @param boolean $added
  328.      * @return Language
  329.      */
  330.     public function setAdded($added)
  331.     {
  332.         $this->added = $added;
  334.         return $this;
  335.     }
  337.     /**
  338.      * Get added
  339.      *
  340.      * @return boolean
  341.      */
  342.     public function getAdded()
  343.     {
  344.         return $this->added;
  345.     }
  347.     /**
  348.      * Set enabled
  349.      *
  350.      * @param boolean $enabled
  351.      * @return Language
  352.      */
  353.     public function setEnabled($enabled)
  354.     {
  355.         $this->enabled = (bool)$enabled;
  357.         return $this;
  358.     }
  360.     /**
  361.      * Get enabled
  362.      *
  363.      * @return boolean
  364.      */
  365.     public function getEnabled()
  366.     {
  367.         return $this->enabled;
  368.     }
  370.     /**
  371.      * Set module
  372.      *
  373.      * @param string $module
  374.      * @return Language
  375.      */
  376.     public function setModule($module)
  377.     {
  378.         $this->module = $module;
  379.         return $this;
  380.     }
  382.     /**
  383.      * Get module
  384.      *
  385.      * @return string
  386.      */
  387.     public function getModule()
  388.     {
  389.         return $this->module;
  390.     }
  392.     /**
  393.      * Set Countries
  394.      *
  395.      * @param \XLite\Model\Country[] $countries
  396.      *
  397.      * @return $this
  398.      */
  399.     public function setCountries($countries)
  400.     {
  401.         foreach ($countries as $country) {
  402.             $country->setLanguage($this);
  403.         }
  405.         $this->countries = $countries;
  407.         return $this;
  408.     }
  410.     /**
  411.      * Get countries
  412.      *
  413.      * @return \Doctrine\Common\Collections\Collection
  414.      */
  415.     public function getCountries()
  416.     {
  417.         return $this->countries;
  418.     }
  419. }