vendor/ibexa/core/src/lib/MVC/Symfony/SiteAccess.php line 15

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. namespace Ibexa\Core\MVC\Symfony;
  9. use Ibexa\Contracts\Core\Repository\Values\ValueObject;
  10. use JsonSerializable;
  12. /**
  13. * Base struct for a siteaccess representation.
  14. */
  15. class SiteAccess extends ValueObject implements JsonSerializable
  16. {
  17. public const DEFAULT_MATCHING_TYPE = 'default';
  19. /**
  20. * Name of the siteaccess.
  21. *
  22. * @var string
  23. */
  24. public $name;
  26. /** @var \Ibexa\Core\MVC\Symfony\SiteAccessGroup[] */
  27. public $groups = [];
  29. /**
  30. * The matching type that has been used to discover the siteaccess.
  31. * Contains the matcher class FQN, or 'default' if fell back to the default siteaccess.
  32. *
  33. * @var string
  34. */
  35. public $matchingType;
  37. /**
  38. * The matcher instance that has been used to discover the siteaccess.
  39. *
  40. * @var \Ibexa\Core\MVC\Symfony\SiteAccess\Matcher
  41. */
  42. public $matcher;
  44. /**
  45. * The name of the provider from which Site Access comes.
  46. *
  47. * @var string|null
  48. */
  49. public $provider;
  51. public function __construct(
  52. string $name,
  53. string $matchingType = self::DEFAULT_MATCHING_TYPE,
  54. $matcher = null,
  55. ?string $provider = null,
  56. array $groups = []
  57. ) {
  58. $this->name = $name;
  59. $this->matchingType = $matchingType;
  60. $this->matcher = $matcher;
  61. $this->provider = $provider;
  62. $this->groups = $groups;
  63. }
  65. public function __toString()
  66. {
  67. return "$this->name (matched by '$this->matchingType')";
  68. }
  70. public function jsonSerialize(): array
  71. {
  72. $matcher = is_object($this->matcher) ? get_class($this->matcher) : null;
  74. return [
  75. 'name' => $this->name,
  76. 'matchingType' => $this->matchingType,
  77. 'matcher' => $matcher,
  78. 'provider' => $this->provider,
  79. 'groups' => $this->groups,
  80. ];
  81. }
  82. }
  84. class_alias(SiteAccess::class, 'eZ\Publish\Core\MVC\Symfony\SiteAccess');