apps/artisancommerce/custom-theme/src/CustomThemePackage.php line 14

Open in your IDE?
  1. <?php
  3. namespace UVDesk\CommunityPackages\ArtisanCommerce\CustomTheme;
  5. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  6. use Symfony\Component\Config\Definition\ConfigurationInterface;
  7. use Symfony\Component\DependencyInjection\ContainerBuilder;
  8. use Symfony\Component\HttpKernel\Bundle\Bundle;
  9. use Webkul\UVDesk\ExtensionFrameworkBundle\Definition\Package\PackageInterface;
  10. use Webkul\UVDesk\ExtensionFrameworkBundle\Definition\Package\ConfigurablePackageInterface;
  11. use UVDesk\CommunityPackages\ArtisanCommerce\CustomTheme\DependencyInjection\Compiler\TwigPathPass;
  12. use Psr\Log\LoggerInterface;
  14. class CustomThemePackage extends Bundle implements PackageInterface, ConfigurablePackageInterface
  15. {
  16. private $metadata;
  17. private $configurationFilepath;
  18. private $configurationParameters = [];
  19. private $logger;
  20. private $debugMode = true;
  22. public function __construct(LoggerInterface $logger = null)
  23. {
  24. $this->logger = $logger;
  26. if ($this->debugMode && $this->logger) {
  27. $this->logger->info('[CustomThemePackage] Package instantiated', [
  28. 'class' => self::class,
  29. 'timestamp' => date('Y-m-d H:i:s')
  30. ]);
  31. }
  32. }
  34. /**
  35. * Symfony Bundle lifecycle: Register compiler passes
  36. */
  37. public function build(ContainerBuilder $container): void
  38. {
  39. parent::build($container);
  41. // Register the Twig path compiler pass
  42. $container->addCompilerPass(new TwigPathPass());
  43. }
  45. /**
  46. * UVDesk installation hook - called during uvdesk:configure-extension
  47. * This is where we auto-register the bundle in config/bundles.php
  48. */
  49. public function install(): void
  50. {
  51. $this->registerBundle();
  52. $this->createConfigurationFile();
  53. }
  55. /**
  56. * Auto-register this bundle in config/bundles.php
  57. */
  58. private function registerBundle(): void
  59. {
  60. // Find project root by traversing up from package root
  61. $projectRoot = $this->findProjectRoot();
  63. if (!$projectRoot) {
  64. if ($this->logger) {
  65. $this->logger->error('[CustomThemePackage] Could not determine project root');
  66. }
  67. return;
  68. }
  70. $bundlesFile = $projectRoot . '/config/bundles.php';
  72. if (!file_exists($bundlesFile)) {
  73. if ($this->logger) {
  74. $this->logger->warning('[CustomThemePackage] bundles.php not found', [
  75. 'expected_path' => $bundlesFile
  76. ]);
  77. }
  78. return;
  79. }
  81. // Load current bundles
  82. $bundles = include $bundlesFile;
  83. $bundleClass = self::class;
  85. // Check if already registered
  86. if (isset($bundles[$bundleClass])) {
  87. if ($this->logger) {
  88. $this->logger->info('[CustomThemePackage] Bundle already registered');
  89. }
  90. return;
  91. }
  93. // Add this bundle to the list
  94. $bundles[$bundleClass] = ['all' => true];
  96. // Generate new bundles.php content
  97. $content = "<?php\n\nreturn [\n";
  98. foreach ($bundles as $class => $envs) {
  99. $envsStr = var_export($envs, true);
  100. $content .= " {$class}::class => {$envsStr},\n";
  101. }
  102. $content .= "];\n";
  104. // Write back to bundles.php
  105. if (file_put_contents($bundlesFile, $content) !== false) {
  106. if ($this->logger) {
  107. $this->logger->info('[CustomThemePackage] Successfully auto-registered bundle', [
  108. 'bundle_class' => $bundleClass,
  109. 'bundles_file' => $bundlesFile
  110. ]);
  111. }
  112. } else {
  113. if ($this->logger) {
  114. $this->logger->error('[CustomThemePackage] Failed to write bundles.php', [
  115. 'bundles_file' => $bundlesFile
  116. ]);
  117. }
  118. }
  119. }
  121. /**
  122. * Create the configuration file required by ConfigurablePackageInterface
  123. */
  124. //private function createConfigurationFile(): void
  125. //{
  126. // if (!empty($this->configurationFilepath)) {
  127. // $configDir = dirname($this->configurationFilepath);
  128. //
  129. // if (!file_exists($configDir)) {
  130. // mkdir($configDir, 0755, true);
  131. // }
  132. //
  133. // if (!file_exists($this->configurationFilepath)) {
  134. // // Create empty configuration file
  135. // $content = "# Custom Theme Package Configuration\ncustom_theme: []\n";
  136. // file_put_contents($this->configurationFilepath, $content);
  137. //
  138. // if ($this->logger) {
  139. // $this->logger->info('[CustomThemePackage] Created configuration file', [
  140. // 'config_file' => $this->configurationFilepath
  141. // ]);
  142. // }
  143. // }
  144. // }
  145. //}
  147. /**
  148. * Create the configuration file with full default values
  149. * Called during install() - ensures config is ready immediately after installation
  150. */
  151. private function createConfigurationFile(): void
  152. {
  153. if (!empty($this->configurationFilepath)) {
  154. $configDir = dirname($this->configurationFilepath);
  156. if (!file_exists($configDir)) {
  157. mkdir($configDir, 0755, true);
  158. }
  160. if (!file_exists($this->configurationFilepath)) {
  161. // Create configuration file with full defaults
  162. $content = <<<YAML
  163. # =============================================================================
  164. # Custom Theme Package Configuration
  165. # =============================================================================
  166. # This file is automatically generated during module installation.
  167. # You can edit these values to customize the module's behavior.
  168. # After making changes, run: php bin/console cache:clear
  169. # =============================================================================
  171. custom_theme:
  173. # Login Tracking Settings
  174. # Track user login sessions, monitor session duration, and view detailed history
  175. login_tracking:
  176. enabled: true # Enable/disable login tracking
  177. session_timeout: 3600 # Session timeout in seconds (default: 1 hour)
  178. max_display_sessions: 100 # Maximum sessions to display in dashboard
  179. track_ip: true # Track IP addresses for sessions
  181. # Theme Customization Settings
  182. # Customize the look and feel of your helpdesk
  183. theme:
  184. enabled: true # Enable custom theme
  185. color_scheme: default # Color scheme: default, dark, light
  186. custom_css: false # Enable custom CSS injection
  188. # Display Preferences
  189. # Configure date/time formats and timezone
  190. display:
  191. date_format: 'd.m.Y' # PHP date() format for dates
  192. time_format: 'H:i:s' # PHP date() format for times
  193. timezone: 'Europe/Vienna' # Default timezone (PHP timezone string)
  195. YAML;
  197. file_put_contents($this->configurationFilepath, $content);
  199. if ($this->logger) {
  200. $this->logger->info('[CustomThemePackage] Created configuration file with defaults', [
  201. 'config_file' => $this->configurationFilepath
  202. ]);
  203. }
  204. }
  205. }
  206. }
  208. /**
  209. * Find project root by traversing up from package location
  210. */
  211. private function findProjectRoot(): ?string
  212. {
  213. $current = __DIR__;
  215. // Traverse up looking for config/bundles.php
  216. for ($i = 0; $i < 10; $i++) {
  217. $current = dirname($current);
  218. if (file_exists($current . '/config/bundles.php')) {
  219. return $current;
  220. }
  221. }
  223. return null;
  224. }
  226. // ========================================
  227. // ConfigurablePackageInterface Methods
  228. // ========================================
  230. //public function getConfiguration(): ConfigurationInterface
  231. //{
  232. // // Return empty configuration schema (required by interface)
  233. // return new class implements ConfigurationInterface {
  234. // public function getConfigTreeBuilder()
  235. // {
  236. // $treeBuilder = new TreeBuilder('custom_theme');
  237. // $rootNode = $treeBuilder->getRootNode();
  238. //
  239. // // Empty configuration - no parameters needed
  240. // return $treeBuilder;
  241. // }
  242. // };
  243. //}
  245. public function getConfiguration(): ConfigurationInterface
  246. {
  247. return new class implements ConfigurationInterface {
  248. public function getConfigTreeBuilder()
  249. {
  250. $treeBuilder = new TreeBuilder('custom_theme');
  251. $rootNode = $treeBuilder->getRootNode();
  253. $rootNode
  254. ->children()
  255. // Login Tracking Settings
  256. ->arrayNode('login_tracking')
  257. ->addDefaultsIfNotSet()
  258. ->children()
  259. ->booleanNode('enabled')
  260. ->defaultTrue()
  261. ->info('Enable login tracking')
  262. ->end()
  263. ->integerNode('session_timeout')
  264. ->defaultValue(3600)
  265. ->min(300)
  266. ->max(86400)
  267. ->info('Session timeout in seconds')
  268. ->end()
  269. ->integerNode('max_display_sessions')
  270. ->defaultValue(100)
  271. ->min(10)
  272. ->max(1000)
  273. ->info('Maximum sessions to display in dashboard')
  274. ->end()
  275. ->booleanNode('track_ip')
  276. ->defaultTrue()
  277. ->info('Track IP addresses')
  278. ->end()
  279. ->end()
  280. ->end()
  282. // Theme Settings
  283. ->arrayNode('theme')
  284. ->addDefaultsIfNotSet()
  285. ->children()
  286. ->booleanNode('enabled')
  287. ->defaultTrue()
  288. ->info('Enable custom theme')
  289. ->end()
  290. ->scalarNode('color_scheme')
  291. ->defaultValue('default')
  292. ->info('Color scheme (default, dark, light)')
  293. ->end()
  294. ->scalarNode('icon_border_radius')
  295. ->defaultValue('50%')
  296. ->info('Dashboard icon border radius (e.g. 50% or 12px)')
  297. ->end()
  298. ->booleanNode('custom_css')
  299. ->defaultFalse()
  300. ->info('Enable custom CSS')
  301. ->end()
  302. ->end()
  303. ->end()
  305. // Display Preferences
  306. ->arrayNode('display')
  307. ->addDefaultsIfNotSet()
  308. ->children()
  309. ->scalarNode('date_format')
  310. ->defaultValue('d.m.Y')
  311. ->info('Date format (PHP date() format)')
  312. ->end()
  313. ->scalarNode('time_format')
  314. ->defaultValue('H:i:s')
  315. ->info('Time format (PHP date() format)')
  316. ->end()
  317. ->scalarNode('timezone')
  318. ->defaultValue('Europe/Vienna')
  319. ->info('Default timezone')
  320. ->end()
  321. ->end()
  322. ->end()
  323. ->end()
  324. ->end();
  326. return $treeBuilder;
  327. }
  328. };
  329. }
  331. public function setConfigurationFilepath(string $configurationFilepath): ConfigurablePackageInterface
  332. {
  333. if (empty($this->configurationFilepath)) {
  334. $this->configurationFilepath = $configurationFilepath;
  335. }
  336. return $this;
  337. }
  339. public function getConfigurationFilepath(): string
  340. {
  341. return $this->configurationFilepath ?? '';
  342. }
  344. public function setConfigurationParameters(array $configurationParameters): ConfigurablePackageInterface
  345. {
  346. if (empty($this->configurationParameters)) {
  347. $this->configurationParameters = $configurationParameters;
  348. }
  349. return $this;
  350. }
  352. public function getConfigurationParameters(): array
  353. {
  354. return $this->configurationParameters;
  355. }
  357. // ========================================
  358. // PackageInterface Methods
  359. // ========================================
  361. final public function setMetadata(\Webkul\UVDesk\ExtensionFrameworkBundle\Definition\Package\PackageMetadata $metadata): PackageInterface
  362. {
  363. $this->metadata = $metadata;
  364. return $this;
  365. }
  367. final public function getMetadata(): \Webkul\UVDesk\ExtensionFrameworkBundle\Definition\Package\PackageMetadata
  368. {
  369. return $this->metadata;
  370. }
  372. // ========================================
  373. // Symfony Bundle Methods
  374. // ========================================
  376. public function getContainerExtension()
  377. {
  378. if (null === $this->extension) {
  379. $this->extension = new \UVDesk\CommunityPackages\ArtisanCommerce\CustomTheme\DependencyInjection\CustomThemeExtension();
  380. }
  382. return $this->extension;
  383. }
  385. public function isMetadataSet(): bool
  386. {
  387. try {
  388. return $this->metadata !== null;
  389. } catch (\Exception $e) {
  390. return false;
  391. }
  392. }
  394. public function getDebugInfo(): array
  395. {
  396. $info = [
  397. 'class' => self::class,
  398. 'is_metadata_set' => $this->isMetadataSet(),
  399. 'metadata' => null,
  400. 'package_file' => __FILE__,
  401. 'timestamp' => date('Y-m-d H:i:s'),
  402. 'configuration_filepath' => $this->configurationFilepath ?? 'not set'
  403. ];
  405. if ($this->isMetadataSet()) {
  406. $metadata = $this->getMetadata();
  407. $info['metadata'] = [
  408. 'name' => $metadata->getName(),
  409. 'description' => $metadata->getDescription(),
  410. 'type' => $metadata->getType(),
  411. 'vendor' => $metadata->getVendor(),
  412. 'package' => $metadata->getPackage(),
  413. 'root' => $metadata->getRoot(),
  414. 'namespaces' => $metadata->getDefinedNamespaces(),
  415. 'package_references' => $metadata->getPackageReferences()
  416. ];
  417. }
  419. return $info;
  420. }
  421. }