vendor/sulu/sulu/src/Sulu/Component/Webspace/Url.php line 16

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Component\Webspace;
  14. use Sulu\Component\Util\ArrayableInterface;
  16. class Url implements ArrayableInterface
  17. {
  18.     /**
  19.      * The language to which the url leads.
  20.      *
  21.      * @var string
  22.      */
  23.     private $language;
  25.     /**
  26.      * The country to which the url leads.
  27.      *
  28.      * @var string
  29.      */
  30.     private $country;
  32.     /**
  33.      * The segment to which the url leads.
  34.      *
  35.      * @var string
  36.      */
  37.     private $segment;
  39.     /**
  40.      * The url to which this url redirects.
  41.      *
  42.      * @var string
  43.      */
  44.     private $redirect;
  46.     /**
  47.      * Indicate the main url.
  48.      *
  49.      * @var bool
  50.      */
  51.     private $main;
  53.     /**
  54.      * @param string $url
  55.      * @param string $environment
  56.      */
  57.     public function __construct(
  58.         private $url = null,
  59.         private $environment = null
  60.     ) {
  61.     }
  63.     /**
  64.      * Sets the url.
  65.      *
  66.      * @param string $url
  67.      */
  68.     public function setUrl($url)
  69.     {
  70.         $this->url = $url;
  71.     }
  73.     /**
  74.      * Returns the url.
  75.      *
  76.      * @return string
  77.      */
  78.     public function getUrl()
  79.     {
  80.         return $this->url;
  81.     }
  83.     /**
  84.      * Sets the country to which this url leads.
  85.      *
  86.      * @param string $country
  87.      */
  88.     public function setCountry($country)
  89.     {
  90.         $this->country = $country;
  91.     }
  93.     /**
  94.      * Returns the country to which this url leads.
  95.      *
  96.      * @return string
  97.      */
  98.     public function getCountry()
  99.     {
  100.         return $this->country;
  101.     }
  103.     /**
  104.      * Sets the language to which this url leads.
  105.      *
  106.      * @param string $language
  107.      */
  108.     public function setLanguage($language)
  109.     {
  110.         $this->language = $language;
  111.     }
  113.     /**
  114.      * Returns the language to which this url leads.
  115.      *
  116.      * @return string
  117.      */
  118.     public function getLanguage()
  119.     {
  120.         return $this->language;
  121.     }
  123.     /**
  124.      * Sets the segment to which this url leads.
  125.      *
  126.      * @param string $segment
  127.      */
  128.     public function setSegment($segment)
  129.     {
  130.         $this->segment = $segment;
  131.     }
  133.     /**
  134.      * Returns the segment to which this url leads.
  135.      *
  136.      * @return string
  137.      */
  138.     public function getSegment()
  139.     {
  140.         return $this->segment;
  141.     }
  143.     /**
  144.      * Sets the redirect for this url.
  145.      *
  146.      * @param string $redirect
  147.      */
  148.     public function setRedirect($redirect)
  149.     {
  150.         $this->redirect = $redirect;
  151.     }
  153.     /**
  154.      * Returns the redirect url.
  155.      *
  156.      * @return string
  157.      */
  158.     public function getRedirect()
  159.     {
  160.         return $this->redirect;
  161.     }
  163.     /**
  164.      * Return main flag.
  165.      *
  166.      * @return bool
  167.      */
  168.     public function isMain()
  169.     {
  170.         return $this->main;
  171.     }
  173.     /**
  174.      * Sets main flag.
  175.      *
  176.      * @param bool $main
  177.      */
  178.     public function setMain($main)
  179.     {
  180.         $this->main = $main;
  181.     }
  183.     /**
  184.      * Returns the environment.
  185.      *
  186.      * @return string
  187.      */
  188.     public function getEnvironment()
  189.     {
  190.         return $this->environment;
  191.     }
  193.     /**
  194.      * Sets the environment.
  195.      *
  196.      * @param string $environment
  197.      */
  198.     public function setEnvironment($environment)
  199.     {
  200.         $this->environment = $environment;
  201.     }
  203.     /**
  204.      * Checks if this URL handles the locale for the given language and country.
  205.      *
  206.      * @param string $language
  207.      * @param string $country
  208.      *
  209.      * @return bool
  210.      */
  211.     public function isValidLocale($language, $country)
  212.     {
  213.         return ($this->getLanguage() === $language && $this->getCountry() === $country)
  214.             || (empty($this->getLanguage()) && empty($this->getCountry()));
  215.     }
  217.     public function toArray($depth = null)
  218.     {
  219.         $res = [];
  220.         $res['url'] = $this->getUrl();
  221.         $res['language'] = $this->getLanguage();
  222.         $res['country'] = $this->getCountry();
  223.         $res['segment'] = $this->getSegment();
  224.         $res['redirect'] = $this->getRedirect();
  225.         $res['main'] = $this->isMain();
  226.         $res['environment'] = $this->getEnvironment();
  228.         return $res;
  229.     }
  230. }