class SocialApiImplementerInstaller in Social API 8.2

Provides utilities for implementer installation.

Hierarchy

• class \Drupal\social_api\Utility\SocialApiImplementerInstaller

File

src/Utility/SocialApiImplementerInstaller.php, line 8

Namespace

Drupal\social_api\Utility

class SocialApiImplementerInstaller {

  /**
   * Checks the library required by an implementer.
   *
   * @param string $machine_name
   *   The module machine name.
   * @param string $name
   *   The module name.
   * @param string $library
   *   The library machine name.
   * @param float $min_version
   *   The min version required.
   * @param float $max_version
   *   The max version required.
   *
   * @return array
   *   Requirements messages.
   */
  public static function checkLibrary($machine_name, $name, $library, $min_version, $max_version) {
    $sdk_found = FALSE;
    $requirements = [];
    $json = self::readPackages();
    if ($json) {

      // Loops through installed packages and check that the SDK version is OK.
      foreach ($json as $package) {
        if ($package['name'] == $library) {
          $sdk_found = TRUE;
          if ($package['version_normalized'] < $min_version || $package['version_normalized'] > $max_version) {
            $requirements[$machine_name] = [
              'description' => t("@name could not be installed because an incompatible version of @library was detected. Please read the installation instructions.", [
                '@name' => $name,
                '@library' => $library,
              ]),
              'severity' => REQUIREMENT_ERROR,
            ];
          }
          break;
        }
      }

      // SDK was not found in installed.json.
      if (!$sdk_found) {
        $requirements[$machine_name] = [
          'description' => t("@name could not be installed because @library was not found. @name must be installed using Composer. Please read the installation instructions.", [
            '@name' => $name,
            '@library' => $library,
          ]),
          'severity' => REQUIREMENT_ERROR,
        ];
      }
    }
    else {
      $requirements[$machine_name] = [
        'description' => t('@name could not be installed: installed.json could not be read.', [
          '@name' => $name,
        ]),
        'severity' => REQUIREMENT_ERROR,
      ];
    }
    return $requirements;
  }

  /**
   * Reads and parses Drupal installed.json.
   *
   * @return array|bool
   *   Parsed installed.json if the file could be read and parsed.
   *   False otherwise.
   */
  protected static function readPackages() {

    // Make this test compatible with either regular installs.
    // Check whether DRUPAL_ROOT is the actual website filesystem root or /web/
    // subdirectory in case of composer drupal-scaffold.
    $base_dir = is_dir(DRUPAL_ROOT . '/vendor') ? DRUPAL_ROOT : dirname(DRUPAL_ROOT);
    $file_uri = $base_dir . '/vendor/composer/installed.json';
    if (file_exists($file_uri)) {
      $filedata = file_get_contents($file_uri);
      if ($filedata) {
        $json = json_decode($filedata, TRUE);
        if ($json !== NULL) {
          return $json;
        }
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SocialApiImplementerInstaller::checkLibrary	public static	function	Checks the library required by an implementer.
SocialApiImplementerInstaller::readPackages	protected static	function	Reads and parses Drupal installed.json.