vendor/sulu/sulu/src/Sulu/Component/Content/Compat/PropertyParameter.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\Content\Compat;
  14. use JMS\Serializer\Annotation\Groups;
  15. use JMS\Serializer\Annotation\Type;
  17. /**
  18. * Represents a parameter of a property.
  19. */
  20. class PropertyParameter implements \JsonSerializable
  21. {
  22. /**
  23. * @var string
  24. */
  25. #[Type('string')]
  26. #[Groups(['frontend'])]
  27. private $name;
  29. /**
  30. * @var string|bool|array
  31. */
  32. #[Groups(['frontend'])]
  33. private $value;
  35. /**
  36. * @var string
  37. */
  38. #[Type('string')]
  39. private $type;
  41. /**
  42. * @var Metadata
  43. */
  44. #[Type('Sulu\Component\Content\Compat\Metadata')]
  45. private $metadata;
  47. /**
  48. * Constructor.
  49. *
  50. * @param string $name
  51. * @param string|null $type
  52. * @param string|bool|array $value
  53. * @param array $metadata
  54. */
  55. public function __construct($name, $value, $type = null, $metadata = [])
  56. {
  57. $this->name = $name;
  58. $this->value = $value;
  59. $this->type = $type;
  60. $this->metadata = new Metadata($metadata);
  61. }
  63. /**
  64. * Returns name of property param.
  65. *
  66. * @return string
  67. */
  68. public function getName()
  69. {
  70. return $this->name;
  71. }
  73. /**
  74. * Returns value of property param.
  75. *
  76. * @return array|bool|string
  77. */
  78. public function getValue()
  79. {
  80. return $this->value;
  81. }
  83. /**
  84. * Returns type of property param.
  85. *
  86. * @return string
  87. */
  88. public function getType()
  89. {
  90. return $this->type;
  91. }
  93. /**
  94. * Returns title of property param.
  95. *
  96. * @param string $languageCode
  97. *
  98. * @return string
  99. */
  100. public function getTitle($languageCode)
  101. {
  102. return $this->metadata->get('title', $languageCode, \ucfirst($this->name));
  103. }
  105. /**
  106. * Returns TRUE if parameter has a localized title the given language.
  107. *
  108. * @param string $languageCode
  109. *
  110. * @return bool
  111. */
  112. public function hasTitle($languageCode)
  113. {
  114. return null !== $this->metadata->get('title', $languageCode);
  115. }
  117. /**
  118. * Returns infoText of property param.
  119. *
  120. * @param string $languageCode
  121. *
  122. * @return string
  123. */
  124. public function getInfoText($languageCode)
  125. {
  126. return $this->metadata->get('info_text', $languageCode, '');
  127. }
  129. /**
  130. * Returns placeholder of property param.
  131. *
  132. * @param string $languageCode
  133. *
  134. * @return string
  135. */
  136. public function getPlaceholder($languageCode)
  137. {
  138. return $this->metadata->get('placeholder', $languageCode, '');
  139. }
  141. public function __toString()
  142. {
  143. $value = $this->getValue();
  145. if (\is_string($value)) {
  146. return $value;
  147. } elseif (\is_bool($value)) {
  148. return $value ? 'true' : 'false';
  149. } else {
  150. return '';
  151. }
  152. }
  154. #[\ReturnTypeWillChange]
  155. public function jsonSerialize()
  156. {
  157. return [
  158. 'value' => $this->getValue(),
  159. 'type' => $this->getType(),
  160. ];
  161. }
  162. }