class ResourceTypeBuildEvent
Same name in other branches
- 9 core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent
- 8.9.x core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent
- 11.x core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent
An event used to configure the construction of a JSON:API resource type.
Hierarchy
- class \Drupal\Component\EventDispatcher\Event extends \Symfony\Contracts\EventDispatcher\Event
- class \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent extends \Drupal\Component\EventDispatcher\Event
Expanded class hierarchy of ResourceTypeBuildEvent
See also
\Drupal\jsonapi\ResourceType\ResourceTypeBuildEvents
\Drupal\jsonapi\ResourceType\ResourceTypeRepository
1 file declares its use of ResourceTypeBuildEvent
- ResourceTypeBuildEventSubscriber.php in core/
modules/ jsonapi/ tests/ modules/ jsonapi_test_resource_type_building/ src/ EventSubscriber/ ResourceTypeBuildEventSubscriber.php
File
-
core/
modules/ jsonapi/ src/ ResourceType/ ResourceTypeBuildEvent.php, line 15
Namespace
Drupal\jsonapi\ResourceTypeView source
class ResourceTypeBuildEvent extends Event {
/**
* The JSON:API resource type name of the instance to be built.
*
* @var null|string
*/
protected $resourceTypeName;
/**
* The fields of the resource type to be built.
*
* @var \Drupal\jsonapi\ResourceType\ResourceTypeField[]
*/
protected $fields;
/**
* Whether the JSON:API resource type to be built should be disabled.
*
* @var bool
*/
protected $disabled = FALSE;
/**
* ResourceTypeBuildEvent constructor.
*
* This constructor is protected by design. Use
* static::createFromEntityTypeAndBundle() instead.
*
* @param string $resource_type_name
* A JSON:API resource type name.
* @param \Drupal\jsonapi\ResourceType\ResourceTypeField[] $fields
* The fields of the resource type to be built.
*/
protected function __construct($resource_type_name, array $fields) {
assert(Inspector::assertAllObjects($fields, ResourceTypeField::class));
$this->resourceTypeName = $resource_type_name;
$this->fields = $fields;
}
/**
* Creates a new ResourceTypeBuildEvent.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* An entity type for the resource type to be built.
* @param string $bundle
* A bundle name for the resource type to be built. If the entity type does
* not have bundles, the entity type ID.
* @param \Drupal\jsonapi\ResourceType\ResourceTypeField[] $fields
* The fields of the resource type to be built.
*
* @return \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent
* A new event.
*/
public static function createFromEntityTypeAndBundle(EntityTypeInterface $entity_type, $bundle, array $fields) {
return new static($entity_type->id() . ResourceType::TYPE_NAME_URI_PATH_SEPARATOR . $bundle, $fields);
}
/**
* Gets current resource type name of the resource type to be built.
*
* @return string
* The resource type name.
*/
public function getResourceTypeName() {
return $this->resourceTypeName;
}
/**
* Sets the name of the resource type to be built.
*
* @param string $resource_type_name
* The resource type name. Also used to build the resource path.
*
* @see \Drupal\jsonapi\ResourceType\ResourceType::getPath()
*/
public function setResourceTypeName(string $resource_type_name) : void {
$this->resourceTypeName = $resource_type_name;
}
/**
* Disables the resource type to be built.
*/
public function disableResourceType() {
$this->disabled = TRUE;
}
/**
* Whether the resource type to be built should be disabled.
*
* @return bool
* TRUE if the resource type should be disabled, FALSE otherwise.
*/
public function resourceTypeShouldBeDisabled() {
return $this->disabled;
}
/**
* Gets the current fields of the resource type to be built.
*
* @return \Drupal\jsonapi\ResourceType\ResourceTypeField[]
* The current fields of the resource type to be built.
*/
public function getFields() {
return $this->fields;
}
/**
* Sets the public name of the given field on the resource type to be built.
*
* @param \Drupal\jsonapi\ResourceType\ResourceTypeField $field
* The field for which to set a public name.
* @param string $public_field_name
* The public field name to set.
*/
public function setPublicFieldName(ResourceTypeField $field, $public_field_name) {
foreach ($this->fields as $index => $value) {
if ($field === $value) {
$this->fields[$index] = $value->withPublicName($public_field_name);
return;
}
}
}
/**
* Disables the given field on the resource type to be built.
*
* @param \Drupal\jsonapi\ResourceType\ResourceTypeField $field
* The field for which to set a public name.
*/
public function disableField(ResourceTypeField $field) {
foreach ($this->fields as $index => $value) {
if ($field === $value) {
$this->fields[$index] = $value->disabled();
return;
}
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ResourceTypeBuildEvent::$disabled | protected | property | Whether the JSON:API resource type to be built should be disabled. |
ResourceTypeBuildEvent::$fields | protected | property | The fields of the resource type to be built. |
ResourceTypeBuildEvent::$resourceTypeName | protected | property | The JSON:API resource type name of the instance to be built. |
ResourceTypeBuildEvent::createFromEntityTypeAndBundle | public static | function | Creates a new ResourceTypeBuildEvent. |
ResourceTypeBuildEvent::disableField | public | function | Disables the given field on the resource type to be built. |
ResourceTypeBuildEvent::disableResourceType | public | function | Disables the resource type to be built. |
ResourceTypeBuildEvent::getFields | public | function | Gets the current fields of the resource type to be built. |
ResourceTypeBuildEvent::getResourceTypeName | public | function | Gets current resource type name of the resource type to be built. |
ResourceTypeBuildEvent::resourceTypeShouldBeDisabled | public | function | Whether the resource type to be built should be disabled. |
ResourceTypeBuildEvent::setPublicFieldName | public | function | Sets the public name of the given field on the resource type to be built. |
ResourceTypeBuildEvent::setResourceTypeName | public | function | Sets the name of the resource type to be built. |
ResourceTypeBuildEvent::__construct | protected | function | ResourceTypeBuildEvent constructor. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.