vendor/coreshop/resource/Metadata/Metadata.php line 110

Open in your IDE?
  1. <?php
  2. /**
  3.  * CoreShop.
  4.  *
  5.  * This source file is subject to the GNU General Public License version 3 (GPLv3)
  6.  * For the full copyright and license information, please view the LICENSE.md and gpl-3.0.txt
  7.  * files that are distributed with this source code.
  8.  *
  9.  * @copyright  Copyright (c) 2015-2020 Dominik Pfaffenbauer (https://www.pfaffenbauer.at)
  10.  * @license    https://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  11.  */
  13. namespace CoreShop\Component\Resource\Metadata;
  15. use Doctrine\Common\Inflector\Inflector;
  17. final class Metadata implements MetadataInterface
  18. {
  19.     /**
  20.      * @var string
  21.      */
  22.     private $name;
  24.     /**
  25.      * @var string
  26.      */
  27.     private $applicationName;
  29.     /**
  30.      * @var string
  31.      */
  32.     private $driver;
  34.     /**
  35.      * @var string
  36.      */
  37.     private $templatesNamespace;
  39.     /**
  40.      * @var array
  41.      */
  42.     private $parameters;
  44.     /**
  45.      * @param string $name
  46.      * @param string $applicationName
  47.      * @param array  $parameters
  48.      */
  49.     private function __construct($name, $applicationName, array $parameters)
  50.     {
  51.         $this->name = $name;
  52.         $this->applicationName = $applicationName;
  54.         $this->driver = $parameters['driver'];
  55.         $this->templatesNamespace = array_key_exists('templates', $parameters) ? $parameters['templates'] : null;
  57.         $this->parameters = $parameters;
  58.     }
  60.     /**
  61.      * @param string $alias
  62.      * @param array  $parameters
  63.      *
  64.      * @return self
  65.      */
  66.     public static function fromAliasAndConfiguration($alias, array $parameters)
  67.     {
  68.         list($applicationName, $name) = self::parseAlias($alias);
  70.         return new self($name, $applicationName, $parameters);
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function getAlias()
  77.     {
  78.         return $this->applicationName . '.' . $this->name;
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function getApplicationName()
  85.     {
  86.         return $this->applicationName;
  87.     }
  89.     /**
  90.      * {@inheritdoc}
  91.      */
  92.     public function getName()
  93.     {
  94.         return $this->name;
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      */
  100.     public function getHumanizedName()
  101.     {
  102.         return trim(strtolower(preg_replace(['/([A-Z])/', '/[_\s]+/'], ['_$1', ' '], $this->name)));
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function getPluralName()
  109.     {
  110.         return Inflector::pluralize($this->name);
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function getDriver()
  117.     {
  118.         return $this->driver;
  119.     }
  121.     /**
  122.      * {@inheritdoc}
  123.      */
  124.     public function getTemplatesNamespace()
  125.     {
  126.         return $this->templatesNamespace;
  127.     }
  129.     /**
  130.      * {@inheritdoc}
  131.      */
  132.     public function getParameter($name)
  133.     {
  134.         if (!$this->hasParameter($name)) {
  135.             throw new \InvalidArgumentException(sprintf('Parameter "%s" is not configured for resource "%s".', $name, $this->getAlias()));
  136.         }
  138.         return $this->parameters[$name];
  139.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      */
  144.     public function hasParameter($name)
  145.     {
  146.         return array_key_exists($name, $this->parameters);
  147.     }
  149.     /**
  150.      * {@inheritdoc}
  151.      */
  152.     public function getParameters()
  153.     {
  154.         return $this->parameters;
  155.     }
  157.     /**
  158.      * {@inheritdoc}
  159.      */
  160.     public function getClass($name)
  161.     {
  162.         if (!$this->hasClass($name)) {
  163.             throw new \InvalidArgumentException(sprintf('Class "%s" is not configured for resource "%s".', $name, $this->getAlias()));
  164.         }
  166.         return $this->parameters['classes'][$name];
  167.     }
  169.     /**
  170.      * {@inheritdoc}
  171.      */
  172.     public function hasClass($name)
  173.     {
  174.         return isset($this->parameters['classes'][$name]);
  175.     }
  177.     /**
  178.      * {@inheritdoc}
  179.      */
  180.     public function getServiceId($serviceName)
  181.     {
  182.         return sprintf('%s.%s.%s', $this->applicationName, $serviceName, $this->name);
  183.     }
  185.     /**
  186.      * {@inheritdoc}
  187.      */
  188.     public function getPermissionCode($permissionName)
  189.     {
  190.         return sprintf('%s.%s.%s', $this->applicationName, $this->name, $permissionName);
  191.     }
  193.     /**
  194.      * @param string $alias
  195.      *
  196.      * @return array
  197.      */
  198.     private static function parseAlias($alias)
  199.     {
  200.         if (false === strpos($alias, '.')) {
  201.             throw new \InvalidArgumentException('Invalid alias supplied, it should conform to the following format "<applicationName>.<name>".');
  202.         }
  204.         return explode('.', $alias);
  205.     }
  206. }