vendor/spatie/schema-org/src/BaseType.php line 87

Open in your IDE?
  1. <?php
  3. namespace Spatie\SchemaOrg;
  5. use ArrayAccess;
  6. use DateTime;
  7. use DateTimeInterface;
  8. use JsonSerializable;
  9. use ReflectionClass;
  10. use Spatie\SchemaOrg\Exceptions\InvalidProperty;
  12. abstract class BaseType implements Type, ArrayAccess, JsonSerializable
  13. {
  14. /** @var array */
  15. protected $properties = [];
  17. public function getContext(): string
  18. {
  19. return 'https://schema.org';
  20. }
  22. public function getType(): string
  23. {
  24. return (new ReflectionClass($this))->getShortName();
  25. }
  27. public function setProperty(string $property, $value)
  28. {
  29. if ($value !== null && $value !== '') {
  30. $this->properties[$property] = $value;
  31. }
  33. return $this;
  34. }
  36. public function addProperties(array $properties)
  37. {
  38. foreach ($properties as $property => $value) {
  39. $this->setProperty($property, $value);
  40. }
  42. return $this;
  43. }
  45. public function if($condition, $callback)
  46. {
  47. if ($condition) {
  48. $callback($this);
  49. }
  51. return $this;
  52. }
  54. public function getProperty(string $property, $default = null)
  55. {
  56. return $this->properties[$property] ?? $default;
  57. }
  59. public function getProperties(): array
  60. {
  61. return $this->properties;
  62. }
  64. /**
  65. * @return ReferencedType|static
  66. */
  67. public function referenced()
  68. {
  69. return new ReferencedType($this);
  70. }
  72. public function offsetExists($offset)
  73. {
  74. return array_key_exists($offset, $this->properties);
  75. }
  77. public function offsetGet($offset)
  78. {
  79. return $this->getProperty($offset);
  80. }
  82. public function offsetSet($offset, $value)
  83. {
  84. $this->setProperty($offset, $value);
  85. }
  87. public function offsetUnset($offset)
  88. {
  89. unset($this->properties[$offset]);
  90. }
  92. public function toArray(): array
  93. {
  94. $this->serializeIdentifier();
  95. $properties = $this->serializeProperty($this->getProperties());
  97. return [
  98. '@context' => $this->getContext(),
  99. '@type' => $this->getType(),
  100. ] + $properties;
  101. }
  103. protected function serializeProperty($property)
  104. {
  105. if (is_array($property)) {
  106. return array_map([$this, 'serializeProperty'], $property);
  107. }
  109. if ($property instanceof Type) {
  110. $property = $property->toArray();
  111. unset($property['@context']);
  112. }
  114. if ($property instanceof DateTimeInterface) {
  115. $property = $property->format(DateTime::ATOM);
  116. }
  118. if (is_object($property) && method_exists($property, '__toString')) {
  119. $property = (string) $property;
  120. }
  122. if (is_object($property)) {
  123. throw new InvalidProperty();
  124. }
  126. return $property;
  127. }
  129. protected function serializeIdentifier()
  130. {
  131. if (
  132. isset($this['identifier'])
  133. && ! $this['identifier'] instanceof Type
  134. ) {
  135. $this->setProperty('@id', $this['identifier']);
  136. unset($this['identifier']);
  137. }
  138. }
  140. public function toScript(): string
  141. {
  142. return '<script type="application/ld+json">'.json_encode($this->toArray(), JSON_UNESCAPED_UNICODE).'</script>';
  143. }
  145. public function jsonSerialize()
  146. {
  147. return $this->toArray();
  148. }
  150. public function __call(string $method, array $arguments)
  151. {
  152. return $this->setProperty($method, $arguments[0] ?? '');
  153. }
  155. public function __toString(): string
  156. {
  157. return $this->toScript();
  158. }
  159. }