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

PHP str_pad

Description

str_pad - Pad a string to a certain length with another string

string str_pad( string input , int pad_length [, string pad_string [, int pad_type]] )

This functions returns the input string padded on the left, the right, or both sides to the specified padding length. If the optional argument pad_string is not supplied, the input is padded with spaces, otherwise it is padded with characters from pad_string up to the limit.

Parameters

• input

  The input string.

• pad_length

  If the value of pad_length is negative or less than the length of the input string, no padding takes place.

• pad_string

  Note: The pad_string may be truncated if the required number of padding characters can't be evenly divided by the pad_string 's length.
  

• pad_type

  Optional argument pad_type can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. If pad_type is not specified it is assumed to be STR_PAD_RIGHT.

Return Values

Returns the padded string.

Javascript str_pad

Source

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

function str_pad( input, pad_length, pad_string, pad_type ) {
    // http://kevin.vanzonneveld.net
    // +   original by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // + namespaced by: Michael White (http://crestidg.com)
    // *     example 1: str_pad('Kevin van Zonneveld', 30, '-=', 'STR_PAD_LEFT');
    // *     returns 1: '-=-=-=-=-=-Kevin van Zonneveld'
    // *     example 2: str_pad('Kevin van Zonneveld', 30, '-', 'STR_PAD_BOTH');
    // *     returns 2: '------Kevin van Zonneveld-----'
 
    var half = '', pad_to_go;
 
    var str_pad_repeater = function(s, len){
            var collect = '', i;
 
            while(collect.length < len) collect += s;
            collect = collect.substr(0,len);
 
            return collect;
        };
 
    if (pad_type != 'STR_PAD_LEFT' && pad_type != 'STR_PAD_RIGHT' && pad_type != 'STR_PAD_BOTH') { pad_type = 'STR_PAD_RIGHT'; }
    if ((pad_to_go = pad_length - input.length) > 0) {
        if (pad_type == 'STR_PAD_LEFT') { input = str_pad_repeater(pad_string, pad_to_go) + input; }
        else if (pad_type == 'STR_PAD_RIGHT') { input = input + str_pad_repeater(pad_string, pad_to_go); }
        else if (pad_type == 'STR_PAD_BOTH') {
            half = str_pad_repeater(pad_string, Math.ceil(pad_to_go/2));
            input = half + input + half;
            input = input.substr(0, pad_length);
        }
    }
 
    return input;
}

Examples

Currently there are 2 examples

Example 1

str_pad('Kevin van Zonneveld', 30, '-=', 'STR_PAD_LEFT');

'-=-=-=-=-=-Kevin van Zonneveld'

Example 2

str_pad('Kevin van Zonneveld', 30, '-', 'STR_PAD_BOTH');

'------Kevin van Zonneveld-----'

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 (169.4kB)
• minified: php.min.js (62.1kB) [recommended]
• compressed: php.packed.js (45.4kB)

Namespaced What is 'namespaced?'

• uncompressed source: php.namespaced.js (208.7kB)
• minified: php.namespaced.min.js (62.3kB)
• compressed: php.namespaced.packed.js (45.6kB)

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.

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:
	array_shift, array_unshift, 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
	GeekFG (link) for contributing to:
	krsort, ksort, time
	Johnny Mast (link) for contributing to:
	array_walk, array_walk_recursive, create_function
	d3x for contributing to:
	array, explode, unserialize
	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
	Mirek Slugen for contributing to:
	htmlspecialchars, htmlspecialchars_decode
	Onno Marsman for contributing to:
	addslashes, isset
	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
	Alex for contributing to:
	is_int
	Alexander Ermolaev (link) for contributing to:
	trim
	Allan Jensen (link) for contributing to:
	number_format
	Andrea Giammarchi (link) for contributing to:
	array_map
	Arno for contributing to:
	htmlspecialchars
	Bayron Guevara for contributing to:
	base64_encode
	Ben Bryan for contributing to:
	print_r
	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
	Howard Yeend for contributing to:
	number_format
	J A R for contributing to:
	end
	Jack for contributing to:
	trim
	Leslie Hoare for contributing to:
	rand
	Lincoln Ramsay for contributing to:
	basename
	Luke Godfrey for contributing to:
	strip_tags
	MeEtc (link) for contributing to:
	date
	Mick@el for contributing to:
	stripslashes
	Nate for contributing to:
	addslashes
	Nathan for contributing to:
	htmlspecialchars
	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
	Pyerre for contributing to:
	checkdate
	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
	Yannoo for contributing to:
	mktime
	baris ozdil for contributing to:
	mktime
	booeyOH for contributing to:
	preg_quote
	djmix for contributing to:
	basename
	dptr1988 for contributing to:
	unserialize
	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
	gorthaur for contributing to:
	strcmp
	jakes for contributing to:
	mktime
	john (link) for contributing to:
	html_entity_decode
	johnrembo for contributing to:
	var_export
	kenneth for contributing to:
	explode
	loonquawl for contributing to:
	htmlspecialchars_decode
	metjay for contributing to:
	time
	penutbutterjelly for contributing to:
	str_ireplace
	sankai for contributing to:
	array_count_values
	sowberry for contributing to:
	utf8_encode
	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.
• Site. A place for PHP.JS of it's own. You can track our lame attempts at phpjs.org (not hyperlinked deliberately). If there are any CakePHP developers out there who would like to contribute, contact me.
• 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.