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: 6 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: mit
- Created: 2023-01-21T07:39:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-04-20T10:16:59.000Z (about 2 months ago)
- Last Synced: 2026-04-20T11:39:22.336Z (about 2 months ago)
- Topics: php, pimcore, pimcore-bundle
- Language: PHP
- Homepage:
- Size: 208 KB
- Stars: 3
- Watchers: 9
- Forks: 0
- Open Issues: 4
-
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
This bundle allows you to create Areabrick configuration dialogs in an object-oriented way.
### 1. Prepare Areabrick Class
Your Areabrick class must implement the `Pimcore\Extension\Document\Areabrick\EditableDialogBoxInterface` interface
and use the `Neusta\Pimcore\AreabrickConfigBundle\HasDialogBox` trait.
Then, implement the `buildDialogBox()` method to define the dialog.
```php
*/
use HasDialogBox;
private function buildDialogBox(DialogBoxBuilder $dialogBox, Editable $area, ?Info $info): void
{
$dialogBox
->addNamedTab('settings', 'Settings',
$dialogBox->createInput('my-input')
->setLabel('Text Input')
->setPlaceholder('Please enter text...')
)
->addNamedTab('options', 'Options',
$dialogBox->createCheckbox('my-checkbox')
->setLabel('Activate')
->setDefaultChecked()
);
}
}
```
### 2. Access in Twig Template
The configured values can be retrieved via the Pimcore editables in the template as usual:
```twig
Input: {{ pimcore_input('my-input').getData() }}
{% if pimcore_checkbox('my-checkbox').isChecked() %}
Checkbox is activated!
{% endif %}
```
## Features
### Dialog Configuration
You can customize the size of the dialog and specify whether the page should be reloaded after closing.
```php
$dialogBox
->width(800)
->height(600)
->reloadOnClose(true);
```
### Layout Options
#### Simple Content
For simple dialogs you can use `addContent`:
```php
$dialogBox->addContent(
$dialogBox->createInput('field-1'),
$dialogBox->createInput('field-2')
);
```
#### Tabs
If you want to organize your fields into multiple tabs, use `addTab`:
```php
$dialogBox->addTab('tab_name', 'Tab Title',
$dialogBox->createInput('field-1'),
$dialogBox->createInput('field-2')
);
```
> [!IMPORTANT]
> You cannot mix `addTab` and `addContent` in the same dialog.
### Available Editables
The `DialogBoxBuilder` provides various methods for creating editables:
#### Input
A simple text input field.
```php
$dialogBox->createInput('name')
->setLabel('Label')
->setPlaceholder('Placeholder')
->setDefaultValue('Default value')
->setWidth(300);
```
#### Checkbox
A simple checkbox to toggle a boolean value.
```php
$dialogBox->createCheckbox('name')
->setLabel('Label')
->setDefaultChecked(); // or setDefaultUnchecked()
```
#### Select
A dropdown selection field.
```php
$dialogBox->createSelect('name', [
'value1' => 'Label 1',
'value2' => 'Label 2',
])
->setLabel('Selection')
->setDefaultValue('value2');
```
#### Relation
Allows the selection of objects, assets, or documents.
```php
$dialogBox->createRelation('my-relation')
->setLabel('Relation')
->allowObjectsOfClass('MyPimcoreClass')
->allowAssetsOfType('image')
->allowDocumentsOfType('page');
```
#### Link
A field for selecting internal or external links.
```php
$dialogBox->createLink('my-link')
->setLabel('Link')
->allowTypes('document', 'asset', 'object')
->disallowFields('anchor', 'rel');
```
#### Numeric
An input field for numbers with min/max validation.
```php
$dialogBox->createNumeric('count', 1, 10)
->setLabel('Count')
->setDefaultValue(5);
```
#### Date
A date picker.
```php
$dialogBox->createDate('date')
->setLabel('Date')
->setFormat('d.m.Y');
```
#### Custom Configuration
All editables allow setting arbitrary configuration values via the `addConfig` method.
This is useful for passing additional parameters that are not covered by the dedicated methods:
```php
$dialogBox->createInput('name')
->addConfig('any-editable-config-key', 'value');
```
## DialogBoxConfigurator
The `DialogBoxConfigurator` allows you to customize the dialog box configuration dynamically.
This is particularly useful if an Areabrick is used within another Areabrick
and you want to adjust settings like default values or select options based on the context.
### 1. Create a Configurator Class
Implement the `Neusta\Pimcore\AreabrickConfigBundle\DialogBoxConfigurator` interface:
```php
height(500);
$dialogBox->getTab('Settings')
->getEditable('my-input')
->setDefaultValue('Custom Context Value');
$dialogBox->reloadOnClose(false);
}
}
```
> [!IMPORTANT]
> The configurator class must be registered as a `public` service in your container.
### 2. Usage in Twig
You can pass the service ID of your configurator via the `dialogBoxConfigurator` parameter
in the `pimcore_area` or `pimcore_areablock` helpers.
> [!TIP]
> If the service ID matches the FQCN, you can simply use the FQCN.
```twig
{{ pimcore_area('myfield', {
type: 'my-areabrick',
params: {
'my-areabrick': {
dialogBoxConfigurator: 'App\Areabrick\MyAreabrickDialogBoxConfigurator',
}
},
}) }}
```
## Configuration
Currently, there is no configuration available.
## Contribution
Feel free to open issues for any bug, feature request, or other ideas.
> [!NOTE]
> This bundle does not yet cover all of Pimcore’s possibilities and will be expanded as needed.
> Pull Requests are welcome!
Please remember to create an issue before creating large pull requests.
### Local Development
To develop on your local machine, instance identification for Pimcore 12 is needed.
Copy the `compose.override.yaml.dist` file to `compose.override.yaml`:
```shell
cp -n compose.override.yaml.dist compose.override.yaml
```
And replace all `replace_with_secret` values with your data.
Then install the dependencies:
```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
```
For the tests there is a different script that includes a database setup.
```shell
bin/run-tests
```