workflow_stream_edit_fns.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset_edit/asset_edit_fns.inc';

class Workflow_Stream_Edit_Fns extends Asset_Edit_Fns
{


    function __construct()
    {
        parent::__construct();

    }//end constructor


    public function paintNewStep(Workflow_Stream $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;

        require_once SQ_LIB_PATH.'/html_form/html_form.inc';
        echo translate('create_new_step_called').' ';
        text_box($prefix.'_new_step', '', 20);
        return TRUE;

    }//end paintNewStep()


    public function processNewStep(Workflow_Stream $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;

        if (isset($_POST[$prefix.'_new_step']) && trim($_POST[$prefix.'_new_step'])) {
            $new_step_name = trim($_POST[$prefix.'_new_step']);
            $GLOBALS['SQ_SYSTEM']->am->includeAsset('workflow_step');
            $new_step = new Workflow_Step();
            $schema_link = Array('asset' => &$asset, 'link_type' => SQ_LINK_TYPE_2, 'sort_order' => -1, 'is_dependant' => 1);
            $new_step->setAttrValue('name', $new_step_name);
            if (!$new_step->create($schema_link)) return FALSE;
        }

        return TRUE;

    }//end processNewStep()


    public function paintWorkflowSummary(Workflow_Stream $asset, Backend_Outputter $o, $prefix)
    {
        $o->addCssInclude(sq_web_path('data').'/asset_types/'.$asset->type().'/css/workflow_stream_edit_fns.css');
        $o->addJsInclude(sq_web_path('data').'/asset_types/'.$asset->type().'/js/workflow_stream_edit_fns.js');
        $am = $GLOBALS['SQ_SYSTEM']->am;

        $write_access = $asset->writeAccess('links');
        if ($write_access) {
            $o->addOnLoad('MatrixWorkflowSchema.onLoad();');
        }

            // show the workflow summary, and allow us to reorder it
            $steps_to_process = Array(
                                    Array(
                                        'assetid'   => $asset->id,
                                        'depth'     => -1,
                                    )
                                );

            $step_order = Array();

            while (count($steps_to_process) > 0) {
                $current_step = array_shift($steps_to_process);
                if ($current_step['depth'] >= 0) {
                    $step_order[] = $current_step;
                }
                $current_links = array_reverse($am->getLinks($current_step['assetid'], SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE));
                foreach ($current_links as $current_link) {
                    $new_step = Array(
                                    'assetid'   => $current_link['minorid'],
                                    'depth'     => $current_step['depth'] + 1,
                                );
                    array_unshift($steps_to_process, $new_step);
                }
            }

            if (count($step_order) > 0) {
                $step_nums = Array(0);
                $current_depth = 0;
                foreach ($step_order as $step) {
                    if ($step['depth'] > $current_depth) {
                        // This step is deeper, ie. starting a new escalation step
                        array_push($step_nums, 0);
                        echo '<div class="sq-workflow-step-escalation-indent">';
                        $current_depth = $step['depth'];
                    }

                    while ($step['depth'] < $current_depth) {
                        // exiting an escalation step... but we need to be able to exit more than one at once
                        array_pop($step_nums);
                        $current_depth--;
                        echo '<div class="sq-workflow-step-divider"></div>';
                        echo '</div>';
                    }

                    echo '<div class="sq-workflow-step-divider"></div>';

                    // Okay, now at current depth, so increment step number;
                    $current_step_num = array_pop($step_nums);
                    $current_step_num++;
                    array_push($step_nums, $current_step_num);

                    $step_assetid = $step['assetid'];
                    $step_asset =& $am->getAsset($step_assetid);

                    echo '<div id="'.$prefix.'workflow-step-'.$step_assetid.'" class="sq-workflow-step">';
                    if ($write_access) {
                        hidden_field($prefix.'_step_order[]', $step_assetid);
                    }

                    echo '<div class="sq-workflow-step-drag">';
                    if ($write_access) {
                        sq_print_icon(sq_web_path('data').'/asset_types/'.$asset->type().'/files/wf_drag_handle.png', 16, 16, 'Re-Order', 'Re-Order Step', 'align="absmiddle" class="sq-workflow-step-drag-handle"');
                    }
                    echo 'Step '.implode('.', $step_nums).'</div>';
                    echo '<div class="sq-workflow-step-tag-line">'.$step_asset->name.'</div>';
                    echo '<div class="sq-workflow-step-condition"><strong>Conditions:</strong> ';
                        $conditions = $am->getLinks($step_assetid, SQ_LINK_TYPE_2, 'workflow_step_condition', TRUE, 'major', NULL, TRUE);
                        if (count($conditions) === 1) {
                            $condition = reset($conditions);
                            $userids = $am->getAttributeValuesByName('userid', 'workflow_step_condition', Array($condition['minorid']));
                            $userid = $userids[$condition['minorid']];
                            echo get_asset_tag_line($userid);
                        } else if (count($conditions) === 0) {
                            echo '<span class="sq-backend-warning">None selected</span>';
                        } else {
                            if (($step_asset->attr('logic') === 'all') || ($step_asset->attr('logic_num') == count($conditions))) {
                                echo 'All '.count($conditions);
                            } else {
                                echo 'At least '.$step_asset->attr('logic_num').' of '.count($conditions);
                            }
                        }
                    echo '</div>';

                    echo '<div class="sq-workflow-step-expiry"><strong>Expiry:</strong> ';
                        $expiry = (int)$step_asset->attr('expiry_time');
                        if ($expiry === 0) {
                            echo 'None set';
                        } else {
                            if ($step_asset->attr('escalate')) {
                                echo '<span class="sq-backend-warning">Escalates</span>';
                            } else {
                                echo 'Reminder';
                            }
                            echo ' after ';

                            $hours = ($expiry / 3600);

                            echo easy_time_total($expiry);
                        }

                    echo '</div>';

                    if ($step['depth'] === 0) {
                        $step_url = '#step-'.$step_assetid;
                    } else {
                        $step_url = $step_asset->getBackendHref('details');
                    }
                    echo '<div class="sq-workflow-step-edit-link">[ <a href="'.$step_url.'">Edit this step</a> ]</div>';
                    echo '<div style="clear: both"></div>';
                    echo '</div>';
                }

                // Do we have any overhanging escalation steps for the last main step?
                while ($current_depth > 0) {
                    echo '<div class="sq-workflow-step-divider"></div>';
                    echo '</div>';
                    $current_depth--;
                }

                // Add a drop point after the last main step
                echo '<div class="sq-workflow-step-divider"></div>';
            }


        return $write_access;

    }//end paintWorkflowSummary()


    public function processWorkflowSummary(Workflow_Stream $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('links')) return FALSE;

        $new_step_order = array_get_index($_POST, $prefix.'_step_order', Array());
        $am = $GLOBALS['SQ_SYSTEM']->am;

        $links_to_build = Array($asset->id);
        $link_assetids = Array();

        while (count($links_to_build) > 0) {
            $assetid = array_shift($links_to_build);
            $current_links = $am->getLinks($assetid, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE);

            // If we have at least 2 links, we can at least move it
            // Even if only 1 though, we need to see if it has multiple
            // escalation steps
            foreach ($current_links as $link) {
                $links_to_build[] = $link['minorid'];
                if (count($current_links) >= 2) {
                    $new_index = array_search($link['minorid'], $new_step_order);
                    $link_assetids[$assetid][$new_index] = $link['minorid'];
                }
            }
        }

        foreach (array_keys($link_assetids) as $link_key) {
            // Sort keys, then use PHP's rule about numeric indices to get the
            // proper sort order for each parent
            ksort($link_assetids[$link_key]);
            $link_assetids[$link_key] = array_values($link_assetids[$link_key]);
            foreach ($link_assetids[$link_key] as $sort_order => $minor_assetid) {
                $link = $am->getLinkByAsset($link_key, $minor_assetid, SQ_LINK_TYPE_2);
                if ($sort_order != $link['sort_order']) {
                    // If the sort order is different, then update it
                    $am->moveLinkPos($link['linkid'], $sort_order);
                }
            }
        }

        return TRUE;

    }//end processWorkflowSummary()


    public function paintSteps(Workflow_Stream $asset, Backend_Outputter $o, $prefix)
    {
        require_once SQ_LIB_PATH.'/html_form/html_form.inc';
        $write_access = $asset->writeAccess('links');
        $ok = $write_access;

        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE);
        $i = 1;
        foreach ($current_links as $link_data) {
            $step = $GLOBALS['SQ_SYSTEM']->am->getAsset($link_data['minorid']);
            if (is_null($step)) continue;

            $o->openSection('Step '.$i.' - '.$step->name);
                if ($write_access) {
                    $o->openField('Delete ?');
                        check_box($prefix.'_delete_steps['.$link_data['linkid'].']');
                        label(translate('delete_step_and_conditions_question'), $prefix.'_delete_steps['.$link_data['linkid'].']');
                    $o->closeField();
                }
                $edit_fns = $step->getEditFns();
                if (!$edit_fns->paintStep($step, $o)) $ok = FALSE;
            $o->closeSection();

            $i++;
        }

        return $ok;

    }//end paintSteps()


    public function processSteps(Workflow_Stream $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;
        $updated = FALSE;

        // process current steps
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE);
        foreach ($current_links as $link_data) {
            $step = $GLOBALS['SQ_SYSTEM']->am->getAsset($link_data['minorid']);
            if (is_null($step)) continue;
            $edit_fns = $step->getEditFns();
            if ($edit_fns->processStep($step, $o)) $updated = TRUE;
        }

        // delete any steps that need deleting
        if (isset($_POST[$prefix.'_delete_steps'])) {
            $delete_steps = $_POST[$prefix.'_delete_steps'];
            foreach ($delete_steps as $linkid => $on) {
                if ($asset->deleteLink($linkid)) $updated = TRUE;
            }
        }

        return $updated;

    }//end processSteps()


    public function generateWorkflowArray(Workflow_Stream $asset)
    {
        $workflow_array['steps']        = Array();
        $workflow_array['current_step'] = Array('1');
        $workflow_array['complete']     = FALSE;
        $workflow_array['schema_name']  = $asset->name;
        $workflow_array['started']      = time();
        $workflow_array['started_by']   = $GLOBALS['SQ_SYSTEM']->currentUserId();

        $i = 1;
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE);
        foreach ($current_links as $link_data) {
            $step = $GLOBALS['SQ_SYSTEM']->am->getAsset($link_data['minorid']);
            if (is_null($step)) continue;
            $edit_fns = $step->getEditFns();
            $workflow_array['steps'][$i] = Array();
            if (!$edit_fns->generateWorkflowArray($step, $workflow_array['steps'][$i])) {
                return FALSE;
            }
            if ($i == 1) {
                $workflow_array['steps'][$i]['started'] = time();
            }
            $i++;
        }
        return $workflow_array;

    }//end generateWorkflowArray()


}//end class

?>