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 url itself.
  20.      *
  21.      * @var string
  22.      */
  23.     private $url;
  25.     /**
  26.      * The language to which the url leads.
  27.      *
  28.      * @var string
  29.      */
  30.     private $language;
  32.     /**
  33.      * The country to which the url leads.
  34.      *
  35.      * @var string
  36.      */
  37.     private $country;
  39.     /**
  40.      * The segment to which the url leads.
  41.      *
  42.      * @var string
  43.      */
  44.     private $segment;
  46.     /**
  47.      * The url to which this url redirects.
  48.      *
  49.      * @var string
  50.      */
  51.     private $redirect;
  53.     /**
  54.      * Indicate the main url.
  55.      *
  56.      * @var bool
  57.      */
  58.     private $main;
  60.     /**
  61.      * @var string
  62.      */
  63.     private $environment;
  65.     public function __construct($url = null, $environment = null)
  66.     {
  67.         $this->url = $url;
  68.         $this->environment = $environment;
  69.     }
  71.     /**
  72.      * Sets the url.
  73.      *
  74.      * @param string $url
  75.      */
  76.     public function setUrl($url)
  77.     {
  78.         $this->url = $url;
  79.     }
  81.     /**
  82.      * Returns the url.
  83.      *
  84.      * @return string
  85.      */
  86.     public function getUrl()
  87.     {
  88.         return $this->url;
  89.     }
  91.     /**
  92.      * Sets the country to which this url leads.
  93.      *
  94.      * @param string $country
  95.      */
  96.     public function setCountry($country)
  97.     {
  98.         $this->country = $country;
  99.     }
  101.     /**
  102.      * Returns the country to which this url leads.
  103.      *
  104.      * @return string
  105.      */
  106.     public function getCountry()
  107.     {
  108.         return $this->country;
  109.     }
  111.     /**
  112.      * Sets the language to which this url leads.
  113.      *
  114.      * @param string $language
  115.      */
  116.     public function setLanguage($language)
  117.     {
  118.         $this->language = $language;
  119.     }
  121.     /**
  122.      * Returns the language to which this url leads.
  123.      *
  124.      * @return string
  125.      */
  126.     public function getLanguage()
  127.     {
  128.         return $this->language;
  129.     }
  131.     /**
  132.      * Sets the segment to which this url leads.
  133.      *
  134.      * @param string $segment
  135.      */
  136.     public function setSegment($segment)
  137.     {
  138.         $this->segment = $segment;
  139.     }
  141.     /**
  142.      * Returns the segment to which this url leads.
  143.      *
  144.      * @return string
  145.      */
  146.     public function getSegment()
  147.     {
  148.         return $this->segment;
  149.     }
  151.     /**
  152.      * Sets the redirect for this url.
  153.      *
  154.      * @param string $redirect
  155.      */
  156.     public function setRedirect($redirect)
  157.     {
  158.         $this->redirect = $redirect;
  159.     }
  161.     /**
  162.      * Returns the redirect url.
  163.      *
  164.      * @return string
  165.      */
  166.     public function getRedirect()
  167.     {
  168.         return $this->redirect;
  169.     }
  171.     /**
  172.      * Return main flag.
  173.      *
  174.      * @return bool
  175.      */
  176.     public function isMain()
  177.     {
  178.         return $this->main;
  179.     }
  181.     /**
  182.      * Sets main flag.
  183.      *
  184.      * @param bool $main
  185.      */
  186.     public function setMain($main)
  187.     {
  188.         $this->main = $main;
  189.     }
  191.     /**
  192.      * Returns the environment.
  193.      *
  194.      * @return string
  195.      */
  196.     public function getEnvironment()
  197.     {
  198.         return $this->environment;
  199.     }
  201.     /**
  202.      * Sets the environment.
  203.      *
  204.      * @param string $environment
  205.      */
  206.     public function setEnvironment($environment)
  207.     {
  208.         $this->environment = $environment;
  209.     }
  211.     /**
  212.      * Checks if this URL handles the locale for the given language and country.
  213.      *
  214.      * @param string $language
  215.      * @param string $country
  216.      *
  217.      * @return bool
  218.      */
  219.     public function isValidLocale($language, $country)
  220.     {
  221.         return ($this->getLanguage() === $language && $this->getCountry() === $country)
  222.             || (empty($this->getLanguage()) && empty($this->getCountry()));
  223.     }
  225.     public function toArray($depth = null)
  226.     {
  227.         $res = [];
  228.         $res['url'] = $this->getUrl();
  229.         $res['language'] = $this->getLanguage();
  230.         $res['country'] = $this->getCountry();
  231.         $res['segment'] = $this->getSegment();
  232.         $res['redirect'] = $this->getRedirect();
  233.         $res['main'] = $this->isMain();
  234.         $res['environment'] = $this->getEnvironment();
  236.         return $res;
  237.     }
  238. }