[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6},"actionData","errors","routes/package",{"_7":8,"_9":10,"_11":-5,"_12":-5,"_13":14},"details",{"_22":23,"_24":25,"_26":27,"_28":29,"_30":31,"_32":33,"_34":35,"_36":37,"_38":39,"_40":41},"embedOptions",{"_15":-5,"_16":17,"_18":-5,"_19":-5,"_20":-5,"_21":-5},"inputCode","snippet","assetOrigin","https://play.phpsandbox.io","border","hideOutputGutter",false,"outputLeftPadding","radius","theme","verticalPadding","name","leongrdic/dataplater","description","Template engine that uses data-* attributes so your HTML templates look great before rendering","type","library","repository","https://github.com/leongrdic/php-dataplater","versions",[51,52,53,54,55,56,57,58,59],"selectedVersion",{"_42":43,"_44":45,"_46":47,"_48":49,"_50":17},"readme","# Dataplater\n\n[![release](http://poser.pugx.org/leongrdic/dataplater/v)](https://packagist.org/packages/leongrdic/dataplater)\n[![php-version](http://poser.pugx.org/leongrdic/dataplater/require/php)](https://packagist.org/packages/leongrdic/dataplater)\n[![license](http://poser.pugx.org/leongrdic/dataplater/license)](https://packagist.org/packages/leongrdic/dataplater)\n\n[![run-tests](https://github.com/leongrdic/php-dataplater/actions/workflows/run-tests.yml/badge.svg)](https://github.com/leongrdic/php-dataplater/actions/workflows/run-tests.yml)\n\nDataplater is a templating engine written in PHP that uses HTML data-attributes and keeps templates valid and clean.\nThis makes Dataplater perfect for creating document templates like invoices, contracts, emails, etc. which can be **previewed in the browser before rendering**.\n\n## Features\n- 💻 make HTML templates that look great even before rendering\n- 💾 use data-attributes to pass data into your template\n- ⚡ powerful expression language ([SMPLang](https://github.com/leongrdic/php-smplang))\n- 📩 automatic escaping\n- 👍 UTF-8 support\n- 🧮 access to php functions in expressions\n- 🔗 include HTML files\n- ➿ nested foreach loops\n- 🔤 set inner HTML or custom attributes of elements\n- 🗑️ delete elements based on conditions\n\n\n## Examples\n\n```html\nThis is \n\nThis is awesome\n```\n\n\nI actually created an [invoice template](https://leongrdic.github.io/php-dataplater/invoice.html) for Dataplater that's used in production.\nThe template's source code is [here](examples/invoice.html).\n\n## Install\n```shell\ncomposer require leongrdic/dataplater\n```\n\n### Requirements\n\n- PHP 8.0+\n- DOM & XML extensions\n\n## Usage\n\n```php\n$dp = new \\Le\\Dataplater\\Dataplater(\n filename: 'template.html', // path relative to baseDir or an absolute path\n // OR\n template: '...', // doesn't have to be a full HTML document\n \n // optional:\n vars: [ 'var' => 'value', ], // global vars\n baseDir: 'app/templates/', // base directory for templates\n attr: 'data-custom' // custom base attribute\n);\n```\n\nWhen creating a Dataplater object, you can either provide a **path to your template file** or pass the **template as a string**.\nThe recommended way to initialize the object is by using PHP8's named arguments.\n\nOptional parameters:\n- `vars`: an array of global vars to pass into the template with keys being the vars' names\n- `baseDir`: the base directory to use for includes (defaults to `.`)\n- `attr`: the base attribute name to use for all attributes (defaults to `data-dp`)\n\n### `render()` method\n\n```php\n$html = $dp->render([\n 'var' => 'local value',\n 'function' => fn () => 'some value',\n]);\n```\n\nThe `render()` method renders the template and returns the rendered HTML as a string.\n\nThe optional parameter is an array of local vars that will override any global vars with the same name.\n\nYou can call this method multiple times on the same object with different vars to render multiple variants of the same document.\n\n\n## Attribute reference\n\nIf you change the base attribute to e.g. `data-custom` (when creating the Dataplater object), use `data-custom-foreach` instead of `data-dp-foreach`.\n\nAll Dataplater attributes will be automatically removed from the template after rendering.\n\n### `data-dp-include`\n**Value**: filename of the HTML template to include.\n\nContent of the included file will be inserted into the document replacing the element with the `data-dp-include` attribute.\n\n```html\n\n```\n\n### `data-dp-if`\n**Value**: SMPL expression\n\nIf the expression evaluates to `true`, the element will be rendered, otherwise it will be removed.\n\n```html\n

this element will always be removed

\n\n

1\">this will be rendered if the condition is met

\n```\n\n### `data-dp-foreach`\n**Value**: SMPL expression\n\n**Additional attributes**:\n- `data-dp-key`: name of var in which will be the current element key (optional)\n- `data-dp-value`: name of var in which will be the current element value (required)\n\nThe expression must evaluate to an array or an iterable object.\nChildren of the element with the `data-dp-foreach` attribute will be copied for each iteration and the `data-dp-key` and `data-dp-value` vars will be set to the current element key and value to be used in those child elements.\n\nThe element containing the `data-dp-foreach` attribute will be removed after the loop.\n\n```html\n

\n\n\n```\n\n### `data-dp-html`\n**Value**: SMPL expression\n\nIf the expression evaluates to `null`, no action will be taken (the element will be rendered without any modifications).\n\nThe expression otherwise must evaluate to a string. The string will be inserted into the element as HTML replacing the element's content.\n\nThe inserted HTML will have only `data-dp`, `data-dp-attr` and attribute shortcuts rendered which means that other attributes like `data-dp-if` or `data-dp-foreach` will be ignored.\n\n```html\n

' ~ name ~ ''\">

\n\n

'\">

\n```\nNote the quotes around the expression in the second example - the outer quotes are defining content of the HTML attribute and the inner quotes are defining a string within the SMPL expression.\n\n### `data-dp`\n**Value**: SMPL expression\n\nIf the expression evaluates to `null`, no action will be taken (the element will be rendered without any modifications).\n\nThe expression otherwise must evaluate to a string. The string will be inserted into the element as escaped text replacing the element's content.\n\n```html\n\n\n 0 ? balance : 'empty balance'\">\n\n\n```\n\nNote: HTML interprets the attribute from the last example as: data-dp=\"\\`cool\\`\", and SMPLang will interpret \\`cool\\` as a string literal. If you wrote `data-dp=\"cool\"` instead, SMPLang would look for a var called `cool` and return its value.\n\n### `data-dp-attr`\n**Value**: `attribute name ; SMPL expression`\n\nIf the expression evaluates to `null`, the attribute won't be set, and it's value will be left as is (if any).\n\nThe expression otherwise must evaluate to a string. The string will be escaped and inserted as the attribute value for the desired attribute.\n\nDataplater also provides a few shortcut for the following attributes: `id` `class` `title` `alt` `value` `href` `src` `style` using the syntax: **data-dp-`attribute`**.\n\n```html\n\n\n\n\n

\n```\n\n## Expression reference\n\nDataplater uses the [SMPLang](https://github.com/leongrdic/php-smplang) expression language. Refer to the SMPLang readme for more information about the syntax and supported operators.\n\nVars from Dataplater are accessible as vars in the SMPL expression.\n\nDataplater also provides a global object `php` which is basically a proxy to all php functions. Use it to access any PHP function from within your expressions:\n\n```\nphp.count(users) > 0\n\nphp.array_reverse(links)\n\nphp.implode('-', php.explode(' ', someText))\n```\n\nKeep in mind you can still pass your own closure/function vars and use them in your templates.\n\nWhen the expression returns a closure, Dataplater will attempt to call it (without any params) and use the result instead of the closure.\n\nDataplater wraps all SMPL exceptions in a `\\Le\\Dataplater\\ParseException` which gives you access to the line number and the causing HTML element.\n\n## Rendering order\n\n1. Includes are inserted (single level only)\n2. `if` checks are performed (except for those in loops)\n3. Loops are performed (recursively) and their contents are fully rendered (which allows for nested loops; including `if` checks)\n4. HTML insertions are performed\n5. Text and attribute insertions are performed\n\n## Notes\n\nDataplater heavily relies on the PHP DOM extension and all escaping is done by the DOM extension natively, so passing user-generated data into Dataplater vars should be safe, although if you do use data from untrusted sources, make sure proper validations is done.\n\nAlso keep in mind that DOM extension sometimes reformats HTML (like adds attribute brackets, removes closing tags if unnecessary, etc.) and that the code coming out of Dataplater is not going to be indented well.\n\nAny contributions to this project are welcome!\n","sampleCode","...', // doesn't have to be a full HTML document\n \n // optional:\n vars: [ 'var' => 'value', ], // global vars\n baseDir: 'app/templates/', // base directory for templates\n attr: 'data-custom' // custom base attribute\n);","companionPackages",[],"repl",{},"value","3.1.2","normalized","3.1.2.0","reference","efcd47ea4143e92ae9261a22c8ac0489e221b8f2","releasedAt","2022-07-11T17:32:27+00:00","isDevelopment",{"_42":43,"_44":45,"_46":47,"_48":49,"_50":17},{"_42":88,"_44":89,"_46":90,"_48":91,"_50":17},{"_42":84,"_44":85,"_46":86,"_48":87,"_50":17},{"_42":80,"_44":81,"_46":82,"_48":83,"_50":17},{"_42":76,"_44":77,"_46":78,"_48":79,"_50":17},{"_42":72,"_44":73,"_46":74,"_48":75,"_50":17},{"_42":68,"_44":69,"_46":70,"_48":71,"_50":17},{"_42":64,"_44":65,"_46":66,"_48":67,"_50":17},{"_42":60,"_44":61,"_46":62,"_48":63,"_50":17},"1.0.0","1.0.0.0","f9e8a33c090f1b61a098960991dee76427ff1a35","2022-02-25T21:15:43+00:00","1.1.0","1.1.0.0","4cc317c425212d889895fb30c2fecc98704a2caa","2022-02-28T08:22:46+00:00","2.0.0","2.0.0.0","4646575042776f2d0aabb96b89760fe0e77e323f","2022-03-13T09:55:23+00:00","2.0.1","2.0.1.0","b6029ab9179673f27ad4938dabbaea88c25df559","2022-03-30T17:50:19+00:00","2.1.0","2.1.0.0","05144bde26a30625b0930373c67379d1ef4c83f5","2022-05-04T17:46:06+00:00","3.0.0","3.0.0.0","ace6fa35a0416790696fb15298b25ff189719192","2022-06-13T09:40:15+00:00","3.1.0","3.1.0.0","10dc420551e3e94bbdbbb6cd3d5f9e58eb7348c2","2022-06-23T13:03:05+00:00","3.1.1","3.1.1.0","6006e438cb6ade8cfab20805ba56e38269a9facf","2022-06-29T11:30:08+00:00"]