https://github.com/dmstr/yii2-prototype-module
Twig, LESS and HTML Content prototyping module for Yii 2.0 Framework
https://github.com/dmstr/yii2-prototype-module
Last synced: 12 months ago
JSON representation
Twig, LESS and HTML Content prototyping module for Yii 2.0 Framework
- Host: GitHub
- URL: https://github.com/dmstr/yii2-prototype-module
- Owner: dmstr
- Created: 2016-03-01T21:56:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T13:39:26.000Z (over 1 year ago)
- Last Synced: 2025-05-13T02:41:20.839Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 202 KB
- Stars: 5
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Yii2 Prototype Module
===========================
[](https://packagist.org/packages/dmstr/yii2-prototype-module)
[](https://packagist.org/packages/dmstr/yii2-prototype-module)
[](https://packagist.org/packages/dmstr/yii2-prototype-module)
Twig, LESS and HTML Content prototyping module for Yii 2.0 Framework
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist dmstr/yii2-prototype-module "*"
```
or add
```
"dmstr/yii2-prototype-module": "*"
```
to the require section of your `composer.json` file.
Requirements
------------
- configured Twig view renderer in application (since 0.5.0-rc6)
Usage
-----
####Prototype command:
#####Configuration
In your console config add:
```
'controllerMap' => [
'prototype' => 'dmstr\modules\prototype\commands'
]
```
##### Commands:
- prototype/export-html
- prototype/export-less
- prototype/export-twig
Each of these commands exports either html, less or twig as a file on a given file path (via `--exportPath` flag) default is `@runtime/exports`
Note: To escape file names you can use the `--escapeFileNames` flag
- prototype/export-asset-bundle
Exports less files and an asset bunde to a given export path (via `--exportPath` flag) default is `@runtime/exports`
Note:
1.) You will be prompted to choose a namespace and to select less files which should be added to the asset bundle
2.) The defined main less file will be automatical have default yes in confirmation
--> if you run this command on non interactive mode (--interactive=0), main less file will be added to the asset bundle and the namespace will be set to `app\assets`
### Twig example
{{ use ('hrzg/moxiecode/moxiemanager/widgets') }}
{{ browse_button_widget( {"tagName": "a"} ) }}
### Cache trigger time
\Yii::$app->cache->get('prototype.less.changed_at');
Testing
-------
docker-compose up -d
docker-compose run phpfpm codecept run
CRUDS
-----
:bangbang: Do no regenerate CRUDs for `html`
$ yii batch \
--tables=app_twig \
--modelNamespace=dmstr\\modules\\prototype\\models \
--modelQueryNamespace=dmstr\\modules\\prototype\\models\\query \
--crudSearchModelNamespace=dmstr\\modules\\prototype\\models\\query \
--crudControllerNamespace=dmstr\\modules\\prototype\\controllers \
--crudViewPath=@dmstr/modules/prototype/views \