Forked from kevinohara/sfdc-trigger-framework.
This framework is modified by introducing a few additional concepts borrowed from Apex Enterprise Patterns as well as a common pattern designed to use Custom Settings to bypass triggers.
3 new overridable methods have been added:
isDisabled()
- Intended to be used with a Custom Setting
- If it returns false, then skip all other methods
applyDefaults()
- Runs before the
beforeInsert()
method
- Runs before the
validate()
- Runse before the
afterInsert()
andafterUpdate()
methods
- Runse before the
Simple example:
public with sharing class AccountTriggerHandler extends TriggerHandler {
public override Boolean isDisabled() {
return BypassAutomation__c.getInstance().Accounts__c;
}
public override void applyDefaults() {}
public override void validate() {}
}
Deploy to SFDX Scratch Org: Deploy
Deploy to Salesforce Org: Deploy
To create a trigger handler, you simply need to create a class that inherits from TriggerHandler.cls. Here is an example for creating an Opportunity trigger handler.
public class OpportunityTriggerHandler extends TriggerHandler {
In your trigger handler, to add logic to any of the trigger contexts, you only need to override them in your trigger handler. Here is how we would add logic to a beforeUpdate
trigger.
public class OpportunityTriggerHandler extends TriggerHandler {
public override void beforeUpdate() {
for(Opportunity o : (List<Opportunity>) Trigger.new) {
// do something
}
}
// add overrides for other contexts
}
Note: When referencing the Trigger statics within a class, SObjects are returned versus SObject subclasses like Opportunity, Account, etc. This means that you must cast when you reference them in your trigger handler. You could do this in your constructor if you wanted.
public class OpportunityTriggerHandler extends TriggerHandler {
private Map<Id, Opportunity> newOppMap;
public OpportunityTriggerHandler() {
this.newOppMap = (Map<Id, Opportunity>) Trigger.newMap;
}
public override void afterUpdate() {
//
}
}
To use the trigger handler, you only need to construct an instance of your trigger handler within the trigger handler itself and call the run()
method. Here is an example of the Opportunity trigger.
trigger OpportunityTrigger on Opportunity (before insert, before update) {
new OpportunityTriggerHandler().run();
}
To prevent recursion, you can set a max loop count for Trigger Handler. If this max is exceeded, and exception will be thrown. A great use case is when you want to ensure that your trigger runs once and only once within a single execution. Example:
public class OpportunityTriggerHandler extends TriggerHandler {
public OpportunityTriggerHandler() {
this.setMaxLoopCount(1);
}
public override void afterUpdate() {
List<Opportunity> opps = [SELECT Id FROM Opportunity WHERE Id IN :Trigger.newMap.keySet()];
update opps; // this will throw after this update
}
}
What if you want to tell other trigger handlers to halt execution? That's easy with the bypass api:
public class OpportunityTriggerHandler extends TriggerHandler {
public override void afterUpdate() {
List<Opportunity> opps = [SELECT Id, AccountId FROM Opportunity WHERE Id IN :Trigger.newMap.keySet()];
Account acc = [SELECT Id, Name FROM Account WHERE Id = :opps.get(0).AccountId];
TriggerHandler.bypass('AccountTriggerHandler');
acc.Name = 'No Trigger';
update acc; // won't invoke the AccountTriggerHandler
TriggerHandler.clearBypass('AccountTriggerHandler');
acc.Name = 'With Trigger';
update acc; // will invoke the AccountTriggerHandler
}
}
If you need to check if a handler is bypassed, use the isBypassed
method:
if (TriggerHandler.isBypassed('AccountTriggerHandler')) {
// ... do something if the Account trigger handler is bypassed!
}
If you want to clear all bypasses for the transaction, simple use the clearAllBypasses
method, as in:
// ... done with bypasses!
TriggerHandler.clearAllBypasses();
// ... now handlers won't be ignored!
Here are all of the methods that you can override. All of the context possibilities are supported.
beforeInsert()
beforeUpdate()
beforeDelete()
afterInsert()
afterUpdate()
afterDelete()
afterUndelete()
isDisabled()
applyDefaults()
validate()