diff --git a/README.md b/README.md index da1badf..7256e9b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Inspired by the [OroCommerce Analytics/GTM Bundle](https://github.com/DivanteLtd Requirements ------------------- -* OroCommerce 5.0.X +* OroCommerce 6.0.X Installation and Usage ------------------- diff --git a/composer.json b/composer.json index c7da3a1..a57ba45 100644 --- a/composer.json +++ b/composer.json @@ -4,7 +4,7 @@ "description": "OroCommerce Bundle to inject Tracking Code (eg LogRocket, Hotjar, FullStory, etc)", "type": "project", "require": { - "oro/commerce": "5.0.*" + "oro/commerce": "6.0.*" }, "autoload": { "psr-4": { "HackOro\\CustomerTrackingBundle\\": "./src/" } diff --git a/src/DependencyInjection/CompilerPass/TrackerPass.php b/src/DependencyInjection/CompilerPass/TrackerPass.php index b90be39..8120fed 100644 --- a/src/DependencyInjection/CompilerPass/TrackerPass.php +++ b/src/DependencyInjection/CompilerPass/TrackerPass.php @@ -21,7 +21,7 @@ class TrackerPass implements CompilerPassInterface /** * {@inheritdoc} */ - public function process(ContainerBuilder $container) + public function process(ContainerBuilder $container): void { if (!$container->hasDefinition(self::REGISTRY_SERVICE)) { return; @@ -44,4 +44,4 @@ public function process(ContainerBuilder $container) $registryDefinition->addMethodCall('addTracker', [new Reference($tracker)]); } } -} \ No newline at end of file +} diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php index 5f938e4..e9a3e8a 100644 --- a/src/DependencyInjection/Configuration.php +++ b/src/DependencyInjection/Configuration.php @@ -33,10 +33,8 @@ class Configuration implements ConfigurationInterface /** * Generates the configuration tree builder. - * - * @return TreeBuilder The tree builder */ - public function getConfigTreeBuilder() + public function getConfigTreeBuilder(): TreeBuilder { $treeBuilder = new TreeBuilder(HackOroCustomerTrackingExtension::ALIAS); @@ -59,12 +57,7 @@ public function getConfigTreeBuilder() return $treeBuilder; } - - /** - * @param string $key - * @return string - */ - public static function getConfigKeyByName($key) + public static function getConfigKeyByName(string $key): string { return implode(ConfigManager::SECTION_MODEL_SEPARATOR, [HackOroCustomerTrackingExtension::ALIAS, $key]); } diff --git a/src/DependencyInjection/HackOroCustomerTrackingExtension.php b/src/DependencyInjection/HackOroCustomerTrackingExtension.php index 42821f3..10ed46d 100644 --- a/src/DependencyInjection/HackOroCustomerTrackingExtension.php +++ b/src/DependencyInjection/HackOroCustomerTrackingExtension.php @@ -21,7 +21,7 @@ class HackOroCustomerTrackingExtension extends Extension /** * @inheritdoc */ - public function load(array $configs, ContainerBuilder $container) + public function load(array $configs, ContainerBuilder $container): void { $configuration = new Configuration(); $config = $this->processConfiguration($configuration, $configs); diff --git a/src/HackOroCustomerTrackingBundle.php b/src/HackOroCustomerTrackingBundle.php index 41d0d15..27edcbb 100644 --- a/src/HackOroCustomerTrackingBundle.php +++ b/src/HackOroCustomerTrackingBundle.php @@ -18,7 +18,7 @@ class HackOroCustomerTrackingBundle extends Bundle /** * {@inheritdoc} */ - public function build(ContainerBuilder $container) + public function build(ContainerBuilder $container): void { parent::build($container); diff --git a/src/Layout/DataProvider/CustomerTrackingDataProvider.php b/src/Layout/DataProvider/CustomerTrackingDataProvider.php index 7d82351..13a1d7e 100644 --- a/src/Layout/DataProvider/CustomerTrackingDataProvider.php +++ b/src/Layout/DataProvider/CustomerTrackingDataProvider.php @@ -14,19 +14,14 @@ class CustomerTrackingDataProvider { - /** @var TrackerRegistry */ - private $trackerRegistry; + private TrackerRegistry $trackerRegistry; public function __construct(TrackerRegistry $trackerRegistry) { $this->trackerRegistry = $trackerRegistry; } - /** - * @param string $name - * @return AbstractTracker|null - */ - public function getTracker(string $name) + public function getTracker(string $name): ?AbstractTracker { return $this->trackerRegistry->getTracker($name); } diff --git a/src/Tracker/AbstractTracker.php b/src/Tracker/AbstractTracker.php index e857593..d31ab0f 100644 --- a/src/Tracker/AbstractTracker.php +++ b/src/Tracker/AbstractTracker.php @@ -14,8 +14,7 @@ abstract class AbstractTracker { - /** @var ConfigManager */ - protected $configManager; + protected ConfigManager $configManager; public function __construct(ConfigManager $configManager) { @@ -24,12 +23,7 @@ public function __construct(ConfigManager $configManager) abstract public function getName() : string; - /** - * @param string $name - * @param bool $default - * @return mixed - */ - public function getConfigValue(string $name, $default = false) + public function getConfigValue(string $name, bool $default = false): mixed { return $this->configManager->get(Configuration::getConfigKeyByName($name), $default); } diff --git a/src/Tracker/FullStoryTracker.php b/src/Tracker/FullStoryTracker.php index c12319d..e314f40 100644 --- a/src/Tracker/FullStoryTracker.php +++ b/src/Tracker/FullStoryTracker.php @@ -28,41 +28,26 @@ public function getName(): string return self::NAME; } - /** - * @return bool - */ public function isEnabled(): bool { return (bool) $this->getConfigValue(Configuration::FULLSTORY_IS_ENABLED); } - /** - * @return string - */ public function getOrg(): ?string { return $this->getConfigValue(Configuration::FULLSTORY_ORG); } - /** - * @return bool - */ public function getDebugEnabled(): bool { return (bool) $this->getConfigValue(Configuration::FULLSTORY_DEBUG_ENABLED); } - /** - * @return string - */ public function getNamespace(): ?string { return $this->getConfigValue(Configuration::FULLSTORY_NAMESPACE) ?? self::DEFAULT_NAMESPACE; } - /** - * @return string - */ public function getHost(): ?string { return self::HOST; diff --git a/src/Tracker/HotjarTracker.php b/src/Tracker/HotjarTracker.php index 67e842a..99a732c 100644 --- a/src/Tracker/HotjarTracker.php +++ b/src/Tracker/HotjarTracker.php @@ -20,17 +20,11 @@ public function getName(): string return self::NAME; } - /** - * @return bool - */ public function isEnabled(): bool { return (bool) $this->getConfigValue(Configuration::HOTJAR_IS_ENABLED); } - /** - * @return string - */ public function getSiteId(): ?string { return $this->getConfigValue(Configuration::HOTJAR_SITE_ID); diff --git a/src/Tracker/LogRocketTracker.php b/src/Tracker/LogRocketTracker.php index 311acf2..0d5ee63 100644 --- a/src/Tracker/LogRocketTracker.php +++ b/src/Tracker/LogRocketTracker.php @@ -22,8 +22,6 @@ public function getName(): string /** * Is LogRocket enabled? - * - * @return bool */ public function isEnabled(): bool { @@ -32,8 +30,6 @@ public function isEnabled(): bool /** * What is the LogRocket APP ID? - * - * @return string */ public function getAppId(): ?string { diff --git a/src/Tracker/TrackerRegistry.php b/src/Tracker/TrackerRegistry.php index dcf7b06..99e61fc 100644 --- a/src/Tracker/TrackerRegistry.php +++ b/src/Tracker/TrackerRegistry.php @@ -16,14 +16,12 @@ class TrackerRegistry /** * @var AbstractTracker[] */ - protected $trackers = []; + protected array $trackers = []; /** * Add tracker to the registry - * - * @param AbstractTracker $tracker */ - public function addTracker(AbstractTracker $tracker) + public function addTracker(AbstractTracker $tracker): void { if (array_key_exists($tracker->getName(), $this->trackers)) { throw new LogicException( @@ -37,7 +35,7 @@ public function addTracker(AbstractTracker $tracker) /** * @return AbstractTracker[] */ - public function getTrackers() + public function getTrackers(): array { return $this->trackers; } @@ -45,11 +43,9 @@ public function getTrackers() /** * Get tracker by name * - * @param string $name - * @return AbstractTracker * @throws LogicException Throw exception when tracker with specified name not found */ - public function getTracker($name) + public function getTracker(string $name): AbstractTracker { if (!array_key_exists($name, $this->trackers)) { throw new LogicException(