Plugin: Detecting Which action just Triggered your Plugin?

☆ A M B ☆
2,475 Posts

Everett Reply #1, 17 years ago

If you have a plugin that is triggered by more than one event, how can you tell which event called the plugin? I know I can make a solution work by writing separate plugin code for each event involved in a process, but it’d be nice to keep things in one place if possible and use something like:

switch ($the_event_that_called_me): 
case 'OnDocLoad':
...
case 'OnSave':
...

This is currently for MODx 0.9.6.3 - 1.0... but it’d also be useful for Revolution too.

Thanks!

Hosting stuff: http://fireproofsocks.com/
Coding stuff: http://craftsmancoding.com/
Blog stuff: http://tipsfor.us/

☆ A M B ☆
2,475 Posts

Everett Reply #2, 17 years ago

Answered my own question.... within your plugin, you can get the name of the event using this:

print $modx->Event->name;

Hosting stuff: http://fireproofsocks.com/
Coding stuff: http://craftsmancoding.com/
Blog stuff: http://tipsfor.us/

MODX Staff
10,725 Posts

opengeek Reply #3, 17 years ago

Just as an FYI, the uppercase $modx->Event is deprecated in favor of $modx->event, for consistency.

Jason Coward
Chief Architect @ MODX
http://www.jasoncoward.com | http://twitter.com/drumshaman | https://github.com/opengeek

☆ A M B ☆
2,475 Posts

Everett Reply #4, 17 years ago

Thanks, Jason. Noted.

Hosting stuff: http://fireproofsocks.com/
Coding stuff: http://craftsmancoding.com/
Blog stuff: http://tipsfor.us/