hipo_job_trigger_batch_events.inc

<?php
require_once SQ_SYSTEM_ROOT.'/core/hipo/hipo_job.inc';

class HIPO_Job_Trigger_Batch_Events extends HIPO_Job
{


    function HIPO_Job_Trigger_Batch_Events($code_name='')
    {
        $this->HIPO_Job($code_name);

    }//end constructor


    public static function paintConfig(&$o, $class, $write_access)
    {
        // threshhold HIPO config entry
        $o->openField(translate('trigger_execution_threshold'));

        if ($write_access) {
            text_box($class.'[SQ_HIPO_TRIGGER_BATCH_EVENTS_THRESHOLD]', SQ_HIPO_TRIGGER_BATCH_EVENTS_THRESHOLD, 0);
        } else {
            echo SQ_HIPO_TRIGGER_BATCH_EVENTS_THRESHOLD;
        }

        $o->closeField();

    }//end paintConfig()


    public static function getConfigVars()
    {
        return Array(
                'SQ_HIPO_TRIGGER_BATCH_EVENTS_THRESHOLD'    => Array('editable' => 1, 'default' => 0),
               );

    }//end getConfigVars()


    function getCodeName()
    {
        return parent::getCodeName().'-u'.$GLOBALS['SQ_SYSTEM']->currentUserId().'-a'.$this->_running_vars['codename_target'].'-'.$this->_running_vars['codename_propagate'];

    }//end getCodeName()


    function getHipoName()
    {
        return translate('hipo_name_trigger_batch_events');

    }//end getHipoName()


    function getInitialStepData()
    {
        return Array(
                Array(
                    'name'          => translate('hipo_processing_assets'),
                    'function_call' => Array(
                                        'process_function'  => 'processAssets',
                                       ),
                    'running_mode'  => 'server',
                    'auto_step'     => true,
                    'allow_cancel'  => true,
                    'percent_done'  => 0,
                    'complete'      => false,
                    'message'       => '',
                ),
               );

    }//end getInitialStepData()


    function getThresholdPercentageRequired()
    {
        if (SQ_HIPO_TRIGGER_BATCH_EVENTS_THRESHOLD == 0) {
            return 0;
        }

        if (empty($this->_running_vars['assets'])) return 0;

        return (($this->_running_vars['total_steps'] / SQ_HIPO_TRIGGER_BATCH_EVENTS_THRESHOLD) * 100);

    }//end getThresholdPercentageRequired()


    function freestyle()
    {
        while (!empty($this->_running_vars['assets'])) {
            if (!$this->processAssets($this->_steps[0], get_class($this))) {
                return false;
            }
        }
        return true;

    }//end freestyle()


    function prepare()
    {
        // to start the batch events, we need to have asset ids and the events to fire on each
        if (empty($this->_running_vars['assets']) || empty($this->_running_vars['events'])) {
            trigger_localised_error('HIPO0002', E_USER_WARNING);
            return false;
        }

        // total steps is the number of assets * the number of events to broadcast for each.
        $this->_running_vars['total_steps'] = count($this->_running_vars['assets']) * count($this->_running_vars['events']);
        $this->_running_vars['step_value']  = (int) (100 / $this->_running_vars['total_steps']);

        if (empty($this->_running_vars['event_parameters'])) $this->_running_vars['event_parameters'] = NULL;
        
        return parent::prepare();

    }//end prepare()


    function processAssets(&$step_data, $prefix)
    {
        if (empty($this->_running_vars['current_events'])) {
            if (empty($this->_running_vars['assets'])) {
                // update percentages, set completed
                $step_data['complete'] = true;
                $step_data['percent_done'] = 100;
                return true;
            }
            $this->_running_vars['current_events'] = $this->_running_vars['events'];
            $this->_running_vars['current_assetid'] = array_pop($this->_running_vars['assets']);
        }

        $current_event = array_pop($this->_running_vars['current_events']);
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->_running_vars['current_assetid']);
        $GLOBALS['SQ_SYSTEM']->broadcastTriggerEvent($current_event, $asset, $this->_running_vars['event_parameters']);

        $step_data['message'] = translate('hipo_broadcast_event', $current_event, $this->_running_vars['current_assetid']);
        $step_data['percent_done'] += $this->_running_vars['step_value'];
        $step_data['complete']     = false;

        return true;

    }//end processAssets()


}//end class

?>