hipo_job_generate_report.inc

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

class HIPO_Job_Generate_Report extends HIPO_Job
{


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

    }//end constructor


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

        if ($write_access) {
            text_box($class.'[SQ_HIPO_REGENERATE_REPORT_THRESHOLD]', SQ_HIPO_REGENERATE_REPORT_THRESHOLD, 5);
        } else {
            echo SQ_HIPO_REGENERATE_REPORT_THRESHOLD;
        }
        echo ' '.translate('assets');

        $o->closeField();

    }//end paintConfig()


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

    }//end getConfigVars()


    function getThresholdPercentageRequired()
    {
        if (SQ_HIPO_REGENERATE_REPORT_THRESHOLD == 0) return 0;
        if (!isset($this->_running_vars['todo'])) return 0;
        if (!is_array($this->_running_vars['todo'])) return 0;
        return (((count($this->_running_vars['todo']) + 1) / SQ_HIPO_REGENERATE_REPORT_THRESHOLD) * 100);

    }//end getThresholdPercentageRequired()


    function getCodeName()
    {
        return parent::getCodeName().'-'.$this->_running_vars['assetid'];

    }//end getCodeName()


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

    }//end getHipoName()


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

    }//end getInitialStepData()


    function freestyle()
    {
        while (empty($this->_running_vars['complete']) && !empty($this->_running_vars['assetid'])) {
            if (!$this->processReport($this->_steps[0], get_class_lower($this))) {
                return FALSE;
            }
        }
        return TRUE;

    }//end freestyle()


    function prepare()
    {
        if (empty($this->_running_vars['assetid'])) {
            trigger_localised_error('HIPO0008', E_USER_WARNING);
            return FALSE;
        }

        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->_running_vars['assetid']);
        $this->_running_vars['type_code'] = $asset->type();
        $this->_running_vars['complete']  = FALSE;
        return parent::prepare();

    }//end prepare()


    function processReport(&$step_data, $prefix)
    {
        if ($step_data['complete']) {
            $this->_running_vars['complete'] = TRUE;
        }
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->_running_vars['assetid'], $this->_running_vars['type_code']);
        $edit_fns = $asset->getEditFns();

        return $edit_fns->generateReport($this, $step_data, $prefix);

    }//end processReport()


}//end class

?>