vendor/symfony/framework-bundle/Controller/ControllerNameParser.php line 62

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Controller;
  14. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  15. use Symfony\Component\HttpKernel\KernelInterface;
  17. /**
  18.  * ControllerNameParser converts controller from the short notation a:b:c
  19.  * (BlogBundle:Post:index) to a fully-qualified class::method string
  20.  * (Bundle\BlogBundle\Controller\PostController::indexAction).
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  *
  24.  * @deprecated since Symfony 4.1
  25.  */
  26. class ControllerNameParser
  27. {
  28.     protected $kernel;
  30.     public function __construct(KernelInterface $kernel)
  31.     {
  32.         $this->kernel = $kernel;
  33.     }
  35.     /**
  36.      * Converts a short notation a:b:c to a class::method.
  37.      *
  38.      * @param string $controller A short notation controller (a:b:c)
  39.      *
  40.      * @return string A string in the class::method notation
  41.      *
  42.      * @throws \InvalidArgumentException when the specified bundle is not enabled
  43.      *                                   or the controller cannot be found
  44.      */
  45.     public function parse($controller)
  46.     {
  47.         if (2 > \func_num_args() || func_get_arg(1)) {
  48.             @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.1.', __CLASS__), E_USER_DEPRECATED);
  49.         }
  51.         $parts = explode(':', $controller);
  52.         if (3 !== \count($parts) || \in_array('', $parts, true)) {
  53.             throw new \InvalidArgumentException(sprintf('The "%s" controller is not a valid "a:b:c" controller string.', $controller));
  54.         }
  56.         $originalController = $controller;
  57.         list($bundleName, $controller, $action) = $parts;
  58.         $controller = str_replace('/', '\\', $controller);
  60.         try {
  61.             // this throws an exception if there is no such bundle
  62.             $bundle = $this->kernel->getBundle($bundleName);
  63.         } catch (\InvalidArgumentException $e) {
  64.             $message = sprintf(
  65.                 'The "%s" (from the _controller value "%s") does not exist or is not enabled in your kernel!',
  66.                 $bundleName,
  67.                 $originalController
  68.             );
  70.             if ($alternative = $this->findAlternative($bundleName)) {
  71.                 $message .= sprintf(' Did you mean "%s:%s:%s"?', $alternative, $controller, $action);
  72.             }
  74.             throw new \InvalidArgumentException($message, 0, $e);
  75.         }
  77.         $try = $bundle->getNamespace().'\\Controller\\'.$controller.'Controller';
  78.         if (class_exists($try)) {
  79.             return $try.'::'.$action.'Action';
  80.         }
  82.         throw new \InvalidArgumentException(sprintf('The _controller value "%s:%s:%s" maps to a "%s" class, but this class was not found. Create this class or check the spelling of the class and its namespace.', $bundleName, $controller, $action, $try));
  83.     }
  85.     /**
  86.      * Converts a class::method notation to a short one (a:b:c).
  87.      *
  88.      * @param string $controller A string in the class::method notation
  89.      *
  90.      * @return string A short notation controller (a:b:c)
  91.      *
  92.      * @throws \InvalidArgumentException when the controller is not valid or cannot be found in any bundle
  93.      */
  94.     public function build($controller)
  95.     {
  96.         @trigger_error(sprintf('The %s class is deprecated since Symfony 4.1.', __CLASS__), E_USER_DEPRECATED);
  98.         if (0 === preg_match('#^(.*?\\\\Controller\\\\(.+)Controller)::(.+)Action$#', $controller, $match)) {
  99.             throw new \InvalidArgumentException(sprintf('The "%s" controller is not a valid "class::method" string.', $controller));
  100.         }
  102.         $className = $match[1];
  103.         $controllerName = $match[2];
  104.         $actionName = $match[3];
  105.         foreach ($this->kernel->getBundles() as $name => $bundle) {
  106.             if (0 !== strpos($className, $bundle->getNamespace())) {
  107.                 continue;
  108.             }
  110.             return sprintf('%s:%s:%s', $name, $controllerName, $actionName);
  111.         }
  113.         throw new \InvalidArgumentException(sprintf('Unable to find a bundle that defines controller "%s".', $controller));
  114.     }
  116.     /**
  117.      * Attempts to find a bundle that is *similar* to the given bundle name.
  118.      */
  119.     private function findAlternative(string $nonExistentBundleName): ?string
  120.     {
  121.         $bundleNames = array_map(function (BundleInterface $b) {
  122.             return $b->getName();
  123.         }, $this->kernel->getBundles());
  125.         $alternative = null;
  126.         $shortest = null;
  127.         foreach ($bundleNames as $bundleName) {
  128.             // if there's a partial match, return it immediately
  129.             if (false !== strpos($bundleName, $nonExistentBundleName)) {
  130.                 return $bundleName;
  131.             }
  133.             $lev = levenshtein($nonExistentBundleName, $bundleName);
  134.             if ($lev <= \strlen($nonExistentBundleName) / 3 && (null === $alternative || $lev < $shortest)) {
  135.                 $alternative = $bundleName;
  136.                 $shortest = $lev;
  137.             }
  138.         }
  140.         return $alternative;
  141.     }
  142. }