Bundle Classes for the Win

Event: DrupalCamp Pune 2023

Drupal 9.3 introduced Bundle Classes. Bundle classes allow us to encapsulate business logic into bundle specific classes. Wonder what are the ways we can use Bundle classes? We will be discussing various types of use cases that we can consider while implementing bundle classes.

In this session we are discussing:

What are the bundle classes
Easy and quick ways to define bundle classes using bca module.
How can we define the methods and use those effectively in twig templates
Impact of bundle classes in the theming
Get computed values from various fields of entity and use it
Write generic methods that are specific to entity’s requirements.
Creating reusable traits to share behaviours across entity-types and projects.

Demo Repository: https://github.com/mohit-rocks/bundle-classes-demo

Transcript

1. Mohit Aghera
   Drupal Developer
   Bundle Classes for the Win 📦
   

   View Slide

2. I’m Mohit Aghera
   Who am I?
   Today I’ll cover:
   Drupal Developer at PreviousNext.
   Drupal.org: mohit_aghera
   Twitter: mohit-rocks
   ● Introduction to Bundle classes
   ● How we can use the bundle classes
   ● Various methods to use the bundle classes
   

   View Slide

3. Established in early 2009 to provide full service
   consulting, design and development for large scale
   Drupal websites.
   Who is PreviousNext?
   Successfully delivered many Drupal based projects for Government, Higher Education,
   Media and Communications clients.
   Very experienced team with long term staff members.
   Strong contribution and involvement in the Drupal community.
   

   View Slide

4. Who have we worked with?
   

   View Slide

5. What are the bundle classes?
   ● Essentially they are business objects
   ● Unique class for each entity bundle
   

   View Slide

6. How to define Bundle Classes?
   Implement
   hook_entity_bundle_info_alter()
   

   View Slide

7. How to define Bundle Classes?
   ● Use “bca” contrib
   module
   ● Leverage annotation
   based discovery
   

   View Slide

8. Improvements in Twig templates
   🌱
   

   View Slide

9. Using methods in Twig
   

   View Slide

10. Implementation in Bundle classes
    

    View Slide

11. Using methods in Twig & TwigSandboxPolicy
    ● Default allowed method prefixes
    ○ “get”
    ○ “has”
    ○ “Is”
    ● Override “twig_sandbox_allowed_prefixes” in settings.php for more
    

    View Slide

12. Improvements in Theming 🎨🖌
    

    View Slide

13. Usage in template_preprocess methods
    node.html.twig
    Template
    pre-process in
    node.module
    

    View Slide

14. Usage in template_preprocess method ⚡
    node.html.twig
    Bundle Class
    

    View Slide

15. Prepare additional template variables
    Method in Bundle class
    Preprocess function in theme/module
    

    View Slide

16. Encourages reusable methods ♻
    

    View Slide

17. Build abstract classes
    ● Introduce common functionality to
    abstract base classes
    ● Even define generic methods in the
    abstract class like
    ○ getBody
    ○ getTags
    

    View Slide

18. Generic methods
    ● A few more example of generic methods like:
    ● Fetch the file from the media entity
    ● Prepare the array for featured Header
    ● Get the generated image url from the media using image styles
    ● Get taxonomy tags
    

    View Slide

19. Traits
    ● Create generic traits that allows reusability
    ● Include traits in bundle classes whenever
    required
    ● https://github.com/dpi/drupal-entity-traits
    

    View Slide

20. Test improvements - Method in Bundle class
    

    View Slide

21. Test improvements - Method test case
    

    View Slide

22. Sample Repository
    https://github.com/mohit-rocks/bundle-classes-demo
    

    View Slide

23. Questions?
    

    View Slide