Object-oriented editable dialog box configuration building for Areabricks.
-
Require the bundle
composer require teamneusta/pimcore-areabrick-config-bundle
-
Enable the bundle
Add the Bundle to your
config/bundles.php:Neusta\Pimcore\AreabrickConfigBundle\NeustaPimcoreAreabrickConfigBundle::class => ['all' => true],
This bundle allows you to create Areabrick configuration dialogs in an object-oriented way.
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
namespace App\Document\Areabrick;
use Neusta\Pimcore\AreabrickConfigBundle\DialogBoxBuilder;
use Neusta\Pimcore\AreabrickConfigBundle\HasDialogBox;
use Pimcore\Extension\Document\Areabrick\AbstractTemplateAreabrick;
use Pimcore\Extension\Document\Areabrick\EditableDialogBoxInterface;
use Pimcore\Model\Document\Editable;
use Pimcore\Model\Document\Editable\Area\Info;
class MyAreabrick extends AbstractTemplateAreabrick implements EditableDialogBoxInterface
{
/** @template-use HasDialogBox<DialogBoxBuilder> */
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()
);
}
}The configured values can be retrieved via the Pimcore editables in the template as usual:
<p>Input: {{ pimcore_input('my-input').getData() }}</p>
{% if pimcore_checkbox('my-checkbox').isChecked() %}
<p>Checkbox is activated!</p>
{% endif %}You can customize the size of the dialog and specify whether the page should be reloaded after closing.
$dialogBox
->width(800)
->height(600)
->reloadOnClose(true);For simple dialogs you can use addContent:
$dialogBox->addContent(
$dialogBox->createInput('field-1'),
$dialogBox->createInput('field-2')
);If you want to organize your fields into multiple tabs, use addTab:
$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.
The DialogBoxBuilder provides various methods for creating editables:
A simple text input field.
$dialogBox->createInput('name')
->setLabel('Label')
->setPlaceholder('Placeholder')
->setDefaultValue('Default value')
->setWidth(300);A simple checkbox to toggle a boolean value.
$dialogBox->createCheckbox('name')
->setLabel('Label')
->setDefaultChecked(); // or setDefaultUnchecked()A dropdown selection field.
$dialogBox->createSelect('name', [
'value1' => 'Label 1',
'value2' => 'Label 2',
])
->setLabel('Selection')
->setDefaultValue('value2');Allows the selection of objects, assets, or documents.
$dialogBox->createRelation('my-relation')
->setLabel('Relation')
->allowObjectsOfClass('MyPimcoreClass')
->allowAssetsOfType('image')
->allowDocumentsOfType('page');A field for selecting internal or external links.
$dialogBox->createLink('my-link')
->setLabel('Link')
->allowTypes('document', 'asset', 'object')
->disallowFields('anchor', 'rel');An input field for numbers with min/max validation.
$dialogBox->createNumeric('count', 1, 10)
->setLabel('Count')
->setDefaultValue(5);A date picker.
$dialogBox->createDate('date')
->setLabel('Date')
->setFormat('d.m.Y');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:
$dialogBox->createInput('name')
->addConfig('any-editable-config-key', 'value');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.
Implement the Neusta\Pimcore\AreabrickConfigBundle\DialogBoxConfigurator interface:
<?php
namespace App\Areabrick;
use Neusta\Pimcore\AreabrickConfigBundle\DialogBoxBuilder;
use Neusta\Pimcore\AreabrickConfigBundle\DialogBoxConfigurator;
use Pimcore\Model\Document\Editable;
use Pimcore\Model\Document\Editable\Area\Info;
final class MyAreabrickDialogBoxConfigurator implements DialogBoxConfigurator
{
public function configureDialogBox(DialogBoxBuilder $dialogBox, Editable $area, ?Info $info): void
{
$dialogBox->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.
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.
{{ pimcore_area('myfield', {
type: 'my-areabrick',
params: {
'my-areabrick': {
dialogBoxConfigurator: 'App\Areabrick\MyAreabrickDialogBoxConfigurator',
}
},
}) }}Currently, there is no configuration available.
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.
To develop on your local machine, instance identification for Pimcore 12 is needed.
Copy the compose.override.yaml.dist file to compose.override.yaml:
cp -n compose.override.yaml.dist compose.override.yamlAnd replace all replace_with_secret values with your data.
Then install the dependencies:
bin/composer installWe use composer scripts for our main quality tools. They can be executed via the bin/composer file as well.
bin/composer cs:fix
bin/composer phpstanFor the tests there is a different script that includes a database setup.
bin/run-tests