You are here

Home » API reference » Flickr API 5 » URL.php

class Net_URL in Flickr API 5

Hierarchy

Expanded class hierarchy of Net_URL

1 string reference to 'Net_URL'
HTTP_Request::sendRequest in phpFlickr/PEAR/HTTP/Request.php
Sends the request

File

phpFlickr/PEAR/Net/URL.php, line 38

View source 
class Net_URL {

  /**
   * Full url
   * @var string
   */
  var $url;

  /**
   * Protocol
   * @var string
   */
  var $protocol;

  /**
   * Username
   * @var string
   */
  var $username;

  /**
   * Password
   * @var string
   */
  var $password;

  /**
   * Host
   * @var string
   */
  var $host;

  /**
   * Port
   * @var integer
   */
  var $port;

  /**
   * Path
   * @var string
   */
  var $path;

  /**
   * Query string
   * @var array
   */
  var $querystring;

  /**
   * Anchor
   * @var string
   */
  var $anchor;

  /**
   * Whether to use []
   * @var bool
   */
  var $useBrackets;

  /**
   * PHP4 Constructor
   *
   * @see __construct()
   */
  function Net_URL($url = null, $useBrackets = true) {
    $this
      ->__construct($url, $useBrackets);
  }

  /**
   * PHP5 Constructor
   *
   * Parses the given url and stores the various parts
   * Defaults are used in certain cases
   *
   * @param string $url         Optional URL
   * @param bool   $useBrackets Whether to use square brackets when
   *                            multiple querystrings with the same name
   *                            exist
   */
  function __construct($url = null, $useBrackets = true) {
    $HTTP_SERVER_VARS = !empty($_SERVER) ? $_SERVER : $GLOBALS['HTTP_SERVER_VARS'];
    $this->useBrackets = $useBrackets;
    $this->url = $url;
    $this->user = '';
    $this->pass = '';
    $this->host = '';
    $this->port = 80;
    $this->path = '';
    $this->querystring = array();
    $this->anchor = '';

    // Only use defaults if not an absolute URL given
    if (!preg_match('/^[a-z0-9]+:\\/\\//i', $url)) {
      $this->protocol = @$HTTP_SERVER_VARS['HTTPS'] == 'on' ? 'https' : 'http';

      /**
       * Figure out host/port
       */
      if (!empty($HTTP_SERVER_VARS['HTTP_HOST']) and preg_match('/^(.*)(:([0-9]+))?$/U', $HTTP_SERVER_VARS['HTTP_HOST'], $matches)) {
        $host = $matches[1];
        if (!empty($matches[3])) {
          $port = $matches[3];
        }
        else {
          $port = $this
            ->getStandardPort($this->protocol);
        }
      }
      $this->user = '';
      $this->pass = '';
      $this->host = !empty($host) ? $host : (isset($HTTP_SERVER_VARS['SERVER_NAME']) ? $HTTP_SERVER_VARS['SERVER_NAME'] : 'localhost');
      $this->port = !empty($port) ? $port : (isset($HTTP_SERVER_VARS['SERVER_PORT']) ? $HTTP_SERVER_VARS['SERVER_PORT'] : $this
        ->getStandardPort($this->protocol));
      $this->path = !empty($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : '/';
      $this->querystring = isset($HTTP_SERVER_VARS['QUERY_STRING']) ? $this
        ->_parseRawQuerystring($HTTP_SERVER_VARS['QUERY_STRING']) : null;
      $this->anchor = '';
    }

    // Parse the url and store the various parts
    if (!empty($url)) {
      $urlinfo = parse_url($url);

      // Default querystring
      $this->querystring = array();
      foreach ($urlinfo as $key => $value) {
        switch ($key) {
          case 'scheme':
            $this->protocol = $value;
            $this->port = $this
              ->getStandardPort($value);
            break;
          case 'user':
          case 'pass':
          case 'host':
          case 'port':
            $this->{$key} = $value;
            break;
          case 'path':
            if ($value[0] == '/') {
              $this->path = $value;
            }
            else {
              $path = dirname($this->path) == DIRECTORY_SEPARATOR ? '' : dirname($this->path);
              $this->path = sprintf('%s/%s', $path, $value);
            }
            break;
          case 'query':
            $this->querystring = $this
              ->_parseRawQueryString($value);
            break;
          case 'fragment':
            $this->anchor = $value;
            break;
        }
      }
    }
  }

  /**
   * Returns full url
   *
   * @return string Full url
   * @access public
   */
  function getURL() {
    $querystring = $this
      ->getQueryString();
    $this->url = $this->protocol . '://' . $this->user . (!empty($this->pass) ? ':' : '') . $this->pass . (!empty($this->user) ? '@' : '') . $this->host . ($this->port == $this
      ->getStandardPort($this->protocol) ? '' : ':' . $this->port) . $this->path . (!empty($querystring) ? '?' . $querystring : '') . (!empty($this->anchor) ? '#' . $this->anchor : '');
    return $this->url;
  }

  /**
   * Adds a querystring item
   *
   * @param  string $name       Name of item
   * @param  string $value      Value of item
   * @param  bool   $preencoded Whether value is urlencoded or not, default = not
   * @access public
   */
  function addQueryString($name, $value, $preencoded = false) {
    if ($preencoded) {
      $this->querystring[$name] = $value;
    }
    else {
      $this->querystring[$name] = is_array($value) ? array_map('rawurlencode', $value) : rawurlencode($value);
    }
  }

  /**
   * Removes a querystring item
   *
   * @param  string $name Name of item
   * @access public
   */
  function removeQueryString($name) {
    if (isset($this->querystring[$name])) {
      unset($this->querystring[$name]);
    }
  }

  /**
   * Sets the querystring to literally what you supply
   *
   * @param  string $querystring The querystring data. Should be of the format foo=bar&x=y etc
   * @access public
   */
  function addRawQueryString($querystring) {
    $this->querystring = $this
      ->_parseRawQueryString($querystring);
  }

  /**
   * Returns flat querystring
   *
   * @return string Querystring
   * @access public
   */
  function getQueryString() {
    if (!empty($this->querystring)) {
      foreach ($this->querystring as $name => $value) {
        if (is_array($value)) {
          foreach ($value as $k => $v) {
            $querystring[] = $this->useBrackets ? sprintf('%s[%s]=%s', $name, $k, $v) : $name . '=' . $v;
          }
        }
        elseif (!is_null($value)) {
          $querystring[] = $name . '=' . $value;
        }
        else {
          $querystring[] = $name;
        }
      }
      $querystring = implode(ini_get('arg_separator.output'), $querystring);
    }
    else {
      $querystring = '';
    }
    return $querystring;
  }

  /**
   * Parses raw querystring and returns an array of it
   *
   * @param  string  $querystring The querystring to parse
   * @return array                An array of the querystring data
   * @access private
   */
  function _parseRawQuerystring($querystring) {
    $parts = preg_split('/[' . preg_quote(ini_get('arg_separator.input'), '/') . ']/', $querystring, -1, PREG_SPLIT_NO_EMPTY);
    $return = array();
    foreach ($parts as $part) {
      if (strpos($part, '=') !== false) {
        $value = substr($part, strpos($part, '=') + 1);
        $key = substr($part, 0, strpos($part, '='));
      }
      else {
        $value = null;
        $key = $part;
      }
      if (substr($key, -2) == '[]') {
        $key = substr($key, 0, -2);
        if (@(!is_array($return[$key]))) {
          $return[$key] = array();
          $return[$key][] = $value;
        }
        else {
          $return[$key][] = $value;
        }
      }
      elseif (!$this->useBrackets and !empty($return[$key])) {
        $return[$key] = (array) $return[$key];
        $return[$key][] = $value;
      }
      else {
        $return[$key] = $value;
      }
    }
    return $return;
  }

  /**
   * Resolves //, ../ and ./ from a path and returns
   * the result. Eg:
   *
   * /foo/bar/../boo.php    => /foo/boo.php
   * /foo/bar/../../boo.php => /boo.php
   * /foo/bar/.././/boo.php => /foo/boo.php
   *
   * This method can also be called statically.
   *
   * @param  string $url URL path to resolve
   * @return string      The result
   */
  function resolvePath($path) {
    $path = explode('/', str_replace('//', '/', $path));
    for ($i = 0; $i < count($path); $i++) {
      if ($path[$i] == '.') {
        unset($path[$i]);
        $path = array_values($path);
        $i--;
      }
      elseif ($path[$i] == '..' and ($i > 1 or $i == 1 and $path[0] != '')) {
        unset($path[$i]);
        unset($path[$i - 1]);
        $path = array_values($path);
        $i -= 2;
      }
      elseif ($path[$i] == '..' and $i == 1 and $path[0] == '') {
        unset($path[$i]);
        $path = array_values($path);
        $i--;
      }
      else {
        continue;
      }
    }
    return implode('/', $path);
  }

  /**
   * Returns the standard port number for a protocol
   *
   * @param  string  $scheme The protocol to lookup
   * @return integer         Port number or NULL if no scheme matches
   *
   * @author Philippe Jausions <Philippe.Jausions@11abacus.com>
   */
  function getStandardPort($scheme) {
    switch (strtolower($scheme)) {
      case 'http':
        return 80;
      case 'https':
        return 443;
      case 'ftp':
        return 21;
      case 'imap':
        return 143;
      case 'imaps':
        return 993;
      case 'pop3':
        return 110;
      case 'pop3s':
        return 995;
      default:
        return null;
    }
  }

  /**
   * Forces the URL to a particular protocol
   *
   * @param string  $protocol Protocol to force the URL to
   * @param integer $port     Optional port (standard port is used by default)
   */
  function setProtocol($protocol, $port = null) {
    $this->protocol = $protocol;
    $this->port = is_null($port) ? $this
      ->getStandardPort() : $port;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Net_URL::$anchor property Anchor
Net_URL::$host property Host
Net_URL::$password property Password
Net_URL::$path property Path
Net_URL::$port property Port
Net_URL::$protocol property Protocol
Net_URL::$querystring property Query string
Net_URL::$url property Full url
Net_URL::$useBrackets property Whether to use []
Net_URL::$username property Username
Net_URL::addQueryString function Adds a querystring item
Net_URL::addRawQueryString function Sets the querystring to literally what you supply
Net_URL::getQueryString function Returns flat querystring
Net_URL::getStandardPort function Returns the standard port number for a protocol
Net_URL::getURL function Returns full url
Net_URL::Net_URL function PHP4 Constructor
Net_URL::removeQueryString function Removes a querystring item
Net_URL::resolvePath function Resolves //, ../ and ./ from a path and returns the result. Eg:
Net_URL::setProtocol function Forces the URL to a particular protocol
Net_URL::_parseRawQuerystring function Parses raw querystring and returns an array of it
Net_URL::__construct function PHP5 Constructor