function ResourceType::includeCount

Same name and namespace in other branches
  1. 8.9.x core/modules/jsonapi/src/ResourceType/ResourceType.php \Drupal\jsonapi\ResourceType\ResourceType::includeCount()
  2. 10 core/modules/jsonapi/src/ResourceType/ResourceType.php \Drupal\jsonapi\ResourceType\ResourceType::includeCount()
  3. 11.x core/modules/jsonapi/src/ResourceType/ResourceType.php \Drupal\jsonapi\ResourceType\ResourceType::includeCount()

Determine whether to include a collection count.

Return value

bool Whether to include a collection count.

1 method overrides ResourceType::includeCount()
CountableResourceType::includeCount in core/modules/jsonapi/tests/modules/jsonapi_test_collection_count/src/ResourceType/CountableResourceType.php
Determine whether to include a collection count.

File

core/modules/jsonapi/src/ResourceType/ResourceType.php, line 264

Class

ResourceType
Value object containing all metadata for a JSON:API resource type.

Namespace

Drupal\jsonapi\ResourceType

Code

public function includeCount() {
    // By default, do not return counts in collection queries.
    return FALSE;
}

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