Symfony Profiler

<?php
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Bundle\CoreBundle\DependencyInjection\Compiler;
use Doctrine\Inflector\Inflector;
use Doctrine\Inflector\InflectorFactory;
use Pimcore\Extension\Document\Areabrick\AreabrickInterface;
use Pimcore\Extension\Document\Areabrick\AreabrickManager;
use Pimcore\Extension\Document\Areabrick\Exception\ConfigurationException;
use Pimcore\Templating\Renderer\EditableRenderer;
use Symfony\Component\Config\Resource\DirectoryResource;
use Symfony\Component\Config\Resource\FileExistenceResource;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\Finder\Finder;
/**
* @internal
*/
final class AreabrickPass implements CompilerPassInterface
{
/**
* @var Inflector
*/
private $inflector;
public function __construct()
{
$this->inflector = InflectorFactory::create()->build();
}
/**
* {@inheritdoc}
*/
public function process(ContainerBuilder $container)
{
$config = $container->getParameter('pimcore.config');
$areabrickManager = $container->getDefinition(AreabrickManager::class);
$areabrickLocator = $container->getDefinition('pimcore.document.areabrick.brick_locator');
$taggedServices = $container->findTaggedServiceIds('pimcore.area.brick');
// keep a list of areas loaded via tags - those classes won't be autoloaded
$taggedAreas = [];
// the service mapping for the service locator
$locatorMapping = [];
foreach ($taggedServices as $id => $tags) {
$definition = $container->getDefinition($id);
$taggedAreas[] = $definition->getClass();
// tags must define the id attribute which will be used to register the brick
// e.g. { name: pimcore.area.brick, id: blockquote }
foreach ($tags as $tag) {
if (!array_key_exists('id', $tag)) {
throw new ConfigurationException(sprintf('Missing "id" attribute on areabrick DI tag for service %s', $id));
}
// add the service to the locator
$locatorMapping[$tag['id']] = new Reference($id);
// register the brick with its ID on the areabrick manager
$areabrickManager->addMethodCall('registerService', [$tag['id'], $id]);
}
// handle bricks implementing ContainerAwareInterface
$this->handleContainerAwareDefinition($container, $definition);
$this->handleEditableRendererCall($definition);
}
// autoload areas from bundles if not yet defined via service config
if ($config['documents']['areas']['autoload']) {
$locatorMapping = $this->autoloadAreabricks($container, $areabrickManager, $locatorMapping, $taggedAreas);
}
$areabrickLocator->setArgument(0, $locatorMapping);
}
/**
* To be autoloaded, an area must fulfill the following conditions:
*
* - implement AreabrickInterface
* - be situated in a bundle in the sub-namespace Document\Areabrick (can be nested into a deeper namespace)
* - the class is not already defined as areabrick through manual config (not included in the tagged results above)
*
* Valid examples:
*
* - MyBundle\Document\Areabrick\Foo
* - MyBundle\Document\Areabrick\Foo\Bar\Baz
*
* @param ContainerBuilder $container
* @param Definition $areaManagerDefinition
* @param array $locatorMapping
* @param array $excludedClasses
*
* @return array
*/
protected function autoloadAreabricks(
ContainerBuilder $container,
Definition $areaManagerDefinition,
array $locatorMapping,
array $excludedClasses
) {
$bundles = $container->getParameter('kernel.bundles_metadata');
//Find bricks from /src since AppBundle is removed
$bundles['App'] = [
'path' => PIMCORE_PROJECT_ROOT . '/src',
'namespace' => 'App',
];
foreach ($bundles as $bundleName => $bundleMetadata) {
$bundleAreas = $this->findBundleBricks($container, $bundleName, $bundleMetadata, $excludedClasses);
foreach ($bundleAreas as $bundleArea) {
/** @var \ReflectionClass $reflector */
$reflector = $bundleArea['reflector'];
$definition = new Definition($reflector->getName());
$definition
->setPublic(false)
->setAutowired(true)
->setAutoconfigured(true);
// add brick definition to container
$container->setDefinition($bundleArea['serviceId'], $definition);
// add the service to the locator
$locatorMapping[$bundleArea['brickId']] = new Reference($bundleArea['serviceId']);
// register brick on the areabrick manager
$areaManagerDefinition->addMethodCall('registerService', [
$bundleArea['brickId'],
$bundleArea['serviceId'],
]);
// handle bricks implementing ContainerAwareInterface
$this->handleContainerAwareDefinition($container, $definition, $reflector);
$this->handleEditableRendererCall($definition);
}
}
return $locatorMapping;
}
/**
* @param Definition $definition
*
* @throws \ReflectionException
*/
private function handleEditableRendererCall(Definition $definition)
{
$reflector = new \ReflectionClass($definition->getClass());
if ($reflector->hasMethod('setEditableRenderer')) {
$definition->addMethodCall('setEditableRenderer', [new Reference(EditableRenderer::class)]);
}
}
/**
* Adds setContainer() call to bricks implementing ContainerAwareInterface
*
* @param ContainerBuilder $container
* @param Definition $definition
* @param \ReflectionClass|null $reflector
*/
protected function handleContainerAwareDefinition(ContainerBuilder $container, Definition $definition, \ReflectionClass $reflector = null)
{
if (null === $reflector) {
$reflector = new \ReflectionClass($definition->getClass());
}
if ($reflector->implementsInterface(ContainerAwareInterface::class)) {
$definition->addMethodCall('setContainer', [new Reference('service_container')]);
}
}
/**
* Look for classes implementing AreabrickInterface in each bundle's Document\Areabrick sub-namespace
*
* @param ContainerBuilder $container
* @param string $name
* @param array $metadata
* @param array $excludedClasses
*
* @return array
*/
protected function findBundleBricks(ContainerBuilder $container, string $name, array $metadata, array $excludedClasses = []): array
{
$sourcePath = is_dir($metadata['path'].'/src') ? $metadata['path'].'/src' : $metadata['path'];
$directory = $sourcePath.DIRECTORY_SEPARATOR.'Document'.DIRECTORY_SEPARATOR.'Areabrick';
// update cache when directory is added/removed
$container->addResource(new FileExistenceResource($directory));
if (!is_dir($directory)) {
return [];
}
// update container cache when areabricks are added/changed
$container->addResource(new DirectoryResource($directory, '/\.php$/'));
$finder = new Finder();
$finder
->files()
->in($directory)
->name('*.php');
$areas = [];
foreach ($finder as $classPath) {
$shortClassName = $classPath->getBasename('.php');
// relative path in bundle path
$relativePath = str_replace($sourcePath, '', $classPath->getPathInfo());
$relativePath = trim($relativePath, DIRECTORY_SEPARATOR);
// namespace starting from bundle path
$relativeNamespace = str_replace(DIRECTORY_SEPARATOR, '\\', $relativePath);
// sub-namespace in Document\Areabrick
$subNamespace = str_replace('Document\\Areabrick', '', $relativeNamespace);
$subNamespace = trim($subNamespace, '\\');
// fully qualified class name
$className = $metadata['namespace'] . '\\' . $relativeNamespace . '\\' . $shortClassName;
// do not autoload areas which were already defined as service via config
if (in_array($className, $excludedClasses)) {
continue;
}
if (class_exists($className)) {
$reflector = new \ReflectionClass($className);
if ($reflector->isInstantiable() && $reflector->implementsInterface(AreabrickInterface::class)) {
$brickId = $this->generateBrickId($reflector);
$serviceId = $this->generateServiceId($name, $subNamespace, $shortClassName);
$areas[] = [
'brickId' => $brickId,
'serviceId' => $serviceId,
'reflector' => $reflector,
];
}
}
}
return $areas;
}
/**
* GalleryTeaserRow -> gallery-teaser-row
*
* @param \ReflectionClass $reflector
*
* @return string
*/
protected function generateBrickId(\ReflectionClass $reflector)
{
$id = $this->inflector->tableize($reflector->getShortName());
$id = str_replace('_', '-', $id);
return $id;
}
/**
* Generate service ID from bundle name and sub-namespace
*
* - MyBundle\Document\Areabrick\Foo -> my.area.brick.foo
* - MyBundle\Document\Areabrick\Foo\Bar\Baz -> my.area.brick.foo.bar.baz
*
* @param string $bundleName
* @param string $subNamespace
* @param string $className
*
* @return string
*/
protected function generateServiceId($bundleName, $subNamespace, $className)
{
$bundleName = str_replace('Bundle', '', $bundleName);
$bundleName = $this->inflector->tableize($bundleName);
if (!empty($subNamespace)) {
$subNamespaceParts = [];
foreach (explode('\\', $subNamespace) as $subNamespacePart) {
$subNamespaceParts[] = $this->inflector->tableize($subNamespacePart);
}
$subNamespace = implode('.', $subNamespaceParts) . '.';
} else {
$subNamespace = '';
}
$brickName = $this->inflector->tableize($className);
return sprintf('%s.area.brick.%s%s', $bundleName, $subNamespace, $brickName);
}
}

vendor/pimcore/pimcore/bundles/CoreBundle/DependencyInjection/Compiler/AreabrickPass.php line 248