» Javascript equivalent for PHP's htmlspecialchars_decode

198 PHP equivalents

PHP to Javascript Project: php.js

php.jsThis article is part of the 'Porting PHP to Javascript' Project, which aims to decrease the gap between developing for PHP & Javascript.

A lot of people are familiar with PHP's functions, and though Javascript functions are often quite similar, some functions may be missing or addressed differently. The Javascript implementations should be as compliant with the PHP versions as possible, a good indication is that the PHP function manual could also apply to the Javascript version.

Porting crucial PHP functions to Javascript can be fun & useful. Currently some PHP functions have been added, but readers are encouraged to contribute and improve functions by adding comments. Eventually the goal is to save all the functions in one php.js file and make it publicly available for your coding pleasure.

If you choose to contribute, let me know how you want to be credited in the function's comments. You may also want to subscribe to RSS so you receive updates whenever new functions are posted.

This is a Javascript version of the PHP function: htmlspecialchars_decode.

PHP htmlspecialchars_decode

Description

htmlspecialchars_decode - Convert special HTML entities back to characters

string htmlspecialchars_decode( string string [, int quote_style] )

The converted entities are: &, " (when ENT_NOQUOTES is not set), ' (when ENT_QUOTES is set), < and >.

Parameters

  • string

    The string to decode

  • quote_style

    The quote style. One of the following constants:

    quote_style constants

    Constant Name Description
    ENT_COMPAT Will convert double-quotes and leave single-quotes alone (default)
    ENT_QUOTES Will convert both double and single quotes
    ENT_NOQUOTES Will leave both double and single quotes unconverted

Return Values

Returns the decoded string.

See Also

Javascript htmlspecialchars_decode

Source

This is the main source of the Javascript version of PHP's htmlspecialchars_decode

function htmlspecialchars_decode(string, quote_style) {
    // http://kevin.vanzonneveld.net
    // +   original by: Mirek Slugen
    // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +   bugfixed by: Mateusz "loonquawl" Zalega
    // +      input by: ReverseSyntax
    // +      input by: Slawomir Kaniecki
    // +      input by: Scott Cariss
    // +      input by: Francois
    // +   bugfixed by: Onno Marsman
    // +    revised by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // -    depends on: get_html_translation_table
    // *     example 1: htmlspecialchars_decode("<p>this -&gt; &quot;</p>", 'ENT_NOQUOTES');
    // *     returns 1: '<p>this -> &quot;</p>'
 
    var histogram = {}, symbol = '', tmp_str = '', i = 0;
    tmp_str = string.toString();
    
    if (false === (histogram = get_html_translation_table('HTML_SPECIALCHARS', quote_style))) {
        return false;
    }
    
    for (symbol in histogram) {
        entity = histogram[symbol];
        tmp_str = tmp_str.split(entity).join(symbol);
    }
    
    return tmp_str;
}

To run the Javascript htmlspecialchars_decode, you will also need the following dependencies:

Examples

Currently there is 1 example

Example 1

This is how you could call htmlspecialchars_decode()
htmlspecialchars_decode("<p>this -> "</p>", 'ENT_NOQUOTES');
And that would return
'<p>this -> "</p>'

More about this Project

Download php.js

To easily include it in your code, every function currently available is stored in

Normal

Namespaced What is 'namespaced?'

To download use Right click, Save Link As
Generally the best way is to use a minified version and gzip it


Credits

Respect & awards go to everybody who has contributed in some way so far:

medalmedalOnno Marsman for contributing to:
 acos, acosh, asin, asinh, atan, atanh, ceil, cos, cosh, decbin, dechex, decoct, exp, floor, fmod, getrandmax, hypot, is_finite, is_infinite, is_nan, lcg_value, log, log10, max, max, min, min, mt_getrandmax, mt_rand, pi, pow, rand, round, sin, sinh, sqrt, tan, tanh, setcookie, preg_quote, addslashes, bin2hex, count_chars, html_entity_decode, htmlentities, htmlspecialchars_decode, levenshtein, ltrim, nl2br, nl2br, ord, parse_str, rtrim, soundex, str_ireplace, str_replace, str_replace, str_rot13, str_split, strcasecmp, strip_tags, stripos, stripslashes, stristr, strlen, strnatcmp, strncasecmp, strpbrk, strpos, strrev, strripos, strrpos, strstr, strtolower, strtoupper, substr, substr_count, trim, ucfirst, ucwords, base64_decode, empty, empty, is_bool, isset, utf8_decode, utf8_encode, utf8_encode
spacemedalMichael White (link) for contributing to:
 array_count_values, get_included_files, include, include_once, require, require_once, md5, number_format, parse_str, printf, sha1, sprintf, str_pad, strnatcmp, http_build_query, floatval, is_object, print_r
spacemedalWaldo Malqui Silva for contributing to:
 array_fill, array_pad, array_product, array_rand, compact, count, range, abs, defined, ip2long, long2ip, implode, strcmp, ucwords
spacemedalJack for contributing to:
 compact, max, min, count_chars, htmlentities, md5, parse_str, soundex, sprintf, str_ireplace, strnatcmp, trim, utf8_encode
spacemedalJonas Raoni Soares Silva (link) for contributing to:
 shuffle, abs, setcookie, number_format, number_format, soundex, str_repeat, str_replace, str_rot13, ucwords, wordwrap, wordwrap
spacemedalPhilip Peterson for contributing to:
 sizeof, log10, round, echo, get_html_translation_table, nl2br, str_replace, strchr, urldecode, urlencode, var_export
spacemedalLegaev Andrey for contributing to:
 end, reset, file, file_get_contents, function_exists, include, include_once, http_build_query, is_array, is_object
spacemedalAtes Goral (link) for contributing to:
 array_change_key_case, array_count_values, array_diff_key, get_class, preg_quote, addslashes, count_chars, str_rot13, stripslashes
spacemedalMartijn Wieringa for contributing to:
 array_shift, array_unshift, str_ireplace, str_split, strcasecmp, stripos, strnatcmp, substr
spacemedalBrett Zamir for contributing to:
 array_fill_keys, array_fill_keys, array_filter, array_merge, array_slice, str_split
spacemedalEnrique Gonzalez for contributing to:
 file_exists, filesize, decbin, decoct, deg2rad, rad2deg
spacemedalNate for contributing to:
 array_merge, array_sum, array_unique, addslashes, echo, strncasecmp
spacemedalPhilippe Baumann for contributing to:
 base_convert, bindec, dechex, hexdec, octdec, empty
spacemedalWebtoolkit.info (link) for contributing to:
 crc32, md5, sha1, utf8_decode, utf8_encode
 
spacemedalCarlos R. L. Rodrigues (link) for contributing to:
 array_chunk, array_unique, date, levenshtein
spacemedalJani Hartikainen for contributing to:
 file, file_exists, file_get_contents, filesize
spacemedalAsh Searle (link) for contributing to:
 basename, printf, sprintf
spacemedalErkekjetter for contributing to:
 ltrim, rtrim, trim
spacemedalGeekFG (link) for contributing to:
 krsort, ksort, time
spacemedalJohnny Mast (link) for contributing to:
 array_walk, array_walk_recursive, create_function
spacemedald3x for contributing to:
 array, explode, unserialize
spacemedalmarrtins for contributing to:
 array_change_key_case, addslashes, stripslashes
spacemedalAJ for contributing to:
 urldecode, urlencode
spacemedalAlex for contributing to:
 strip_tags, is_int
spacemedalAlfonso Jimenez (link) for contributing to:
 array_reduce, strpbrk
spacemedalAman Gupta for contributing to:
 base64_decode, utf8_decode
spacemedalArpad Ray (mailto:arpad@php.net) for contributing to:
 serialize, unserialize
spacemedalKarol Kowalski for contributing to:
 array_reverse, abs
spacemedalMirek Slugen for contributing to:
 htmlspecialchars, htmlspecialchars_decode
spacemedalPaulo Ricardo F. Santos for contributing to:
 chunk_split, sprintf
spacemedalSakimori for contributing to:
 strlen, wordwrap
spacemedalThunder.m for contributing to:
 base64_decode, base64_encode
spacemedalTyler Akins (link) for contributing to:
 base64_decode, base64_encode
spacemedalmdsjack (link) for contributing to:
 include, trim
spacemedal0m3r for contributing to:
 array_diff_assoc
spacemedalAlexander Ermolaev (link) for contributing to:
 trim
spacemedalAllan Jensen (link) for contributing to:
 number_format
spacemedalAndrea Giammarchi (link) for contributing to:
 array_map
spacemedalAndreas for contributing to:
 setcookie
spacemedalAndrej Pavlovic for contributing to:
 serialize
spacemedalAnton Ongson for contributing to:
 str_replace
spacemedalArno for contributing to:
 htmlspecialchars
spacemedalAtli Þór for contributing to:
 nl2br
spacemedalBayron Guevara for contributing to:
 base64_encode
spacemedalBen Bryan for contributing to:
 print_r
spacemedalBenjamin Lupton for contributing to:
 number_format
spacemedalBrad Touesnard for contributing to:
 date
spacemedalCagri Ekin for contributing to:
 parse_str
spacemedalChristian Doebler for contributing to:
 sleep
spacemedalCord for contributing to:
 is_array
spacemedalDavid for contributing to:
 is_numeric
spacemedalDavid James for contributing to:
 get_class
spacemedalDino for contributing to:
 serialize
spacemedalDxGx for contributing to:
 trim
spacemedalFGFEmperor for contributing to:
 mktime
spacemedalFelix Geisendoerfer (link) for contributing to:
 array_key_exists
spacemedalFrancesco for contributing to:
 empty
spacemedalFrancois for contributing to:
 htmlspecialchars_decode
spacemedalFremyCompany for contributing to:
 isset
spacemedalGabriel Paderni for contributing to:
 str_replace
spacemedalHoward Yeend for contributing to:
 number_format
spacemedalJ A R for contributing to:
 end
spacemedalKirk Strobeck for contributing to:
 strlen
spacemedalLH for contributing to:
 empty
spacemedalLeslie Hoare for contributing to:
 rand
spacemedalLincoln Ramsay for contributing to:
 basename
spacemedalLinuxworld for contributing to:
 bin2hex
spacemedalLuke Godfrey for contributing to:
 strip_tags
spacemedalManish for contributing to:
 is_array
spacemedalMarc Palau for contributing to:
 strip_tags
spacemedalMateusz "loonquawl" Zalega for contributing to:
 htmlspecialchars_decode
spacemedalMeEtc (link) for contributing to:
 date
spacemedalMick@el for contributing to:
 stripslashes
spacemedalNathan for contributing to:
 htmlspecialchars
spacemedalNick Callen for contributing to:
 wordwrap
spacemedalNorman "zEh" Fuchs for contributing to:
 utf8_decode
spacemedalOzh for contributing to:
 dirname
spacemedalPedro Tainha (link) for contributing to:
 unserialize
spacemedalPeter-Paul Koch (link) for contributing to:
 date
spacemedalPul for contributing to:
 strip_tags
spacemedalPyerre for contributing to:
 checkdate
spacemedalReverseSyntax for contributing to:
 htmlspecialchars_decode
spacemedalRobin for contributing to:
 is_nan
spacemedalSanjoy Roy for contributing to:
 array_diff
spacemedalSaulo Vallory for contributing to:
 strncasecmp
spacemedalScott Cariss for contributing to:
 htmlspecialchars_decode
spacemedalSimon Willison (link) for contributing to:
 str_replace
spacemedalSlawomir Kaniecki for contributing to:
 htmlspecialchars_decode
spacemedalSteve Clay for contributing to:
 function_exists
spacemedalSteve Hilder for contributing to:
 strcmp
spacemedalSteven Levithan (link) for contributing to:
 trim
spacemedalSubhasis Deb for contributing to:
 array_merge_recursive
spacemedalT.Wild for contributing to:
 substr
spacemedalT0bsn for contributing to:
 crc32
spacemedalThiago Mata (link) for contributing to:
 call_user_func_array
spacemedalTim Wiel for contributing to:
 date
spacemedalTod Gentille for contributing to:
 log10
spacemedalXoraX (link) for contributing to:
 dirname
spacemedalYannoo for contributing to:
 mktime
spacemedalYves Sucaet for contributing to:
 utf8_encode
spacemedalbaris ozdil for contributing to:
 mktime
spacemedalbooeyOH for contributing to:
 preg_quote
spacemedaldjmix for contributing to:
 basename
spacemedaldptr1988 for contributing to:
 unserialize
spacemedalduncan for contributing to:
 array_unique
spacemedalecho is bad for contributing to:
 echo
spacemedalgabriel paderni for contributing to:
 mktime
spacemedalger for contributing to:
 html_entity_decode
spacemedalgorthaur for contributing to:
 strcmp
spacemedalhitwork for contributing to:
 utf8_decode
spacemedaljakes for contributing to:
 mktime
spacemedaljohn (link) for contributing to:
 html_entity_decode
spacemedaljohnrembo for contributing to:
 var_export
spacemedalkenneth for contributing to:
 explode
spacemedalmarc andreu for contributing to:
 html_entity_decode
spacemedalmetjay for contributing to:
 time
spacemedalnobbler for contributing to:
 htmlentities
spacemedalnoname for contributing to:
 get_html_translation_table
spacemedalpenutbutterjelly for contributing to:
 str_ireplace
spacemedalsankai for contributing to:
 array_count_values
spacemedalsowberry for contributing to:
 utf8_encode
spacemedalstensi for contributing to:
 intval

Your name here?

Contributing is as easy as adding a comment with better code, or code for a new function.
Any contribution leading to improvement will directly get your name & link here.


Coming Project features

Project features that we are currently working on:

  • Site. A place for php.js of it's own. You can track our lame attempts at phpjs.org. If there are any CakePHP developers out there who would like to help out, please contact me.
  • Compile. Compile your own php.js version, with only the functions you need. Should generate a hash with which you can retrieve latest versions of your php.js combination.
  • docBlock. Move to docBlock comments for improved compatibility with IDEs.
  • Done - Testsuite. A better test-suite that can be ran locally so developers can easily test before commiting. Also the testing itself should be more thorough.
  • Done - Versioning. Individual functions are versioned, but the entire library should be versioned as well.

Like this article?

   Then Dzone it!
Or use another bookmark button below to show your support &
help me spread the word.


Hot Stuff

Flaming articles

» Survive heavy traffic with you...
» Upgrade to Ubuntu Gutsy with C...
» PHP.JS Licensing
» Change more display settings i...
» Create your own screencast

Related

Articles like this one

» PHP.JS Licensing
» Javascript equivalent for PHP'...
» Javascript equivalent for PHP'...
» Javascript equivalent for PHP'...
» PHP.JS Namespaced

tags: programming, php, javascript, phpjs
category: Programming - Javascript - PHP equivalents
read: 2,630 times

Add comment

(required, shown)(required, not shown)for syntax highlighting

[CODE="Javascript"]
your_code_here();
[/CODE]

Replace "Javascript"
with "php", "text", etc.code (to make sure you are not a spammer)

Keep track of reactions with: rss feed comments feed

Comments

#10. Kevin on 29 September 2008

Member avatar: Kevin@ ReverseSyntax & Onno Marsman: Wow that was ugly. Sorry everyone. Fixed.

#9. Onno Marsman on 25 September 2008

Gravatar.com: Onno MarsmanThere is a serious parse error in this function 

string = string.replace(/&gt;/g '>');
should be (added a comma): 
string = string.replace(/&gt;/g, '>');

#8. ReverseSyntax on 25 September 2008

Gravatar.com: ReverseSyntaxThere is an error in the htmlspecialchars_decode(),
There a single quote around the regex for all params values in replace() except for > the only one that works. this is in the php.min.js

#7. Kevin on 21 September 2008

Member avatar: Kevin

<?php
echo html_entity_decode("&#56;")."\n";
?>
returns 8. This behavior is not documented in the PHP manual though, do you know what table is used here?

#6. Trevor on 17 September 2008

Gravatar.com: TrevorIssue: Doesn't decode all html escaped characters, such as &#56;

#5. Kevin on 27 July 2008

Member avatar: Kevin@ Bob Palin: Thank you for noticing. It is possible to declare global constants in javascript, but that would increase the number of dependencies throughout this project.

We have deliberately chosen to implement this a bit different from the original PHP documentation to allow for more functions to be included separately.

#4. Bob Palin on 27 July 2008

Default avatar:Bob PalinThe function description says that 'quote_style' is an int and list constants, in fact the argument is a string as shown in the code and example.

#3. Mateusz &quot;loonquawl&quot; Zalega (http://loonquawl.yoyo.pl) on 31 May 2008

Default avatar:Mateusz \"loonquawl\" Zalega (http://loonquawl.yoyo.pl)No problem :) There's another bug in this function. First argument of called function string.replace() is a string object '/&amp;/g'. It won't work, unless it's a regular expression object (should be /&amp;/g - without the apostrophes). Here's the correct code: 

string = string.toString();
    
    // Always encode
    string = string.replace(/&amp;/g, '&');
    string = string.replace(/&lt;/g, '<');
    string = string.replace(/&gt;/g, '>');
    
    // Encode depending on quote_style
    if (quote_style == 'ENT_QUOTES') {
        string = string.replace(/&quot;/g, '"');
        string = string.replace(/&#039;/g, '\'');
    } else if (quote_style != 'ENT_NOQUOTES') {
        // All other cases (ENT_COMPAT, default, but not ENT_NOQUOTES)
        string = string.replace(/&quot;/g, '"');
    }
    
    return string;
This is explained here: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:String:replace http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Objects:RegExp Btw. Most people involved in php2js project have their full names in credits. So, my name's Mateusz Zalega. Just saying :)

#2. Kevin on