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_deprecation(
  209.             'sulu/sulu',
  210.             '2.2',
  211.             'Segment on the PortalInformation will be removed and should not be used anymore.'
  212.         );
  213.         $this->segment = $segment;
  214.     }
  216.     /**
  217.      * Returns the segment for the PortalInformation.
  218.      *
  219.      * @deprecated Is not set anymore since https://github.com/sulu/sulu/pull/5277
  220.      *
  221.      * @return Segment
  222.      */
  223.     public function getSegment()
  224.     {
  225.         @trigger_deprecation(
  226.             'sulu/sulu',
  227.             '2.2',
  228.             'Segment on the PortalInformation will be removed and should not be used anymore.'
  229.         );
  231.         return $this->segment;
  232.     }
  234.     /**
  235.      * @deprecated Is not set anymore since https://github.com/sulu/sulu/pull/5277
  236.      */
  237.     public function getSegmentKey()
  238.     {
  239.         @trigger_deprecation(
  240.             'sulu/sulu',
  241.             '2.2',
  242.             'Segment on the PortalInformation will be removed and should not be used anymore.'
  243.         );
  245.         return $this->segment ? $this->segment->getKey() : null;
  246.     }
  248.     /**
  249.      * Sets the match type of this PortalInformation.
  250.      *
  251.      * @param int $type
  252.      */
  253.     public function setType($type)
  254.     {
  255.         $this->type = $type;
  256.     }
  258.     /**
  259.      * Returns the match type of this PortalInformation.
  260.      *
  261.      * @return int
  262.      */
  263.     public function getType()
  264.     {
  265.         return $this->type;
  266.     }
  268.     /**
  269.      * Sets the URL of this Portalinformation.
  270.      *
  271.      * @param string $url
  272.      */
  273.     public function setUrl($url)
  274.     {
  275.         $this->url = $url;
  276.     }
  278.     /**
  279.      * Returns the URL of this Portalinformation.
  280.      *
  281.      * @return string
  282.      */
  283.     public function getUrl()
  284.     {
  285.         return $this->url;
  286.     }
  288.     /**
  289.      * Returns the host including the domain for the PortalInformation.
  290.      *
  291.      * @return string
  292.      */
  293.     public function getHost()
  294.     {
  295.         return \substr($this->url, 0, $this->getHostLength());
  296.     }
  298.     /**
  299.      * Returns the prefix (the url without the host) for this PortalInformation.
  300.      *
  301.      * @return string
  302.      */
  303.     public function getPrefix()
  304.     {
  305.         $prefix = \substr($this->url, $this->getHostLength() + 1);
  307.         return $prefix ? $prefix . '/' : null;
  308.     }
  310.     /**
  311.      * Sets the webspace for this PortalInformation.
  312.      *
  313.      * @param Webspace $webspace
  314.      */
  315.     public function setWebspace($webspace)
  316.     {
  317.         $this->webspace = $webspace;
  318.     }
  320.     /**
  321.      * Returns the webspace for this PortalInformation.
  322.      *
  323.      * @return Webspace
  324.      */
  325.     public function getWebspace()
  326.     {
  327.         return $this->webspace;
  328.     }
  330.     /**
  331.      * Returns key of webspace.
  332.      */
  333.     public function getWebspaceKey()
  334.     {
  335.         if (null === $this->webspace) {
  336.             return;
  337.         }
  339.         return $this->webspace->getKey();
  340.     }
  342.     /**
  343.      * Returns true if url is main.
  344.      *
  345.      * @return bool
  346.      */
  347.     public function isMain()
  348.     {
  349.         return $this->main;
  350.     }
  352.     /**
  353.      * Sets true if url is main.
  354.      *
  355.      * @param bool $main
  356.      */
  357.     public function setMain($main)
  358.     {
  359.         $this->main = $main;
  360.     }
  362.     /**
  363.      * Returns expression for url.
  364.      *
  365.      * @return string
  366.      */
  367.     public function getUrlExpression()
  368.     {
  369.         return $this->urlExpression;
  370.     }
  372.     /**
  373.      * Sets expression for url.
  374.      *
  375.      * @param string $urlExpression
  376.      */
  377.     public function setUrlExpression($urlExpression)
  378.     {
  379.         $this->urlExpression = $urlExpression;
  380.     }
  382.     /**
  383.      * Calculate the length of the host part of the URL.
  384.      *
  385.      * @return int
  386.      */
  387.     private function getHostLength()
  388.     {
  389.         $hostLength = \strpos($this->url, '/');
  390.         $hostLength = (false === $hostLength) ? \strlen($this->url) : $hostLength;
  392.         return $hostLength;
  393.     }
  395.     /**
  396.      * @return int
  397.      */
  398.     public function getPriority()
  399.     {
  400.         return $this->priority;
  401.     }
  403.     /**
  404.      * @param int $priority
  405.      */
  406.     public function setPriority($priority)
  407.     {
  408.         $this->priority = $priority;
  409.     }
  411.     public function toArray($depth = null)
  412.     {
  413.         $result = [];
  414.         $result['type'] = $this->getType();
  415.         $result['webspace'] = $this->getWebspace()->getKey();
  416.         $result['url'] = $this->getUrl();
  417.         $result['main'] = $this->isMain();
  418.         $result['priority'] = $this->getPriority();
  420.         $portal = $this->getPortal();
  421.         if ($portal) {
  422.             $result['portal'] = $portal->getKey();
  423.         }
  425.         $localization = $this->getLocalization();
  426.         if ($localization) {
  427.             $result['localization'] = $localization->toArray();
  428.         }
  430.         $result['redirect'] = $this->getRedirect();
  432.         $segment = $this->getSegment();
  433.         if ($segment) {
  434.             $result['segment'] = $segment->getKey();
  435.         }
  437.         $urlExpression = $this->getUrlExpression();
  438.         if ($urlExpression) {
  439.             $result['urlExpression'] = $urlExpression;
  440.         }
  442.         return $result;
  443.     }
  444. }