Skip to content

Commit 3d3e995

Browse files
committed
Update Taxes::EVENT_REGISTER_TAX_ENGINE phpdoc
1 parent f610d85 commit 3d3e995

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/services/Taxes.php

+20
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,26 @@ class Taxes extends Component implements TaxEngineInterface
2424
/**
2525
* @event TaxEngineEvent The event that is triggered when determining the tax engine.
2626
* @since 3.1
27+
*
28+
* ```php
29+
* use craft\commerce\base\TaxEngineInterface;
30+
* use craft\commerce\engines\Tax;
31+
* use craft\commerce\events\TaxEngineEvent;
32+
* use craft\commerce\services\Taxes;
33+
* use yii\base\Event;
34+
*
35+
* Event::on(
36+
* Taxes::class,
37+
* Taxes::EVENT_REGISTER_TAX_ENGINE,
38+
* function(TaxEngineEvent $event) {
39+
* // @var TaxEngineInterface $currentEngine
40+
* $currentEngine = $event->engine;
41+
*
42+
* // Set a new tax engine on `$event->engine`
43+
* // ...
44+
* }
45+
* );
46+
* ```
2747
*/
2848
public const EVENT_REGISTER_TAX_ENGINE = 'registerTaxEngine';
2949

0 commit comments

Comments
 (0)