Convert simple JS data to PHP
npm install js-php-data
> This package takes a JavaScript expression and converts it into a PHP expression.
✨ Try it out in the online demo.
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.
Install it from npm:
``bash`
npm install js-php-data
`javascript
// In CommonJS modules
const jsPhpData = require('js-php-data')
// In module packages
import jsPhpData from 'js-php-data'
`
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:
`html`
Once you have somehow imported the jsPhpData function from this module, you can use it by passing it a value.
`javascript
jsPhpData({
foo: 'bar',
baz: 5
})
/*
[
'foo' => 'bar',
'baz' => 5
]
*/
`
You may also pass some optional configuration options:
---
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.
---
Type: boolean
Default: true
Use PHP's bracket [] notation for arrays. If set to false, the older/more compatible array() notation will be used.
---
Type: boolean
Default: false
If set to true, the last items of all arrays will have a comma appended.
---
Type: number | "tab"
Default: 2
By how many spaces arrays should be indented. If set to "tab", one tab will be used instead.
---
Type: "single" | "double"
Default: "single"
Which quotes to use to delimit creating strings.
---
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.
---
Type: "null" | "nullWithComment" | "string" | "throw"
Default: "nullWithComment"
How to handle circular references.
- "null": replace them with null
- : replace them with null and a adjoining / CIRCULAR / comment"string"
- : replace them with "::CIRCULAR::"
-
---
This tool is about converting plain structures. Resolving circular dependencies or converting objects with prototypes is not supported on purpose.