phpjs/_octopress/source/functions/pathinfo/index.markdown

php.js offers community built php functions in javascript

---
layout: page
title: "JavaScript pathinfo function"
comments: true
sharing: true
footer: true
alias:
- /functions/view/pathinfo:486
- /functions/view/pathinfo
- /functions/view/486
- /functions/pathinfo:486
- /functions/486
---
<!-- Generated by Rakefile:build -->
A JavaScript equivalent of PHP's pathinfo

{% codeblock filesystem/pathinfo.js lang:js https://raw.github.com/kvz/phpjs/master/functions/filesystem/pathinfo.js raw on github %}
function pathinfo (path, options) {
  // From: http://phpjs.org/functions
  // +   original by: Nate
  // +    revised by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
  // +    improved by: Brett Zamir (http://brett-zamir.me)
  // +    input by: Timo
  // %        note 1: Inspired by actual PHP source: php5-5.2.6/ext/standard/string.c line #1559
  // %        note 1: The way the bitwise arguments are handled allows for greater flexibility
  // %        note 1: & compatability. We might even standardize this code and use a similar approach for
  // %        note 1: other bitwise PHP functions
  // %        note 2: php.js tries very hard to stay away from a core.js file with global dependencies, because we like
  // %        note 2: that you can just take a couple of functions and be on your way.
  // %        note 2: But by way we implemented this function, if you want you can still declare the PATHINFO_*
  // %        note 2: yourself, and then you can use: pathinfo('/www/index.html', PATHINFO_BASENAME | PATHINFO_EXTENSION);
  // %        note 2: which makes it fully compliant with PHP syntax.
  // -    depends on: dirname
  // -    depends on: basename
  // *          test: skip
  // *     example 1: pathinfo('/www/htdocs/index.html', 1);
  // *     returns 1: '/www/htdocs'
  // *     example 2: pathinfo('/www/htdocs/index.html', 'PATHINFO_BASENAME');
  // *     returns 2: 'index.html'
  // *     example 3: pathinfo('/www/htdocs/index.html', 'PATHINFO_EXTENSION');
  // *     returns 3: 'html'
  // *     example 4: pathinfo('/www/htdocs/index.html', 'PATHINFO_FILENAME');
  // *     returns 4: 'index'
  // *     example 5: pathinfo('/www/htdocs/index.html', 2 | 4);
  // *     returns 5: {basename: 'index.html', extension: 'html'}
  // *     example 6: pathinfo('/www/htdocs/index.html', 'PATHINFO_ALL');
  // *     returns 6: {dirname: '/www/htdocs', basename: 'index.html', extension: 'html', filename: 'index'}
  // *     example 7: pathinfo('/www/htdocs/index.html');
  // *     returns 7: {dirname: '/www/htdocs', basename: 'index.html', extension: 'html', filename: 'index'}
  // Working vars
  var opt = '',
    optName = '',
    optTemp = 0,
    tmp_arr = {},
    cnt = 0,
    i = 0;
  var have_basename = false,
    have_extension = false,
    have_filename = false;

  // Input defaulting & sanitation
  if (!path) {
    return false;
  }
  if (!options) {
    options = 'PATHINFO_ALL';
  }

  // Initialize binary arguments. Both the string & integer (constant) input is
  // allowed
  var OPTS = {
    'PATHINFO_DIRNAME': 1,
    'PATHINFO_BASENAME': 2,
    'PATHINFO_EXTENSION': 4,
    'PATHINFO_FILENAME': 8,
    'PATHINFO_ALL': 0
  };
  // PATHINFO_ALL sums up all previously defined PATHINFOs (could just pre-calculate)
  for (optName in OPTS) {
    OPTS.PATHINFO_ALL = OPTS.PATHINFO_ALL | OPTS[optName];
  }
  if (typeof options !== 'number') { // Allow for a single string or an array of string flags
    options = [].concat(options);
    for (i = 0; i < options.length; i++) {
      // Resolve string input to bitwise e.g. 'PATHINFO_EXTENSION' becomes 4
      if (OPTS[options[i]]) {
        optTemp = optTemp | OPTS[options[i]];
      }
    }
    options = optTemp;
  }

  // Internal Functions
  var __getExt = function (path) {
    var str = path + '';
    var dotP = str.lastIndexOf('.') + 1;
    return !dotP ? false : dotP !== str.length ? str.substr(dotP) : '';
  };


  // Gather path infos
  if (options & OPTS.PATHINFO_DIRNAME) {
    var dirname = this.dirname(path);
    tmp_arr.dirname = dirname === path ? '.' : dirname;
  }

  if (options & OPTS.PATHINFO_BASENAME) {
    if (false === have_basename) {
      have_basename = this.basename(path);
    }
    tmp_arr.basename = have_basename;
  }

  if (options & OPTS.PATHINFO_EXTENSION) {
    if (false === have_basename) {
      have_basename = this.basename(path);
    }
    if (false === have_extension) {
      have_extension = __getExt(have_basename);
    }
    if (false !== have_extension) {
      tmp_arr.extension = have_extension;
    }
  }

  if (options & OPTS.PATHINFO_FILENAME) {
    if (false === have_basename) {
      have_basename = this.basename(path);
    }
    if (false === have_extension) {
      have_extension = __getExt(have_basename);
    }
    if (false === have_filename) {
      have_filename = have_basename.slice(0, have_basename.length - (have_extension ? have_extension.length + 1 : have_extension === false ? 0 : 1));
    }

    tmp_arr.filename = have_filename;
  }


  // If array contains only 1 element: return string
  cnt = 0;
  for (opt in tmp_arr) {
    cnt++;
  }
  if (cnt == 1) {
    return tmp_arr[opt];
  }

  // Return full-blown array
  return tmp_arr;
}
{% endcodeblock %}

 - [Raw function on GitHub](https://github.com/kvz/phpjs/blob/master/functions/filesystem/pathinfo.js)

Please note that php.js uses JavaScript objects as substitutes for PHP arrays, they are 
the closest match to this hashtable-like data structure. 

Please also note that php.js offers community built functions and goes by the 
[McDonald's Theory](https://medium.com/what-i-learned-building/9216e1c9da7d). We'll put online 
functions that are far from perfect, in the hopes to spark better contributions. 
Do you have one? Then please just: 

 - [Edit on GitHub](https://github.com/kvz/phpjs/edit/master/functions/filesystem/pathinfo.js)

### Example 1
This code
{% codeblock lang:js example %}
pathinfo('/www/htdocs/index.html', 1);
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
'/www/htdocs'
{% endcodeblock %}

### Example 2
This code
{% codeblock lang:js example %}
pathinfo('/www/htdocs/index.html', 'PATHINFO_BASENAME');
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
'index.html'
{% endcodeblock %}

### Example 3
This code
{% codeblock lang:js example %}
pathinfo('/www/htdocs/index.html', 'PATHINFO_EXTENSION');
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
'html'
{% endcodeblock %}


### Other PHP functions in the filesystem extension
{% render_partial _includes/custom/filesystem.html %}