diff --git a/hovercss.install b/hovercss.install index de83282..4bc1172 100644 --- a/hovercss.install +++ b/hovercss.install @@ -1,5 +1,8 @@ getLibraryByName('hovercss', 'hover.css'); $library_exist_css = FALSE; @@ -49,7 +52,7 @@ function hovercss_requirements($phase) { $requirements['hovercss'] = [ 'title' => t('Hover.css library'), 'value' => $library_exist_css ? t('Installed') : t('Not installed'), - 'severity' => $library_exist_css ? REQUIREMENT_OK : REQUIREMENT_ERROR, + 'severity' => $library_exist_css ? DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.2.0', fn() => RequirementSeverity::OK, fn() => REQUIREMENT_OK) : DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.2.0', fn() => RequirementSeverity::Error, fn() => REQUIREMENT_ERROR), 'description' => $description, ]; diff --git a/hovercss.module b/hovercss.module index 33a476b..98cd5aa 100644 --- a/hovercss.module +++ b/hovercss.module @@ -17,34 +17,17 @@ * * Copyright (C) 2013-2023 Ian Lunn */ - +use Drupal\Core\Hook\Attribute\LegacyHook; +use Drupal\hovercss\Hook\HovercssHooks; use Drupal\Core\Installer\InstallerKernel; use Drupal\Core\Routing\RouteMatchInterface; /** * Implements hook_help(). */ +#[LegacyHook] function hovercss_help($route_name, RouteMatchInterface $route_match) { - switch ($route_name) { - case 'help.page.hovercss': - $output = '

' . t('About') . '

'; - $output .= '

' . t('The HoverCSS is a module that aims to integrate Hover.css library with Drupal. Hover.css is a collection of CSS3 powered hover effects to be applied to links, buttons, logos, SVG, featured images and so on. Easily apply to your own elements, modify or just use for inspiration. Available in CSS, Sass, and LESS.', [':hover_library' => 'https://ianlunn.github.io/Hover/']) . '

'; - $output .= '

' . t('Uses') . '

'; - $output .= '
'; - $output .= '
' . t('Basic usage') . '
'; - $output .= '

' . t('Add the hover effect class to an element, along with any of the effects names (do not forget the hvr- prefix!)') . '

'; - $output .= '
';
-      $output .= '<a class="button hvr-grow">Add to Basket</a>' . "\n";
-      $output .= '
'; - $output .= '
' . t('Usage with Javascript') . '
'; - $output .= '

' . t('You can do a whole bunch of other stuff with hover.css when you combine it with Javascript.') . '

'; - $output .= '
';
-      $output .= "const element = document.querySelector('.my-element');" . "\n";
-      $output .= "element.classList.add('hvr-grow');";
-      $output .= '
'; - $output .= '
'; - return $output; - } + return \Drupal::service(HovercssHooks::class)->help($route_name, $route_match); } /** @@ -55,7 +38,7 @@ function hovercss_help($route_name, RouteMatchInterface $route_match) { */ function hovercss_check_installed() { // Throw error if hovercss.css library file not found. - /** @var Drupal\Core\Asset\LibraryDiscovery $library_discovery */ + /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */ $library_discovery = \Drupal::service('library.discovery'); $library_exists = FALSE; $definition = $library_discovery->getLibraryByName('hovercss', 'hover.css'); @@ -71,22 +54,10 @@ function hovercss_check_installed() { /** * Implements hook_page_attachments(). */ -function hovercss_page_attachments(array &$attachments) { - // Don't add the Library during installation. - if (InstallerKernel::installationAttempted()) { - return; - } - - // Check first HoverCSS UI module in not installed and library not exists. - $moduleHandler = \Drupal::service('module_handler'); - if (!$moduleHandler->moduleExists('hovercss_ui')) { - if (hovercss_check_installed()) { - $attachments['#attached']['library'][] = 'hovercss/hover.css'; - } - else { - $attachments['#attached']['library'][] = 'hovercss/hover.cdn'; - } - } +#[LegacyHook] +function hovercss_page_attachments(array &$attachments) +{ + \Drupal::service(HovercssHooks::class)->pageAttachments($attachments); } /** diff --git a/hovercss.services.yml b/hovercss.services.yml new file mode 100644 index 0000000..5516beb --- /dev/null +++ b/hovercss.services.yml @@ -0,0 +1,5 @@ + +services: + Drupal\hovercss\Hook\HovercssHooks: + class: Drupal\hovercss\Hook\HovercssHooks + autowire: true diff --git a/hovercss_ui/hovercss_ui.install b/hovercss_ui/hovercss_ui.install index 04da959..b2dd980 100644 --- a/hovercss_ui/hovercss_ui.install +++ b/hovercss_ui/hovercss_ui.install @@ -4,7 +4,7 @@ * @file * Install, update and uninstall functions for the HoverCSS module. */ - +use Drupal\Component\Utility\DeprecationHelper; use Drupal\Core\Url; /** @@ -105,5 +105,5 @@ function hovercss_ui_update_8000() { $config = $config_factory->getEditable('hovercss.settings'); // Add new hide configuration field. $config->set('hide', FALSE); - $config->save(TRUE); + DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.4.0', fn() => $config->save(), fn() => $config->save(TRUE)); } diff --git a/hovercss_ui/hovercss_ui.module b/hovercss_ui/hovercss_ui.module index a72f830..5181479 100644 --- a/hovercss_ui/hovercss_ui.module +++ b/hovercss_ui/hovercss_ui.module @@ -17,7 +17,8 @@ * * Copyright (C) 2013-2023 Ian Lunn */ - +use Drupal\Core\Hook\Attribute\LegacyHook; +use Drupal\hovercss_ui\Hook\HovercssUiHooks; use Drupal\Core\Asset\AttachedAssetsInterface; use Drupal\Core\Installer\InstallerKernel; use Drupal\Core\Routing\RouteMatchInterface; @@ -28,227 +29,27 @@ use Symfony\Component\HttpFoundation\RequestStack; /** * Implements hook_help(). */ +#[LegacyHook] function hovercss_ui_help($route_name, RouteMatchInterface $route_match) { - switch ($route_name) { - case 'help.page.hovercss_ui': - $output = '

' . t('About') . '

'; - $output .= '

' . t('HoverCSS UI is a innovative and powerful Drupal module that provides hover effect dynamically, enhancing site interactivity with awesome animations.') . '

'; - $output .= '

' . t('Usage') . '

'; - $output .= '
'; - $output .= '
' . t('Hover admin page') . '
'; - $output .= '

' . t('Go to Hover CSS admin overview page in your Drupal administration configuration menu.', [':hovercss_admin' => Url::fromRoute('hovercss.admin')->setAbsolute()->toString()]) . '

'; - $output .= '

' . t('Click on Add effect button in top of the hover css admin overview page.', [':add_effect' => Url::fromRoute('hovercss.add')->setAbsolute()->toString()]) . '

'; - $output .= '

' . t('Enter valid selector, you can use HTML tag, class with dot(.) and ID with hash(#) prefix.') . '

'; - $output .= '

' . t('Then you can add hover effect.') . '

'; - $output .= '

' . t('Save effect and that`s it, Enjoy animation with Hover!') . '

'; - $output .= '
'; - $output .= '
' . t('HoverCSS global configuration page') . '
'; - $output .= '

' . t('Go to Hover CSS settings page in your Drupal configuration menu.', [':hovercss_settings' => Url::fromRoute('hovercss.settings')->setAbsolute()->toString()]) . '

'; - $output .= '

' . t('You can change default setting options if you need such as:') . '

'; - $output .= '
'; - $output .= '
'; - $output .= '
'; - $output .= '

' . t('Additional Information') . '

'; - $output .= '

' . t('Pick existing valid selector you want to add hover effect by using right-click on your website, choose "Inspect" or "View page source (CTRL + U)" of context menu in your Chrome browser and find exact valid button class name.') . '

'; - $output .= '
'; - return $output; - } + return \Drupal::service(HovercssUiHooks::class)->help($route_name, $route_match); } /** * Implements hook_css_alter(). */ -function hovercss_ui_css_alter(&$css, AttachedAssetsInterface $assets) { - // Load the Hover.css configuration settings. - $config = \Drupal::config('hovercss.settings'); - $hover_library = []; - - if (_hovercss_ui_check_admin()) { - if (hovercss_check_installed()) { - $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-dev'); - } - else { - $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-cdn-dev'); - } - - $path = $hover_library['css'][0]['data'] ?? ''; - - if (isset($css[$path])) { - $css[$path]['group'] = 369; - - // Check hover.patch.css. - if ($config->get('patch')) { - $hover_patch = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-patch'); - $patch_path = $hover_patch['css'][0]['data'] ?? ''; - if (isset($css[$patch_path])) { - $css[$patch_path]['group'] = 396; - } - } - } - } - - // Don't include Hover.css library if the user has opted out of loading it. - if (!$config->get('load')) { - return TRUE; - } - - // Don't add the Hover.css on specified paths. - if (!_hovercss_ui_check_url()) { - return TRUE; - } - - // Check Hover.css with chosen method. - $method = hovercss_check_installed() ? $config->get('method') : 'cdn'; - - // Check for development and production version. - $variant_options = ['source', 'minified']; - $variant = $variant_options[$config->get('minimized.options')]; - - if ($method == 'cdn') { - // Check variant Hover.css is CDN. - switch ($variant) { - case 'minified': - $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-cdn'); - break; - - case 'source': - $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-cdn-dev'); - break; - } - } - else { - // Check variant Hover.css is local. - switch ($variant) { - case 'minified': - $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-css'); - break; - - case 'source': - $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-dev'); - break; - } - } - - $path = $hover_library['css'][0]['data'] ?? ''; - - if (isset($css[$path])) { - $css[$path]['group'] = 369; - - // Check hover.patch.css. - if ($config->get('patch')) { - $hover_patch = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-patch'); - $patch_path = $hover_patch['css'][0]['data'] ?? ''; - if (isset($css[$patch_path])) { - $css[$patch_path]['group'] = 396; - } - } - } +#[LegacyHook] +function hovercss_ui_css_alter(&$css, AttachedAssetsInterface $assets) +{ + return \Drupal::service(HovercssUiHooks::class)->cssAlter($css, $assets); } /** * Implements hook_page_attachments(). */ -function hovercss_ui_page_attachments(array &$attachments) { - // Don't add the library during installation. - if (InstallerKernel::installationAttempted()) { - return; - } - - // Load the Hover.css configuration settings. - $config = \Drupal::config('hovercss.settings'); - - // Checking the path to load Hover.css for demo examples, - // It's just in HoverCSS configuration. - if (_hovercss_ui_check_admin()) { - $options = $config->get('options'); - $options['selector'] = '.hover__sample'; - - // Attach Hover.css for examples. - $attachments['#attached']['drupalSettings']['hovercss']['sample'] = $options; - if (hovercss_check_installed()) { - $attachments['#attached']['library'][] = 'hovercss_ui/hover-dev'; - } - else { - $attachments['#attached']['library'][] = 'hovercss_ui/hover-cdn-dev'; - } - - // Attach hover.patch.css for examples. - if ($config->get('patch')) { - $attachments['#attached']['library'][] = 'hovercss_ui/hover-patch'; - } - - $attachments['#attached']['library'][] = 'hovercss_ui/hover-admin'; - - return; - } - - // Don't include Hover.css library if the user has opted out of loading it. - if (!$config->get('load')) { - return TRUE; - } - - // Don't add the Hover.css on specified paths. - if (!_hovercss_ui_check_url()) { - return TRUE; - } - - // Check if config is an object. - if (is_object($config)) { - // Attach Hover.css by config. - _hovercss_ui_attach_library($attachments, $config); - } - - // Get selectors from config. - $options = $config->get('options'); - $hovered = []; - - // Load enabled hover selectors from database. - $results = \Drupal::service('hovercss.effect_manager')->loadHover()->fetchAll(); - if (count($results)) { - $selectors = []; - foreach ($results as $hover) { - $selectors[] = $hover->selector; - $hover_options = unserialize($hover->options, ['allowed_classes' => FALSE]); - $hovered[$hover->hid] = ['selector' => $hover->selector] + $hover_options; - } - - // Merge global selectors from config with database selectors. - if (count($config->get('options.selector')) && count($selectors)) { - $options['selector'] = array_diff($options['selector'], $selectors); - - // Attach config selectors after merge if there were any left. - if (count($options['selector'])) { - array_unshift($hovered, $options); - } - } - } - else { - // If global selectors are set, get the selectors from the configuration. - if (count($config->get('options.selector'))) { - $hovered = [$options]; - } - } - - // If there is hover selectors, then the init file - // with options will be added to the page. - if (count($hovered)) { - // Export settings. - $attachments['#attached']['drupalSettings']['hovercss']['elements'] = $hovered; - - // Init hover. - $attachments['#attached']['library'][] = 'hovercss_ui/hover-init'; - } +#[LegacyHook] +function hovercss_ui_page_attachments(array &$attachments) +{ + return \Drupal::service(HovercssUiHooks::class)->pageAttachments($attachments); } /** diff --git a/hovercss_ui/hovercss_ui.services.yml b/hovercss_ui/hovercss_ui.services.yml index 841f515..f841d9c 100644 --- a/hovercss_ui/hovercss_ui.services.yml +++ b/hovercss_ui/hovercss_ui.services.yml @@ -4,3 +4,7 @@ services: arguments: [ '@database' ] tags: - { name: backend_overridable } + + Drupal\hovercss_ui\Hook\HovercssUiHooks: + class: Drupal\hovercss_ui\Hook\HovercssUiHooks + autowire: true diff --git a/hovercss_ui/src/Hook/HovercssUiHooks.php b/hovercss_ui/src/Hook/HovercssUiHooks.php new file mode 100644 index 0000000..ece7af4 --- /dev/null +++ b/hovercss_ui/src/Hook/HovercssUiHooks.php @@ -0,0 +1,230 @@ +' . $this->t('About') . ''; + $output .= '

' . $this->t('HoverCSS UI is a innovative and powerful Drupal module that provides hover effect dynamically, enhancing site interactivity with awesome animations.') . '

'; + $output .= '

' . $this->t('Usage') . '

'; + $output .= '
'; + $output .= '
' . $this->t('Hover admin page') . '
'; + $output .= '

' . $this->t('Go to Hover CSS admin overview page in your Drupal administration configuration menu.', [ + ':hovercss_admin' => \Drupal\Core\Url::fromRoute('hovercss.admin')->setAbsolute()->toString(), + ]) . '

'; + $output .= '

' . $this->t('Click on Add effect button in top of the hover css admin overview page.', [ + ':add_effect' => \Drupal\Core\Url::fromRoute('hovercss.add')->setAbsolute()->toString(), + ]) . '

'; + $output .= '

' . $this->t('Enter valid selector, you can use HTML tag, class with dot(.) and ID with hash(#) prefix.') . '

'; + $output .= '

' . $this->t('Then you can add hover effect.') . '

'; + $output .= '

' . $this->t('Save effect and that`s it, Enjoy animation with Hover!') . '

'; + $output .= '
'; + $output .= '
' . $this->t('HoverCSS global configuration page') . '
'; + $output .= '

' . $this->t('Go to Hover CSS settings page in your Drupal configuration menu.', [ + ':hovercss_settings' => \Drupal\Core\Url::fromRoute('hovercss.settings')->setAbsolute()->toString(), + ]) . '

'; + $output .= '

' . $this->t('You can change default setting options if you need such as:') . '

'; + $output .= '
'; + $output .= '
'; + $output .= '
'; + $output .= '

' . $this->t('Additional Information') . '

'; + $output .= '

' . $this->t('Pick existing valid selector you want to add hover effect by using right-click on your website, choose "Inspect" or "View page source (CTRL + U)" of context menu in your Chrome browser and find exact valid button class name.') . '

'; + $output .= '
'; + return $output; + } + } + /** + * Implements hook_css_alter(). + */ + #[Hook('css_alter')] + public static function cssAlter(&$css, \Drupal\Core\Asset\AttachedAssetsInterface $assets) + { + // Load the Hover.css configuration settings. + $config = \Drupal::config('hovercss.settings'); + $hover_library = [ + ]; + if (_hovercss_ui_check_admin()) { + if (hovercss_check_installed()) { + $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-dev'); + } else { + $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-cdn-dev'); + } + $path = $hover_library['css'][0]['data'] ?? ''; + if (isset($css[$path])) { + $css[$path]['group'] = 369; + // Check hover.patch.css. + if ($config->get('patch')) { + $hover_patch = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-patch'); + $patch_path = $hover_patch['css'][0]['data'] ?? ''; + if (isset($css[$patch_path])) { + $css[$patch_path]['group'] = 396; + } + } + } + } + // Don't include Hover.css library if the user has opted out of loading it. + if (!$config->get('load')) { + return TRUE; + } + // Don't add the Hover.css on specified paths. + if (!_hovercss_ui_check_url()) { + return TRUE; + } + // Check Hover.css with chosen method. + $method = hovercss_check_installed() ? $config->get('method') : 'cdn'; + // Check for development and production version. + $variant_options = [ + 'source', + 'minified', + ]; + $variant = $variant_options[$config->get('minimized.options')]; + if ($method == 'cdn') { + // Check variant Hover.css is CDN. + switch ($variant) { + case 'minified': + $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-cdn'); + break; + case 'source': + $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-cdn-dev'); + break; + } + } else { + // Check variant Hover.css is local. + switch ($variant) { + case 'minified': + $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-css'); + break; + case 'source': + $hover_library = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-dev'); + break; + } + } + $path = $hover_library['css'][0]['data'] ?? ''; + if (isset($css[$path])) { + $css[$path]['group'] = 369; + // Check hover.patch.css. + if ($config->get('patch')) { + $hover_patch = \Drupal::service('library.discovery')->getLibraryByName('hovercss_ui', 'hover-patch'); + $patch_path = $hover_patch['css'][0]['data'] ?? ''; + if (isset($css[$patch_path])) { + $css[$patch_path]['group'] = 396; + } + } + } + } + /** + * Implements hook_page_attachments(). + */ + #[Hook('page_attachments')] + public static function pageAttachments(array &$attachments) + { + // Don't add the library during installation. + if (\Drupal\Core\Installer\InstallerKernel::installationAttempted()) { + return; + } + // Load the Hover.css configuration settings. + $config = \Drupal::config('hovercss.settings'); + // Checking the path to load Hover.css for demo examples, + // It's just in HoverCSS configuration. + if (_hovercss_ui_check_admin()) { + $options = $config->get('options'); + $options['selector'] = '.hover__sample'; + // Attach Hover.css for examples. + $attachments['#attached']['drupalSettings']['hovercss']['sample'] = $options; + if (hovercss_check_installed()) { + $attachments['#attached']['library'][] = 'hovercss_ui/hover-dev'; + } else { + $attachments['#attached']['library'][] = 'hovercss_ui/hover-cdn-dev'; + } + // Attach hover.patch.css for examples. + if ($config->get('patch')) { + $attachments['#attached']['library'][] = 'hovercss_ui/hover-patch'; + } + $attachments['#attached']['library'][] = 'hovercss_ui/hover-admin'; + return; + } + // Don't include Hover.css library if the user has opted out of loading it. + if (!$config->get('load')) { + return TRUE; + } + // Don't add the Hover.css on specified paths. + if (!_hovercss_ui_check_url()) { + return TRUE; + } + // Check if config is an object. + if (is_object($config)) { + // Attach Hover.css by config. + _hovercss_ui_attach_library($attachments, $config); + } + // Get selectors from config. + $options = $config->get('options'); + $hovered = [ + ]; + // Load enabled hover selectors from database. + $results = \Drupal::service('hovercss.effect_manager')->loadHover()->fetchAll(); + if (count($results)) { + $selectors = [ + ]; + foreach ($results as $hover) { + $selectors[] = $hover->selector; + $hover_options = unserialize($hover->options, [ + 'allowed_classes' => FALSE, + ]); + $hovered[$hover->hid] = [ + 'selector' => $hover->selector, + ] + $hover_options; + } + // Merge global selectors from config with database selectors. + if (count($config->get('options.selector')) && count($selectors)) { + $options['selector'] = array_diff($options['selector'], $selectors); + // Attach config selectors after merge if there were any left. + if (count($options['selector'])) { + array_unshift($hovered, $options); + } + } + } else if (count($config->get('options.selector'))) { + $hovered = [ + $options, + ]; + } + // If there is hover selectors, then the init file + // with options will be added to the page. + if (count($hovered)) { + // Export settings. + $attachments['#attached']['drupalSettings']['hovercss']['elements'] = $hovered; + // Init hover. + $attachments['#attached']['library'][] = 'hovercss_ui/hover-init'; + } + } +} diff --git a/src/Hook/HovercssHooks.php b/src/Hook/HovercssHooks.php new file mode 100644 index 0000000..a21034f --- /dev/null +++ b/src/Hook/HovercssHooks.php @@ -0,0 +1,64 @@ +' . $this->t('About') . ''; + $output .= '

' . $this->t('The HoverCSS is a module that aims to integrate Hover.css library with Drupal. Hover.css is a collection of CSS3 powered hover effects to be applied to links, buttons, logos, SVG, featured images and so on. Easily apply to your own elements, modify or just use for inspiration. Available in CSS, Sass, and LESS.', [ + ':hover_library' => 'https://ianlunn.github.io/Hover/', + ]) . '

'; + $output .= '

' . $this->t('Uses') . '

'; + $output .= '
'; + $output .= '
' . $this->t('Basic usage') . '
'; + $output .= '

' . $this->t('Add the hover effect class to an element, along with any of the effects names (do not forget the hvr- prefix!)') . '

'; + $output .= '
';
+                $output .= '<a class="button hvr-grow">Add to Basket</a>' . "\n";
+                $output .= '
'; + $output .= '
' . $this->t('Usage with Javascript') . '
'; + $output .= '

' . $this->t('You can do a whole bunch of other stuff with hover.css when you combine it with Javascript.') . '

'; + $output .= '
';
+                $output .= "const element = document.querySelector('.my-element');" . "\n";
+                $output .= "element.classList.add('hvr-grow');";
+                $output .= '
'; + $output .= '
'; + return $output; + } + } + /** + * Implements hook_page_attachments(). + */ + #[Hook('page_attachments')] + public static function pageAttachments(array &$attachments) + { + // Don't add the Library during installation. + if (\Drupal\Core\Installer\InstallerKernel::installationAttempted()) { + return; + } + // Check first HoverCSS UI module in not installed and library not exists. + $moduleHandler = \Drupal::service('module_handler'); + if (!$moduleHandler->moduleExists('hovercss_ui')) { + if (hovercss_check_installed()) { + $attachments['#attached']['library'][] = 'hovercss/hover.css'; + } else { + $attachments['#attached']['library'][] = 'hovercss/hover.cdn'; + } + } + } +}