public static function SavedSearch::bundleFieldDefinitions in Search API Saved Searches 8

Provides field definitions for a specific bundle.

This function can return definitions both for bundle fields (fields that are not defined in $base_field_definitions, and therefore might not exist on some bundles) as well as bundle-specific overrides of base fields (fields that are defined in $base_field_definitions, and therefore exist for all bundles). However, bundle-specific base field overrides can also be provided by 'base_field_override' configuration entities, and that is the recommended approach except in cases where an entity type needs to provide a bundle-specific base field override that is decoupled from configuration. Note that for most entity types, the bundles themselves are derived from configuration (e.g., 'node' bundles are managed via 'node_type' configuration entities), so decoupling bundle-specific base field overrides from configuration only makes sense for entity types that also decouple their bundles from configuration. In cases where both this function returns a bundle-specific override of a base field and a 'base_field_override' configuration entity exists, the latter takes precedence.

@todo WARNING: This method will be changed in https://www.drupal.org/node/2346347.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

string $bundle: The bundle.

\Drupal\Core\Field\FieldDefinitionInterface[] $base_field_definitions: The list of base field definitions.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of bundle field definitions, keyed by field name.

Overrides ContentEntityBase::bundleFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()

1 call to SavedSearch::bundleFieldDefinitions()

search_api_saved_searches_entity_field_storage_info in ./search_api_saved_searches.module

Implements hook_entity_field_storage_info().

File

src/Entity/SavedSearch.php, line 235

Class

SavedSearch

Provides an entity type for saved searches.

Namespace

Drupal\search_api_saved_searches\Entity

Code

public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
  $fields = parent::bundleFieldDefinitions($entity_type, $bundle, $base_field_definitions);

  /** @var \Drupal\search_api_saved_searches\SavedSearchTypeInterface $type */
  $type = \Drupal::entityTypeManager()
    ->getStorage('search_api_saved_search_type')
    ->load($bundle);

  // If we are called with an illegal $bundle, avoid a fatal error.
  if ($type) {
    $fields += $type
      ->getNotificationPluginFieldDefinitions();
  }
  return $fields;
}