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

Open in your IDE?
  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. * Container for a webspace definition.
  19. */
  20. class Webspace implements ArrayableInterface
  21. {
  22. /**
  23. * The name of the webspace.
  24. *
  25. * @var string
  26. */
  27. private $name;
  29. /**
  30. * The key of the webspace.
  31. *
  32. * @var string
  33. */
  34. private $key;
  36. /**
  37. * The localizations defined for this webspace.
  38. *
  39. * @var Localization[]
  40. */
  41. private $localizations = [];
  43. /**
  44. * The default localization defined for this webspace.
  45. *
  46. * @var Localization
  47. */
  48. private $defaultLocalization;
  50. /**
  51. * The x-default localization defined for this webspace.
  52. *
  53. * @var Localization
  54. */
  55. private $xDefaultLocalization;
  57. /**
  58. * The segments defined for this webspace.
  59. *
  60. * @var Segment[]
  61. */
  62. private $segments = [];
  64. /**
  65. * The default segment defined for this webspace.
  66. *
  67. * @var Segment
  68. */
  69. private $defaultSegment;
  71. /**
  72. * The theme of the webspace.
  73. *
  74. * @var string
  75. */
  76. private $theme;
  78. /**
  79. * The portals defined for this webspace.
  80. *
  81. * @var Portal[]
  82. */
  83. private $portals = [];
  85. /**
  86. * The security system for this webspace.
  87. *
  88. * @var Security|null
  89. */
  90. private $security;
  92. /**
  93. * Navigation for this webspace.
  94. *
  95. * @var Navigation
  96. */
  97. private $navigation;
  99. /**
  100. * A list of twig templates.
  101. *
  102. * @var array
  103. */
  104. private $templates = [];
  106. /**
  107. * Template which is selected by default if no other template is chosen.
  108. *
  109. * @var string[]
  110. */
  111. private $defaultTemplates = [];
  113. /**
  114. * @var string[]
  115. */
  116. private $excludedTemplates = [];
  118. /**
  119. * The url generation strategy for this portal.
  120. *
  121. * @var string
  122. */
  123. private $resourceLocatorStrategy;
  125. /**
  126. * Sets the key of the webspace.
  127. *
  128. * @param string $key
  129. *
  130. * @return void
  131. */
  132. public function setKey($key)
  133. {
  134. $this->key = $key;
  135. }
  137. /**
  138. * Returns the key of the webspace.
  139. *
  140. * @return string
  141. */
  142. public function getKey()
  143. {
  144. return $this->key;
  145. }
  147. /**
  148. * Adds a localization to the webspace.
  149. *
  150. * @return void
  151. */
  152. public function addLocalization(Localization $localization)
  153. {
  154. $this->localizations[] = $localization;
  156. if ($localization->isDefault()) {
  157. $this->setDefaultLocalization($localization);
  158. }
  160. if ($localization->isXDefault(false)) {
  161. $this->xDefaultLocalization = $localization;
  162. }
  163. }
  165. /**
  166. * Returns the localizations of this webspace.
  167. *
  168. * @param Localization[] $localizations
  169. *
  170. * @return void
  171. */
  172. public function setLocalizations($localizations)
  173. {
  174. $this->localizations = $localizations;
  175. }
  177. /**
  178. * Returns the localizations of this webspace.
  179. *
  180. * @return Localization[]
  181. */
  182. public function getLocalizations()
  183. {
  184. return $this->localizations;
  185. }
  187. /**
  188. * Returns a list of all localizations and sublocalizations.
  189. *
  190. * @return Localization[]
  191. */
  192. public function getAllLocalizations()
  193. {
  194. $localizations = [];
  195. foreach ($this->getLocalizations() as $child) {
  196. $localizations[] = $child;
  197. $localizations = \array_merge($localizations, $child->getAllLocalizations());
  198. }
  200. return $localizations;
  201. }
  203. /**
  204. * Returns the localization object for a given localization string.
  205. *
  206. * @param string $localization
  207. *
  208. * @return Localization|null
  209. */
  210. public function getLocalization($localization)
  211. {
  212. $localizations = $this->getLocalizations();
  213. if (!empty($localizations)) {
  214. foreach ($localizations as $webspaceLocalization) {
  215. $result = $webspaceLocalization->findLocalization($localization);
  217. if ($result) {
  218. return $result;
  219. }
  220. }
  221. }
  223. return null;
  224. }
  226. /**
  227. * Sets the default localization for this webspace.
  228. *
  229. * @param Localization $defaultLocalization
  230. *
  231. * @return void
  232. */
  233. public function setDefaultLocalization($defaultLocalization)
  234. {
  235. $this->defaultLocalization = $defaultLocalization;
  237. if (!$this->getXDefaultLocalization()) {
  238. $this->xDefaultLocalization = $defaultLocalization;
  239. }
  240. }
  242. /**
  243. * Returns the default localization for this webspace.
  244. *
  245. * @return Localization
  246. */
  247. public function getDefaultLocalization()
  248. {
  249. if (!$this->defaultLocalization) {
  250. return $this->localizations[0];
  251. }
  253. return $this->defaultLocalization;
  254. }
  256. /**
  257. * Returns the x-default localization for this webspace.
  258. *
  259. * @return Localization
  260. */
  261. public function getXDefaultLocalization()
  262. {
  263. if (!$this->xDefaultLocalization) {
  264. return $this->localizations[0];
  265. }
  267. return $this->xDefaultLocalization;
  268. }
  270. /**
  271. * Sets the name of the webspace.
  272. *
  273. * @param string $name
  274. *
  275. * @return void
  276. */
  277. public function setName($name)
  278. {
  279. $this->name = $name;
  280. }
  282. /**
  283. * Returns the name of the webspace.
  284. *
  285. * @return string
  286. */
  287. public function getName()
  288. {
  289. return $this->name;
  290. }
  292. /**
  293. * Adds a portal to the webspace.
  294. *
  295. * @return void
  296. */
  297. public function addPortal(Portal $portal)
  298. {
  299. $this->portals[] = $portal;
  300. }
  302. /**
  303. * Sets the portals of this webspace.
  304. *
  305. * @param Portal[] $portals
  306. *
  307. * @return void
  308. */
  309. public function setPortals($portals)
  310. {
  311. $this->portals = $portals;
  312. }
  314. /**
  315. * Returns the portals of this webspace.
  316. *
  317. * @return Portal[]
  318. */
  319. public function getPortals()
  320. {
  321. return $this->portals;
  322. }
  324. /**
  325. * Adds a segment to the webspace.
  326. *
  327. * @return void
  328. */
  329. public function addSegment(Segment $segment)
  330. {
  331. $this->segments[] = $segment;
  333. if ($segment->isDefault()) {
  334. $this->setDefaultSegment($segment);
  335. }
  336. }
  338. /**
  339. * Sets the segments of this webspace.
  340. *
  341. * @param Segment[] $segments
  342. *
  343. * @return void
  344. */
  345. public function setSegments($segments)
  346. {
  347. $this->segments = $segments;
  348. }
  350. /**
  351. * Returns the segments of this webspace.
  352. *
  353. * @return Segment[]
  354. */
  355. public function getSegments()
  356. {
  357. return $this->segments;
  358. }
  360. public function getSegment(string $segmentKey): ?Segment
  361. {
  362. foreach ($this->segments as $segment) {
  363. if ($segment->getKey() === $segmentKey) {
  364. return $segment;
  365. }
  366. }
  368. return null;
  369. }
  371. /**
  372. * Sets the default segment of this webspace.
  373. *
  374. * @param Segment $defaultSegment
  375. *
  376. * @return void
  377. */
  378. public function setDefaultSegment($defaultSegment)
  379. {
  380. $this->defaultSegment = $defaultSegment;
  381. }
  383. /**
  384. * Returns the default segment for this webspace.
  385. *
  386. * @return Segment
  387. */
  388. public function getDefaultSegment()
  389. {
  390. return $this->defaultSegment;
  391. }
  393. /**
  394. * Sets the theme for this portal.
  395. *
  396. * @param string|null $theme this parameter is options
  397. *
  398. * @return void
  399. */
  400. public function setTheme($theme = null)
  401. {
  402. $this->theme = $theme;
  403. }
  405. /**
  406. * Returns the theme for this portal.
  407. *
  408. * @return string
  409. */
  410. public function getTheme()
  411. {
  412. return $this->theme;
  413. }
  415. /**
  416. * Sets the security system.
  417. *
  418. * @param Security|null $security
  419. *
  420. * @return void
  421. */
  422. public function setSecurity($security)
  423. {
  424. $this->security = $security;
  425. }
  427. /**
  428. * Returns the security system.
  429. *
  430. * @return Security|null
  431. */
  432. public function getSecurity()
  433. {
  434. return $this->security;
  435. }
  437. /**
  438. * @return bool
  439. */
  440. public function hasWebsiteSecurity()
  441. {
  442. $security = $this->getSecurity();
  444. if (!$security) {
  445. return false;
  446. }
  448. return null !== $security->getSystem() && $security->getPermissionCheck();
  449. }
  451. /**
  452. * @return Navigation
  453. */
  454. public function getNavigation()
  455. {
  456. return $this->navigation;
  457. }
  459. /**
  460. * @param Navigation $navigation
  461. *
  462. * @return void
  463. */
  464. public function setNavigation($navigation)
  465. {
  466. $this->navigation = $navigation;
  467. }
  469. /**
  470. * Returns false if domain not exists in webspace.
  471. *
  472. * @param string $domain
  473. * @param string $environment
  474. * @param string $locale
  475. *
  476. * @return bool
  477. *
  478. * @throws Exception\EnvironmentNotFoundException
  479. */
  480. public function hasDomain($domain, $environment, $locale = null)
  481. {
  482. $localizationParts = \explode('_', $locale);
  483. $language = $localizationParts[0];
  484. $country = isset($localizationParts[1]) ? $localizationParts[1] : '';
  486. foreach ($this->getPortals() as $portal) {
  487. foreach ($portal->getEnvironment($environment)->getUrls() as $url) {
  488. $host = \parse_url('//' . $url->getUrl())['host'];
  489. if ((null === $locale || $url->isValidLocale($language, $country))
  490. && ($host === $domain || '{host}' === $host)
  491. ) {
  492. return true;
  493. }
  494. }
  495. }
  497. return false;
  498. }
  500. /**
  501. * Add a new template for given type.
  502. *
  503. * @param string $type
  504. * @param string $template
  505. *
  506. * @return void
  507. */
  508. public function addTemplate($type, $template)
  509. {
  510. $this->templates[$type] = $template;
  511. }
  513. /**
  514. * Returns a template for the given type.
  515. *
  516. * @param string $type
  517. * @param string $format
  518. *
  519. * @return string|null
  520. */
  521. public function getTemplate($type, $format = 'html')
  522. {
  523. if (\array_key_exists($type, $this->templates)) {
  524. return $this->templates[$type] . '.' . $format . '.twig';
  525. }
  527. return null;
  528. }
  530. /**
  531. * Returns an array of templates.
  532. *
  533. * @return string[]
  534. */
  535. public function getTemplates()
  536. {
  537. return $this->templates;
  538. }
  540. /**
  541. * Add a new default template for given type.
  542. *
  543. * @param string $type
  544. * @param string $template
  545. *
  546. * @return void
  547. */
  548. public function addDefaultTemplate($type, $template)
  549. {
  550. $this->defaultTemplates[$type] = $template;
  551. }
  553. /**
  554. * Returns a error template for given code.
  555. *
  556. * @param string $type
  557. *
  558. * @return string|null
  559. */
  560. public function getDefaultTemplate($type)
  561. {
  562. if (\array_key_exists($type, $this->defaultTemplates)) {
  563. return $this->defaultTemplates[$type];
  564. }
  566. return null;
  567. }
  569. /**
  570. * Returns a array of default template.
  571. *
  572. * @return string[]
  573. */
  574. public function getDefaultTemplates()
  575. {
  576. return $this->defaultTemplates;
  577. }
  579. /**
  580. * Add a new template for given type.
  581. *
  582. * @param string $excludedTemplate
  583. *
  584. * @return void
  585. */
  586. public function addExcludedTemplate($excludedTemplate)
  587. {
  588. $this->excludedTemplates[] = $excludedTemplate;
  589. }
  591. /**
  592. * @return string[]
  593. */
  594. public function getExcludedTemplates()
  595. {
  596. return $this->excludedTemplates;
  597. }
  599. /**
  600. * Set resource-locator strategy.
  601. *
  602. * @param string $resourceLocatorStrategy
  603. *
  604. * @return void
  605. */
  606. public function setResourceLocatorStrategy($resourceLocatorStrategy)
  607. {
  608. $this->resourceLocatorStrategy = $resourceLocatorStrategy;
  609. }
  611. /**
  612. * Returns resource-locator strategy.
  613. *
  614. * @return string
  615. */
  616. public function getResourceLocatorStrategy()
  617. {
  618. return $this->resourceLocatorStrategy;
  619. }
  621. /**
  622. * @return array
  623. */
  624. public function toArray($depth = null)
  625. {
  626. $res = [];
  627. $res['key'] = $this->getKey();
  628. $res['name'] = $this->getName();
  629. $res['localizations'] = [];
  630. $res['templates'] = $this->getTemplates();
  631. $res['defaultTemplates'] = $this->getDefaultTemplates();
  632. $res['excludedTemplates'] = $this->getExcludedTemplates();
  633. $res['resourceLocator']['strategy'] = $this->getResourceLocatorStrategy();
  635. foreach ($this->getLocalizations() as $localization) {
  636. $res['localizations'][] = $localization->toArray();
  637. }
  639. $thisSecurity = $this->getSecurity();
  640. if (null != $thisSecurity) {
  641. $res['security']['system'] = $thisSecurity->getSystem();
  642. $res['security']['permissionCheck'] = $thisSecurity->getPermissionCheck();
  643. }
  645. $res['segments'] = [];
  646. $segments = $this->getSegments();
  648. if (!empty($segments)) {
  649. foreach ($segments as $segment) {
  650. $res['segments'][] = $segment->toArray();
  651. }
  652. }
  654. $res['theme'] = !$this->theme ? null : $this->theme;
  656. $res['portals'] = [];
  657. foreach ($this->getPortals() as $portal) {
  658. $res['portals'][] = $portal->toArray();
  659. }
  661. $res['navigation'] = [];
  662. $res['navigation']['contexts'] = [];
  663. if ($navigation = $this->getNavigation()) {
  664. foreach ($navigation->getContexts() as $context) {
  665. $res['navigation']['contexts'][] = [
  666. 'key' => $context->getKey(),
  667. 'metadata' => $context->getMetadata(),
  668. ];
  669. }
  670. }
  672. return $res;
  673. }
  674. }