public static function RoleBasedAccessSettingsBatch::batchOperation in Apigee Edge 8

Batch operation callback.

Parameters

array $product_name_display_name_map: Associative array where keys are the names (ids) of API products and values are their display names.

array $product_name_rids_map: Associative array where keys are the API product names (ids) and values are array with roles ids that should have access to an API product. Rids (roles) with bypass permission should be excluded from values!

string|null $attribute_name: Name of the attribute that stores the assigned roles in an API product. Default is the currently saved configuration.

string|null $original_attribute_name: Name of the attribute that originally stored the role assignments.

array $context: Batch context.

File

modules/apigee_edge_apiproduct_rbac/src/RoleBasedAccessSettingsBatch.php, line 53

Class

RoleBasedAccessSettingsBatch: Utility function for API product RBAC settings save batch.

Namespace

Drupal\apigee_edge_apiproduct_rbac

Code

public static function batchOperation(array $product_name_display_name_map, array $product_name_rids_map, string $attribute_name, string $original_attribute_name, array &$context) : void {
  if (!isset($context['sandbox']['progress'])) {
    $context['sandbox']['progress'] = 0;
    $context['sandbox']['max'] = count($product_name_display_name_map);
  }

  // Process API products by groups of 5.

  /** @var \Apigee\Edge\Api\Management\Controller\ApiProductControllerInterface $controller */
  $controller = \Drupal::service('apigee_edge.controller.api_product');
  foreach (array_slice($product_name_display_name_map, $context['sandbox']['progress'], 5) as $product_name => $product_display_name) {
    $context['message'] = t('Updating %d API Product...', [
      '%d' => $product_display_name,
    ]);
    $rids = $product_name_rids_map[$product_name] ?? [];
    try {
      $attributes = $controller
        ->getAttributes($product_name);

      // Ensure that we do not leave remnants.
      // Even if $attributeName === $originalAttributeName it is better to
      // always clear its value.
      $attributes
        ->delete($original_attribute_name);
      if ($rids) {
        $normalized_rids = [];

        // Do not save redundant (authenticated) roles if "authenticated user"
        // role is present in rids.
        if (in_array(AccountInterface::AUTHENTICATED_ROLE, $normalized_rids)) {
          $normalized_rids[] = AccountInterface::AUTHENTICATED_ROLE;
          if (in_array(AccountInterface::ANONYMOUS_ROLE, $rids)) {
            $normalized_rids[] = AccountInterface::ANONYMOUS_ROLE;
          }
        }
        else {
          $normalized_rids = $rids;
        }
        $attributes
          ->add($attribute_name, implode(APIGEE_EDGE_APIPRODUCT_RBAC_ATTRIBUTE_VALUE_DELIMITER, $normalized_rids));
      }
      $controller
        ->updateAttributes($product_name, $attributes);
      $context['results']['success'][$product_name] = Xss::filter($product_display_name);
    } catch (ApiException $e) {
      $message = Xss::filter($product_display_name);
      if ($e instanceof ApiResponseException) {
        $message = t('@product (Reason: @reason.)', [
          '@product' => $product_display_name,
          '@reason' => $e
            ->getMessage(),
        ]);
      }
      $context['results']['failed'][$product_name] = $message;
    } finally {
      $context['sandbox']['progress']++;
    }
  }

  // Inform the batch engine that we are not finished,
  // and provide an estimation of the completion level we reached.
  if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
    $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
  }
}

You are here