class FeedsExJsonUtility in Feeds extensible parsers 7

Various helpers for handling JSON.

Hierarchy

• class \FeedsExJsonUtility

1 string reference to 'FeedsExJsonUtility'

feeds_ex_feeds_plugins in ./feeds_ex.feeds.inc

Implements hook_feeds_plugins().

File

src/Json/Utility.php, line 11

Contains FeedsExJsonUtility.

class FeedsExJsonUtility {

  /**
   * Translates an error message.
   *
   * @param int $error
   *   The JSON error.
   *
   * @return string
   *   The JSON parsing error message.
   */
  public static function translateError($error) {

    // This shouldn't get called for PHP < 5.3.0.
    if (version_compare(PHP_VERSION, '5.3.0', '<')) {
      return 'Unknown error';
    }
    if (version_compare(PHP_VERSION, '5.3.3', '>=')) {
      switch ($error) {
        case JSON_ERROR_UTF8:
          return 'Malformed UTF-8 characters, possibly incorrectly encoded';
      }
    }
    if (version_compare(PHP_VERSION, '5.5.0', '>=')) {
      switch ($error) {
        case JSON_ERROR_RECURSION:
          return 'One or more recursive references in the value to be encoded';
        case JSON_ERROR_INF_OR_NAN:
          return 'One or more NAN or INF values in the value to be encoded';
        case JSON_ERROR_UNSUPPORTED_TYPE:
          return 'A value of a type that cannot be encoded was given';
      }
    }
    switch ($error) {
      case JSON_ERROR_NONE:
        return 'No error has occurred';
      case JSON_ERROR_DEPTH:
        return 'The maximum stack depth has been exceeded';
      case JSON_ERROR_STATE_MISMATCH:
        return 'Invalid or malformed JSON';
      case JSON_ERROR_CTRL_CHAR:
        return 'Control character error, possibly incorrectly encoded';
      case JSON_ERROR_SYNTAX:
        return 'Syntax error';
      default:
        return 'Unknown error';
    }
  }

  /**
   * Decodes a JSON string into an array.
   *
   * @param string $json
   *   A JSON string.
   *
   * @return array
   *   A PHP array.
   *
   * @throws RuntimeException
   *   Thrown if the encoded JSON does not result in an array.
   */
  public static function decodeJsonArray($json) {
    $parsed = drupal_json_decode($json);
    if (!is_array($parsed)) {
      throw new RuntimeException(t('The JSON is invalid.'));
    }
    return $parsed;
  }

  /**
   * Decodes a JSON string into an object or array.
   *
   * @param string $json
   *   A JSON string.
   *
   * @return object|array
   *   A PHP object or array.
   *
   * @throws RuntimeException
   *   Thrown if the encoded JSON does not result in an array or object.
   */
  public static function decodeJsonObject($json) {
    $parsed = json_decode($json);
    if (!is_array($parsed) && !is_object($parsed)) {
      throw new RuntimeException(t('The JSON is invalid.'));
    }
    return $parsed;
  }

  /**
   * Returns the path of the JSONPath library.
   *
   * @return string|false|array
   *   The root-relative path to the JSONPath include(s), or false on failure.
   */
  public static function jsonPathLibraryPath() {
    $libraries_path = module_exists('libraries') ? libraries_get_path('jsonpath') : FALSE;
    if ($libraries_path && is_dir($libraries_path)) {
      $path = $libraries_path;
    }
    elseif (is_dir(DRUPAL_ROOT . '/sites/all/libraries/jsonpath')) {
      $path = 'sites/all/libraries/jsonpath';
    }
    if (!isset($path)) {
      if (is_file(DRUPAL_ROOT . '/vendor/autoload.php')) {

        // This can exist when running tests on drupal.org.
        return 'vendor/autoload.php';
      }
      return FALSE;
    }

    // Check if there is an autoload file. There is one when the library is
    // installed with Composer in /sites/all/libraries/jsonpath.
    if (is_file($path . '/vendor/autoload.php')) {
      return $path . '/vendor/autoload.php';
    }
    return FALSE;
  }

  /**
   * Determines if a JSONPath parser is installed.
   *
   * @return bool
   *   True if a parser is installed, false if not.
   */
  public static function jsonPathParserInstalled() {

    // Check first if the class is already loaded.
    if (class_exists('\\Flow\\JSONPath\\JSONPath', TRUE)) {

      // We're good!
      return TRUE;
    }

    // Try loading the library using libraries module.
    if (static::loadJsonPathUsingLibraries()) {
      return TRUE;
    }

    // Try loading the library by checking common paths.
    if (static::loadJsonPathUsingPath()) {
      return TRUE;
    }

    // In all other cases, loading the library failed.
    return FALSE;
  }

  /**
   * Tries to load the jsonpath library using the libraries module.
   *
   * @return bool
   *   True if loading succeed. False otherwise.
   */
  protected static function loadJsonPathUsingLibraries() {

    // If not, then we should have libraries installed.
    if (!module_exists('libraries')) {
      return FALSE;
    }
    $library = libraries_load('jsonpath');
    if ($library['loaded'] === FALSE) {
      return FALSE;
    }
    if (!class_exists('\\Flow\\JSONPath\\JSONPath', TRUE)) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Tries to load the jsonpath library by looking for a path.
   *
   * @return bool
   *   True if loading succeed. False otherwise.
   */
  protected static function loadJsonPathUsingPath() {

    // Try loading the library by looking for it manually.
    $path = static::jsonPathLibraryPath();
    if (!$path) {
      return FALSE;
    }
    if (is_array($path)) {
      foreach ($path as $subpath) {
        require_once DRUPAL_ROOT . '/' . $subpath;
      }
    }
    else {
      require_once DRUPAL_ROOT . '/' . $path;
    }
    if (!class_exists('\\Flow\\JSONPath\\JSONPath', TRUE)) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Determines if a JMESPath parser is installed.
   *
   * @return bool
   *   True if a parser is installed, false if not.
   */
  public static function jmesPathParserInstalled() {
    if (class_exists('JmesPath\\AstRuntime') || class_exists('JmesPath\\Runtime\\AstRuntime')) {
      return TRUE;
    }
    $path = feeds_ex_library_path('jmespath.php', 'vendor/autoload.php');
    if (!$path && is_file(DRUPAL_ROOT . '/vendor/autoload.php')) {

      // This can exist when running tests on drupal.org.
      $path = 'vendor/autoload.php';
    }
    if (!$path) {
      return FALSE;
    }
    require_once DRUPAL_ROOT . '/' . $path;
    return class_exists('JmesPath\\AstRuntime') || class_exists('JmesPath\\Runtime\\AstRuntime');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsExJsonUtility::decodeJsonArray	public static	function	Decodes a JSON string into an array.
FeedsExJsonUtility::decodeJsonObject	public static	function	Decodes a JSON string into an object or array.
FeedsExJsonUtility::jmesPathParserInstalled	public static	function	Determines if a JMESPath parser is installed.
FeedsExJsonUtility::jsonPathLibraryPath	public static	function	Returns the path of the JSONPath library.
FeedsExJsonUtility::jsonPathParserInstalled	public static	function	Determines if a JSONPath parser is installed.
FeedsExJsonUtility::loadJsonPathUsingLibraries	protected static	function	Tries to load the jsonpath library using the libraries module.
FeedsExJsonUtility::loadJsonPathUsingPath	protected static	function	Tries to load the jsonpath library by looking for a path.
FeedsExJsonUtility::translateError	public static	function	Translates an error message.