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. */
  28. private $name;
  30. /**
  31. * @var string|bool|array
  32. *
  33. * @Groups({"frontend"})
  34. */
  35. private $value;
  37. /**
  38. * @var string
  39. *
  40. * @Type("string")
  41. */
  42. private $type;
  44. /**
  45. * @var Metadata
  46. *
  47. * @Type("Sulu\Component\Content\Compat\Metadata")
  48. */
  49. private $metadata;
  51. /**
  52. * Constructor.
  53. *
  54. * @param string $name
  55. * @param string|null $type
  56. * @param string|bool|array $value
  57. * @param array $metadata
  58. */
  59. public function __construct($name, $value, $type = null, $metadata = [])
  60. {
  61. $this->name = $name;
  62. $this->value = $value;
  63. $this->type = $type;
  64. $this->metadata = new Metadata($metadata);
  65. }
  67. /**
  68. * Returns name of property param.
  69. *
  70. * @return string
  71. */
  72. public function getName()
  73. {
  74. return $this->name;
  75. }
  77. /**
  78. * Returns value of property param.
  79. *
  80. * @return array|bool|string
  81. */
  82. public function getValue()
  83. {
  84. return $this->value;
  85. }
  87. /**
  88. * Returns type of property param.
  89. *
  90. * @return string
  91. */
  92. public function getType()
  93. {
  94. return $this->type;
  95. }
  97. /**
  98. * Returns title of property param.
  99. *
  100. * @param string $languageCode
  101. *
  102. * @return string
  103. */
  104. public function getTitle($languageCode)
  105. {
  106. return $this->metadata->get('title', $languageCode, \ucfirst($this->name));
  107. }
  109. /**
  110. * Returns TRUE if parameter has a localized title the given language.
  111. *
  112. * @param string $languageCode
  113. *
  114. * @return bool
  115. */
  116. public function hasTitle($languageCode)
  117. {
  118. return null !== $this->metadata->get('title', $languageCode);
  119. }
  121. /**
  122. * Returns infoText of property param.
  123. *
  124. * @param string $languageCode
  125. *
  126. * @return string
  127. */
  128. public function getInfoText($languageCode)
  129. {
  130. return $this->metadata->get('info_text', $languageCode, '');
  131. }
  133. /**
  134. * Returns placeholder of property param.
  135. *
  136. * @param string $languageCode
  137. *
  138. * @return string
  139. */
  140. public function getPlaceholder($languageCode)
  141. {
  142. return $this->metadata->get('placeholder', $languageCode, '');
  143. }
  145. public function __toString()
  146. {
  147. $value = $this->getValue();
  149. if (\is_string($value)) {
  150. return $value;
  151. } elseif (\is_bool($value)) {
  152. return $value ? 'true' : 'false';
  153. } else {
  154. return '';
  155. }
  156. }
  158. #[\ReturnTypeWillChange]
  159. public function jsonSerialize()
  160. {
  161. return [
  162. 'value' => $this->getValue(),
  163. 'type' => $this->getType(),
  164. ];
  165. }
  166. }