src/Twig/ComponentDataAdapterExtension.php line 59

Open in your IDE?
  1. <?php
  3. namespace App\Twig;
  5. use App\Twig\Components\ComponentsMiddleware;
  6. use Twig\Extension\AbstractExtension;
  7. use Twig\TwigFunction;
  9. /**
  10.  * Twig extension with adapt_attribute twig function.
  11.  *
  12.  * adapt_attribute can be used for any attribute of any markups in twig layer. This function is responsible for passing
  13.  * input and output thanks to lazy loading of proper handler.
  14.  * adapt_attribute has 2 parameters:
  15.  *  - concatenation of key of handler (name of microfrontend component) and name of method (name of attribute) to which
  16.  *    data have to be passed written in snake case and separated with "." (eg. download_files.items)
  17.  *  - data which have to be handled.
  18.  *
  19.  * There are a lot of handlers. Single handler responses to single microfrontend component. Methods which are
  20.  * responsible for data handling must be suffixed with "Attribute" for better readability.
  21.  * Handling of common data eg. images, is encapsulated in traits which can be used in handlers eg. ImageTrait is used
  22.  * in many handlers because many components needs images.
  23.  *
  24.  * @example Breadcrumbs microfrontend components has some data to handle for its attribute social-media. So there is
  25.  * need to call adapt_attribute('breadcrumbs.social_media', data). Data will be passed to Breadcrumbs handler to
  26.  * socialMediaAttribute method.
  27.  *
  28.  * @author Michał Wiązek <michal.wiazek@makolab.com>
  29.  */
  30. class ComponentDataAdapterExtension extends AbstractExtension
  31. {
  32.     private ComponentsMiddleware $componentMiddleware;
  34.     /**
  35.      * Constructor.
  36.      */
  37.     public function __construct(ComponentsMiddleware $componentMiddleware)
  38.     {
  39.         $this->componentMiddleware = $componentMiddleware;
  40.     }
  42.     /**
  43.      * {@inheritDoc}
  44.      */
  45.     public function getFunctions(): array
  46.     {
  47.         return [
  48.             new TwigFunction('adapt_attribute', [$this, 'adaptAttribute']),
  49.         ];
  50.     }
  52.     /**
  53.      * Return structure and data fitting to frontend components.
  54.      *
  55.      * @param array $data
  56.      *
  57.      * @return mixed
  58.      */
  59.     public function adaptAttribute(string $componentAttribute, array $data = null)
  60.     {
  61.         list($componentKey, $attribute) = explode('.', $componentAttribute);
  62.         $method = $this->snakeToCamel($attribute).'Attribute';
  64.         $preparedData = $this->componentMiddleware->getServiceLocator()->get($componentKey)->$method($data);
  66.         return $preparedData;
  67.     }
  69.     /**
  70.      * Convert snakeCase to camelCase.
  71.      *
  72.      * @param $snakeCase
  73.      */
  74.     private function snakeToCamel($snakeCase): string
  75.     {
  76.         return lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', $snakeCase))));
  77.     }
  78. }