chill-bundles/src/Bundle/ChillMainBundle/DependencyInjection/Widget/Factory/WidgetFactoryInterface.php

<?php

declare(strict_types=1);

/*
 * Chill is a software for social workers
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Chill\MainBundle\DependencyInjection\Widget\Factory;

use Symfony\Component\Config\Definition\Builder\NodeBuilder;
use Symfony\Component\DependencyInjection\ContainerBuilder;

/**
 * Factory for creating configuration of widgets.
 *
 * When you need a widget with some configuration, you should implements this
 * interface on a factory. The factory will add configuration to the bundle
 * giving the places for your widget.
 *
 * Using this interface, **you do not need** to define the service in your
 * container configuration (`services.yml` files).
 *
 * Once the class is created, you should inject the factory inside the container
 * at compile time, in your `Bundle` class :
 *
 *
 * ```
 * namespace Chill\PersonBundle;
 *
 * use Symfony\Component\HttpKernel\Bundle\Bundle;
 * use Symfony\Component\DependencyInjection\ContainerBuilder;
 * use Chill\PersonBundle\Widget\PersonListWidgetFactory;
 *
 * class ChillPersonBundle extends Bundle
 * {
 *      public function build(ContainerBuilder $container)
 *   {
 *       parent::build($container);
 *       // register a widget factory into chill_main :
 *       $container->getExtension('chill_main')
 *           ->addWidgetFactory(new PersonListWidgetFactory());
 *   }
 * }
 * ```
 */
interface WidgetFactoryInterface
{
    /**
     * configure options for the widget. Those options will be added in
     * configuration in the bundle where the widget will be used.
     *
     * @param type $place
     */
    public function configureOptions($place, NodeBuilder $node);

    /**
     * Create a definition for the service which will render the widget.
     *
     * (Note: you can define the service by yourself, as other services,
     * using the `AbstractWidgetFactory`)
     *
     * @param type $place
     * @param type $order
     */
    public function createDefinition(ContainerBuilder $containerBuilder, $place, $order, array $config);

    /**
     * return the service id to build the widget.
     *
     * @param string $place
     * @param float $order
     *
     * @return string the service definition
     */
    public function getServiceId(ContainerBuilder $containerBuilder, $place, $order, array $config);

    /**
     * get the widget alias. This alias will be used in configuration (`config.yml`).
     */
    public function getWidgetAlias();
}