Search for source

  1. Search 7.x for source
  2. Search 9.5.x for source
  3. Search 8.9.x for source
  4. Search 11.x for source
  5. Other projects
Title Object type File name Summary
ResourceTestBase::setUpFields function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Sets up additional fields for testing.
ResourceTestBase::setUpRevisionAuthorization function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Sets up the necessary authorization for handling revisions.
ResourceTestBase::testCollection function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Tests GETting a collection of resources.
ResourceTestBase::testGetIndividual function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Tests GETting an individual resource, plus edge cases to ensure good DX.
ResourceTestBase::testIndividual function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Tests POST/PATCH/DELETE for an individual resource.
ResourceTestBase::testRelated function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Tests GET of the related resource of an individual resource.
ResourceTestBase::testRelationships function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Tests CRUD of individual resource relationship data.
ResourceTestBase::testRevisions function core/modules/jsonapi/tests/src/Functional/ResourceTestBase.php Tests individual and collection revisions.
ResourceType class core/modules/jsonapi/src/ResourceType/ResourceType.php Value object containing all metadata for a JSON:API resource type.
ResourceType.php file core/modules/jsonapi/src/ResourceType/ResourceType.php
ResourceType::$bundle property core/modules/jsonapi/src/ResourceType/ResourceType.php The bundle ID.
ResourceType::$deserializationTargetClass property core/modules/jsonapi/src/ResourceType/ResourceType.php The class to which a payload converts to.
ResourceType::$entityTypeId property core/modules/jsonapi/src/ResourceType/ResourceType.php The entity type ID.
ResourceType::$fieldMapping property core/modules/jsonapi/src/ResourceType/ResourceType.php The mapping for field aliases: keys=public names, values=internal names.
ResourceType::$fields property core/modules/jsonapi/src/ResourceType/ResourceType.php The list of fields on the underlying entity type + bundle.
ResourceType::$internal property core/modules/jsonapi/src/ResourceType/ResourceType.php Whether this resource type is internal.
ResourceType::$isLocatable property core/modules/jsonapi/src/ResourceType/ResourceType.php Whether this resource type's resources are locatable.
ResourceType::$isMutable property core/modules/jsonapi/src/ResourceType/ResourceType.php Whether this resource type's resources are mutable.
ResourceType::$isVersionable property core/modules/jsonapi/src/ResourceType/ResourceType.php Whether this resource type's resources are versionable.
ResourceType::$relatableResourceTypesByField property core/modules/jsonapi/src/ResourceType/ResourceType.php An array of arrays of relatable resource types, keyed by public field name.
ResourceType::$typeName property core/modules/jsonapi/src/ResourceType/ResourceType.php The type name.
ResourceType::getBundle function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets the bundle.
ResourceType::getDeserializationTargetClass function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets the deserialization target class.
ResourceType::getEntityTypeId function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets the entity type ID.
ResourceType::getFieldByInternalName function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets a particular attribute or relationship field by internal field name.
ResourceType::getFieldByPublicName function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets a particular attribute or relationship field by public field name.
ResourceType::getFields function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets the attribute and relationship fields of this resource type.
ResourceType::getInternalName function core/modules/jsonapi/src/ResourceType/ResourceType.php Translates the public field name to the entity field name.
ResourceType::getPath function core/modules/jsonapi/src/ResourceType/ResourceType.php Get the resource path.
ResourceType::getPublicName function core/modules/jsonapi/src/ResourceType/ResourceType.php Translates the entity field name to the public field name.
ResourceType::getRelatableResourceTypes function core/modules/jsonapi/src/ResourceType/ResourceType.php Get all resource types with which this type may have a relationship.
ResourceType::getRelatableResourceTypesByField function core/modules/jsonapi/src/ResourceType/ResourceType.php Get all resource types with which the given field may have a relationship.
ResourceType::getTypeName function core/modules/jsonapi/src/ResourceType/ResourceType.php Gets the type name.
ResourceType::hasField function core/modules/jsonapi/src/ResourceType/ResourceType.php Checks if the field exists.
ResourceType::includeCount function core/modules/jsonapi/src/ResourceType/ResourceType.php Determine whether to include a collection count.
ResourceType::isFieldEnabled function core/modules/jsonapi/src/ResourceType/ResourceType.php Checks if a field is enabled or not.
ResourceType::isInternal function core/modules/jsonapi/src/ResourceType/ResourceType.php Whether this resource type is internal.
ResourceType::isLocatable function core/modules/jsonapi/src/ResourceType/ResourceType.php Whether resources of this resource type are locatable.
ResourceType::isMutable function core/modules/jsonapi/src/ResourceType/ResourceType.php Whether resources of this resource type are mutable.
ResourceType::isVersionable function core/modules/jsonapi/src/ResourceType/ResourceType.php Whether resources of this resource type are versionable.
ResourceType::setRelatableResourceTypes function core/modules/jsonapi/src/ResourceType/ResourceType.php Sets the relatable resource types.
ResourceType::TYPE_NAME_URI_PATH_SEPARATOR constant core/modules/jsonapi/src/ResourceType/ResourceType.php A string which is used as path separator in resource type names.
ResourceType::__construct function core/modules/jsonapi/src/ResourceType/ResourceType.php Instantiates a ResourceType object.
ResourceTypeAttribute class core/modules/jsonapi/src/ResourceType/ResourceTypeAttribute.php Specialization of a ResourceTypeField to represent a resource type attribute.
ResourceTypeAttribute.php file core/modules/jsonapi/src/ResourceType/ResourceTypeAttribute.php
ResourceTypeBuildEvent class core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php An event used to configure the construction of a JSON:API resource type.
ResourceTypeBuildEvent.php file core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php
ResourceTypeBuildEvent::$disabled property core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php Whether the JSON:API resource type to be built should be disabled.
ResourceTypeBuildEvent::$fields property core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php The fields of the resource type to be built.
ResourceTypeBuildEvent::$resourceTypeName property core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php The JSON:API resource type name of the instance to be built.

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