hipo_job_quick_hipo.inc

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

class HIPO_Job_Quick_HIPO extends HIPO_Job
{


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

    }//end constructor


    function getCodeName()
    {
        $items = Array();
        foreach ($this->_running_vars['items'] as $key => $val) {
            $items[] = $key.'='.$val;
        }

        return parent::getCodeName().'-'.$this->_running_vars['callback_assetid'].'-'.md5(implode(',', $items));

    }//end getCodeName()


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

    }//end getHipoName()


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

    }//end getInitialStepData()


    function freestyle()
    {
        while (!empty($this->_running_vars['todo_items'])) {
            if (!$this->processQuickHipo($this->_steps[0], get_class($this))) {
                return FALSE;
            }
        }
        return TRUE;

    }//end freestyle()


    function &_getCallbackAsset()
    {
        $null = NULL;
        $callback_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->_running_vars['callback_assetid']);

        if (is_null($callback_asset)) {
            trigger_localised_error('HIPO0080', E_USER_ERROR, $this->_running_vars['callback_assetid']);
            return $NULL;
        }

        if (!method_exists($callback_asset, $this->_running_vars['callback_function'])) {
            trigger_localised_error('HIPO0081', E_USER_ERROR, $this->_running_vars['callback_function']);
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($callback_asset);
            return $NULL;
        }

        return $callback_asset;

    }//end _getCallbackAsset()


    function prepare()
    {
        // to start acquiring locks, we need to have an asset id to acquire a lock on
        if (empty($this->_running_vars['items'])) {
            trigger_localised_error('HIPO0079', E_USER_WARNING, translate('hipo_name_quick_hipo'));
            return FALSE;
        }

        // check that the callback asset is valid, and the callback function exists
        $callback_asset = $this->_getCallbackAsset();
        if (is_null($callback_asset)) return FALSE;

        $this->_running_vars['total_count'] = count($this->_running_vars['items']);
        $this->_running_vars['todo_items']  = array_keys($this->_running_vars['items']);
        $this->_running_vars['done_items']  = Array();

        return parent::prepare();

    }//end prepare()


    function processQuickHipo(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_items'])) {

            // check that the callback asset is valid, and the callback function exists
            $callback_asset = $this->_getCallbackAsset();
            if (is_null($callback_asset)) return FALSE;

            $current_item_index = reset($this->_running_vars['todo_items']);
            $callback_function  = $this->_running_vars['callback_function'];

            if (!$callback_asset->$callback_function($current_item_index, $this->_running_vars['items'][$current_item_index], $this->_running_vars['settings'])) {
                if ($this->_running_vars['fail_on_error']) {
                    return FALSE;
                }
            }

            // add this item to the done array so we dont do it again, then remove the item from the todo list
            $this->_running_vars['done_items'][] = $current_item_index;
            array_shift($this->_running_vars['todo_items']);
        }

        if (empty($this->_running_vars['todo_items'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete']     = TRUE;
        } else {
            $step_data['percent_done'] = (count($this->_running_vars['done_items']) / $this->_running_vars['total_count']) * 100;
            $step_data['complete']     = FALSE;
        }

        return TRUE;

    }//end processQuickHipo()


}//end class

?>