trigger - mymagic/open_hub GitHub Wiki

Yii Framework support event driven application out of the box by default. To avoid confuse with Event model of OpenHub, we called it Trigger.

Custom Trigger

class TestModel extends ActiveRecordBase
{
    // ...
    public function setApprove()
    {
        if ($this->save()) {
            $this->raiseEvent('onApproveSuccess', new CEvent($this, array('model' => $this)));
        } else {
            $this->raiseEvent('onApproveFailed', new CEvent($this, array('model' => $this)));
        }
    }

    // this is required event is empty
    public function onApproveSuccess($event){}

    // this is required event is empty
    public function onApproveFailed($event){}
}

To trigger it (usually from controller):

$model = new TestModel();

$model->attachEventHandler('onApproveSuccess', function ($event) {echo "Test model #".$event->params['model']->id." is updated successfully");});
$model->attachEventHandler('onApproveFailed', function ($event) {echo "Test model #".$event->params['model']->id." failed to update");});

Built-in Trigger

Developers may built-in trigger to their module at model and controller level, for other modules to add on features to it.

For example, job module cpanel publishJob() trigger this event upon job publishing successfully.

HUB::triggerEvent($this->module, 'publishJob', array('jobVacancy' => $model));

MagicOps module can implement this event with the following code in MagicOpsModule

public function triggerJobPublishJob($params)
{
    $msg = sprintf(Yii::t('magicOps', "'{organizationTitle}' published new job vacancy '{jobTitle}' {link}", array(
        '{organizationTitle}' => $params['jobVacancy']->ownerOrganization->title,
        '{jobTitle}' => $params['jobVacancy']->title,
        '{link}' => $params['jobVacancy']->getPublicUrl(true),
    )));
    if (YeeModule::hasActiveModule('discord')) {
        HubDiscord::broadcast($msg, Yii::app()->getModule('job')->discordChannelPublishedJob);
    }
}

Common building blocks

Organization

• triggerHubOrganizationCreateOrganization(['organization'=>$organization])
• triggerHubOrganizationUpdateOrganization(['organization'=>$organization])

Individual

• triggerHubIndividualCreateIndividual(['individual'=>$individual])
• triggerHubIndividualUpdateIndividual(['individual'=>$individual])

Event

• triggerHubEventCreateEvent(['event'=>$event])
• triggerHubEventUpdateEvent(['event'=>$event])

Default Modules

Registry

• triggerHubRegistrySet(['registry'=>$registry])

CV

• triggerCVEnablePortfolio(['cvPortfolio'=>$cvPortfolio])
• triggerCVDisablePortfolio(['cvPortfolio'=>$cvPortfolio])

Job

• triggerJobSubmit(['jobVacancy'=>$jobVacancy])
• triggerJobPublishJob(['jobVacancy'=>$jobVacancy])
• triggerJobUnpublishJob(['jobVacancy'=>$jobVacancy])
• triggerJobApproveJob(['jobVacancy'=>$jobVacancy])

Modules

Challenge

• triggerChallengeApprove(['challenge'=>$challenge])
• triggerChallengeReject(['challenge'=>$challenge])
• triggerChallengePublishChallenge(['challenge'=>$challenge])
• triggerChallengeUnpublishChallenge(['challenge'=>$challenge])