apigee_m10n-8.x-1.7/src/Plugin/Requirement/Requirement/ApigeeEdgeConnection.php

<?php

/*
 * Copyright 2019 Google Inc.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 2 as published by the
 * Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

namespace Drupal\apigee_m10n\Plugin\Requirement\Requirement;

use Drupal\Core\Utility\Error;
use Drupal\apigee_m10n\ApigeeEdgeSdkConnectorTrait;
use Drupal\requirement\Plugin\RequirementBase;

/**
 * Check that the Apigee Edge connection is working.
 *
 * @Requirement(
 *   id="apigee_edge_connection",
 *   group="apigee_edge",
 *   label="Apigee Edge connection",
 *   description="A working connection to Apigee Edge is required.",
 *   form="\Drupal\apigee_edge\Form\AuthenticationForm",
 *   action_button_label="Configure credentials",
 *   severity="error",
 *   weight=-100
 * )
 */
class ApigeeEdgeConnection extends RequirementBase {

  use ApigeeEdgeSdkConnectorTrait;

  /**
   * {@inheritdoc}
   */
  public function isApplicable(): bool {
    // This is always applicable. A connection to Apigee Edge is required.
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function isCompleted(): bool {
    $logger = \Drupal::logger('apigee_m10n');
    try {
      $this->getApigeeEdgeSdkConnector()->testConnection();
      return TRUE;
    }
    catch (\Exception $exception) {
      Error::logException($logger, $exception);
    }

    return FALSE;
  }

}