class HttpHelpers in Feeds 8.3

Various helpers for dealing with HTTP data.

@todo Move this some place else and split it up.

Hierarchy

• class \Drupal\feeds\Component\HttpHelpers uses XmlParserTrait

2 files declare their use of HttpHelpers

HttpHelpersTest.php in tests/src/Unit/Component/HttpHelpersTest.php

PubSubHubbub.php in src/EventSubscriber/PubSubHubbub.php

File

src/Component/HttpHelpers.php, line 10

Namespace

Drupal\feeds\Component

class HttpHelpers {
  use XmlParserTrait;

  /**
   * Finds a relation type in a header array.
   *
   * @param array $headers
   *   The header array.
   * @param string $relation
   *   The type of relation to find.
   *
   * @return string|false
   *   The link, or false.
   */
  public static function findLinkHeader(array $headers, $relation) {
    $headers = array_change_key_case($headers);
    if (!isset($headers['link'])) {
      return FALSE;
    }
    foreach ((array) $headers['link'] as $link) {
      if ($link = static::parseLinkRelation($link, $relation)) {
        return $link;
      }
    }
    return FALSE;
  }

  /**
   * Finds a hub link from a Link header.
   *
   * @param string $link_header
   *   The full link header string.
   * @param string $relation
   *   The relationship to find.
   *
   * @return string
   *   The link, or an empty string if one wasn't found.
   */
  public static function parseLinkRelation($link_header, $relation) {
    if (!preg_match_all('/<([^>]*)>\\s*;.*?rel\\s*=(.+?)(?:;|$)/is', trim($link_header), $matches)) {
      return '';
    }
    foreach ($matches[2] as $delta => $match) {
      $match = trim($match);

      // Strip quotes if present.
      $len = strlen($match);
      if ($match[0] === '"' && $match[$len - 1] === '"') {
        $match = substr($match, 1, $len - 2);
      }

      // Normalize whitespace.
      preg_replace('/\\s+/s', ' ', trim($match));
      if (in_array($relation, explode(' ', $match), TRUE)) {
        return $matches[1][$delta];
      }
    }
    return '';
  }

  /**
   * Finds a link relation in XML.
   *
   * @param string $xml
   *   The XML.
   * @param string $relation
   *   The relation to find.
   *
   * @return string|false
   *   The relation, or false.
   */
  public static function findRelationFromXml($xml, $relation) {

    // Check if $xml has length.
    if (!isset($xml[0])) {
      return FALSE;
    }
    $document = static::getDomDocument($xml);
    $xpath = new \DOMXPath($document);
    $list = $xpath
      ->query('//*[local-name() = "link" and @rel = "' . $relation . '"]/@href');
    if ($list->length === 0) {
      return FALSE;
    }
    return $list
      ->item(0)->value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HttpHelpers::findLinkHeader	public static	function	Finds a relation type in a header array.
HttpHelpers::findRelationFromXml	public static	function	Finds a link relation in XML.
HttpHelpers::parseLinkRelation	public static	function	Finds a hub link from a Link header.
XmlParserTrait::$_elementRegex	protected static	property	Matches the characters of an XML element.
XmlParserTrait::$_entityLoader	protected static	property	The previous value of the entity loader.
XmlParserTrait::$_errors	protected static	property	The errors reported during parsing.
XmlParserTrait::$_useError	protected static	property	The previous value of libxml error reporting.
XmlParserTrait::getDomDocument	protected static	function	Returns a new DOMDocument.
XmlParserTrait::getXmlErrors	protected static	function	Returns the errors reported during parsing.
XmlParserTrait::removeDefaultNamespaces	protected static	function	Strips the default namespaces from an XML string.
XmlParserTrait::startXmlErrorHandling	protected static	function	Starts custom error handling.
XmlParserTrait::stopXmlErrorHandling	protected static	function	Stops custom error handling.