vendor/sulu/sulu/src/Sulu/Component/Webspace/PortalInformation.php line 20

  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\Localization\Localization;
  15. use Sulu\Component\Util\ArrayableInterface;
  17. /**
  18.  * This class represents the information for a given URL.
  19.  */
  20. class PortalInformation implements ArrayableInterface
  21. {
  22.     /**
  23.      * The type of the match.
  24.      *
  25.      * @var int
  26.      */
  27.     private $type;
  29.     /**
  30.      * The webspace for this portal information.
  31.      *
  32.      * @var Webspace
  33.      */
  34.     private $webspace;
  36.     /**
  37.      * The portal for this portal information.
  38.      *
  39.      * @var Portal
  40.      */
  41.     private $portal;
  43.     /**
  44.      * The localization for this portal information.
  45.      *
  46.      * @var Localization
  47.      */
  48.     private $localization;
  50.     /**
  51.      * The segment for this portal information.
  52.      *
  53.      * @deprecated Is not set anymore since https://github.com/sulu/sulu/pull/5277
  54.      *
  55.      * @var Segment
  56.      */
  57.     private $segment;
  59.     /**
  60.      * The url for this portal information.
  61.      *
  62.      * @var string
  63.      */
  64.     private $url;
  66.     /**
  67.      * @var string The url to redirect to
  68.      */
  69.     private $redirect;
  71.     /**
  72.      * @var bool
  73.      */
  74.     private $main;
  76.     /**
  77.      * @var string
  78.      */
  79.     private $urlExpression;
  81.     /**
  82.      * @var int
  83.      */
  84.     private $priority;
  86.     public function __construct(
  87.         $type,
  88.         Webspace $webspace = null,
  89.         Portal $portal = null,
  90.         Localization $localization = null,
  91.         $url = null,
  92.         Segment $segment = null,
  93.         $redirect = null,
  94.         $main = false,
  95.         $urlExpression = null,
  96.         $priority = 0
  97.     ) {
  98.         $this->setType($type);
  99.         $this->setWebspace($webspace);
  100.         $this->setPortal($portal);
  101.         $this->setLocalization($localization);
  102.         $this->setUrl($url);
  103.         $this->setRedirect($redirect);
  104.         $this->setMain($main);
  105.         $this->setUrlExpression($urlExpression);
  106.         $this->setPriority($priority);
  108.         if ($segment) {
  109.             $this->setSegment($segment);
  110.         }
  111.     }
  113.     /**
  114.      * Sets the localization for this PortalInformation.
  115.      *
  116.      * @param Localization $localization
  117.      */
  118.     public function setLocalization($localization)
  119.     {
  120.         $this->localization = $localization;
  121.     }
  123.     /**
  124.      * Returns the localization for this PortalInformation.
  125.      *
  126.      * @return Localization
  127.      */
  128.     public function getLocalization()
  129.     {
  130.         return $this->localization;
  131.     }
  133.     /**
  134.      * Returns the localization for this PortalInformation.
  135.      *
  136.      * @return string
  137.      */
  138.     public function getLocale()
  139.     {
  140.         if (null === $this->localization) {
  141.             return;
  142.         }
  144.         return $this->localization->getLocale();
  145.     }
  147.     /**
  148.      * Sets the portal for this PortalInformation.
  149.      *
  150.      * @param Portal $portal
  151.      */
  152.     public function setPortal($portal)
  153.     {
  154.         $this->portal = $portal;
  155.     }
  157.     /**
  158.      * Returns the portal for this PortalInformation.
  159.      *
  160.      * @return Portal
  161.      */
  162.     public function getPortal()
  163.     {
  164.         return $this->portal;
  165.     }
  167.     /**
  168.      * Returns key of portal.
  169.      */
  170.     public function getPortalKey()
  171.     {
  172.         if (null === $this->portal) {
  173.             return;
  174.         }
  176.         return $this->portal->getKey();
  177.     }
  179.     /**
  180.      * Sets the redirect for the PortalInformation.
  181.      *
  182.      * @param string $redirect
  183.      */
  184.     public function setRedirect($redirect)
  185.     {
  186.         $this->redirect = $redirect;
  187.     }
  189.     /**
  190.      * Returns the redirect for the PortalInformation.
  191.      *
  192.      * @return string
  193.      */
  194.     public function getRedirect()
  195.     {
  196.         return $this->redirect;
  197.     }
  199.     /**
  200.      * Sets the segment for the PortalInformation.
  201.      *
  202.      * @deprecated Is not set anymore since https://github.com/sulu/sulu/pull/5277
  203.      *
  204.      * @param Segment $segment
  205.      */
  206.     public function setSegment($segment)
  207.     {
  208.         @\trigger_error(
  209.             'Segment on the PortalInformation will be removed and should not be used anymore since Sulu 2.2',
  210.             \E_USER_DEPRECATED
  211.         );
  212.         $this->segment = $segment;
  213.     }
  215.     /**
  216.      * Returns the segment for the PortalInformation.
  217.      *
  218.      * @deprecated Is not set anymore since https://github.com/sulu/sulu/pull/5277
  219.      *
  220.      * @return Segment
  221.      */
  222.     public function getSegment()
  223.     {
  224.         @\trigger_error(
  225.             'Segment on the PortalInformation will be removed and should not be used anymore since Sulu 2.2',
  226.             \E_USER_DEPRECATED
  227.         );
  229.         return $this->segment;
  230.     }
  232.     /**
  233.      * @deprecated Is not set anymore since https://github.com/sulu/sulu/pull/5277
  234.      */
  235.     public function getSegmentKey()
  236.     {
  237.         @\trigger_error(
  238.             'Segment on the PortalInformation will be removed and should not be used anymore since Sulu 2.2',
  239.             \E_USER_DEPRECATED
  240.         );
  242.         return $this->segment ? $this->segment->getKey() : null;
  243.     }
  245.     /**
  246.      * Sets the match type of this PortalInformation.
  247.      *
  248.      * @param int $type
  249.      */
  250.     public function setType($type)
  251.     {
  252.         $this->type = $type;
  253.     }
  255.     /**
  256.      * Returns the match type of this PortalInformation.
  257.      *
  258.      * @return int
  259.      */
  260.     public function getType()
  261.     {
  262.         return $this->type;
  263.     }
  265.     /**
  266.      * Sets the URL of this Portalinformation.
  267.      *
  268.      * @param string $url
  269.      */
  270.     public function setUrl($url)
  271.     {
  272.         $this->url = $url;
  273.     }
  275.     /**
  276.      * Returns the URL of this Portalinformation.
  277.      *
  278.      * @return string
  279.      */
  280.     public function getUrl()
  281.     {
  282.         return $this->url;
  283.     }
  285.     /**
  286.      * Returns the host including the domain for the PortalInformation.
  287.      *
  288.      * @return string
  289.      */
  290.     public function getHost()
  291.     {
  292.         return \substr($this->url, 0, $this->getHostLength());
  293.     }
  295.     /**
  296.      * Returns the prefix (the url without the host) for this PortalInformation.
  297.      *
  298.      * @return string
  299.      */
  300.     public function getPrefix()
  301.     {
  302.         $prefix = \substr($this->url, $this->getHostLength() + 1);
  304.         return $prefix ? $prefix . '/' : null;
  305.     }
  307.     /**
  308.      * Sets the webspace for this PortalInformation.
  309.      *
  310.      * @param Webspace $webspace
  311.      */
  312.     public function setWebspace($webspace)
  313.     {
  314.         $this->webspace = $webspace;
  315.     }
  317.     /**
  318.      * Returns the webspace for this PortalInformation.
  319.      *
  320.      * @return Webspace
  321.      */
  322.     public function getWebspace()
  323.     {
  324.         return $this->webspace;
  325.     }
  327.     /**
  328.      * Returns key of webspace.
  329.      */
  330.     public function getWebspaceKey()
  331.     {
  332.         if (null === $this->webspace) {
  333.             return;
  334.         }
  336.         return $this->webspace->getKey();
  337.     }
  339.     /**
  340.      * Returns true if url is main.
  341.      *
  342.      * @return bool
  343.      */
  344.     public function isMain()
  345.     {
  346.         return $this->main;
  347.     }
  349.     /**
  350.      * Sets true if url is main.
  351.      *
  352.      * @param bool $main
  353.      */
  354.     public function setMain($main)
  355.     {
  356.         $this->main = $main;
  357.     }
  359.     /**
  360.      * Returns expression for url.
  361.      *
  362.      * @return string
  363.      */
  364.     public function getUrlExpression()
  365.     {
  366.         return $this->urlExpression;
  367.     }
  369.     /**
  370.      * Sets expression for url.
  371.      *
  372.      * @param string $urlExpression
  373.      */
  374.     public function setUrlExpression($urlExpression)
  375.     {
  376.         $this->urlExpression = $urlExpression;
  377.     }
  379.     /**
  380.      * Calculate the length of the host part of the URL.
  381.      *
  382.      * @return int
  383.      */
  384.     private function getHostLength()
  385.     {
  386.         $hostLength = \strpos($this->url, '/');
  387.         $hostLength = (false === $hostLength) ? \strlen($this->url) : $hostLength;
  389.         return $hostLength;
  390.     }
  392.     /**
  393.      * @return int
  394.      */
  395.     public function getPriority()
  396.     {
  397.         return $this->priority;
  398.     }
  400.     /**
  401.      * @param int $priority
  402.      */
  403.     public function setPriority($priority)
  404.     {
  405.         $this->priority = $priority;
  406.     }
  408.     public function toArray($depth = null)
  409.     {
  410.         $result = [];
  411.         $result['type'] = $this->getType();
  412.         $result['webspace'] = $this->getWebspace()->getKey();
  413.         $result['url'] = $this->getUrl();
  414.         $result['main'] = $this->isMain();
  415.         $result['priority'] = $this->getPriority();
  417.         $portal = $this->getPortal();
  418.         if ($portal) {
  419.             $result['portal'] = $portal->getKey();
  420.         }
  422.         $localization = $this->getLocalization();
  423.         if ($localization) {
  424.             $result['localization'] = $localization->toArray();
  425.         }
  427.         $result['redirect'] = $this->getRedirect();
  429.         $segment = $this->getSegment();
  430.         if ($segment) {
  431.             $result['segment'] = $segment->getKey();
  432.         }
  434.         $urlExpression = $this->getUrlExpression();
  435.         if ($urlExpression) {
  436.             $result['urlExpression'] = $urlExpression;
  437.         }
  439.         return $result;
  440.     }
  441. }