JsonApiFilter::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()

File

core/modules/jsonapi/src/JsonApiFilter.php, line 53

Class

JsonApiFilter
JsonApi filter options.

Namespace

Drupal\jsonapi

Code

const AMONG_ENABLED = 'filter_among_enabled';

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