Same name and namespace in other branches
  1. 8.9.x core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_ENABLED
  2. 9 core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_ENABLED

Array key for denoting type-based enabled-only filtering access.

Array key for denoting access to filter among all enabled entities of a given type, regardless of their owner.

This is used when an entity type has a "status" entity key and there's a query condition for the value of that equaling 1.

For the User entity type, which does not have a "status" entity key, the "status" field is used.

See also

hook_jsonapi_entity_filter_access()

hook_jsonapi_ENTITY_TYPE_filter_access()

4 uses of JSONAPI_FILTER_AMONG_ENABLED
jsonapi_jsonapi_node_filter_access in core/modules/jsonapi/jsonapi.module
Implements hook_jsonapi_ENTITY_TYPE_filter_access() for 'node'.
jsonapi_jsonapi_user_filter_access in core/modules/jsonapi/jsonapi.module
Implements hook_jsonapi_ENTITY_TYPE_filter_access() for 'user'.
TemporaryQueryGuard::getAccessConditionForKnownSubsets in core/modules/jsonapi/src/Access/TemporaryQueryGuard.php
Gets an access condition for the allowed JSONAPI_FILTER_AMONG_* subsets.
TemporaryQueryGuard::getAccessResultsFromEntityFilterHook in core/modules/jsonapi/src/Access/TemporaryQueryGuard.php
Gets the combined access result for each JSONAPI_FILTER_AMONG_* subset.

File

core/modules/jsonapi/jsonapi.module, line 56
Module implementation file.

Code

const JSONAPI_FILTER_AMONG_ENABLED = 'filter_among_enabled';