Exists.php

Same filename in other branches
  1. 11.x core/lib/Drupal/Core/Config/Action/Exists.php

Namespace

Drupal\Core\Config\Action

File

core/lib/Drupal/Core/Config/Action/Exists.php

View source
<?php

// phpcs:ignoreFile
declare (strict_types=1);
namespace Drupal\Core\Config\Action;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * @internal
 *   This API is experimental.
 */
enum Exists
{
    case ErrorIfExists;
    case ErrorIfNotExists;
    case ReturnEarlyIfExists;
    case ReturnEarlyIfNotExists;
    
    /**
     * Determines if an action should return early depending on $entity.
     *
     * @param string $configName
     *   The config name supplied to the action.
     * @param \Drupal\Core\Config\Entity\ConfigEntityInterface|null $entity
     *   The entity, if it exists.
     *
     * @return bool
     *   TRUE if the action should return early, FALSE if not.
     *
     * @throws \Drupal\Core\Config\Action\ConfigActionException
     *   Thrown depending on $entity and the value of $this.
     */
    public function returnEarly(string $configName, ?ConfigEntityInterface $entity) : bool {
        return match (TRUE) {    $this === self::ReturnEarlyIfExists && $entity !== NULL, $this === self::ReturnEarlyIfNotExists && $entity === NULL => TRUE,
            $this === self::ErrorIfExists && $entity !== NULL => throw new ConfigActionException(sprintf('Entity %s exists', $configName)),
            $this === self::ErrorIfNotExists && $entity === NULL => throw new ConfigActionException(sprintf('Entity %s does not exist', $configName)),
            default => FALSE,
        
        };
    }
}

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