trigger_action_delete_future_status.inc

<?php
require_once SQ_INCLUDE_PATH.'/general_occasional.inc';

class Trigger_Action_Delete_Future_Status extends Trigger_Action
{


    public static function execute($settings, &$state)
    {
        // check settings, status
        if (empty($settings['status'])) {
            // if no settings, fail
            return FALSE;
        }

        if (empty($state['asset'])) {
            // grab the asset if assetid is given, but not the asset.
            if (empty($state['assetid'])) {
                return FALSE;
            } else {
                $state['asset'] = $GLOBALS['SQ_SYSTEM']->am->getAsset($state['assetid']);
            }
        }
        $assetid = $state['asset']->id;

        $cron_mgr = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('cron_manager');
        if (is_null($cron_mgr)) return FALSE;

        // nothing to process
        $GLOBALS['SQ_SYSTEM']->am->includeAsset('cron_job_future_status');
        $future_status_jobs = Cron_Job_Future_Status::getActiveJobs($state['asset']);
        if (empty($future_status_jobs)) return TRUE;

        $status_list = Trigger_Action_Delete_Future_Status::_getStatusList();
        $jobids = Array();

        foreach ($future_status_jobs as $job) {
            // Does it meet the conditions?
            $status_desc = $job->statusName();
            if ($status_desc != $status_list[$settings['status']]) {
                continue;
            }

            // Okidoki, let's delete them
            if (!$cron_mgr->removeJob($job)) {
                trigger_localised_error('CORE0261', E_USER_WARNING, $job->id);
            } else {
                $jobids[] = $job->id;
            }
        }

        return Array(
                'jobids'    => $jobids,
               );

    }//end execute()


    public static function getInterface($settings, $prefix, $write_access=FALSE)
    {
        if (empty($settings['status'])) {
            // set to default
            $selected_status = SQ_STATUS_UNDER_CONSTRUCTION;
        } else {
            $selected_status = $settings['status'];
        }

        $status_list = Trigger_Action_Delete_Future_Status::_getStatusList();

        if (!$write_access) {
            $form_element_extras = 'disabled="disabled"';
        } else {
            $form_element_extras = '';
        }

        ob_start();
            echo translate('trigger_delete_future_status');
            combo_box($prefix.'[status]', $status_list, FALSE, $selected_status, NULL, $form_element_extras);
            $html = ob_get_contents();
        ob_end_clean();

        return $html;

    }//end getInterface()


    public static function processInterface(&$settings, $request_data)
    {
        // status
        $status = array_get_index($request_data, 'status', NULL);
        if (is_null($status)) {
            return 'Status has not been specified';
        }

        $status_list = Trigger_Action_Delete_Future_Status::_getStatusList();

        // check if the status is valid
        if (!isset($status_list[$status])) {
            return 'Specified status is invalid';
        }
        $settings['status'] = $status;

        return FALSE;

    }//end processInterface()


    protected static function _getStatusList()
    {
        $status = Array();
        foreach (get_constant_values('SQ_STATUS_') as $status_value) {
            $status[$status_value] = get_status_description($status_value);
        }
        return $status;

    }//end _getStatusList()


}//end class

?>