graphql_core_schema-1.0.x-dev/src/CoreComposableConfig.php

<?php

namespace Drupal\graphql_core_schema;

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Render\Element\Checkboxes;

/**
 * Wrapper for the graphql_core_schema configuration.
 */
class CoreComposableConfig {

  /**
   * Constructs a new CoreComposableConfig object.
   *
   * @param string[] $enabledEntityTypes
   *   Array of enabled entity types.
   * @param string[][] $enabledFields
   *   Array of enabled fields.
   * @param string[][] $enabledEntityFields
   *   Enabled fields for the Entity interface.
   * @param string[][] $enabledEntityBundles
   *   Enabled bundles.
   * @param bool $valueFields
   *   Whether to generate value fields.
   */
  public function __construct(
    protected array $enabledEntityTypes,
    protected array $enabledFields,
    protected array $enabledEntityFields,
    protected array $enabledEntityBundles,
    protected bool $valueFields,
  ) {}

  /**
   * Create the config object from the configuration array.
   *
   * @param array $configuration
   *   The configuration.
   *
   * @return static
   */
  public static function fromConfiguration(array $configuration): static {
    return new self(
      Checkboxes::getCheckedCheckboxes($configuration['enabled_entity_types'] ?? []),
      $configuration['fields'] ?? [],
      Checkboxes::getCheckedCheckboxes($configuration['entity_base_fields']['fields'] ?? []),
      $configuration['bundles'] ?? [],
      !empty($configuration['generate_value_fields'])
    );
  }

  /**
   * Get enabled Entity interface fields.
   *
   * @return string[]
   *   The fields that are enabled.
   */
  public function getEnabledEntityFields(): array {
    return array_merge($this->enabledEntityFields, ['id']);
  }

  /**
   * Get enabled bundles.
   *
   * @return string[]
   *   The bundles that are enabled.
   */
  public function getEnabledEntityBundles(): array {
    return $this->enabledEntityBundles;
  }

  /**
   * Check if the given entity type is enabled.
   *
   * @param string $entityTypeId
   *   The ID of the entity type.
   *
   * @return bool
   *   TRUE if the entity type is enabled.
   */
  public function isEntityTypeEnabled(string $entityTypeId): bool {
    return in_array($entityTypeId, $this->enabledEntityTypes);
  }

  /**
   * Check if the given bundle of an entity type is enabled.
   *
   * @param string $entityTypeId
   *   The ID of the entity type.
   * @param string $bundle
   *   The name of the bundle.
   *
   * @return bool
   *   TRUE if the bundle is enabled.
   */
  public function isBundleEnabled(string $entityTypeId, string $bundle): bool {
    return $this->enabledEntityBundles[$entityTypeId][$bundle]['enabled'] ?? FALSE;
  }

  /**
   * Returns the GraphQL type name for the given entity type and bundle.
   *
   * The GraphQL type name can be configured by the site builder in the server
   * form. When omitted, we fall back to the entity type name and bundle. For
   * example, the node type "article" would be named "NodeArticle".
   *
   * If a bundle is not exposed, a dummy bundle type name will be returned, for
   * example "NodeUnexposed".
   *
   * @param string $entityTypeId
   *   The entity type ID.
   * @param string $bundle
   *   The bundle name.
   *
   * @return string
   *   The GraphQL type name.
   */
  public function getBundleTypeName(string $entityTypeId, string $bundle): string {
    $bundle = $this->isBundleEnabled($entityTypeId, $bundle) ? $bundle : EntitySchemaBuilder::UNEXPOSED_BUNDLE_NAME;
    return $this->enabledEntityBundles[$entityTypeId][$bundle]['type_name'] ?? EntitySchemaHelper::toPascalCase([$entityTypeId, $bundle]);
  }

  /**
   * Returns the GraphQL type name for the given entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity.
   *
   * @return string
   *   The GraphQL type name.
   */
  public function getTypeNameForEntity(EntityInterface $entity): string {
    $type = $entity->getEntityType();
    $hasBundles = $type->hasKey('bundle');
    if ($hasBundles) {
      return $this->getBundleTypeName($type->id(), $entity->bundle());
    }
    return EntitySchemaHelper::toPascalCase([$type->id()]);
  }

  /**
   * Whether to generate value fields.
   *
   * @return bool
   *   TRUE if value fields should be generated.
   */
  public function shouldGeneratedValueFields(): bool {
    return $this->valueFields;
  }

  /**
   * Get the enabled entity types.
   *
   * @return string[]
   *   The enabled entity types.
   */
  public function getEnabledEntityTypes(): array {
    return $this->enabledEntityTypes;
  }

  /**
   * Check if the given field is enabled.
   *
   * @param string $entityTypeId
   *   The entity type ID.
   * @param string $fieldName
   *   The field name.
   *
   * @return bool
   *   TRUE if the field is enabled for this entity type.
   */
  public function fieldIsEnabled(string $entityTypeId, string $fieldName) {
    if (empty($this->enabledFields[$entityTypeId])) {
      return FALSE;
    }
    return in_array($fieldName, $this->enabledFields[$entityTypeId]);
  }

}