This commit is contained in:
Xes
2025-08-14 22:41:49 +02:00
parent 2de81ccc46
commit 8ce45119b6
39774 changed files with 4309466 additions and 0 deletions

View File

@@ -0,0 +1,421 @@
<?php
/*
* This file is part of the Sonata Project package.
*
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Sonata\AdminBundle\DependencyInjection\Compiler;
use Doctrine\Common\Inflector\Inflector;
use Sonata\AdminBundle\Datagrid\Pager;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\DefinitionDecorator;
use Symfony\Component\DependencyInjection\Reference;
/**
* Add all dependencies to the Admin class, this avoid to write too many lines
* in the configuration files.
*
* @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
*/
class AddDependencyCallsCompilerPass implements CompilerPassInterface
{
/**
* {@inheritdoc}
*/
public function process(ContainerBuilder $container)
{
// check if translator service exist
if (!$container->has('translator')) {
throw new \RuntimeException('The "translator" service is not yet enabled.
It\'s required by SonataAdmin to display all labels properly.
To learn how to enable the translator service please visit:
http://symfony.com/doc/current/translation.html#configuration
');
}
$parameterBag = $container->getParameterBag();
$groupDefaults = $admins = $classes = [];
$pool = $container->getDefinition('sonata.admin.pool');
foreach ($container->findTaggedServiceIds('sonata.admin') as $id => $tags) {
foreach ($tags as $attributes) {
$definition = $container->getDefinition($id);
$parentDefinition = null;
// NEXT_MAJOR: Remove check for DefinitionDecorator instance when dropping Symfony <3.3 support
if ($definition instanceof ChildDefinition || $definition instanceof DefinitionDecorator) {
$parentDefinition = $container->getDefinition($definition->getParent());
}
$this->replaceDefaultArguments([
0 => $id,
2 => 'SonataAdminBundle:CRUD',
], $definition, $parentDefinition);
$this->applyConfigurationFromAttribute($definition, $attributes);
$this->applyDefaults($container, $id, $attributes);
$arguments = $parentDefinition ?
array_merge($parentDefinition->getArguments(), $definition->getArguments()) :
$definition->getArguments();
$admins[] = $id;
if (!isset($classes[$arguments[1]])) {
$classes[$arguments[1]] = [];
}
$classes[$arguments[1]][] = $id;
$showInDashboard = (bool) (isset($attributes['show_in_dashboard']) ? $parameterBag->resolveValue($attributes['show_in_dashboard']) : true);
if (!$showInDashboard) {
continue;
}
$resolvedGroupName = isset($attributes['group']) ? $parameterBag->resolveValue($attributes['group']) : 'default';
$labelCatalogue = isset($attributes['label_catalogue']) ? $attributes['label_catalogue'] : 'SonataAdminBundle';
$icon = isset($attributes['icon']) ? $attributes['icon'] : '<i class="fa fa-folder"></i>';
$onTop = isset($attributes['on_top']) ? $attributes['on_top'] : false;
$keepOpen = isset($attributes['keep_open']) ? $attributes['keep_open'] : false;
if (!isset($groupDefaults[$resolvedGroupName])) {
$groupDefaults[$resolvedGroupName] = [
'label' => $resolvedGroupName,
'label_catalogue' => $labelCatalogue,
'icon' => $icon,
'roles' => [],
'on_top' => false,
'keep_open' => false,
];
}
$groupDefaults[$resolvedGroupName]['items'][] = [
'admin' => $id,
'label' => !empty($attributes['label']) ? $attributes['label'] : '',
'route' => '',
'route_params' => [],
'route_absolute' => false,
];
if (isset($groupDefaults[$resolvedGroupName]['on_top']) && $groupDefaults[$resolvedGroupName]['on_top']
|| $onTop && (count($groupDefaults[$resolvedGroupName]['items']) > 1)) {
throw new \RuntimeException('You can\'t use "on_top" option with multiple same name groups.');
}
$groupDefaults[$resolvedGroupName]['on_top'] = $onTop;
$groupDefaults[$resolvedGroupName]['keep_open'] = $keepOpen;
}
}
$dashboardGroupsSettings = $container->getParameter('sonata.admin.configuration.dashboard_groups');
if (!empty($dashboardGroupsSettings)) {
$groups = $dashboardGroupsSettings;
foreach ($dashboardGroupsSettings as $groupName => $group) {
$resolvedGroupName = $parameterBag->resolveValue($groupName);
if (!isset($groupDefaults[$resolvedGroupName])) {
$groupDefaults[$resolvedGroupName] = [
'items' => [],
'label' => $resolvedGroupName,
'roles' => [],
'on_top' => false,
'keep_open' => false,
];
}
if (empty($group['items'])) {
$groups[$resolvedGroupName]['items'] = $groupDefaults[$resolvedGroupName]['items'];
}
if (empty($group['label'])) {
$groups[$resolvedGroupName]['label'] = $groupDefaults[$resolvedGroupName]['label'];
}
if (empty($group['label_catalogue'])) {
$groups[$resolvedGroupName]['label_catalogue'] = 'SonataAdminBundle';
}
if (empty($group['icon'])) {
$groups[$resolvedGroupName]['icon'] = $groupDefaults[$resolvedGroupName]['icon'];
}
if (!empty($group['item_adds'])) {
$groups[$resolvedGroupName]['items'] = array_merge($groups[$resolvedGroupName]['items'], $group['item_adds']);
}
if (empty($group['roles'])) {
$groups[$resolvedGroupName]['roles'] = $groupDefaults[$resolvedGroupName]['roles'];
}
if (isset($groups[$resolvedGroupName]['on_top']) && !empty($group['on_top']) && $group['on_top']
&& (count($groups[$resolvedGroupName]['items']) > 1)) {
throw new \RuntimeException('You can\'t use "on_top" option with multiple same name groups.');
}
if (empty($group['on_top'])) {
$groups[$resolvedGroupName]['on_top'] = $groupDefaults[$resolvedGroupName]['on_top'];
}
if (empty($group['keep_open'])) {
$groups[$resolvedGroupName]['keep_open'] = $groupDefaults[$resolvedGroupName]['keep_open'];
}
}
} elseif ($container->getParameter('sonata.admin.configuration.sort_admins')) {
$groups = $groupDefaults;
$elementSort = function (&$element) {
usort(
$element['items'],
function ($a, $b) {
$a = !empty($a['label']) ? $a['label'] : $a['admin'];
$b = !empty($b['label']) ? $b['label'] : $b['admin'];
if ($a === $b) {
return 0;
}
return $a < $b ? -1 : 1;
}
);
};
/*
* 1) sort the groups by their index
* 2) sort the elements within each group by label/admin
*/
ksort($groups);
array_walk($groups, $elementSort);
} else {
$groups = $groupDefaults;
}
$pool->addMethodCall('setAdminServiceIds', [$admins]);
$pool->addMethodCall('setAdminGroups', [$groups]);
$pool->addMethodCall('setAdminClasses', [$classes]);
$routeLoader = $container->getDefinition('sonata.admin.route_loader');
$routeLoader->replaceArgument(1, $admins);
}
/**
* This method read the attribute keys and configure admin class to use the related dependency.
*
* @param Definition $definition
* @param array $attributes
*/
public function applyConfigurationFromAttribute(Definition $definition, array $attributes)
{
$keys = [
'model_manager',
'form_contractor',
'show_builder',
'list_builder',
'datagrid_builder',
'translator',
'configuration_pool',
'router',
'validator',
'security_handler',
'menu_factory',
'route_builder',
'label_translator_strategy',
];
foreach ($keys as $key) {
$method = 'set'.Inflector::classify($key);
if (!isset($attributes[$key]) || $definition->hasMethodCall($method)) {
continue;
}
$definition->addMethodCall($method, [new Reference($attributes[$key])]);
}
}
/**
* Apply the default values required by the AdminInterface to the Admin service definition.
*
* @param ContainerBuilder $container
* @param string $serviceId
* @param array $attributes
*
* @return Definition
*/
public function applyDefaults(ContainerBuilder $container, $serviceId, array $attributes = [])
{
$definition = $container->getDefinition($serviceId);
$settings = $container->getParameter('sonata.admin.configuration.admin_services');
if (method_exists($definition, 'setShared')) { // Symfony 2.8+
$definition->setShared(false);
} else { // For Symfony <2.8 compatibility
$definition->setScope(ContainerInterface::SCOPE_PROTOTYPE);
}
$manager_type = $attributes['manager_type'];
$overwriteAdminConfiguration = isset($settings[$serviceId]) ? $settings[$serviceId] : [];
$defaultAddServices = [
'model_manager' => sprintf('sonata.admin.manager.%s', $manager_type),
'form_contractor' => sprintf('sonata.admin.builder.%s_form', $manager_type),
'show_builder' => sprintf('sonata.admin.builder.%s_show', $manager_type),
'list_builder' => sprintf('sonata.admin.builder.%s_list', $manager_type),
'datagrid_builder' => sprintf('sonata.admin.builder.%s_datagrid', $manager_type),
'translator' => 'translator',
'configuration_pool' => 'sonata.admin.pool',
'route_generator' => 'sonata.admin.route.default_generator',
'validator' => 'validator',
'security_handler' => 'sonata.admin.security.handler',
'menu_factory' => 'knp_menu.factory',
'route_builder' => 'sonata.admin.route.path_info'.
(($manager_type == 'doctrine_phpcr') ? '_slashes' : ''),
'label_translator_strategy' => 'sonata.admin.label.strategy.native',
];
$definition->addMethodCall('setManagerType', [$manager_type]);
foreach ($defaultAddServices as $attr => $addServiceId) {
$method = 'set'.Inflector::classify($attr);
if (isset($overwriteAdminConfiguration[$attr]) || !$definition->hasMethodCall($method)) {
$args = [new Reference(isset($overwriteAdminConfiguration[$attr]) ? $overwriteAdminConfiguration[$attr] : $addServiceId)];
if ('translator' === $attr) {
$args[] = false;
}
$definition->addMethodCall($method, $args);
}
}
if (isset($overwriteAdminConfiguration['pager_type'])) {
$pagerType = $overwriteAdminConfiguration['pager_type'];
} elseif (isset($attributes['pager_type'])) {
$pagerType = $attributes['pager_type'];
} else {
$pagerType = Pager::TYPE_DEFAULT;
}
$definition->addMethodCall('setPagerType', [$pagerType]);
if (isset($overwriteAdminConfiguration['label'])) {
$label = $overwriteAdminConfiguration['label'];
} elseif (isset($attributes['label'])) {
$label = $attributes['label'];
} else {
$label = '-';
}
$definition->addMethodCall('setLabel', [$label]);
if (isset($attributes['persist_filters'])) {
$persistFilters = (bool) $attributes['persist_filters'];
} else {
$persistFilters = (bool) $container->getParameter('sonata.admin.configuration.filters.persist');
}
$definition->addMethodCall('setPersistFilters', [$persistFilters]);
if (isset($overwriteAdminConfiguration['show_mosaic_button'])) {
$showMosaicButton = $overwriteAdminConfiguration['show_mosaic_button'];
} elseif (isset($attributes['show_mosaic_button'])) {
$showMosaicButton = $attributes['show_mosaic_button'];
} else {
$showMosaicButton = $container->getParameter('sonata.admin.configuration.show.mosaic.button');
}
$definition->addMethodCall('showMosaicButton', [$showMosaicButton]);
$this->fixTemplates($container, $definition, isset($overwriteAdminConfiguration['templates']) ? $overwriteAdminConfiguration['templates'] : ['view' => []]);
if ($container->hasParameter('sonata.admin.configuration.security.information') && !$definition->hasMethodCall('setSecurityInformation')) {
$definition->addMethodCall('setSecurityInformation', ['%sonata.admin.configuration.security.information%']);
}
$definition->addMethodCall('initialize');
return $definition;
}
/**
* @param ContainerBuilder $container
* @param Definition $definition
* @param array $overwrittenTemplates
*/
public function fixTemplates(ContainerBuilder $container, Definition $definition, array $overwrittenTemplates = [])
{
$definedTemplates = $container->getParameter('sonata.admin.configuration.templates');
$methods = [];
$pos = 0;
foreach ($definition->getMethodCalls() as $method) {
if ($method[0] == 'setTemplates') {
$definedTemplates = array_merge($definedTemplates, $method[1][0]);
continue;
}
if ($method[0] == 'setTemplate') {
$definedTemplates[$method[1][0]] = $method[1][1];
continue;
}
// set template for simple pager if it is not already overwritten
if ($method[0] === 'setPagerType'
&& $method[1][0] === Pager::TYPE_SIMPLE
&& (
!isset($definedTemplates['pager_results'])
|| $definedTemplates['pager_results'] === 'SonataAdminBundle:Pager:results.html.twig'
)
) {
$definedTemplates['pager_results'] = 'SonataAdminBundle:Pager:simple_pager_results.html.twig';
}
$methods[$pos] = $method;
++$pos;
}
$definition->setMethodCalls($methods);
$definedTemplates = $overwrittenTemplates['view'] + $definedTemplates;
if ($container->getParameter('sonata.admin.configuration.templates') !== $definedTemplates) {
$definition->addMethodCall('setTemplates', [$definedTemplates]);
} else {
$definition->addMethodCall('setTemplates', ['%sonata.admin.configuration.templates%']);
}
}
/**
* Replace the empty arguments required by the Admin service definition.
*
* @param array $defaultArguments
* @param Definition $definition
* @param Definition|null $parentDefinition
*/
private function replaceDefaultArguments(array $defaultArguments, Definition $definition, Definition $parentDefinition = null)
{
$arguments = $definition->getArguments();
$parentArguments = $parentDefinition ? $parentDefinition->getArguments() : [];
foreach ($defaultArguments as $index => $value) {
$declaredInParent = $parentDefinition && array_key_exists($index, $parentArguments);
if (strlen($declaredInParent ? $parentArguments[$index] : $arguments[$index]) == 0) {
$arguments[$declaredInParent ? sprintf('index_%s', $index) : $index] = $value;
}
}
$definition->setArguments($arguments);
}
}

View File

@@ -0,0 +1,50 @@
<?php
/*
* This file is part of the Sonata Project package.
*
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Sonata\AdminBundle\DependencyInjection\Compiler;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
*/
class AddFilterTypeCompilerPass implements CompilerPassInterface
{
/**
* @param ContainerBuilder $container
*/
public function process(ContainerBuilder $container)
{
$definition = $container->getDefinition('sonata.admin.builder.filter.factory');
$types = [];
foreach ($container->findTaggedServiceIds('sonata.admin.filter.type') as $id => $attributes) {
$serviceDefinition = $container->getDefinition($id);
if (method_exists($definition, 'setShared')) { // Symfony 2.8+
$serviceDefinition->setShared(false);
} else { // For Symfony <2.8 compatibility
$serviceDefinition->setScope(ContainerInterface::SCOPE_PROTOTYPE);
}
$types[$serviceDefinition->getClass()] = $id;
// NEXT_MAJOR: Remove the alias when dropping support for symfony 2.x
foreach ($attributes as $eachTag) {
$types[$eachTag['alias']] = $id;
}
}
$definition->replaceArgument(1, $types);
}
}

View File

@@ -0,0 +1,244 @@
<?php
/*
* This file is part of the Sonata Project package.
*
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Sonata\AdminBundle\DependencyInjection\Compiler;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;
/**
* @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
*/
class ExtensionCompilerPass implements CompilerPassInterface
{
/**
* {@inheritdoc}
*/
public function process(ContainerBuilder $container)
{
$universalExtensions = [];
$targets = [];
foreach ($container->findTaggedServiceIds('sonata.admin.extension') as $id => $tags) {
foreach ($tags as $attributes) {
$target = false;
if (isset($attributes['target'])) {
$target = $attributes['target'];
}
if (isset($attributes['global']) && $attributes['global']) {
$universalExtensions[$id] = $attributes;
}
if (!$target || !$container->hasDefinition($target)) {
continue;
}
$this->addExtension($targets, $target, $id, $attributes);
}
}
$extensionConfig = $container->getParameter('sonata.admin.extension.map');
$extensionMap = $this->flattenExtensionConfiguration($extensionConfig);
foreach ($container->findTaggedServiceIds('sonata.admin') as $id => $attributes) {
$admin = $container->getDefinition($id);
if (!isset($targets[$id])) {
$targets[$id] = new \SplPriorityQueue();
}
foreach ($universalExtensions as $extension => $extensionAttributes) {
$this->addExtension($targets, $id, $extension, $extensionAttributes);
}
$extensions = $this->getExtensionsForAdmin($id, $admin, $container, $extensionMap);
foreach ($extensions as $extension => $attributes) {
if (!$container->has($extension)) {
throw new \InvalidArgumentException(
sprintf('Unable to find extension service for id %s', $extension)
);
}
$this->addExtension($targets, $id, $extension, $attributes);
}
}
foreach ($targets as $target => $extensions) {
$extensions = iterator_to_array($extensions);
krsort($extensions);
$admin = $container->getDefinition($target);
foreach (array_values($extensions) as $extension) {
$admin->addMethodCall('addExtension', [$extension]);
}
}
}
/**
* @param string $id
* @param Definition $admin
* @param ContainerBuilder $container
* @param array $extensionMap
*
* @return array
*/
protected function getExtensionsForAdmin($id, Definition $admin, ContainerBuilder $container, array $extensionMap)
{
$extensions = [];
$classReflection = $subjectReflection = null;
$excludes = $extensionMap['excludes'];
unset($extensionMap['excludes']);
foreach ($extensionMap as $type => $subjects) {
foreach ($subjects as $subject => $extensionList) {
if ('admins' == $type) {
if ($id == $subject) {
$extensions = array_merge($extensions, $extensionList);
}
} else {
$class = $this->getManagedClass($admin, $container);
if (!class_exists($class)) {
continue;
}
$classReflection = new \ReflectionClass($class);
$subjectReflection = new \ReflectionClass($subject);
}
if ('instanceof' == $type) {
if ($subjectReflection->getName() == $classReflection->getName() || $classReflection->isSubclassOf($subject)) {
$extensions = array_merge($extensions, $extensionList);
}
}
if ('implements' == $type) {
if ($classReflection->implementsInterface($subject)) {
$extensions = array_merge($extensions, $extensionList);
}
}
if ('extends' == $type) {
if ($classReflection->isSubclassOf($subject)) {
$extensions = array_merge($extensions, $extensionList);
}
}
if ('uses' == $type) {
if ($this->hasTrait($classReflection, $subject)) {
$extensions = array_merge($extensions, $extensionList);
}
}
}
}
if (isset($excludes[$id])) {
$extensions = array_diff_key($extensions, $excludes[$id]);
}
return $extensions;
}
/**
* Resolves the class argument of the admin to an actual class (in case of %parameter%).
*
* @param Definition $admin
* @param ContainerBuilder $container
*
* @return string
*/
protected function getManagedClass(Definition $admin, ContainerBuilder $container)
{
return $container->getParameterBag()->resolveValue($admin->getArgument(1));
}
/**
* @param array $config
*
* @return array An array with the following structure.
*
* array(
* 'excludes' => array('<admin_id>' => array('<extension_id>' => array('priority' => <int>))),
* 'admins' => array('<admin_id>' => array('<extension_id>' => array('priority' => <int>))),
* 'implements' => array('<interface>' => array('<extension_id>' => array('priority' => <int>))),
* 'extends' => array('<class>' => array('<extension_id>' => array('priority' => <int>))),
* 'instanceof' => array('<class>' => array('<extension_id>' => array('priority' => <int>))),
* 'uses' => array('<trait>' => array('<extension_id>' => array('priority' => <int>))),
* )
*/
protected function flattenExtensionConfiguration(array $config)
{
$extensionMap = [
'excludes' => [],
'admins' => [],
'implements' => [],
'extends' => [],
'instanceof' => [],
'uses' => [],
];
foreach ($config as $extension => $options) {
$optionsMap = array_intersect_key($options, $extensionMap);
foreach ($optionsMap as $key => $value) {
foreach ($value as $source) {
if (!isset($extensionMap[$key][$source])) {
$extensionMap[$key][$source] = [];
}
$extensionMap[$key][$source][$extension]['priority'] = $options['priority'];
}
}
}
return $extensionMap;
}
/**
* @param \ReflectionClass $class
* @param $traitName
*
* @return bool
*/
protected function hasTrait(\ReflectionClass $class, $traitName)
{
if (in_array($traitName, $class->getTraitNames())) {
return true;
}
if (!$parentClass = $class->getParentClass()) {
return false;
}
return $this->hasTrait($parentClass, $traitName);
}
/**
* Add extension configuration to the targets array.
*
* @param array $targets
* @param string $target
* @param string $extension
* @param array $attributes
*/
private function addExtension(array &$targets, $target, $extension, array $attributes)
{
if (!isset($targets[$target])) {
$targets[$target] = new \SplPriorityQueue();
}
$priority = isset($attributes['priority']) ? $attributes['priority'] : 0;
$targets[$target]->insert(new Reference($extension), $priority);
}
}

View File

@@ -0,0 +1,31 @@
<?php
/*
* This file is part of the Sonata Project package.
*
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Sonata\AdminBundle\DependencyInjection\Compiler;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;
/**
* @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
*/
class GlobalVariablesCompilerPass implements CompilerPassInterface
{
/**
* {@inheritdoc}
*/
public function process(ContainerBuilder $container)
{
$container->getDefinition('twig')
->addMethodCall('addGlobal', ['sonata_admin', new Reference('sonata.admin.twig.global')]);
}
}