class CollectResourceObjectMetaEvent

Event for collecting resource object metadata of a JSON:API resource types.

Subscribers of this event that call ::setMetaValue() must set the appropriate cache tags and contexts. These should be based on the data that is used to set the meta. These will then bubble up to the normalization.

Hierarchy

Expanded class hierarchy of CollectResourceObjectMetaEvent

Related topics

Events
Overview of event dispatch and subscribing
2 files declare their use of CollectResourceObjectMetaEvent
MetaEventSubscriber.php in core/modules/jsonapi/tests/modules/jsonapi_test_meta_events/src/EventSubscriber/MetaEventSubscriber.php
ResourceObjectNormalizer.php in core/modules/jsonapi/src/Normalizer/ResourceObjectNormalizer.php

File

core/modules/jsonapi/src/Events/CollectResourceObjectMetaEvent.php, line 22

Namespace

Drupal\jsonapi\Events
View source 
final class CollectResourceObjectMetaEvent extends Event implements RefinableCacheableDependencyInterface {
    use RefinableCacheableDependencyTrait;
    
    /**
     * The metadata.
     *
     * @var array
     */
    private array $meta = [];
    
    /**
     * Constructs a new CollectResourceObjectMetaEvent object.
     *
     * @param \Drupal\jsonapi\JsonApiResource\ResourceObject $resourceObject
     *   The resource object.
     * @param array $context
     *   The context options for the normalizer.
     */
    public function __construct(ResourceObject $resourceObject, array $context) {
        if (empty($context['resource_object']) || !$context['resource_object'] instanceof ResourceObject || $this->context['resource_object']
            ->getId() !== $this->resourceObject
            ->getId()) {
            throw new \RuntimeException('The context must contain a valid resource object.');
        }
    }
    
    /**
     * Gets the resource object.
     *
     * @return \Drupal\jsonapi\JsonApiResource\ResourceObject
     *   The resource object.
     */
    public function getResourceObject() : ResourceObject {
        return $this->resourceObject;
    }
    
    /**
     * Gets context options for the normalizer.
     *
     * @return array
     *   The context options for the normalizer.
     */
    public function getContext() : array {
        return $this->context;
    }
    
    /**
     * Gets the meta values.
     *
     * @return array
     *   The meta data.
     */
    public function getMeta() : array {
        return $this->meta;
    }
    
    /**
     * Sets a meta value.
     *
     * @param array|string $property
     *   The key or array of keys.
     * @param mixed $value
     *   The value.
     *
     * @return $this
     */
    public function setMetaValue(array|string $property, mixed $value) : self {
        NestedArray::setValue($this->meta, (array) $property, $value, TRUE);
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::getCacheContexts public function 4
CacheableDependencyTrait::getCacheMaxAge public function 4
CacheableDependencyTrait::getCacheTags public function 4
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
CollectResourceObjectMetaEvent::$meta private property The metadata.
CollectResourceObjectMetaEvent::getContext public function Gets context options for the normalizer.
CollectResourceObjectMetaEvent::getMeta public function Gets the meta values.
CollectResourceObjectMetaEvent::getResourceObject public function Gets the resource object.
CollectResourceObjectMetaEvent::setMetaValue public function Sets a meta value.
CollectResourceObjectMetaEvent::__construct public function Constructs a new CollectResourceObjectMetaEvent object.
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.