Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamneusta/pimcore-areabrick-config-bundle
Object-oriented editable dialog box configuration building for areabricks
https://github.com/teamneusta/pimcore-areabrick-config-bundle
php pimcore pimcore-bundle
Last synced: 20 days ago
JSON representation
Object-oriented editable dialog box configuration building for areabricks
- Host: GitHub
- URL: https://github.com/teamneusta/pimcore-areabrick-config-bundle
- Owner: teamneusta
- License: gpl-3.0
- Created: 2023-01-21T07:39:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T18:22:29.000Z (about 1 month ago)
- Last Synced: 2024-12-03T08:08:28.699Z (about 1 month ago)
- Topics: php, pimcore, pimcore-bundle
- Language: PHP
- Homepage:
- Size: 145 KB
- Stars: 3
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Areabrick Config Bundle
Object-oriented editable dialog box configuration building for areabricks.
## Installation
1. **Require the bundle**
```shell
composer require teamneusta/pimcore-areabrick-config-bundle
```
2. **Enable the bundle**
Add the Bundle to your `config/bundles.php`:
```php
Neusta\Pimcore\AreabrickConfigBundle\NeustaPimcoreAreabrickConfigBundle::class => ['all' => true],
```
## Usage
You need this bundle if you want to stuff your areabricks easily with an editable config dialog.
A simple example should show how to do it.
### Areabrick Class
Your areabrick class must implement Pimcore's `Pimcore\Extension\Document\Areabrick\EditableDialogBoxInterface` interface
and additionally use the `Neusta\Pimcore\AreabrickConfigBundle\HasDialogBox` trait.
Then it's up to you to implement the `buildDialogBox()` method as you wish.
```php
*/
use HasDialogBox;
/******************************************************************
* This is the code you have to implement
*****************************************************************/
private function buildDialogBox(DialogBoxBuilder $dialogBox, Editable $area, ?Info $info): void
{
$dialogBox
->addTab('Einstellungen meines Bricks',
$dialogBox->createInput('input-label')
->setPlaceholder('Hier bitte was eintragen...')
->setLabel('Texteingabefeld')
)
->addTab('Weitere Einstellungen',
$dialogBox->createCheckbox('checkbox-label-1')
->setLabel('Feld zum Abhaken')
->setDefaultUnchecked(),
$dialogBox->createCheckbox('checkbox-label-2')
->setLabel('Weiteres Feld zum Abhaken (bereits abgehakt)')
->setDefaultChecked()
)
->addTab('Und noch mehr',
$dialogBox->createSelect(
'select-label',
[
'value 1' => 'label 1',
'value 2' => 'label 2',
'value 3' => 'label 3',
]
)
->setLabel('Auswahlfeld (Standard: value 2)')
->setDefaultValue('label 2')
);
}
// other things may follow
}
```
As you can (nearly) see, we add a 3-tabbed-config dialog to our brick which can be opened by clicking on the pencil of
your areabrick:
The config dialog will be opened:
And after editing the values, they are accessible in the Twig template:
```html
Im Feld 'Texteingabefeld' wurde der Wert
{{ pimcore_input('input-label').getData() }}
gewählt.
Die Checkbox 'Feld zum Abhaken' ist
{% if pimcore_checkbox('checkbox-label-1').isChecked() %}
abgehakt.
{% else %}
NICHT abgehakt.
{% endif %}
.
Die Checkbox 'Weiteres Feld zum Abhaken (bereits abgehakt)' ist
{% if pimcore_checkbox('checkbox-label-2').isChecked() %}
abgehakt.
{% else %}
NICHT abgehakt.
{% endif %}
Im Auswahlfeld (Standard: wert 2) wurde der Wert
{{ pimcore_select('select-label').getData() }}
gewählt.
```
## Configuration
Currently, there is no configuration available.
## Contribution
Feel free to open issues for any bug, feature request, or other ideas.
Please remember to create an issue before creating large pull requests.
### Local Development
To develop on local machine, the vendor dependencies are required.
```shell
bin/composer install
```
We use composer scripts for our main quality tools. They can be executed via the `bin/composer` file as well.
```shell
bin/composer cs:fix
bin/composer phpstan
bin/composer tests
```