Js-php-data NPM

JS data to PHP converter

This package takes a JavaScript expression and converts it into a PHP expression.

Why?

For a PHP-oriented full stack developer, it's quite common having to convert JavaScript (or even JSON) data into a PHP array. This is tedious to do manually and I wanted a copy&paste solution.

Therefore, the actual purpose of this package is its online demo, the package is merely a byproduct.

Installation

Install it from npm:

npm install js-php-data

Use in Node.js

// In CommonJS modules
const jsPhpData = require('js-php-data')

// In module packages
import jsPhpData from 'js-php-data'

Use in the Browser

You can use this package in your browser. It is compiled to ES5, so it runs in all major browsers down to IE 11.

This build exposes a global jsPhpData function and relies on the prettier and prettierPlugins.php globals to already be loaded:

<script src="https://unpkg.com/js-php-data/dist/js-php-data.umd.js"></script>

Usage

Once you have somehow imported the jsPhpData function from this module, you can use it by passing it a value.

jsPhpData({
  foo: 'bar',
  baz: 5
})

/*
[
    'foo' => 'bar',
    'baz' => 5
]
*/

You may also pass some optional configuration options:

`castToObject`

Type: boolean

Default: false

PHP arrays are used for converted JavaScript arrays as well as JavaScript objects.

This is usually fine, but you can enable this option to make the distinction extra clear by prepending an (object) type cast to converted objects. This is especially useful if you want to convert the result back to JavaScript later (for example with json_encode), since sometimes converted arrays and objects are then indistinguishable.

`bracketArrays`

Type: boolean

Default: true

Use PHP's bracket [] notation for arrays. If set to false, the older/more compatible array() notation will be used.

`trailingCommas`

Type: boolean

Default: false

If set to true, the last items of all arrays will have a comma appended.

`indentation`

Type: number | "tab"

Default: 2

By how many spaces arrays should be indented. If set to "tab", one tab will be used instead.

`quotes`

Type: "single" | "double"

Default: "single"

Which quotes to use to delimit creating strings.

`removeUndefinedProperties`

Type: boolean

Default: true

If set to true, properties with an undefined value will be omitted from the output.

If set to false, the value will be replaced with null.

`onCircular`

Type: "null" | "nullWithComment" | "string" | "throw"

Default: "nullWithComment"

How to handle circular references.

"null": replace them with null
"nullWithComment": replace them with null and a adjoining /* CIRCULAR */ comment
"string": replace them with "::CIRCULAR::"
"throw": Throw an error