diff --git a/block_class.info.yml b/block_class.info.yml index 7e699de..b9a6b10 100644 --- a/block_class.info.yml +++ b/block_class.info.yml @@ -3,6 +3,6 @@ type: module description: 'Allows assigning classes, attributes and ID to blocks.' package: User interface configure: block_class.settings -core_version_requirement: ^9 || ^10 || ^11 +core_version_requirement: ^10.1 || ^11 || ^12 dependencies: - drupal:block diff --git a/block_class.module b/block_class.module index aa068e9..1097c7e 100644 --- a/block_class.module +++ b/block_class.module @@ -5,6 +5,8 @@ * Adding classes to blocks. */ +use Drupal\Core\Hook\Attribute\LegacyHook; +use Drupal\block_class\Hook\BlockClassHooks; use Drupal\block\BlockInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Routing\RouteMatchInterface; @@ -12,129 +14,37 @@ use Drupal\Core\Routing\RouteMatchInterface; /** * Implements hook_help(). */ +#[LegacyHook] function block_class_help($route_name, RouteMatchInterface $route_match) { - switch ($route_name) { - - case 'help.page.block_class': - - $output = ''; - $output .= '

' . t('About') . '

'; - $output .= '

' . t("Block Class allows users to add classes to any block through the block's configuration interface. Hooray for more powerful block theming!") . '

'; - $output .= '

' . t('Usage') . '

'; - $output .= '
'; - $output .= '
' . t("To add a class to a block, simply visit that block's configuration page at Administration » Structure » Block Layout and click on Configure of the desired block.") . '
'; - $output .= '
' . t('The max-length by default is 255, after the 2.0.x version there is a Global Settings Page and you can modify if you need at: Configuration » Content authoring » Block Class') . '
'; - $output .= '
' . t('You can also add attributes in the multiple attributes field available in the block list as well. You can set the key and the value of the attributes that you want.') . '
'; - $output .= '
' . t("Remember that you can't use id attribute because is the Drupal's default, and you can't use attribute class because there is a specific field to use in class.") . '
'; - $output .= '
'; - $output .= '

' . t('Global Configuration') . '

'; - $output .= '
'; - $output .= '
' . t('Inside of global settings there are some possibilities to be used:') . '
'; - - $output .= ''; - - $output .= '

' . t('Block List') . '

'; - $output .= '
'; - $output .= '
' . t("You're able to see that at admin/config/content/block-class/list , on this list you're able to see all blocks that have block class added, and on this table you also can edit easily your block classes and if you need you can remove the block class using this page as well") . '
'; - $output .= '
'; - $output .= '

' . t('Bulk Operations') . '

'; - $output .= '
'; - $output .= '
' . t('There is a Bulk Operation to update classes automatically to help. To do this, you can go to Administration » Configuration » Content authoring » Block Class » Bulk Operations and there you can select some options:') . '
'; - $output .= '
' . t('Insert classes: With that option you can insert a class by default in all blocks that you have') . '
'; - $output .= '
' . t('Insert Attributes: With this option you can insert with a bulk operation attributes to all blocks that you have') . '
'; - $output .= '
' . t('Convert all attributes to uppercase: With this operation you can update all attributes that you have to use uppercase.') . '
'; - $output .= '
' . t('Convert all attributes to lowercase: With this operation you can update all attributes that you have to use lowercase.') . '
'; - $output .= '
' . t('Convert all block classes to uppercase: With this operation you can convert all block classes that you have to use uppercase.') . '
'; - $output .= '
' . t('Convert all block classes to lowercase: With this operation you can convert all block classes that you have to use lowercase.') . '
'; - $output .= '
' . t('Update class: With that option you can insert a current class that you have in the field "Current class" and in the other field "New class" you can insert the new class that you want to use. After this you\'ll be redirected to another page to review that and update all classes.') . '
'; - $output .= '
' . t("Delete all block classes: With this option, the bulk operation will remove all block classes on blocks. After this form you'll be redirected to another page to confirm that operation") . '
'; - $output .= '
' . t("Delete all attributes: With this option the bulk operation will remove all attributes on blocks. After this form you'll be redirected to another page to confirm that operation.") . '
'; - $output .= '
' . t('Insert Attributes: With this option you can insert with a bulk operation attributes to all blocks that you have') . '
'; - $output .= '
' . t("Delete all block classes: With this option, the bulk operation will remove all block classes on blocks. After this form you'll be redirected to another page to confirm that operation") . '
'; - $output .= '
'; - $output .= '

' . t('Block Class Documentation') . '

'; - $output .= '
'; - $output .= '
' . t('To see more information feel free to see our documentation at Drupal » Contributed Projects » Block Class') . '
'; - $output .= '
'; - - return $output; - } + return \Drupal::service(BlockClassHooks::class)->help($route_name, $route_match); } /** * Implements hook_ENTITY_TYPE_presave(). */ +#[LegacyHook] function block_class_block_presave(BlockInterface $entity) { - // Call the helper class to implement the presave logic. - \Drupal::service('block_class.helper')->blockClassPreSave($entity); + \Drupal::service(BlockClassHooks::class)->blockPresave($entity); } /** * Implements hook_form_FORM_ID_alter(). */ +#[LegacyHook] function block_class_form_block_form_alter(&$form, FormStateInterface $form_state, $form_id) { - // Call the helper class to implement the form alter logic. - \Drupal::service('block_class.helper')->blockClassFormAlter($form, $form_state); + \Drupal::service(BlockClassHooks::class)->formBlockFormAlter($form, $form_state, $form_id); } /** * Implements hook_form_FORM_ID_alter(). */ +#[LegacyHook] function block_class_form_block_class_admin_bulk_operations_alter(&$form, FormStateInterface $form_state, $form_id) { - - // Add the library for bulk operation. - $form['#attached']['library'][] = 'block_class/block-class'; - - // Get the config object. - $config = \Drupal::configFactory()->getEditable('block_class.settings'); - - // Get the default case on settings. - $default_case = $config->get('default_case', 'standard'); - - // Put the "default case" in the Drupal settings to be used in the JS. - $form['#attached']['drupalSettings']['block_class']['default_case'] = $default_case; - + \Drupal::service(BlockClassHooks::class)->formBlockClassAdminBulkOperationsAlter($form, $form_state, $form_id); } /** @@ -149,9 +59,9 @@ function block_class_form_block_form_validate(&$form, FormStateInterface $form_s /** * Implements hook_preprocess_HOOK(). */ +#[LegacyHook] function block_class_preprocess_block(&$variables) { - // Call the helper class to implement the preprocess block logic. - \Drupal::service('block_class.helper')->blockClassPreprocessBlock($variables); + \Drupal::service(BlockClassHooks::class)->preprocessBlock($variables); } diff --git a/block_class.services.yml b/block_class.services.yml index ae9f2b3..d16acaa 100644 --- a/block_class.services.yml +++ b/block_class.services.yml @@ -2,3 +2,7 @@ services: block_class.helper: class: Drupal\block_class\Service\BlockClassHelperService arguments: ['@config.factory', '@current_user', '@entity_type.manager'] + + Drupal\block_class\Hook\BlockClassHooks: + class: Drupal\block_class\Hook\BlockClassHooks + autowire: true diff --git a/src/Hook/BlockClassHooks.php b/src/Hook/BlockClassHooks.php new file mode 100644 index 0000000..10c4944 --- /dev/null +++ b/src/Hook/BlockClassHooks.php @@ -0,0 +1,138 @@ +' . $this->t('About') . ''; + $output .= '

' . $this->t("Block Class allows users to add classes to any block through the block's configuration interface. Hooray for more powerful block theming!") . '

'; + $output .= '

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

'; + $output .= '
'; + $output .= '
' . $this->t("To add a class to a block, simply visit that block's configuration page at Administration » Structure » Block Layout and click on Configure of the desired block.") . '
'; + $output .= '
' . $this->t('The max-length by default is 255, after the 2.0.x version there is a Global Settings Page and you can modify if you need at: Configuration » Content authoring » Block Class') . '
'; + $output .= '
' . $this->t('You can also add attributes in the multiple attributes field available in the block list as well. You can set the key and the value of the attributes that you want.') . '
'; + $output .= '
' . $this->t("Remember that you can't use id attribute because is the Drupal's default, and you can't use attribute class because there is a specific field to use in class.") . '
'; + $output .= '
'; + $output .= '

' . $this->t('Global Configuration') . '

'; + $output .= '
'; + $output .= '
' . $this->t('Inside of global settings there are some possibilities to be used:') . '
'; + $output .= ''; + $output .= '

' . $this->t('Block List') . '

'; + $output .= '
'; + $output .= '
' . $this->t("You're able to see that at admin/config/content/block-class/list , on this list you're able to see all blocks that have block class added, and on this table you also can edit easily your block classes and if you need you can remove the block class using this page as well") . '
'; + $output .= '
'; + $output .= '

' . $this->t('Bulk Operations') . '

'; + $output .= '
'; + $output .= '
' . $this->t('There is a Bulk Operation to update classes automatically to help. To do this, you can go to Administration » Configuration » Content authoring » Block Class » Bulk Operations and there you can select some options:') . '
'; + $output .= '
' . $this->t('Insert classes: With that option you can insert a class by default in all blocks that you have') . '
'; + $output .= '
' . $this->t('Insert Attributes: With this option you can insert with a bulk operation attributes to all blocks that you have') . '
'; + $output .= '
' . $this->t('Convert all attributes to uppercase: With this operation you can update all attributes that you have to use uppercase.') . '
'; + $output .= '
' . $this->t('Convert all attributes to lowercase: With this operation you can update all attributes that you have to use lowercase.') . '
'; + $output .= '
' . $this->t('Convert all block classes to uppercase: With this operation you can convert all block classes that you have to use uppercase.') . '
'; + $output .= '
' . $this->t('Convert all block classes to lowercase: With this operation you can convert all block classes that you have to use lowercase.') . '
'; + $output .= '
' . $this->t('Update class: With that option you can insert a current class that you have in the field "Current class" and in the other field "New class" you can insert the new class that you want to use. After this you\'ll be redirected to another page to review that and update all classes.') . '
'; + $output .= '
' . $this->t("Delete all block classes: With this option, the bulk operation will remove all block classes on blocks. After this form you'll be redirected to another page to confirm that operation") . '
'; + $output .= '
' . $this->t("Delete all attributes: With this option the bulk operation will remove all attributes on blocks. After this form you'll be redirected to another page to confirm that operation.") . '
'; + $output .= '
' . $this->t('Insert Attributes: With this option you can insert with a bulk operation attributes to all blocks that you have') . '
'; + $output .= '
' . $this->t("Delete all block classes: With this option, the bulk operation will remove all block classes on blocks. After this form you'll be redirected to another page to confirm that operation") . '
'; + $output .= '
'; + $output .= '

' . $this->t('Block Class Documentation') . '

'; + $output .= '
'; + $output .= '
' . $this->t('To see more information feel free to see our documentation at Drupal » Contributed Projects » Block Class') . '
'; + $output .= '
'; + return $output; + } + } + + /** + * Implements hook_ENTITY_TYPE_presave(). + */ + #[Hook('block_presave')] + public static function blockPresave(BlockInterface $entity) { + // Call the helper class to implement the presave logic. + \Drupal::service('block_class.helper')->blockClassPreSave($entity); + } + + /** + * Implements hook_form_FORM_ID_alter(). + */ + #[Hook('form_block_form_alter')] + public static function formBlockFormAlter(&$form, FormStateInterface $form_state, $form_id) { + // Call the helper class to implement the form alter logic. + \Drupal::service('block_class.helper')->blockClassFormAlter($form, $form_state); + } + + /** + * Implements hook_form_FORM_ID_alter(). + */ + #[Hook('form_block_class_admin_bulk_operations_alter')] + public static function formBlockClassAdminBulkOperationsAlter(&$form, FormStateInterface $form_state, $form_id) { + // Add the library for bulk operation. + $form['#attached']['library'][] = 'block_class/block-class'; + // Get the config object. + $config = \Drupal::configFactory()->getEditable('block_class.settings'); + // Get the default case on settings. + $default_case = $config->get('default_case', 'standard'); + // Put the "default case" in the Drupal settings to be used in the JS. + $form['#attached']['drupalSettings']['block_class']['default_case'] = $default_case; + } + + /** + * Implements hook_preprocess_HOOK(). + */ + #[Hook('preprocess_block')] + public static function preprocessBlock(&$variables) { + // Call the helper class to implement the preprocess block logic. + \Drupal::service('block_class.helper')->blockClassPreprocessBlock($variables); + } + +} diff --git a/tests/src/Functional/BlockClassBulkOperationsTest.php b/tests/src/Functional/BlockClassBulkOperationsTest.php index 96474de..a53d801 100644 --- a/tests/src/Functional/BlockClassBulkOperationsTest.php +++ b/tests/src/Functional/BlockClassBulkOperationsTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\block_class\Functional; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\block_class\Constants\BlockClassConstants; use Drupal\Tests\BrowserTestBase; @@ -10,6 +12,8 @@ use Drupal\Tests\BrowserTestBase; * * @group block_class */ +#[Group('block_class')] +#[RunTestsInSeparateProcesses] class BlockClassBulkOperationsTest extends BrowserTestBase { /** diff --git a/tests/src/Functional/BlockClassControllerTest.php b/tests/src/Functional/BlockClassControllerTest.php index 0a8b093..e024dfa 100644 --- a/tests/src/Functional/BlockClassControllerTest.php +++ b/tests/src/Functional/BlockClassControllerTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\block_class\Functional; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\block_class\Constants\BlockClassConstants; use Drupal\Tests\BrowserTestBase; @@ -10,6 +12,8 @@ use Drupal\Tests\BrowserTestBase; * * @group block_class */ +#[Group('block_class')] +#[RunTestsInSeparateProcesses] class BlockClassControllerTest extends BrowserTestBase { /** diff --git a/tests/src/Functional/BlockClassFormOperationsTest.php b/tests/src/Functional/BlockClassFormOperationsTest.php index e1dda4c..a1b8d40 100644 --- a/tests/src/Functional/BlockClassFormOperationsTest.php +++ b/tests/src/Functional/BlockClassFormOperationsTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\block_class\Functional; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\block_class\Constants\BlockClassConstants; use Drupal\Tests\BrowserTestBase; @@ -10,6 +12,8 @@ use Drupal\Tests\BrowserTestBase; * * @group block_class */ +#[Group('block_class')] +#[RunTestsInSeparateProcesses] class BlockClassFormOperationsTest extends BrowserTestBase { /** diff --git a/tests/src/Functional/BlockClassSettingsFormTest.php b/tests/src/Functional/BlockClassSettingsFormTest.php index 2c97529..3831aff 100644 --- a/tests/src/Functional/BlockClassSettingsFormTest.php +++ b/tests/src/Functional/BlockClassSettingsFormTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\block_class\Functional; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\block_class\Constants\BlockClassConstants; use Drupal\Tests\BrowserTestBase; @@ -10,6 +12,8 @@ use Drupal\Tests\BrowserTestBase; * * @group block_class */ +#[Group('block_class')] +#[RunTestsInSeparateProcesses] class BlockClassSettingsFormTest extends BrowserTestBase { /** diff --git a/tests/src/Functional/BlockClassTest.php b/tests/src/Functional/BlockClassTest.php index 5aa69fa..ea9318c 100644 --- a/tests/src/Functional/BlockClassTest.php +++ b/tests/src/Functional/BlockClassTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\block_class\Functional; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\block_class\Constants\BlockClassConstants; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\BrowserTestBase; @@ -13,6 +15,8 @@ use Drupal\Tests\BrowserTestBase; * * @group block_class */ +#[Group('block_class')] +#[RunTestsInSeparateProcesses] class BlockClassTest extends BrowserTestBase { use StringTranslationTrait;