134 PHP equivalents

PHP to Javascript Project: php.js

php.js This 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: file_get_contents.

PHP file_get_contents

Description

file_get_contents - Reads entire file into a string

string file_get_contents( string filename [, int flags [, resource context [, int offset [, int maxlen]]]] )

This function is similar to file(), except that file_get_contents() returns the file in astring, starting at the specified offsetup to maxlen bytes. On failure,file_get_contents() will return FALSE.

Parameters

filename
Name of the file to read.

flags Warning

For all versions prior to PHP 6, this parameter is called use_include_path and is a bool. The flags parameter is only available since PHP 6. If you use an older version and want to search for filename in the include path, this parameter must be TRUE. Since PHP 6, you have to use the FILE_USE_INCLUDE_PATH flag instead.

The value of flags can be any combination of the following flags (with some restrictions), joined with the binary OR (|) operator.

Available flags

Flag	Description
FILE_USE_INCLUDE_PATH	Search for filename in the include directory. See include_path for more information.
FILE_TEXT	If unicode semantics are enabled, the default encoding of the read data is UTF-8. You can specify a different encoding by creating a custom context or by changing the default using stream_default_encoding(). This flag cannot be used with FILE_BINARY.
FILE_BINARY	With this flag, the file is read in binary mode. This is the default setting and cannot be used with FILE_TEXT.

context
A valid context resource created with stream_context_create(). If you don't need to use a custom context, you can skip this parameter by NULL.
offset
The offset where the reading starts.
maxlen
Maximum length of data read.

Return Values

The function returns the read data or FALSE on failure.

Javascript file_get_contents

Source

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

function file_get_contents( url ) {
    // http://kevin.vanzonneveld.net
    // +   original by: Legaev Andrey
    // %        note 1: This function uses XmlHttpRequest and cannot retrieve resource from different domain.
    // *     example 1: file_get_contents('http://kevin.vanzonneveld.net/pj_test_supportfile_1.htm');
    // *     returns 1: '123'
 
    var req = null;
    try { req = new ActiveXObject("Msxml2.XMLHTTP"); } catch (e) {
        try { req = new ActiveXObject("Microsoft.XMLHTTP"); } catch (e) {
            try { req = new XMLHttpRequest(); } catch(e) {}
        }
    }
    if (req == null) throw new Error('XMLHttpRequest not supported');
 
    req.open("GET", url, false);
    req.send(null);
 
    return req.responseText;
}

Examples

Currently there is 1 example

Example 1

This is how you could call file_get_contents()

file_get_contents('http://kevin.vanzonneveld.net/pj_test_supportfile_1.htm');

And that would return

'123'

More about this Project

Download php.js

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

Normal

uncompressed source: php.js (147.1kB)
minified: php.min.js (54.1kB)
compressed: php.packed.js (39kB)

Namespaced What is 'namespaced?'

uncompressed source: php.namespaced.js (181.6kB)
minified: php.namespaced.min.js (54.5kB)
compressed: php.namespaced.packed.js (39.4kB)

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

Testing the functions

The number of functions is growing fast and so it becomes hard to maintain quality.

To defeat that danger of bad code, syntax errors, etc, I've added a new feature: php.js tester.

It is an automatically generated page that includes ALL functions in your browser, and then extracts specific testing information from each function's comments. This info is then used to run the function, and the return value is compared to a predefined one.

This way code is always checked on syntax errors, and if it doesn't function correctly anymore after an update, we should also be able to detect it more easily.

If you want, go check it out.

Credits

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

	Michael 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
	_argos for contributing to:
	array_fill, array_pad, array_product, array_rand, compact, count, range, abs, defined, ip2long, long2ip, implode, strcmp, ucwords
	Jonas Raoni Soares Silva (link) for contributing to:
	shuffle, abs, setcookie, number_format, number_format, soundex, str_repeat, str_replace, str_rot13, ucwords, wordwrap, wordwrap
	Legaev Andrey for contributing to:
	end, reset, file, file_get_contents, function_exists, include, include_once, http_build_query, is_array, is_object
	Ates 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
	Philip Peterson for contributing to:
	sizeof, round, echo, nl2br, str_replace, strchr, urldecode, urlencode, var_export
	Martijn Wieringa for contributing to:
	str_ireplace, str_split, strcasecmp, stripos, strnatcmp, substr
	Webtoolkit.info (link) for contributing to:
	crc32, md5, sha1, utf8_decode, utf8_encode

	Carlos R. L. Rodrigues (link) for contributing to:
	array_chunk, array_unique, date, levenshtein
	Ash Searle (link) for contributing to:
	basename, printf, sprintf
	Erkekjetter for contributing to:
	ltrim, rtrim, trim
	marrtins for contributing to:
	array_change_key_case, addslashes, stripslashes
	Alfonso Jimenez (link) for contributing to:
	array_reduce, strpbrk
	Aman Gupta for contributing to:
	base64_decode, utf8_decode
	Arpad Ray (mailto:arpad@php.net) for contributing to:
	serialize, unserialize
	Karol Kowalski for contributing to:
	array_reverse, abs
	Thunder.m for contributing to:
	base64_decode, base64_encode
	Tyler Akins (link) for contributing to:
	base64_decode, base64_encode
	mdsjack (link) for contributing to:
	include, trim
	Alexander Ermolaev (link) for contributing to:
	trim
	Allan Jensen (link) for contributing to:
	number_format
	Andrea Giammarchi (link) for contributing to:
	array_map
	Bayron Guevara for contributing to:
	base64_encode
	Benjamin Lupton for contributing to:
	number_format
	Brad Touesnard for contributing to:
	date
	Brett Zamir for contributing to:
	str_split
	Cagri Ekin for contributing to:
	parse_str
	Cord for contributing to:
	is_array
	David for contributing to:
	is_numeric
	David James for contributing to:
	get_class
	DxGx for contributing to:
	trim
	FGFEmperor for contributing to:
	mktime
	Felix Geisendoerfer (link) for contributing to:
	array_key_exists
	FremyCompany for contributing to:
	isset
	Gabriel Paderni for contributing to:
	str_replace
	Leslie Hoare for contributing to:
	rand
	Lincoln Ramsay for contributing to:
	basename
	MeEtc (link) for contributing to:
	date
	Mick@el for contributing to:
	stripslashes
	Nick Callen for contributing to:
	wordwrap
	Ozh for contributing to:
	dirname
	Pedro Tainha (link) for contributing to:
	unserialize
	Peter-Paul Koch (link) for contributing to:
	date
	Philippe Baumann for contributing to:
	empty
	Sakimori for contributing to:
	strlen
	Sanjoy Roy for contributing to:
	array_diff
	Simon Willison (link) for contributing to:
	str_replace
	Steve Clay for contributing to:
	function_exists
	Steve Hilder for contributing to:
	strcmp
	Steven Levithan (link) for contributing to:
	trim
	T0bsn for contributing to:
	crc32
	Thiago Mata (link) for contributing to:
	call_user_func_array
	Tim Wiel for contributing to:
	date
	XoraX (link) for contributing to:
	dirname
	baris ozdil for contributing to:
	mktime
	booeyOH for contributing to:
	preg_quote
	djmix for contributing to:
	basename
	duncan for contributing to:
	array_unique
	echo is bad for contributing to:
	echo
	gabriel paderni for contributing to:
	mktime
	ger for contributing to:
	html_entity_decode
	john (link) for contributing to:
	html_entity_decode
	kenneth for contributing to:
	explode
	penutbutterjelly for contributing to:
	str_ireplace
	stensi 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:

Versioning. Individual functions are versioned, but the entire library should be versioned as well.
Light. A lightweight version of php.js should be made available with only common functions in it.